priceRuleCreate

mutation

deprecated

Code examples for MUTATION: priceRuleCreate

Query Reference for MUTATION: priceRuleCreate

"mutation priceRuleCreate($priceRule: PriceRuleInput!) {\n  priceRuleCreate(priceRule: $priceRule) {\n    priceRule {\n      # PriceRule fields\n    }\n    priceRuleDiscountCode {\n      # PriceRuleDiscountCode fields\n    }\n    priceRuleUserErrors {\n      # PriceRuleUserError fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: priceRuleCreate

"{\n  \"priceRule\": {\n    \"allocationLimit\": 1,\n    \"allocationMethod\": \"ACROSS\",\n    \"combinesWith\": {\n      \"orderDiscounts\": true,\n      \"productDiscounts\": true,\n      \"shippingDiscounts\": true\n    },\n    \"customerSelection\": {\n      \"customerIdsToAdd\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ],\n      \"customerIdsToRemove\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ],\n      \"forAllCustomers\": true,\n      \"segmentIds\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ]\n    },\n    \"itemEntitlements\": {\n      \"collectionIds\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ],\n      \"productIds\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ],\n      \"productVariantIds\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ],\n      \"targetAllLineItems\": true\n    },\n    \"itemPrerequisites\": {\n      \"collectionIds\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ],\n      \"productIds\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ],\n      \"productVariantIds\": [\n        \"gid://shopify/<objectName>/10079785100\"\n      ]\n    },\n    \"oncePerCustomer\": true,\n    \"prerequisiteQuantityRange\": {\n      \"greaterThan\": 1,\n      \"greaterThanOrEqualTo\": 1,\n      \"lessThan\": 1,\n      \"lessThanOrEqualTo\": 1\n    },\n    \"prerequisiteShippingPriceRange\": {\n      \"greaterThan\": \"100.57\",\n      \"greaterThanOrEqualTo\": \"100.57\",\n      \"lessThan\": \"100.57\",\n      \"lessThanOrEqualTo\": \"100.57\"\n    },\n    \"prerequisiteSubtotalRange\": {\n      \"greaterThan\": \"100.57\",\n      \"greaterThanOrEqualTo\": \"100.57\",\n      \"lessThan\": \"100.57\",\n      \"lessThanOrEqualTo\": \"100.57\"\n    },\n    \"prerequisiteToEntitlementQuantityRatio\": {\n      \"entitlementQuantity\": 1,\n      \"prerequisiteQuantity\": 1\n    },\n    \"shippingEntitlements\": {\n      \"countryCodes\": [\n        \"AC\"\n      ],\n      \"includeRestOfWorld\": true,\n      \"targetAllShippingLines\": true\n    },\n    \"target\": \"LINE_ITEM\",\n    \"title\": \"<your-title>\",\n    \"usageLimit\": 1,\n    \"validityPeriod\": {\n      \"end\": \"2019-09-07T15:50:00Z\",\n      \"start\": \"2019-09-07T15:50:00Z\"\n    },\n    \"value\": {\n      \"fixedAmountValue\": \"100.57\",\n      \"percentageValue\": 1.1\n    }\n  },\n  \"priceRuleDiscountCode\": {\n    \"code\": \"<your-code>\"\n  }\n}"

Schema Reference for MUTATION: priceRuleCreate

