Choose pickup or shipping
With a location_id, the cart switches to pickup at that store location:
freight is cleared and the location's pickup fee becomes the shipping.
With fulfillment_method: "shipping", the cart goes back to shipping and
needs a freight option again.
Path Parameters
Store slug
Header Parameters
The shopper's cart; the cart_id cookie or body field works too
uuidA unique value (e.g. a UUID) per logical request. Retrying with the same key within 24 hours replays the first response instead of repeating the side effect; the replay carries Idempotent-Replayed: true. Reusing a key for a different request is a 422 idempotency_key_reused; retrying while the first is still running is a 409 idempotency_request_in_progress. JSON bodies up to 1 MB.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/storefront-api/string/api/cart/pickup" \ -H "Content-Type: application/json" \ -d '{}'{
"fulfillment_method": "string",
"ok": true,
"pickup_location_id": "5eb4dd60-b565-4dc0-8014-f7a790828fbb",
"shipping_cents": 0
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}