For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • MUTcreateCart
          • MUTdeleteCart
          • MUTaddCartLineItems
          • MUTupdateCartLineItem
          • MUTdeleteCartLineItem
          • MUTupdateCartCurrency
          • MUTassignCartToCustomer
          • MUTunassignCartFromCustomer
          • MUTcreateCartMetafield
          • MUTupdateCartMetafield
          • MUTdeleteCartMetafield
          • MUTcreateCartRedirectUrls
          • MUTcreateCheckout
          • MUTupdateCheckout
          • MUTaddCheckoutBillingAddress
          • MUTupdateCheckoutBillingAddress
          • MUTupdateCheckoutCustomerMessage
          • MUTselectCheckoutShippingOption
          • MUTapplyCheckoutCoupon
          • MUTunapplyCheckoutCoupon
          • MUTapplyCheckoutGiftCertificate
          • MUTunapplyCheckoutGiftCertificate
          • MUTapplyCheckoutSpamProtection
          • MUTaddCheckoutShippingConsignments
          • MUTupdateCheckoutShippingConsignment
          • MUTdeleteCheckoutConsignment
          • MUTcompleteCheckout
          • MUTlogin
          • MUTlogout
          • MUTcreateWishlist
          • MUTaddWishlistItems
          • MUTdeleteWishlistItems
          • MUTupdateWishlist
          • MUTdeleteWishlists
          • MUTloginWithCustomerLoginJwt
          • MUTsubmitContactUs
          • MUTgenerateSessionSyncJwt
          • MUTvalidateSessionSyncJwt
          • MUTproductViewedEvent
          • MUTpageViewedEvent
          • MUTvisitStartedEvent
          • MUTsearchProductEvent
          • MUTpreviewGiftCertificate
          • MUTregisterCompany
          • MUTaddProductReview
          • MUTchangePassword
          • MUTrequestResetPassword
          • MUTresetPassword
          • MUTregisterCustomer
          • MUTupdateCustomer
          • MUTaddCustomerAddress
          • MUTupdateCustomerAddress
          • MUTdeleteCustomerAddress
          • MUTpayment
          • MUTsubscribe
          • MUTunsubscribe
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontMutations

updateCheckoutShippingConsignment

Example Query
1mutation ExampleMutation($input: UpdateCheckoutShippingConsignmentInput) {
2  updateCheckoutShippingConsignment(input: $input) {
3    checkout {
4      id
5      entityId
6      currencyCode
7      displayCurrencyCode
8      billingAddress
9      cart
10      shippingConsignments
11      shippingCostTotal
12      shippingCostTotalInDisplayCurrency
13      shippingCostBeforeDiscount
14    }
15  }
16}
Variables
1{
2  "input": {
3    "checkoutEntityId": "example",
4    "consignmentEntityId": "example",
5    "data": {
6      "consignment": {
7        "address": {
8          "firstName": "example",
9          "lastName": "example",
10          "email": "example",
11          "company": "example",
12          "address1": "example",
13          "address2": "example",
14          "city": "example",
15          "stateOrProvince": "example",
16          "stateOrProvinceCode": "example",
17          "countryCode": "example"
18        },
19        "lineItems": [
20          {
21            "lineItemEntityId": "example",
22            "quantity": 0
23          }
24        ]
25      }
26    },
27    "version": 0
28  }
29}
Example response
1{
2  "data": {
3    "updateCheckoutShippingConsignment": {
4      "checkout": {
5        "id": "example",
6        "entityId": "example",
7        "currencyCode": "example",
8        "displayCurrencyCode": "example",
9        "billingAddress": {
10          "entityId": null,
11          "firstName": null,
12          "lastName": null,
13          "email": null,
14          "company": null,
15          "address1": null,
16          "address2": null,
17          "city": null,
18          "stateOrProvince": null,
19          "stateOrProvinceCode": null
20        },
21        "cart": {
22          "id": null,
23          "entityId": null,
24          "currencyCode": null,
25          "displayCurrencyCode": null,
26          "isTaxIncluded": null,
27          "baseAmount": null,
28          "baseAmountInDisplayCurrency": null,
29          "discountedAmount": null,
30          "discountedAmountInDisplayCurrency": null,
31          "amount": null
32        },
33        "shippingConsignments": [
34          {
35            "entityId": null,
36            "address": null,
37            "availableShippingOptions": null,
38            "selectedShippingOption": null,
39            "coupons": null,
40            "shippingCost": null,
41            "shippingCostInDisplayCurrency": null,
42            "shippingCostBeforeDiscount": null,
43            "shippingCostBeforeDiscountInDisplayCurrency": null,
44            "comparisonShippingCost": null
45          }
46        ],
47        "shippingCostTotal": {
48          "currencyCode": null,
49          "value": null,
50          "formatted": null,
51          "formattedV2": null
52        },
53        "shippingCostTotalInDisplayCurrency": {
54          "currencyCode": null,
55          "value": null,
56          "formatted": null,
57          "formattedV2": null
58        },
59        "shippingCostBeforeDiscount": {
60          "currencyCode": null,
61          "value": null,
62          "formatted": null,
63          "formattedV2": null
64        }
65      }
66    }
67  }
68}
Updates a checkout shipping consignments.
Was this page helpful?
Previous

addCheckoutShippingConsignments

Next

deleteCheckoutConsignment

Built with

Arguments

inputUpdateCheckoutShippingConsignmentInputRequired
Update checkout shipping consignment input object

Returns

an optional UpdateCheckoutShippingConsignmentResult
checkoutCheckout
The Checkout that is updated as a result of mutation.