# discountAutomaticFreeShippingCreate - admin-graphql - MUTATION Version: 2024-07 ## Description Creates a [free shipping discount](https://help.shopify.com/manual/discounts/discount-types/free-shipping) that's automatically applied on a cart and at checkout. > Note: > To create code discounts, use the [`discountCodeFreeShippingCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeFreeShippingCreate) mutation. ### Access Scopes Apps must have `write_discounts` access scope. ## Arguments * [freeShippingAutomaticDiscount](/docs/api/admin-graphql/2024-07/input-objects/DiscountAutomaticFreeShippingInput): DiscountAutomaticFreeShippingInput! - The input data used to create the automatic free shipping discount. ## Returns * [automaticDiscountNode](/docs/api/admin-graphql/2024-07/objects/DiscountAutomaticNode): DiscountAutomaticNode The automatic free shipping discount that was created. * [userErrors](/docs/api/admin-graphql/2024-07/objects/DiscountUserError): DiscountUserError! The list of errors that occurred from executing the mutation. ## Examples ### Create a free shipping discount for 5+ items Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } }\",\n \"variables\": {\n \"input\": {\n \"title\": \"FREESHIP5PLUS\",\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"minimumRequirement\": {\n \"quantity\": {\n \"greaterThanOrEqualToQuantity\": \"5\"\n }\n },\n \"destination\": {\n \"all\": true\n }\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {\n automaticDiscountNode {\n id\n automaticDiscount {\n ... on DiscountAutomaticFreeShipping {\n title\n startsAt\n endsAt\n minimumRequirement {\n ... on DiscountMinimumQuantity {\n greaterThanOrEqualToQuantity\n }\n }\n destinationSelection {\n ... on DiscountCountryAll {\n allCountries\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"title\": \"FREESHIP5PLUS\",\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"minimumRequirement\": {\n \"quantity\": {\n \"greaterThanOrEqualToQuantity\": \"5\"\n }\n },\n \"destination\": {\n \"all\": true\n }\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {\n automaticDiscountNode {\n id\n automaticDiscount {\n ... on DiscountAutomaticFreeShipping {\n title\n startsAt\n endsAt\n minimumRequirement {\n ... on DiscountMinimumQuantity {\n greaterThanOrEqualToQuantity\n }\n }\n destinationSelection {\n ... on DiscountCountryAll {\n allCountries\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"title\": \"FREESHIP5PLUS\",\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"minimumRequirement\": {\n \"quantity\": {\n \"greaterThanOrEqualToQuantity\": \"5\"\n }\n },\n \"destination\": {\n \"all\": true\n }\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {\n automaticDiscountNode {\n id\n automaticDiscount {\n ... on DiscountAutomaticFreeShipping {\n title\n startsAt\n endsAt\n minimumRequirement {\n ... on DiscountMinimumQuantity {\n greaterThanOrEqualToQuantity\n }\n }\n destinationSelection {\n ... on DiscountCountryAll {\n allCountries\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"title\": \"FREESHIP5PLUS\",\n \"startsAt\": \"2025-01-01T00:00:00Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"minimumRequirement\": {\n \"quantity\": {\n \"greaterThanOrEqualToQuantity\": \"5\"\n }\n },\n \"destination\": {\n \"all\": true\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation CreateFreeShippingDiscount($input: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $input) {\n automaticDiscountNode {\n id\n automaticDiscount {\n ... on DiscountAutomaticFreeShipping {\n title\n startsAt\n endsAt\n minimumRequirement {\n ... on DiscountMinimumQuantity {\n greaterThanOrEqualToQuantity\n }\n }\n destinationSelection {\n ... on DiscountCountryAll {\n allCountries\n }\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "input": { "title": "FREESHIP5PLUS", "startsAt": "2025-01-01T00:00:00Z", "endsAt": "2025-12-31T23:59:59Z", "minimumRequirement": { "quantity": { "greaterThanOrEqualToQuantity": "5" } }, "destination": { "all": true } } } #### Graphql Response { "data": { "discountAutomaticFreeShippingCreate": { "automaticDiscountNode": { "id": "gid://shopify/DiscountAutomaticNode/1057371256", "automaticDiscount": { "title": "FREESHIP5PLUS", "startsAt": "2025-01-01T00:00:00Z", "endsAt": "2025-12-31T23:59:59Z", "minimumRequirement": { "greaterThanOrEqualToQuantity": "5" }, "destinationSelection": { "allCountries": true } } }, "userErrors": [] } } } ### Create a subtotal-based shipping discount Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) { discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) { automaticDiscountNode { id } userErrors { field message } } }\",\n \"variables\": {\n \"freeShippingAutomaticDiscount\": {\n \"title\": \"FREESHIPPING50\",\n \"startsAt\": \"2025-01-11T22:30:47Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"destination\": {\n \"countries\": {\n \"add\": [\n \"CA\",\n \"US\"\n ]\n }\n },\n \"appliesOnOneTimePurchase\": true,\n \"maximumShippingPrice\": \"200\",\n \"minimumRequirement\": {\n \"subtotal\": {\n \"greaterThanOrEqualToSubtotal\": \"50\"\n }\n },\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true\n }\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {\n automaticDiscountNode {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"freeShippingAutomaticDiscount\": {\n \"title\": \"FREESHIPPING50\",\n \"startsAt\": \"2025-01-11T22:30:47Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"destination\": {\n \"countries\": {\n \"add\": [\n \"CA\",\n \"US\"\n ]\n }\n },\n \"appliesOnOneTimePurchase\": true,\n \"maximumShippingPrice\": \"200\",\n \"minimumRequirement\": {\n \"subtotal\": {\n \"greaterThanOrEqualToSubtotal\": \"50\"\n }\n },\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true\n }\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {\n automaticDiscountNode {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"freeShippingAutomaticDiscount\": {\n \"title\": \"FREESHIPPING50\",\n \"startsAt\": \"2025-01-11T22:30:47Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"destination\": {\n \"countries\": {\n \"add\": [\"CA\", \"US\"]\n }\n },\n \"appliesOnOneTimePurchase\": true,\n \"maximumShippingPrice\": \"200\",\n \"minimumRequirement\": {\n \"subtotal\": {\n \"greaterThanOrEqualToSubtotal\": \"50\"\n }\n },\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true\n }\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {\n automaticDiscountNode {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"freeShippingAutomaticDiscount\": {\n \"title\": \"FREESHIPPING50\",\n \"startsAt\": \"2025-01-11T22:30:47Z\",\n \"endsAt\": \"2025-12-31T23:59:59Z\",\n \"destination\": {\n \"countries\": {\n \"add\": [\n \"CA\",\n \"US\"\n ]\n }\n },\n \"appliesOnOneTimePurchase\": true,\n \"maximumShippingPrice\": \"200\",\n \"minimumRequirement\": {\n \"subtotal\": {\n \"greaterThanOrEqualToSubtotal\": \"50\"\n }\n },\n \"combinesWith\": {\n \"orderDiscounts\": true,\n \"productDiscounts\": true\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation M($freeShippingAutomaticDiscount: DiscountAutomaticFreeShippingInput!) {\n discountAutomaticFreeShippingCreate(freeShippingAutomaticDiscount: $freeShippingAutomaticDiscount) {\n automaticDiscountNode {\n id\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "freeShippingAutomaticDiscount": { "title": "FREESHIPPING50", "startsAt": "2025-01-11T22:30:47Z", "endsAt": "2025-12-31T23:59:59Z", "destination": { "countries": { "add": [ "CA", "US" ] } }, "appliesOnOneTimePurchase": true, "maximumShippingPrice": "200", "minimumRequirement": { "subtotal": { "greaterThanOrEqualToSubtotal": "50" } }, "combinesWith": { "orderDiscounts": true, "productDiscounts": true } } } #### Graphql Response { "data": { "discountAutomaticFreeShippingCreate": { "automaticDiscountNode": { "id": "gid://shopify/DiscountAutomaticNode/1057371255" }, "userErrors": [] } } }