PriceRule - admin-graphql - OBJECT

Version: 2024-04

Description:

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources.

Access Scopes

`read_price_rules` access scope.

Fields

• allocationLimit: Int - The maximum number of times that the price rule can be allocated onto an order.
• allocationMethod: PriceRuleAllocationMethod! - The method by which the price rule's value is allocated to its entitled items.
• app: App - The application that created the price rule.
• combinesWith: DiscountCombinesWith! - Determines which discount classes the discount can combine with.
• createdAt: DateTime! - The date and time when the price rule was created.
• customerSelection: PriceRuleCustomerSelection! - The customers that can use this price rule.
• discountClass: DiscountClass! - The class of the discount for combining purposes.
• discountCodesCount: Count - How many discount codes associated with the price rule.
• endsAt: DateTime - The date and time when the price rule ends. For open-ended price rules, use `null`.
• entitlementToPrerequisiteQuantityRatio: PriceRuleEntitlementToPrerequisiteQuantityRatio - Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
• features: PriceRuleFeature! - A list of the price rule's features.
• hasTimelineComment: Boolean! - Indicates whether there are any timeline comments on the price rule.
• id: ID! - A globally-unique ID.
• itemEntitlements: PriceRuleItemEntitlements! - The items to which the price rule applies.
• itemPrerequisites: PriceRuleLineItemPrerequisites! - The items required for the price rule to be applicable.
• legacyResourceId: UnsignedInt64! - The ID of the corresponding resource in the REST Admin API.
• oncePerCustomer: Boolean! - Whether the price rule can be applied only once per customer.
• prerequisiteQuantityRange: PriceRuleQuantityRange - The number of the entitled items must fall within this range for the price rule to be applicable.
• prerequisiteShippingPriceRange: PriceRuleMoneyRange - The shipping cost must fall within this range for the price rule to be applicable.
• prerequisiteSubtotalRange: PriceRuleMoneyRange - The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.
• prerequisiteToEntitlementQuantityRatio: PriceRulePrerequisiteToEntitlementQuantityRatio - Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.
• shareableUrls: PriceRuleShareableUrl! - URLs that can be used to share the discount.
• shippingEntitlements: PriceRuleShippingLineEntitlements! - The shipping lines to which the price rule applies.
• startsAt: DateTime! - The date and time when the price rule starts.
• status: PriceRuleStatus! - The status of the price rule.
• summary: String - A detailed summary of the price rule.
• target: PriceRuleTarget! - The type of lines (line_item or shipping_line) to which the price rule applies.
• title: String! - The title of the price rule.
• totalSales: MoneyV2 - The total sales from orders where the price rule was used.
• traits: PriceRuleTrait! - A list of the price rule's features.
• usageCount: Int! - The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.
• usageLimit: Int - The maximum number of times that the price rule can be used in total.
• validityPeriod: PriceRuleValidityPeriod! - A time period during which a price rule is applicable.
• value: PriceRuleValue! - The value of the price rule.
• valueV2: PricingValue! - The value of the price rule.

Connections

• discountCodes: PriceRuleDiscountCodeConnection!
• events: EventConnection!

Related queries

• priceRule Returns a code price rule resource by ID.
• priceRules Returns a list of price rule resources that have at least one associated discount code.

Related mutations

• priceRuleActivate Activate a price rule.
• priceRuleCreate Create a price rule using the input.
• priceRuleDeactivate Deactivate a price rule.
• priceRuleDiscountCodeCreate Create a discount code for a price rule.
• priceRuleDiscountCodeUpdate Update a discount code for a price rule.
• priceRuleUpdate Updates a price rule using its ID and an input.

Related Unions

Examples

• Retrieve a price rule by its ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GetPriceRule($id: ID!) { priceRule(id: $id) { id title status } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/PriceRule/1057371215\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query GetPriceRule($id: ID!) {\n      priceRule(id: $id) {\n        id\n        title\n        status\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/PriceRule/1057371215\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query GetPriceRule($id: ID!) {\n    priceRule(id: $id) {\n      id\n      title\n      status\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/PriceRule/1057371215\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/PriceRule/1057371215\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query GetPriceRule($id: ID!) {\n    priceRule(id: $id) {\n      id\n      title\n      status\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/PriceRule/1057371215\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query GetPriceRule($id: ID!) {\n  priceRule(id: $id) {\n    id\n    title\n    status\n  }\n}"
        

  input: {
    "id": "gid://shopify/PriceRule/1057371215"
  }

  response: {
    "data": {
      "priceRule": {
        "id": "gid://shopify/PriceRule/1057371215",
        "title": "PROTABO",
        "status": "ACTIVE"
      }
    }
  }