priceRuleUpdate - admin-graphql - MUTATION

Version: 2024-04

Description:

Updates a price rule using its ID and an input.

Access Scopes

`write_price_rules` access scope.

Arguments

• id: ID! - ID of the price rule to update.
• priceRule: PriceRuleInput! - The input fields to update a price rule.
• priceRuleDiscountCode: PriceRuleDiscountCodeInput - The input fields to update the discount code of the price rule.

Returns

• priceRule: PriceRule The updated price rule.
• priceRuleDiscountCode: PriceRuleDiscountCode The updated discount code.
• priceRuleUserErrors: PriceRuleUserError! The list of errors that occurred from executing the mutation.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Update a price rule's title and details

          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\": \"mutation priceRuleUpdate($id: ID!, $priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) { priceRuleUpdate(id: $id, priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) { priceRuleUserErrors { field message code } priceRule { id title allocationMethod target validityPeriod { start end } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/PriceRule/1057371201\",\n    \"priceRule\": {\n      \"title\": \"New Title\",\n      \"allocationMethod\": \"ACROSS\",\n      \"target\": \"LINE_ITEM\",\n      \"validityPeriod\": {\n        \"start\": \"2016-08-29T12:00:00-04:00\",\n        \"end\": null\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation priceRuleUpdate($id: ID!, $priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n      priceRuleUpdate(id: $id, priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n        priceRuleUserErrors {\n          field\n          message\n          code\n        }\n        priceRule {\n          id\n          title\n          allocationMethod\n          target\n          validityPeriod {\n            start\n            end\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/PriceRule/1057371201\",\n      \"priceRule\": {\n        \"title\": \"New Title\",\n        \"allocationMethod\": \"ACROSS\",\n        \"target\": \"LINE_ITEM\",\n        \"validityPeriod\": {\n          \"start\": \"2016-08-29T12:00:00-04:00\",\n          \"end\": null\n        }\n      }\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  mutation priceRuleUpdate($id: ID!, $priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n    priceRuleUpdate(id: $id, priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      priceRule {\n        id\n        title\n        allocationMethod\n        target\n        validityPeriod {\n          start\n          end\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/PriceRule/1057371201\",\n  \"priceRule\": {\n    \"title\": \"New Title\",\n    \"allocationMethod\": \"ACROSS\",\n    \"target\": \"LINE_ITEM\",\n    \"validityPeriod\": {\n      \"start\": \"2016-08-29T12:00:00-04:00\",\n      \"end\": null\n    }\n  }\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/1057371201\",\n  \"priceRule\" => [\n    \"title\" => \"New Title\",\n    \"allocationMethod\" => \"ACROSS\",\n    \"target\" => \"LINE_ITEM\",\n    \"validityPeriod\" => [\n      \"start\" => \"2016-08-29T12:00:00-04:00\",\n      \"end\" => null,\n    ],\n  ],\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  mutation priceRuleUpdate($id: ID!, $priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n    priceRuleUpdate(id: $id, priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      priceRule {\n        id\n        title\n        allocationMethod\n        target\n        validityPeriod {\n          start\n          end\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/PriceRule/1057371201\",\n      \"priceRule\": {\n        \"title\": \"New Title\",\n        \"allocationMethod\": \"ACROSS\",\n        \"target\": \"LINE_ITEM\",\n        \"validityPeriod\": {\n          \"start\": \"2016-08-29T12:00:00-04:00\",\n          \"end\": null\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation priceRuleUpdate($id: ID!, $priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {\n  priceRuleUpdate(id: $id, priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {\n    priceRuleUserErrors {\n      field\n      message\n      code\n    }\n    priceRule {\n      id\n      title\n      allocationMethod\n      target\n      validityPeriod {\n        start\n        end\n      }\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/PriceRule/1057371201",
    "priceRule": {
      "title": "New Title",
      "allocationMethod": "ACROSS",
      "target": "LINE_ITEM",
      "validityPeriod": {
        "start": "2016-08-29T12:00:00-04:00",
        "end": null
      }
    }
  }

  response: {
    "data": {
      "priceRuleUpdate": {
        "priceRuleUserErrors": [],
        "priceRule": {
          "id": "gid://shopify/PriceRule/1057371201",
          "title": "New Title",
          "allocationMethod": "ACROSS",
          "target": "LINE_ITEM",
          "validityPeriod": {
            "start": "2016-08-29T16:00:00Z",
            "end": null
          }
        }
      }
    }
  }