checkoutShippingLineUpdate mutation
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead
Updates the shipping lines on an existing checkout.
Required access
unauthenticated_write_checkouts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
checkoutId
(
ID!
)
required
|
The ID of the checkout. |
shippingRateHandle
(
String!
)
required
|
A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. |
Return fields
-
checkout (
Checkout
)The updated checkout object.
-
checkoutUserErrors (
[CheckoutUserError!]!
)List of errors that occurred executing the mutation.
Deprecated return fields
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
checkoutUserErrors
instead