discount Code Deactivatemutation
mutation
2024-01
Requires Apps must have write
access scope.
Deactivates a code discount.
Arguments
The ID of the code discount to deactivate.
Was this section helpful?
DiscountCodeDeactivatePayload returns
The deactivated code discount.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Examples
Hide code
DescriptionCopy
mutation discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }
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 discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }", "variables": { "id": "gid://shopify/DiscountCodeNode/206265824" } }'
const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }`, { variables: { "id": "gid://shopify/DiscountCodeNode/206265824" }, }, ); 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 discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } } QUERY variables = { "id": "gid://shopify/DiscountCodeNode/206265824" } response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }`, "variables": { "id": "gid://shopify/DiscountCodeNode/206265824" }, }, });
use Shopify\Clients\Graphql; $client = new Graphql("your-development-store.myshopify.com", $accessToken); $query = <<<QUERY mutation discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } } QUERY; $variables = [ "id" => "gid://shopify/DiscountCodeNode/206265824", ]; $response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{ "id": "gid://shopify/DiscountCodeNode/206265824" }
Hide code
Response
JSON
{ "discountCodeDeactivate": { "codeDiscountNode": { "codeDiscount": { "title": "percentage_off_code", "status": "EXPIRED", "startsAt": "2024-09-12T01:06:40Z", "endsAt": "2024-09-12T01:06:40Z" } }, "userErrors": [] } }