priceRuleUpdate

mutationDeprecated

Requires write_price_rules access scope.

Updates a price rule using its ID and an input. Use discountCodeBasicUpdate instead.

Arguments

Anchor to idid • ID!required: ID of the price rule to update.
Anchor to priceRulepriceRule • PriceRuleInput!required: The input fields to update a price rule.
Anchor to priceRuleDiscountCodepriceRuleDiscountCode • PriceRuleDiscountCodeInput: The input fields to update the discount code of the price rule.

Was this section helpful?

Anchor to PriceRuleUpdatePayload returnsPriceRuleUpdatePayload returns

Anchor to priceRulepriceRule • PriceRule: The updated price rule.
Anchor to priceRuleDiscountCodepriceRuleDiscountCode • PriceRuleDiscountCode: The updated discount code.
Anchor to priceRuleUserErrorspriceRuleUserErrors • [PriceRuleUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to userErrorsuserErrors • [UserError!]!non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Update a price rule's title and details
priceRuleUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation priceRuleUpdate($id: ID!, $priceRule: PriceRuleInput!, $priceRuleDiscountCode: PriceRuleDiscountCodeInput) {
6    priceRuleUpdate(id: $id, priceRule: $priceRule, priceRuleDiscountCode: $priceRuleDiscountCode) {
7      priceRuleUserErrors {
8        field
9        message
10        code
11      }
12      priceRule {
13        id
14        title
15        allocationMethod
16        target
17        validityPeriod {
18          start
19          end
20        }
21      }
22    }
23  }`,
24  {
25    variables: {
26      "id": "gid://shopify/PriceRule/1057371201",
27      "priceRule": {
28        "title": "New Title",
29        "allocationMethod": "ACROSS",
30        "target": "LINE_ITEM",
31        "validityPeriod": {
32          "start": "2016-08-29T12:00:00-04:00",
33          "end": null
34        }
35      }
36    },
37  },
38);
39
40const data = await response.json();
41

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
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } } }",
 "variables": {
    "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
      }
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  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
        }
      }
    }
  }`,
  {
    variables: {
      "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
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "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
          }
        }
      }
    }`,
    "variables": {
      "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
        }
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~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
        }
      }
    }
  }
QUERY

variables = {
  "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 = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/PriceRule/1057371201",
3  "priceRule": {
4    "title": "New Title",
5    "allocationMethod": "ACROSS",
6    "target": "LINE_ITEM",
7    "validityPeriod": {
8      "start": "2016-08-29T12:00:00-04:00",
9      "end": null
10    }
11  }
12}

Response

JSON

1{
2  "priceRuleUpdate": {
3    "priceRuleUserErrors": [],
4    "priceRule": {
5      "id": "gid://shopify/PriceRule/1057371201",
6      "title": "New Title",
7      "allocationMethod": "ACROSS",
8      "target": "LINE_ITEM",
9      "validityPeriod": {
10        "start": "2016-08-29T16:00:00Z",
11        "end": null
12      }
13    }
14  }
15}