cart.set_pickup_location
Choose WHERE this order will be picked up. Requires the cart to already carry a pickup-kind shipping method (get both from the read shipping_options, which returns the eligible points with the option). An inactive point is refused.
- Scope:
public - System: no
- Reachable from:
POST /v1/cart/commands/cart.set_pickup_location— an ANONYMOUS face:x-forge-storeis required, no credential is sent, and it is never on/v1/commands/* - Events: none — Which point the shopper picked is session state, read back no-store on the next step, and it fires every time they tap another store in the list. What DID change for everyone — the points themselves — is announced by pickup_location.* through shipping.config.updated; this only records one shopper’s choice.
Input (JSON Schema)
Section titled “Input (JSON Schema)”{ "properties": { "cart_id": { "minLength": 1, "type": "string" }, "pickup_location_id": { "minLength": 1, "type": "string" } }, "required": [ "cart_id", "pickup_location_id" ], "type": "object"}Result (200)
Section titled “Result (200)”{ "additionalProperties": false, "properties": { "cart_id": { "type": "string" } }, "required": [ "cart_id" ], "type": "object"}Errors
Section titled “Errors”validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)