discountCodeFreeShippingUpdate

mutation

Requires Apps must have write_discounts access scope.

Updates a free shipping discount that's applied on a cart and at checkout when a customer enters a code.

Note

To update a free shipping discount that's automatically applied on a cart and at checkout, use the discountAutomaticFreeShippingUpdate mutation.

Arguments

Anchor to freeShippingCodeDiscountfreeShippingCodeDiscount • DiscountCodeFreeShippingInput!required: The input data used to update the discount code.
Anchor to idid • ID!required: The ID of the discount code to update.

Was this section helpful?

Anchor to DiscountCodeFreeShippingUpdatePayload returnsDiscountCodeFreeShippingUpdatePayload returns

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

Was this section helpful?

Update a free shipping discount code
discountCodeFreeShippingUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation discountCodeFreeShippingUpdate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!, $id: ID!) {
6    discountCodeFreeShippingUpdate(freeShippingCodeDiscount: $freeShippingCodeDiscount, id: $id) {
7      codeDiscountNode {
8        id
9        codeDiscount {
10          ... on DiscountCodeFreeShipping {
11            title
12            startsAt
13            endsAt
14            minimumRequirement {
15              ... on DiscountMinimumSubtotal {
16                greaterThanOrEqualToSubtotal {
17                  amount
18                  currencyCode
19                }
20              }
21            }
22            codes(first: 2) {
23              nodes {
24                code
25              }
26            }
27          }
28        }
29      }
30      userErrors {
31        field
32        code
33        message
34      }
35    }
36  }`,
37  {
38    variables: {
39      "freeShippingCodeDiscount": {
40        "code": "FRSHP25",
41        "minimumRequirement": {
42          "subtotal": {
43            "greaterThanOrEqualToSubtotal": 25.0
44          }
45        },
46        "startsAt": "2022-08-01",
47        "endsAt": "2022-08-08",
48        "title": "Free shipping for orders above $25"
49      },
50      "id": "gid://shopify/DiscountCodeFreeShipping/445378512"
51    },
52  },
53);
54
55const data = await response.json();
56

mutation discountCodeFreeShippingUpdate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!, $id: ID!) {
  discountCodeFreeShippingUpdate(freeShippingCodeDiscount: $freeShippingCodeDiscount, id: $id) {
    codeDiscountNode {
      id
      codeDiscount {
        ... on DiscountCodeFreeShipping {
          title
          startsAt
          endsAt
          minimumRequirement {
            ... on DiscountMinimumSubtotal {
              greaterThanOrEqualToSubtotal {
                amount
                currencyCode
              }
            }
          }
          codes(first: 2) {
            nodes {
              code
            }
          }
        }
      }
    }
    userErrors {
      field
      code
      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 discountCodeFreeShippingUpdate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!, $id: ID!) { discountCodeFreeShippingUpdate(freeShippingCodeDiscount: $freeShippingCodeDiscount, id: $id) { codeDiscountNode { id codeDiscount { ... on DiscountCodeFreeShipping { title startsAt endsAt minimumRequirement { ... on DiscountMinimumSubtotal { greaterThanOrEqualToSubtotal { amount currencyCode } } } codes(first: 2) { nodes { code } } } } } userErrors { field code message } } }",
 "variables": {
    "freeShippingCodeDiscount": {
      "code": "FRSHP25",
      "minimumRequirement": {
        "subtotal": {
          "greaterThanOrEqualToSubtotal": 25.0
        }
      },
      "startsAt": "2022-08-01",
      "endsAt": "2022-08-08",
      "title": "Free shipping for orders above $25"
    },
    "id": "gid://shopify/DiscountCodeFreeShipping/445378512"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation discountCodeFreeShippingUpdate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!, $id: ID!) {
    discountCodeFreeShippingUpdate(freeShippingCodeDiscount: $freeShippingCodeDiscount, id: $id) {
      codeDiscountNode {
        id
        codeDiscount {
          ... on DiscountCodeFreeShipping {
            title
            startsAt
            endsAt
            minimumRequirement {
              ... on DiscountMinimumSubtotal {
                greaterThanOrEqualToSubtotal {
                  amount
                  currencyCode
                }
              }
            }
            codes(first: 2) {
              nodes {
                code
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }`,
  {
    variables: {
      "freeShippingCodeDiscount": {
        "code": "FRSHP25",
        "minimumRequirement": {
          "subtotal": {
            "greaterThanOrEqualToSubtotal": 25.0
          }
        },
        "startsAt": "2022-08-01",
        "endsAt": "2022-08-08",
        "title": "Free shipping for orders above $25"
      },
      "id": "gid://shopify/DiscountCodeFreeShipping/445378512"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeFreeShippingUpdate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!, $id: ID!) {
      discountCodeFreeShippingUpdate(freeShippingCodeDiscount: $freeShippingCodeDiscount, id: $id) {
        codeDiscountNode {
          id
          codeDiscount {
            ... on DiscountCodeFreeShipping {
              title
              startsAt
              endsAt
              minimumRequirement {
                ... on DiscountMinimumSubtotal {
                  greaterThanOrEqualToSubtotal {
                    amount
                    currencyCode
                  }
                }
              }
              codes(first: 2) {
                nodes {
                  code
                }
              }
            }
          }
        }
        userErrors {
          field
          code
          message
        }
      }
    }`,
    "variables": {
      "freeShippingCodeDiscount": {
        "code": "FRSHP25",
        "minimumRequirement": {
          "subtotal": {
            "greaterThanOrEqualToSubtotal": 25.0
          }
        },
        "startsAt": "2022-08-01",
        "endsAt": "2022-08-08",
        "title": "Free shipping for orders above $25"
      },
      "id": "gid://shopify/DiscountCodeFreeShipping/445378512"
    },
  },
});

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 discountCodeFreeShippingUpdate($freeShippingCodeDiscount: DiscountCodeFreeShippingInput!, $id: ID!) {
    discountCodeFreeShippingUpdate(freeShippingCodeDiscount: $freeShippingCodeDiscount, id: $id) {
      codeDiscountNode {
        id
        codeDiscount {
          ... on DiscountCodeFreeShipping {
            title
            startsAt
            endsAt
            minimumRequirement {
              ... on DiscountMinimumSubtotal {
                greaterThanOrEqualToSubtotal {
                  amount
                  currencyCode
                }
              }
            }
            codes(first: 2) {
              nodes {
                code
              }
            }
          }
        }
      }
      userErrors {
        field
        code
        message
      }
    }
  }
QUERY

variables = {
  "freeShippingCodeDiscount": {
    "code": "FRSHP25",
    "minimumRequirement": {
      "subtotal": {
        "greaterThanOrEqualToSubtotal": 25.0
      }
    },
    "startsAt": "2022-08-01",
    "endsAt": "2022-08-08",
    "title": "Free shipping for orders above $25"
  },
  "id": "gid://shopify/DiscountCodeFreeShipping/445378512"
}

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

Input variables

JSON

1{
2  "freeShippingCodeDiscount": {
3    "code": "FRSHP25",
4    "minimumRequirement": {
5      "subtotal": {
6        "greaterThanOrEqualToSubtotal": 25
7      }
8    },
9    "startsAt": "2022-08-01",
10    "endsAt": "2022-08-08",
11    "title": "Free shipping for orders above $25"
12  },
13  "id": "gid://shopify/DiscountCodeFreeShipping/445378512"
14}

Response

JSON

1{
2  "discountCodeFreeShippingUpdate": {
3    "codeDiscountNode": {
4      "id": "gid://shopify/DiscountCodeNode/445378512",
5      "codeDiscount": {
6        "title": "Free shipping for orders above $25",
7        "startsAt": "2022-08-01T00:00:00Z",
8        "endsAt": "2022-08-08T00:00:00Z",
9        "minimumRequirement": {
10          "greaterThanOrEqualToSubtotal": {
11            "amount": "25.0",
12            "currencyCode": "USD"
13          }
14        },
15        "codes": {
16          "nodes": [
17            {
18              "code": "FRSHP25"
19            }
20          ]
21        }
22      }
23    },
24    "userErrors": []
25  }
26}