discountCodeActivate

mutation

Requires Apps must have write_discounts access scope.

Activates a code discount.

Arguments

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

Was this section helpful?

Anchor to DiscountCodeActivatePayload returnsDiscountCodeActivatePayload returns

Anchor to codeDiscountNodecodeDiscountNode • DiscountCodeNode: The activated code discount.
Anchor to userErrorsuserErrors • [DiscountUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Activate a code discount set to start in the future
Activate an expired code discount
discountCodeActivate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation discountCodeActivate($id: ID!) {
6    discountCodeActivate(id: $id) {
7      codeDiscountNode {
8        codeDiscount {
9          ... on DiscountCodeBasic {
10            title
11            status
12            startsAt
13            endsAt
14          }
15        }
16      }
17      userErrors {
18        field
19        code
20        message
21      }
22    }
23  }`,
24  {
25    variables: {
26      "id": "gid://shopify/DiscountCodeNode/206265824"
27    },
28  },
29);
30
31const data = await response.json();
32

mutation discountCodeActivate($id: ID!) {
  discountCodeActivate(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-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountCodeActivate($id: ID!) { discountCodeActivate(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 discountCodeActivate($id: ID!) {
    discountCodeActivate(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();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeActivate($id: ID!) {
      discountCodeActivate(id: $id) {
        codeDiscountNode {
          codeDiscount {
            ... on DiscountCodeBasic {
              title
              status
              startsAt
              endsAt
            }
          }
        }
        userErrors {
          field
          code
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DiscountCodeNode/206265824"
    },
  },
});

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 discountCodeActivate($id: ID!) {
    discountCodeActivate(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)

Input variables

JSON

1{
2  "id": "gid://shopify/DiscountCodeNode/206265824"
3}

Response

JSON

1{
2  "discountCodeActivate": {
3    "codeDiscountNode": {
4      "codeDiscount": {
5        "title": "percentage_off_code",
6        "status": "ACTIVE",
7        "startsAt": "2024-09-12T01:06:59Z",
8        "endsAt": "2049-02-01T05:00:00Z"
9      }
10    },
11    "userErrors": []
12  }
13}