discountAutomaticFreeShippingCreate

mutation

Requires Apps must have write_discounts access scope.

Creates a free shipping discount that's automatically applied on a cart and at checkout.

Note

To create code discounts, use the discountCodeFreeShippingCreate mutation.

Arguments

Anchor to freeShippingAutomaticDiscountfreeShippingAutomaticDiscount • DiscountAutomaticFreeShippingInput!required: The input data used to create the automatic free shipping discount.

Was this section helpful?

Anchor to DiscountAutomaticFreeShippingCreatePayload returnsDiscountAutomaticFreeShippingCreatePayload returns

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

Was this section helpful?

Create a free shipping discount for 5+ items
Create a subtotal-based shipping discount
discountAutomaticFreeShippingCreate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {
6    discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {
7      automaticDiscountNode {
8        id
9        automaticDiscount {
10          ... on DiscountAutomaticFreeShipping {
11            title
12            startsAt
13            endsAt
14            minimumRequirement {
15              ... on DiscountMinimumQuantity {
16                greaterThanOrEqualToQuantity
17              }
18            }
19            destinationSelection {
20              ... on DiscountCountryAll {
21                allCountries
22              }
23            }
24          }
25        }
26      }
27      userErrors {
28        field
29        message
30      }
31    }
32  }`,
33  {
34    variables: {
35      "input": {
36        "title": "FREESHIP5PLUS",
37        "startsAt": "2025-01-01T00:00:00Z",
38        "endsAt": "2025-12-31T23:59:59Z",
39        "minimumRequirement": {
40          "quantity": {
41            "greaterThanOrEqualToQuantity": "5"
42          }
43        },
44        "destination": {
45          "all": true
46        }
47      }
48    },
49  },
50);
51
52const data = await response.json();
53

mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {
  discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {
    automaticDiscountNode {
      id
      automaticDiscount {
        ... on DiscountAutomaticFreeShipping {
          title
          startsAt
          endsAt
          minimumRequirement {
            ... on DiscountMinimumQuantity {
              greaterThanOrEqualToQuantity
            }
          }
          destinationSelection {
            ... on DiscountCountryAll {
              allCountries
            }
          }
        }
      }
    }
    userErrors {
      field
      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 CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) { discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) { automaticDiscountNode { id automaticDiscount { ... on DiscountAutomaticFreeShipping { title startsAt endsAt minimumRequirement { ... on DiscountMinimumQuantity { greaterThanOrEqualToQuantity } } destinationSelection { ... on DiscountCountryAll { allCountries } } } } } userErrors { field message } } }",
 "variables": {
    "input": {
      "title": "FREESHIP5PLUS",
      "startsAt": "2025-01-01T00:00:00Z",
      "endsAt": "2025-12-31T23:59:59Z",
      "minimumRequirement": {
        "quantity": {
          "greaterThanOrEqualToQuantity": "5"
        }
      },
      "destination": {
        "all": true
      }
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {
    discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticFreeShipping {
            title
            startsAt
            endsAt
            minimumRequirement {
              ... on DiscountMinimumQuantity {
                greaterThanOrEqualToQuantity
              }
            }
            destinationSelection {
              ... on DiscountCountryAll {
                allCountries
              }
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "title": "FREESHIP5PLUS",
        "startsAt": "2025-01-01T00:00:00Z",
        "endsAt": "2025-12-31T23:59:59Z",
        "minimumRequirement": {
          "quantity": {
            "greaterThanOrEqualToQuantity": "5"
          }
        },
        "destination": {
          "all": true
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {
      discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {
        automaticDiscountNode {
          id
          automaticDiscount {
            ... on DiscountAutomaticFreeShipping {
              title
              startsAt
              endsAt
              minimumRequirement {
                ... on DiscountMinimumQuantity {
                  greaterThanOrEqualToQuantity
                }
              }
              destinationSelection {
                ... on DiscountCountryAll {
                  allCountries
                }
              }
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "title": "FREESHIP5PLUS",
        "startsAt": "2025-01-01T00:00:00Z",
        "endsAt": "2025-12-31T23:59:59Z",
        "minimumRequirement": {
          "quantity": {
            "greaterThanOrEqualToQuantity": "5"
          }
        },
        "destination": {
          "all": true
        }
      }
    },
  },
});

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 CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {
    discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {
      automaticDiscountNode {
        id
        automaticDiscount {
          ... on DiscountAutomaticFreeShipping {
            title
            startsAt
            endsAt
            minimumRequirement {
              ... on DiscountMinimumQuantity {
                greaterThanOrEqualToQuantity
              }
            }
            destinationSelection {
              ... on DiscountCountryAll {
                allCountries
              }
            }
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "title": "FREESHIP5PLUS",
    "startsAt": "2025-01-01T00:00:00Z",
    "endsAt": "2025-12-31T23:59:59Z",
    "minimumRequirement": {
      "quantity": {
        "greaterThanOrEqualToQuantity": "5"
      }
    },
    "destination": {
      "all": true
    }
  }
}

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

Input variables

JSON

1{
2  "input": {
3    "title": "FREESHIP5PLUS",
4    "startsAt": "2025-01-01T00:00:00Z",
5    "endsAt": "2025-12-31T23:59:59Z",
6    "minimumRequirement": {
7      "quantity": {
8        "greaterThanOrEqualToQuantity": "5"
9      }
10    },
11    "destination": {
12      "all": true
13    }
14  }
15}

Response

JSON

1{
2  "discountAutomaticFreeShippingCreate": {
3    "automaticDiscountNode": {
4      "id": "gid://shopify/DiscountAutomaticNode/1057371256",
5      "automaticDiscount": {
6        "title": "FREESHIP5PLUS",
7        "startsAt": "2025-01-01T00:00:00Z",
8        "endsAt": "2025-12-31T23:59:59Z",
9        "minimumRequirement": {
10          "greaterThanOrEqualToQuantity": "5"
11        },
12        "destinationSelection": {
13          "allCountries": true
14        }
15      }
16    },
17    "userErrors": []
18  }
19}