Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions reference/checkouts.sf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1126,19 +1126,20 @@ paths:
Adds a new *Consignment* to *Checkout*.

Perform the following two steps to define the fulfillment of the items in the cart.
### For **shipping** consignments:
1. Add a new Consignment to Checkout.
* Send a `POST` request to `/consignments` with each shipping address, line item IDs, and quantities. Each address can have its own line item IDs.
* Provide a full valid customer address before placing the order. If provided, the order placement will succeed.
* As part of the request URL make sure to add `include=consignments.availableShippingOptions` to return the available shipping options based on the items, the address, and the shipping location. This will return `availableShippingOptions` in the response.
### For **shipping** consignments:
1. Add a new Consignment to Checkout.
* Send a `POST` request to `/consignments` with each shipping address, line item IDs, and quantities. Each address can have its own line item IDs.
* Provide a full valid customer address before placing the order. If provided, the order placement will succeed.
* As part of the request URL make sure to add `include=consignments.availableShippingOptions` to return the available shipping options based on the items, the address, and the shipping location. This will return `availableShippingOptions` in the response.

* Required Fields:
* `shipping_address` (deprecated) or `address`
* `lineItems`
2. Update the Consignment with Shipping Options using the [REST Storefront API](/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).

### For **pickup** consignments:
1. Create a new consignment object.

2. Update the Consignment with Shipping Options using the [REST Storefront API](/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).

### For **pickup** consignments:
1. Create a new consignment object.
- Send a `POST` request to `/consignments` with line item IDs and quantities.
- Provide a `pickupMethodId`. This is the `id` of the Pickup Method provided in the response body of the Storefront Pickup Options API.
- Required Fields:
Expand Down