Updates an existing consignment. An update is either one of the following:
- Updates the consignment address and/or line items.
- Selects a specific fulfillment option.
Update the consignment address and line items
For this type of update, the payload is the same as when creating a new consignment. Update each Consignment shippingOptionId (shipping address and line items) with the availableShippingOption > id from the POST /consignment response.
Note:
Updating a consignment could invalidate the value for selectedShippingOption and selectedPickupOption.
Select a specific fulfillment option
Before placing an order, each consignment must have a selectedShippingOption or a selectedPickupOption.
If the consignment already has a pick-up option selected and a shipping option is provided, the pick-up option will be deselected and the shipping option will be selected instead (and vice versa). The PUT request will fail if it contains a shipping option ID and a pickup option ID.
Required Fields:
shippingOptionId or pickupOptionId
lineItems
To learn more about creating a Checkout Consignment see Checkout Consignment API.
Notes
- You cannot pass both an
address and a shippingOptionId because the shipping option may not be available for the new address
- Substitute your storefront domain for
yourstore.example.com.
- The Send a Test Request feature is not currently supported for this endpoint.
- Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
- This endpoint requires using Stencil CLI, a local session, and a csrf token to work.