Skip to navigation
GraphQLStorefrontTypesObjects

CheckoutShippingConsignment

OBJECT
Checkout shipping consignment.

Fields

entityIdStringRequired
Shipping consignment ID.
addressCheckoutConsignmentAddressRequired
Shipping consignment address.
shippingCostBeforeDiscountMoneyRequired
The shipping cost for the consignment before any discounts are applied.
shippingCostBeforeDiscountInDisplayCurrencyMoneyRequired
Shipping cost before discount in display currency.
comparisonShippingCostMoneyRequired
The shipping cost for the consignment before coupon discounts are applied.
comparisonShippingCostInDisplayCurrencyMoneyRequired
Comparison shipping cost in display currency.
lineItemIdslist of StringsRequired
List of line item IDs for the consignment.
availableShippingOptionslist of CheckoutAvailableShippingOptionsOptional
Shipping options available for this consignment, calculated from its address and line items. Pass an option's entityId to the selectCheckoutShippingOption mutation to select it.
selectedShippingOptionCheckoutSelectedShippingOptionOptional
The shipping option selected for this consignment. This is 'null' until an option is selected, either with the selectCheckoutShippingOption mutation or when the consignment is created by createCheckout with selectRecommendedOption or shippingOptionSelectionStrategy. Changing the line items, or changing the address so that the selected option is no longer available, can clear the selection. Every consignment needs a selected option before the checkout can be completed.
couponslist of CheckoutCouponsOptional
List of coupons applied to this shipping consignment.
shippingCostMoneyOptional
The shipping cost for the consignment.
shippingCostInDisplayCurrencyMoneyOptional
Shipping cost in display currency.
handlingCostMoneyOptional
The handling cost of shipping for the consignment.
handlingCostInDisplayCurrencyMoneyOptional
Handling cost in display currency.