"input PriceRuleInput {\n  allocationLimit: Int\n  allocationMethod: PriceRuleAllocationMethod\n  combinesWith: DiscountCombinesWithInput\n  customerSelection: PriceRuleCustomerSelectionInput\n  entitlementToPrerequisiteQuantityRatio: PriceRuleEntitlementToPrerequisiteQuantityRatioInput\n  itemEntitlements: PriceRuleItemEntitlementsInput\n  itemPrerequisites: PriceRuleItemPrerequisitesInput\n  oncePerCustomer: Boolean\n  prerequisiteQuantityRange: PriceRuleQuantityRangeInput\n  prerequisiteShippingPriceRange: PriceRuleMoneyRangeInput\n  prerequisiteSubtotalRange: PriceRuleMoneyRangeInput\n  prerequisiteToEntitlementQuantityRatio: PriceRulePrerequisiteToEntitlementQuantityRatioInput\n  shippingEntitlements: PriceRuleShippingEntitlementsInput\n  target: PriceRuleTarget\n  title: String\n  usageLimit: Int\n  validityPeriod: PriceRuleValidityPeriodInput\n  value: PriceRuleValueInput\n}\n\ninput DiscountCombinesWithInput {\n  orderDiscounts: Boolean\n  productDiscounts: Boolean\n  shippingDiscounts: Boolean\n}\n\ninput PriceRuleCustomerSelectionInput {\n  customerIdsToAdd: [ID!]\n  customerIdsToRemove: [ID!]\n  forAllCustomers: Boolean\n  segmentIds: [ID!]\n}\n\ninput PriceRuleEntitlementToPrerequisiteQuantityRatioInput {\n  entitlementQuantity: Int\n  prerequisiteQuantity: Int\n}\n\ninput PriceRuleItemEntitlementsInput {\n  collectionIds: [ID!]\n  productIds: [ID!]\n  productVariantIds: [ID!]\n  targetAllLineItems: Boolean\n}\n\ninput PriceRuleItemPrerequisitesInput {\n  collectionIds: [ID!]\n  productIds: [ID!]\n  productVariantIds: [ID!]\n}\n\ninput PriceRuleQuantityRangeInput {\n  greaterThan: Int\n  greaterThanOrEqualTo: Int\n  lessThan: Int\n  lessThanOrEqualTo: Int\n}\n\ninput PriceRuleMoneyRangeInput {\n  greaterThan: Money\n  greaterThanOrEqualTo: Money\n  lessThan: Money\n  lessThanOrEqualTo: Money\n}\n\ninput PriceRulePrerequisiteToEntitlementQuantityRatioInput {\n  entitlementQuantity: Int\n  prerequisiteQuantity: Int\n}\n\ninput PriceRuleShippingEntitlementsInput {\n  countryCodes: [CountryCode!]\n  includeRestOfWorld: Boolean\n  targetAllShippingLines: Boolean\n}\n\ninput PriceRuleValidityPeriodInput {\n  end: DateTime\n  start: DateTime!\n}\n\ninput PriceRuleValueInput {\n  fixedAmountValue: Money\n  percentageValue: Float\n}\n\ninput PriceRuleDiscountCodeInput {\n  code: String\n}\n"

Display Examples for MUTATION: priceRuleCreate

