Choose a version:

discountAutomaticBasicUpdate

mutation

Requires Apps must have write_discounts access scope.

Updates an existing amount off discount that's automatically applied on a cart and at checkout.

Note

To update code discounts, use the discountCodeBasicUpdate mutation instead.

Anchor to Arguments

Arguments

Anchor to automaticBasicDiscountautomaticBasicDiscount

•DiscountAutomaticBasicInput!

required

The input data used to update the automatic amount off discount.

Anchor to idid

•ID!

required

The ID of the automatic amount off discount to update.

Was this section helpful?

Anchor to DiscountAutomaticBasicUpdatePayload returnsDiscountAutomaticBasicUpdatePayload returns

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

Was this section helpful?

Examples

Update an automatic basic discount

Description

Modify an existing automatic discount's percentage discount and make it apply only on a specific collection.

Query

mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
    automaticDiscountNode {
      id
      automaticDiscount {
        ... on DiscountAutomaticBasic {
          customerGets {
            value {
              ... on DiscountPercentage {
                percentage
              }
            }
            items {
              ... on DiscountCollections {
                collections(first: 5) {
                  nodes {
                    id
                  }
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      code
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "customerGets": {
      "value": {
        "percentage": 0.5
      },
      "items": {
        "collections": {
          "add": [
            "gid://shopify/Collection/142458073"
          ]
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) { discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) { automaticDiscountNode { id automaticDiscount { ... on DiscountAutomaticBasic { customerGets { value { ... on DiscountPercentage { percentage } } items { ... on DiscountCollections { collections(first: 5) { nodes { id } } } } } } } } userErrors { field code message } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/299501151",
    "automaticBasicDiscount": {
      "customerGets": {
        "value": {
          "percentage": 0.5
        },
        "items": {
          "collections": {
            "add": [
              "gid://shopify/Collection/142458073"
            ]
          }
        }
      }
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
    discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            customerGets {
              value {
                ... on DiscountPercentage {
                  percentage
                }
              }
              items {
                ... on DiscountCollections {
                  collections(first: 5) {
                    nodes {
                      id
                    }
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "automaticBasicDiscount": {
            "customerGets": {
                "value": {
                    "percentage": 0.5
                },
                "items": {
                    "collections": {
                        "add": [
                            "gid://shopify/Collection/142458073"
                        ]
                    }
                }
            }
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
    discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            customerGets {
              value {
                ... on DiscountPercentage {
                  percentage
                }
              }
              items {
                ... on DiscountCollections {
                  collections(first: 5) {
                    nodes {
                      id
                    }
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "customerGets": {
      "value": {
        "percentage": 0.5
      },
      "items": {
        "collections": {
          "add": [
            "gid://shopify/Collection/142458073"
          ]
        }
      }
    }
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
      discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
        automaticDiscountNode {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              customerGets {
                value {
                  ... on DiscountPercentage {
                    percentage
                  }
                }
                items {
                  ... on DiscountCollections {
                    collections(first: 5) {
                      nodes {
                        id
                      }
                    }
                  }
                }
              }
            }
          }
        }
        userErrors {
          field
          code
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "automaticBasicDiscount": {
            "customerGets": {
                "value": {
                    "percentage": 0.5
                },
                "items": {
                    "collections": {
                        "add": [
                            "gid://shopify/Collection/142458073"
                        ]
                    }
                }
            }
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
    automaticDiscountNode {
      id
      automaticDiscount {
        ... on DiscountAutomaticBasic {
          customerGets {
            value {
              ... on DiscountPercentage {
                percentage
              }
            }
            items {
              ... on DiscountCollections {
                collections(first: 5) {
                  nodes {
                    id
                  }
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      code
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "customerGets": {
      "value": {
        "percentage": 0.5
      },
      "items": {
        "collections": {
          "add": [
            "gid://shopify/Collection/142458073"
          ]
        }
      }
    }
  }
}'

Response

{
  "discountAutomaticBasicUpdate": {
    "automaticDiscountNode": {
      "id": "gid://shopify/DiscountAutomaticNode/299501151",
      "automaticDiscount": {
        "customerGets": {
          "value": {
            "percentage": 0.5
          },
          "items": {
            "collections": {
              "nodes": [
                {
                  "id": "gid://shopify/Collection/142458073"
                }
              ]
            }
          }
        }
      }
    },
    "userErrors": []
  }
}

Update context for automatic basic discount for a customer segment

Description

Modify an existing automatic discount's and make it apply only on a specific customer segment.

Query

mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
    automaticDiscountNode {
      id
      automaticDiscount {
        ... on DiscountAutomaticBasic {
          context {
            ... on DiscountCustomerSegments {
              segments {
                id
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      code
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "context": {
      "customerSegments": {
        "add": [
          "gid://shopify/Segment/210588551"
        ]
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) { discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) { automaticDiscountNode { id automaticDiscount { ... on DiscountAutomaticBasic { context { ... on DiscountCustomerSegments { segments { id } } } } } } userErrors { field code message } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/299501151",
    "automaticBasicDiscount": {
      "context": {
        "customerSegments": {
          "add": [
            "gid://shopify/Segment/210588551"
          ]
        }
      }
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
    discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            context {
              ... on DiscountCustomerSegments {
                segments {
                  id
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "automaticBasicDiscount": {
            "context": {
                "customerSegments": {
                    "add": [
                        "gid://shopify/Segment/210588551"
                    ]
                }
            }
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
    discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            context {
              ... on DiscountCustomerSegments {
                segments {
                  id
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "context": {
      "customerSegments": {
        "add": [
          "gid://shopify/Segment/210588551"
        ]
      }
    }
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
      discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
        automaticDiscountNode {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              context {
                ... on DiscountCustomerSegments {
                  segments {
                    id
                  }
                }
              }
            }
          }
        }
        userErrors {
          field
          code
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "automaticBasicDiscount": {
            "context": {
                "customerSegments": {
                    "add": [
                        "gid://shopify/Segment/210588551"
                    ]
                }
            }
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
    automaticDiscountNode {
      id
      automaticDiscount {
        ... on DiscountAutomaticBasic {
          context {
            ... on DiscountCustomerSegments {
              segments {
                id
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      code
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "context": {
      "customerSegments": {
        "add": [
          "gid://shopify/Segment/210588551"
        ]
      }
    }
  }
}'

Response

{
  "discountAutomaticBasicUpdate": {
    "automaticDiscountNode": {
      "id": "gid://shopify/DiscountAutomaticNode/299501151",
      "automaticDiscount": {
        "context": {
          "segments": [
            {
              "id": "gid://shopify/Segment/210588551"
            }
          ]
        }
      }
    },
    "userErrors": []
  }
}

discountAutomaticBasicUpdate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {

discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {

automaticDiscountNode {

automaticDiscount {

... on DiscountAutomaticBasic {

customerGets {

value {

... on DiscountPercentage {

percentage

}

items {

... on DiscountCollections {

collections(first: 5) {

nodes {

}

userErrors {

field

code

message

}

}`,

{

variables: {

"id": "gid://shopify/DiscountAutomaticNode/299501151",

"automaticBasicDiscount": {

"customerGets": {

"value": {

"percentage": 0.5

"items": {

"collections": {

"add": [

"gid://shopify/Collection/142458073"

]

}

);

const json = await response.json();

return json.data;

}

GQL

mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
    automaticDiscountNode {
      id
      automaticDiscount {
        ... on DiscountAutomaticBasic {
          customerGets {
            value {
              ... on DiscountPercentage {
                percentage
              }
            }
            items {
              ... on DiscountCollections {
                collections(first: 5) {
                  nodes {
                    id
                  }
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      code
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) { discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) { automaticDiscountNode { id automaticDiscount { ... on DiscountAutomaticBasic { customerGets { value { ... on DiscountPercentage { percentage } } items { ... on DiscountCollections { collections(first: 5) { nodes { id } } } } } } } } userErrors { field code message } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/299501151",
    "automaticBasicDiscount": {
      "customerGets": {
        "value": {
          "percentage": 0.5
        },
        "items": {
          "collections": {
            "add": [
              "gid://shopify/Collection/142458073"
            ]
          }
        }
      }
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
    discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            customerGets {
              value {
                ... on DiscountPercentage {
                  percentage
                }
              }
              items {
                ... on DiscountCollections {
                  collections(first: 5) {
                    nodes {
                      id
                    }
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "automaticBasicDiscount": {
            "customerGets": {
                "value": {
                    "percentage": 0.5
                },
                "items": {
                    "collections": {
                        "add": [
                            "gid://shopify/Collection/142458073"
                        ]
                    }
                }
            }
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
      discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
        automaticDiscountNode {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              customerGets {
                value {
                  ... on DiscountPercentage {
                    percentage
                  }
                }
                items {
                  ... on DiscountCollections {
                    collections(first: 5) {
                      nodes {
                        id
                      }
                    }
                  }
                }
              }
            }
          }
        }
        userErrors {
          field
          code
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/DiscountAutomaticNode/299501151",
        "automaticBasicDiscount": {
            "customerGets": {
                "value": {
                    "percentage": 0.5
                },
                "items": {
                    "collections": {
                        "add": [
                            "gid://shopify/Collection/142458073"
                        ]
                    }
                }
            }
        }
    },
  },
});

Ruby

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 discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
    discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            customerGets {
              value {
                ... on DiscountPercentage {
                  percentage
                }
              }
              items {
                ... on DiscountCollections {
                  collections(first: 5) {
                    nodes {
                      id
                    }
                  }
                }
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "customerGets": {
      "value": {
        "percentage": 0.5
      },
      "items": {
        "collections": {
          "add": [
            "gid://shopify/Collection/142458073"
          ]
        }
      }
    }
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation discountAutomaticBasicUpdate($id: ID!, $automaticBasicDiscount: DiscountAutomaticBasicInput!) {
  discountAutomaticBasicUpdate(id: $id, automaticBasicDiscount: $automaticBasicDiscount) {
    automaticDiscountNode {
      id
      automaticDiscount {
        ... on DiscountAutomaticBasic {
          customerGets {
            value {
              ... on DiscountPercentage {
                percentage
              }
            }
            items {
              ... on DiscountCollections {
                collections(first: 5) {
                  nodes {
                    id
                  }
                }
              }
            }
          }
        }
      }
    }
    userErrors {
      field
      code
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/DiscountAutomaticNode/299501151",
  "automaticBasicDiscount": {
    "customerGets": {
      "value": {
        "percentage": 0.5
      },
      "items": {
        "collections": {
          "add": [
            "gid://shopify/Collection/142458073"
          ]
        }
      }
    }
  }
}'

Input variables

JSON

{

"id": "gid://shopify/DiscountAutomaticNode/299501151",

"automaticBasicDiscount": {

"customerGets": {

"value": {

"percentage": 0.5

"items": {

"collections": {

"add": [

"gid://shopify/Collection/142458073"

]

}

Response

JSON

{

"discountAutomaticBasicUpdate": {

"automaticDiscountNode": {

"id": "gid://shopify/DiscountAutomaticNode/299501151",

"automaticDiscount": {

"customerGets": {

"value": {

"percentage": 0.5

"items": {

"collections": {

"nodes": [

{

"id": "gid://shopify/Collection/142458073"

}

]

}

"userErrors": []

}