discountCodeDelete

mutation

Requires Apps must have write_discounts access scope.

Deletes a code discount.

Arguments

Anchor to idid • ID!required: The ID of the code discount to delete.

Was this section helpful?

Anchor to DiscountCodeDeletePayload returnsDiscountCodeDeletePayload returns

Anchor to deletedCodeDiscountIddeletedCodeDiscountId • ID: The ID of the code discount that was deleted.
Anchor to userErrorsuserErrors • [DiscountUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete an amount off discount
discountCodeDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation {
6    discountCodeDelete(id: "gid://shopify/DiscountCodeNode/206265824") {
7      deletedCodeDiscountId
8      userErrors {
9        field
10        code
11        message
12      }
13    }
14  }`,
15);
16
17const data = await response.json();
18

mutation {
  discountCodeDelete(id: "gid://shopify/DiscountCodeNode/206265824") {
    deletedCodeDiscountId
    userErrors {
      field
      code
      message
    }
  }
}

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 { discountCodeDelete(id: \"gid://shopify/DiscountCodeNode/206265824\") { deletedCodeDiscountId userErrors { field code message } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  mutation {
    discountCodeDelete(id: "gid://shopify/DiscountCodeNode/206265824") {
      deletedCodeDiscountId
      userErrors {
        field
        code
        message
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation {
    discountCodeDelete(id: "gid://shopify/DiscountCodeNode/206265824") {
      deletedCodeDiscountId
      userErrors {
        field
        code
        message
      }
    }
  }`,
});

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 {
    discountCodeDelete(id: "gid://shopify/DiscountCodeNode/206265824") {
      deletedCodeDiscountId
      userErrors {
        field
        code
        message
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "discountCodeDelete": {
3    "deletedCodeDiscountId": "gid://shopify/DiscountCodeNode/206265824",
4    "userErrors": []
5  }
6}