Skip to navigation

ShippingConsignmentUpdateCheckoutInput

INPUT
Shipping consignment update checkout input object

Input fields

entityIdStringOptional
The shipping consignment id. If omitted, a new consignment will be created. Otherwise, the existing consignment will be updated.
addressCheckoutAddressInputOptional
The shipping address
lineItemslist of CheckoutConsignmentLineItemInputsOptional
List of line items for the consignment
shippingOptionEntityIdStringOptional
The shipping option id
selectRecommendedOptionBooleanOptional
Whether to select the recommended shipping option
shippingOptionSelectionStrategyShippingOptionSelectionStrategyOptional
Select a shipping option using this strategy instead of the store's default shipping option setting. The selected option may differ from the one marked isRecommended. Cannot be provided with shippingOptionEntityId or with selectRecommendedOption set to true.
Allowed values: