API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04 Unsupported
API version: 2020-01 Unsupported

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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List 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!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use checkoutUserErrors instead