[
  {
    "example": {
      "type_name": "pricerulecreate",
      "title": "Create a price rule",
      "description": "Creates a price rule that reduces the cost of boots by a fixed amount for all customers.",
      "query_string": "mutation priceRuleCreate($priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n  priceRuleCreate(priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n    priceRule {\n      id\n      title\n      validityPeriod {\n        start\n      }\n      allocationMethod\n      itemEntitlements {\n        products(first: 3) {\n          edges {\n            node {\n              id\n            }\n          }\n        }\n        targetAllLineItems\n      }\n      valueV2 {\n        ... on MoneyV2 {\n          amount\n          currencyCode\n        }\n      }\n      customerSelection {\n        forAllCustomers\n      }\n      oncePerCustomer\n      usageLimit\n      target\n    }\n    priceRuleDiscountCode {\n      id\n      code\n    }\n    priceRuleUserErrors {\n      code\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "priceRule": {
          "title": "Boots Discount",
          "allocationMethod": "ACROSS",
          "customerSelection": {
            "forAllCustomers": true
          },
          "itemEntitlements": {
            "targetAllLineItems": false,
            "productIds": [
              "gid://shopify/Product/121709582"
            ]
          },
          "target": "LINE_ITEM",
          "validityPeriod": {
            "start": "2016-08-29T12:00:00-04:00"
          },
          "value": {
            "fixedAmountValue": "-10.0"
          }
        }
      },
      "response": {
        "data": {
          "priceRuleCreate": {
            "priceRule": {
              "id": "gid://shopify/PriceRule/1057371212",
              "title": "Boots Discount",
              "validityPeriod": {
                "start": "2016-08-29T16:00:00Z"
              },
              "allocationMethod": "ACROSS",
              "itemEntitlements": {
                "products": {
                  "edges": [
                    {
                      "node": {
                        "id": "gid://shopify/Product/121709582"
                      }
                    }
                  ]
                },
                "targetAllLineItems": false
              },
              "valueV2": {
                "amount": "-10.0",
                "currencyCode": "USD"
              },
              "customerSelection": {
                "forAllCustomers": true
              },
              "oncePerCustomer": false,
              "usageLimit": null,
              "target": "LINE_ITEM"
            },
            "priceRuleDiscountCode": null,
            "priceRuleUserErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "2024-07",
      "location": "/components/pricing/test/unit/graph_api/admin/mutations/price_rule_create_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation priceRuleCreate($priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) { priceRuleCreate(priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) { priceRule { id title validityPeriod { start } allocationMethod itemEntitlements { products(first: 3) { edges { node { id } } } targetAllLineItems } valueV2 { ... on MoneyV2 { amount currencyCode } } customerSelection { forAllCustomers } oncePerCustomer usageLimit target } priceRuleDiscountCode { id code } priceRuleUserErrors { code field message } } }\",\n \"variables\": {\n    \"priceRule\": {\n      \"title\": \"Boots Discount\",\n      \"allocationMethod\": \"ACROSS\",\n      \"customerSelection\": {\n        \"forAllCustomers\": true\n      },\n      \"itemEntitlements\": {\n        \"targetAllLineItems\": false,\n        \"productIds\": [\n          \"gid://shopify/Product/121709582\"\n        ]\n      },\n      \"target\": \"LINE_ITEM\",\n      \"validityPeriod\": {\n        \"start\": \"2016-08-29T12:00:00-04:00\"\n      },\n      \"value\": {\n        \"fixedAmountValue\": \"-10.0\"\n      }\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation priceRuleCreate($priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n    priceRuleCreate(priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n      priceRule {\n        id\n        title\n        validityPeriod {\n          start\n        }\n        allocationMethod\n        itemEntitlements {\n          products(first: 3) {\n            edges {\n              node {\n                id\n              }\n            }\n          }\n          targetAllLineItems\n        }\n        valueV2 {\n          ... on MoneyV2 {\n            amount\n            currencyCode\n          }\n        }\n        customerSelection {\n          forAllCustomers\n        }\n        oncePerCustomer\n        usageLimit\n        target\n      }\n      priceRuleDiscountCode {\n        id\n        code\n      }\n      priceRuleUserErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"priceRule\": {\n        \"title\": \"Boots Discount\",\n        \"allocationMethod\": \"ACROSS\",\n        \"customerSelection\": {\n          \"forAllCustomers\": true\n        },\n        \"itemEntitlements\": {\n          \"targetAllLineItems\": false,\n          \"productIds\": [\n            \"gid://shopify/Product/121709582\"\n          ]\n        },\n        \"target\": \"LINE_ITEM\",\n        \"validityPeriod\": {\n          \"start\": \"2016-08-29T12:00:00-04:00\"\n        },\n        \"value\": {\n          \"fixedAmountValue\": \"-10.0\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\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  mutation priceRuleCreate($priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n    priceRuleCreate(priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n      priceRule {\n        id\n        title\n        validityPeriod {\n          start\n        }\n        allocationMethod\n        itemEntitlements {\n          products(first: 3) {\n            edges {\n              node {\n                id\n              }\n            }\n          }\n          targetAllLineItems\n        }\n        valueV2 {\n          ... on MoneyV2 {\n            amount\n            currencyCode\n          }\n        }\n        customerSelection {\n          forAllCustomers\n        }\n        oncePerCustomer\n        usageLimit\n        target\n      }\n      priceRuleDiscountCode {\n        id\n        code\n      }\n      priceRuleUserErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"priceRule\": {\n    \"title\": \"Boots Discount\",\n    \"allocationMethod\": \"ACROSS\",\n    \"customerSelection\": {\n      \"forAllCustomers\": true\n    },\n    \"itemEntitlements\": {\n      \"targetAllLineItems\": false,\n      \"productIds\": [\"gid://shopify/Product/121709582\"]\n    },\n    \"target\": \"LINE_ITEM\",\n    \"validityPeriod\": {\n      \"start\": \"2016-08-29T12:00:00-04:00\"\n    },\n    \"value\": {\n      \"fixedAmountValue\": \"-10.0\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation priceRuleCreate($priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n      priceRuleCreate(priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n        priceRule {\n          id\n          title\n          validityPeriod {\n            start\n          }\n          allocationMethod\n          itemEntitlements {\n            products(first: 3) {\n              edges {\n                node {\n                  id\n                }\n              }\n            }\n            targetAllLineItems\n          }\n          valueV2 {\n            ... on MoneyV2 {\n              amount\n              currencyCode\n            }\n          }\n          customerSelection {\n            forAllCustomers\n          }\n          oncePerCustomer\n          usageLimit\n          target\n        }\n        priceRuleDiscountCode {\n          id\n          code\n        }\n        priceRuleUserErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"priceRule\": {\n        \"title\": \"Boots Discount\",\n        \"allocationMethod\": \"ACROSS\",\n        \"customerSelection\": {\n          \"forAllCustomers\": true\n        },\n        \"itemEntitlements\": {\n          \"targetAllLineItems\": false,\n          \"productIds\": [\n            \"gid://shopify/Product/121709582\"\n          ]\n        },\n        \"target\": \"LINE_ITEM\",\n        \"validityPeriod\": {\n          \"start\": \"2016-08-29T12:00:00-04:00\"\n        },\n        \"value\": {\n          \"fixedAmountValue\": \"-10.0\"\n        }\n      }\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation priceRuleCreate($priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n    priceRuleCreate(priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n      priceRule {\n        id\n        title\n        validityPeriod {\n          start\n        }\n        allocationMethod\n        itemEntitlements {\n          products(first: 3) {\n            edges {\n              node {\n                id\n              }\n            }\n          }\n          targetAllLineItems\n        }\n        valueV2 {\n          ... on MoneyV2 {\n            amount\n            currencyCode\n          }\n        }\n        customerSelection {\n          forAllCustomers\n        }\n        oncePerCustomer\n        usageLimit\n        target\n      }\n      priceRuleDiscountCode {\n        id\n        code\n      }\n      priceRuleUserErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"priceRule\" => [\n    \"title\" => \"Boots Discount\",\n    \"allocationMethod\" => \"ACROSS\",\n    \"customerSelection\" => [\n      \"forAllCustomers\" => true,\n    ],\n    \"itemEntitlements\" => [\n      \"targetAllLineItems\" => false,\n      \"productIds\" => [\"gid://shopify/Product/121709582\"],\n    ],\n    \"target\" => \"LINE_ITEM\",\n    \"validityPeriod\" => [\n      \"start\" => \"2016-08-29T12:00:00-04:00\",\n    ],\n    \"value\" => [\n      \"fixedAmountValue\" => \"-10.0\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "priceRule",
          "description": "The input fields to create a price rule.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "PriceRuleInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "PriceRuleInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "priceRule",
        "argValue": " {\"title\":\"Boots Discount\",\"allocationMethod\":\"ACROSS\",\"customerSelection\":{\"forAllCustomers\":true},\"itemEntitlements\":{\"targetAllLineItems\":false,\"productIds\":[\"gid://shopify/Product/121709582\"]},\"target\":\"LINE_ITEM\",\"validityPeriod\":{\"start\":\"2016-08-29T12:00:00-04:00\"},\"value\":{\"fixedAmountValue\":\"-10.0\"}}",
        "typeKind": "MUTATION"
      }
    ]
  }
]