Anchor to section titled 'undefined'

discountCodeFreeShippingUpdate
mutation

Requires Apps must have write_discounts access scope.

Updates a free shipping code discount.

Anchor to section titled 'Arguments'

Arguments

Anchor to freeShippingCodeDiscount
freeShippingCodeDiscount
DiscountCodeFreeShippingInput!
required

The input data used to update the code discount.

Anchor to id
id
ID!
required

The ID of the code discount to update.

Was this section helpful?
Anchor to section titled 'DiscountCodeFreeShippingUpdatePayload returns'

DiscountCodeFreeShippingUpdatePayload returns

Anchor to DiscountCodeFreeShippingUpdatePayload.codeDiscountNode
codeDiscountNode
DiscountCodeNode

The updated code discount.

Anchor to DiscountCodeFreeShippingUpdatePayload.userErrors
userErrors
[DiscountUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
DescriptionCopy
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/2024-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();

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)

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"
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "freeShippingCodeDiscount": {
    "code": "FRSHP25",
    "minimumRequirement": {
      "subtotal": {
        "greaterThanOrEqualToSubtotal": 25
      }
    },
    "startsAt": "2022-08-01",
    "endsAt": "2022-08-08",
    "title": "Free shipping for orders above $25"
  },
  "id": "gid://shopify/DiscountCodeFreeShipping/445378512"
}
Hide code
Response
JSON
{
  "discountCodeFreeShippingUpdate": {
    "codeDiscountNode": {
      "id": "gid://shopify/DiscountCodeNode/445378512",
      "codeDiscount": {
        "title": "Free shipping for orders above $25",
        "startsAt": "2022-08-01T00:00:00Z",
        "endsAt": "2022-08-08T00:00:00Z",
        "minimumRequirement": {
          "greaterThanOrEqualToSubtotal": {
            "amount": "25.0",
            "currencyCode": "USD"
          }
        },
        "codes": {
          "nodes": [
            {
              "code": "FRSHP25"
            }
          ]
        }
      }
    },
    "userErrors": []
  }
}