Choose a version:

discountAutomaticActivate

mutation

Requires Apps must have write_discounts access scope.

Activates an automatic discount.

Arguments

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

Was this section helpful?

Anchor to DiscountAutomaticActivatePayload returnsDiscountAutomaticActivatePayload returns

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

Was this section helpful?

Activate an automatic discount set to start in the future
Activate an expired automatic discount
discountAutomaticActivate reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation discountAutomaticActivate($id: ID!) {

discountAutomaticActivate(id: $id) {

automaticDiscountNode {

automaticDiscount {

... on DiscountAutomaticBxgy {

status

startsAt

endsAt

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/DiscountAutomaticNode/198286294"

);

const data = await response.json();

mutation discountAutomaticActivate($id: ID!) {
  discountAutomaticActivate(id: $id) {
    automaticDiscountNode {
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          status
          startsAt
          endsAt
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticActivate($id: ID!) { discountAutomaticActivate(id: $id) { automaticDiscountNode { automaticDiscount { ... on DiscountAutomaticBxgy { status startsAt endsAt } } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/198286294"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation discountAutomaticActivate($id: ID!) {
    discountAutomaticActivate(id: $id) {
      automaticDiscountNode {
        automaticDiscount {
          ... on DiscountAutomaticBxgy {
            status
            startsAt
            endsAt
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/DiscountAutomaticNode/198286294"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticActivate($id: ID!) {
      discountAutomaticActivate(id: $id) {
        automaticDiscountNode {
          automaticDiscount {
            ... on DiscountAutomaticBxgy {
              status
              startsAt
              endsAt
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DiscountAutomaticNode/198286294"
    },
  },
});

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 discountAutomaticActivate($id: ID!) {
    discountAutomaticActivate(id: $id) {
      automaticDiscountNode {
        automaticDiscount {
          ... on DiscountAutomaticBxgy {
            status
            startsAt
            endsAt
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountAutomaticNode/198286294"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/DiscountAutomaticNode/198286294"

}

Response

JSON

{

"discountAutomaticActivate": {

"automaticDiscountNode": {

"automaticDiscount": {

"status": "ACTIVE",

"startsAt": "2024-09-12T01:06:56Z",

"endsAt": "2049-02-01T05:00:00Z"

}

"userErrors": []

}