Anchor to section titled 'undefined'

priceRuleDiscountCodeUpdate
mutation
deprecated

Requires write_price_rules access scope.

Update a discount code for a price rule. Use discountCodeBasicUpdate instead.


The new code of a price rule.

Anchor to priceRuleId
priceRuleId
required

The ID of the price rule object.


Was this section helpful?

The updated price rule.

The updated discount code.

The list of errors that occurred from executing the mutation.

The list of errors that occurred from executing the mutation. Use priceRuleUserErrors instead.


Was this section helpful?

Examples

Hide code
Copy
mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {
  priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {
    priceRuleUserErrors {
      field
      message
      code
    }
    priceRule {
      id
      title
      allocationMethod
      target
      validityPeriod {
        start
        end
      }
    }
    priceRuleDiscountCode {
      code
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) { priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) { priceRuleUserErrors { field message code } priceRule { id title allocationMethod target validityPeriod { start end } } priceRuleDiscountCode { code } } }",
 "variables": {
    "priceRuleId": "gid://shopify/PriceRule/1057371214",
    "code": "NEWCODE"
  }
}'
const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {
    priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {
      priceRuleUserErrors {
        field
        message
        code
      }
      priceRule {
        id
        title
        allocationMethod
        target
        validityPeriod {
          start
          end
        }
      }
      priceRuleDiscountCode {
        code
      }
    }
  }`,
  {
    variables: {
      "priceRuleId": "gid://shopify/PriceRule/1057371214",
      "code": "NEWCODE"
    },
  },
);

const data = await response.json();
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 priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {
    priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {
      priceRuleUserErrors {
        field
        message
        code
      }
      priceRule {
        id
        title
        allocationMethod
        target
        validityPeriod {
          start
          end
        }
      }
      priceRuleDiscountCode {
        code
      }
    }
  }
QUERY

variables = {
  "priceRuleId": "gid://shopify/PriceRule/1057371214",
  "code": "NEWCODE"
}

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {
      priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {
        priceRuleUserErrors {
          field
          message
          code
        }
        priceRule {
          id
          title
          allocationMethod
          target
          validityPeriod {
            start
            end
          }
        }
        priceRuleDiscountCode {
          code
        }
      }
    }`,
    "variables": {
      "priceRuleId": "gid://shopify/PriceRule/1057371214",
      "code": "NEWCODE"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation priceRuleDiscountCodeUpdate($priceRuleId: ID!, $code: String!) {
    priceRuleDiscountCodeUpdate(priceRuleId: $priceRuleId, code: $code) {
      priceRuleUserErrors {
        field
        message
        code
      }
      priceRule {
        id
        title
        allocationMethod
        target
        validityPeriod {
          start
          end
        }
      }
      priceRuleDiscountCode {
        code
      }
    }
  }
QUERY;

$variables = [
  "priceRuleId" => "gid://shopify/PriceRule/1057371214",
  "code" => "NEWCODE",
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "priceRuleId": "gid://shopify/PriceRule/1057371214",
  "code": "NEWCODE"
}
Hide code
Response
JSON
{
  "priceRuleDiscountCodeUpdate": {
    "priceRuleUserErrors": [],
    "priceRule": {
      "id": "gid://shopify/PriceRule/1057371214",
      "title": "PROTABO",
      "allocationMethod": "ACROSS",
      "target": "LINE_ITEM",
      "validityPeriod": {
        "start": "2016-08-29T16:00:00Z",
        "end": "2124-09-12T02:11:13Z"
      }
    },
    "priceRuleDiscountCode": {
      "code": "NEWCODE"
    }
  }
}