Edit in GitHubLog an issue

setShippingMethodsOnCart mutation

The setShippingMethodsOnCart mutation sets one or more delivery methods on a cart. By default, GraphQL supports the following delivery methods:

LabelCarrier codeMethod code
DHL
dhl
Varies
Federal Express
fedex
Varies
Flat Rate
flatrate
flatrate
Free Shipping
freeshipping
freeshipping
Best Way
tablerate
bestway
United Parcel Service
ups
Varies
United States Postal Service
usps
Varies

Syntax

mutation: {setShippingMethodsOnCart(input: setShippingMethodsOnCartInput) {setShippingMethodsOnCartOutput}}

Reference

The setShippingMethodsOnCart reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example sets the delivery method to Best Way.

Request:

Copied to your clipboard
mutation {
setShippingMethodsOnCart(
input: {
cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG",
shipping_methods: [
{
carrier_code: "tablerate"
method_code: "bestway"
}
]
}
) {
cart {
shipping_addresses {
selected_shipping_method {
carrier_code
carrier_title
method_code
method_title
amount {
value
currency
}
}
}
}
}
}

Response:

Copied to your clipboard
{
"data": {
"setShippingMethodsOnCart": {
"cart": {
"shipping_addresses": [
{
"selected_shipping_method": {
"carrier_code": "tablerate",
"carrier_title": "Best Way",
"method_code": "bestway",
"method_title": "Table Rate",
"amount": {
"value": 0,
"currency": "USD"
}
}
}
]
}
}
}
}

Errors

ErrorDescription
Could not find a cart with ID "XXX"
The specified cart_id value does not exist in the quote_id_mask table.
Carrier with such method not found: carrier_code, method_code
A specified carrier method was not found, or it is not applicable for the defined shipping address.
Required parameter "cart_id" is missing
The value specified in the cart_id argument is empty.
Required parameter "carrier_code" is missing.
The value specified in the shipping_methods.carrier_code argument is empty.
Required parameter "method_code" is missing.
The value specified in the shipping_methods.method_code argument is empty.
Required parameter "shipping_methods" is missing
The value specified in the shipping_methods argument is empty.
The current user cannot perform operations on cart "XXX"
An unauthorized user (guest) tried to set a delivery method for an order on behalf of an authorized user (customer), or a customer tried to set a delivery method for an order on behalf of another customer.
The shipping method can't be set for an empty cart. Add an item to cart and try again.
The delivery method cannot be set for an empty cart.
You cannot specify multiple shipping methods.
You can set only one delivery method for an order.
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.