Anchor to priceRuleUpdateprice
priceRuleUpdate
mutationDeprecated
Requires access scope.
Updates a price rule using its ID and an input. Use instead.
Anchor to Arguments
Arguments
- •ID!required
ID of the price rule to update.
- Anchor to priceRuleprice•
Rule PriceRule requiredInput! The input fields to update a price rule.
- Anchor to priceRuleDiscountCodeprice•
Rule Discount Code The input fields to update the discount code of the price rule.
Was this section helpful?
Anchor to PriceRuleUpdatePayload returnsPriceRuleUpdatePayload returns
- Anchor to priceRuleprice•
Rule The updated price rule.
- Anchor to priceRuleDiscountCodeprice•
Rule Discount Code The updated discount code.
- Anchor to priceRuleUserErrorsprice•
Rule User Errors [PriceRule non-nullUser Error!]! The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•
Errors 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
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",
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-04/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{
"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
JSON{
"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
}
}
}
}