discountAutomaticFreeShippingUpdate

mutation

Requires Apps must have write_discounts access scope.

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

Note

To update code discounts, use the discountCodeFreeShippingUpdate mutation instead.

Arguments

Anchor to freeShippingAutomaticDiscountfreeShippingAutomaticDiscount • DiscountAutomaticFreeShippingInput!required: The input data used to update the automatic free shipping discount.
Anchor to idid • ID!required: The ID of the automatic free shipping discount to update.

Was this section helpful?

Anchor to DiscountAutomaticFreeShippingUpdatePayload returnsDiscountAutomaticFreeShippingUpdatePayload 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?

Update an automatic free shipping discount
Updates an existing a price rule
discountAutomaticFreeShippingUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation M($id: ID!, $freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
6    discountAutomaticFreeShippingUpdate(id: $id, freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
7      automaticDiscountNode {
8        automaticDiscount {
9          ... on DiscountAutomaticFreeShipping {
10            title
11          }
12        }
13      }
14      userErrors {
15        message
16        field
17        code
18      }
19    }
20  }`,
21  {
22    variables: {
23      "id": "gid://shopify/DiscountAutomaticNode/1057371302",
24      "freeShippingAutomaticDiscount": {
25        "title": "A new title"
26      }
27    },
28  },
29);
30
31const data = await response.json();
32

mutation M($id: ID!, $freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
  discountAutomaticFreeShippingUpdate(id: $id, freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
    automaticDiscountNode {
      automaticDiscount {
        ... on DiscountAutomaticFreeShipping {
          title
        }
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation M($id: ID!, $freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) { discountAutomaticFreeShippingUpdate(id: $id, freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) { automaticDiscountNode { automaticDiscount { ... on DiscountAutomaticFreeShipping { title } } } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/1057371302",
    "freeShippingAutomaticDiscount": {
      "title": "A new title"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation M($id: ID!, $freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
    discountAutomaticFreeShippingUpdate(id: $id, freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
      automaticDiscountNode {
        automaticDiscount {
          ... on DiscountAutomaticFreeShipping {
            title
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/DiscountAutomaticNode/1057371302",
      "freeShippingAutomaticDiscount": {
        "title": "A new title"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation M($id: ID!, $freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
      discountAutomaticFreeShippingUpdate(id: $id, freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
        automaticDiscountNode {
          automaticDiscount {
            ... on DiscountAutomaticFreeShipping {
              title
            }
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DiscountAutomaticNode/1057371302",
      "freeShippingAutomaticDiscount": {
        "title": "A new title"
      }
    },
  },
});

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 M($id: ID!, $freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {
    discountAutomaticFreeShippingUpdate(id: $id, freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {
      automaticDiscountNode {
        automaticDiscount {
          ... on DiscountAutomaticFreeShipping {
            title
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountAutomaticNode/1057371302",
  "freeShippingAutomaticDiscount": {
    "title": "A new title"
  }
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/DiscountAutomaticNode/1057371302",
3  "freeShippingAutomaticDiscount": {
4    "title": "A new title"
5  }
6}

Response

JSON

1{
2  "discountAutomaticFreeShippingUpdate": {
3    "automaticDiscountNode": {
4      "automaticDiscount": {
5        "title": "A new title"
6      }
7    },
8    "userErrors": []
9  }
10}