API overview
Discover cart checkout requirements
Choose an operation to see its request, response shape, access rules and implementation source.
ReadPublic cart context
GET/api/v1/checkout/requirements
Discover cart checkout requirements
No auth:sanctum or bearer ability is required by this route.
Request
| Field | In | Rule |
|---|---|---|
X-Cart-Token | Header | Guest cart credential returned by the cart API. Preserve it; a missing or malformed token starts a new cart context. |
No request body.
curl --request GET "https://shop.example.test/api/v1/checkout/requirements" \
--header 'Accept: application/json' \
--header "X-Cart-Token: $CART_TOKEN"Response200
Success: 200
Response shape (notation, not a captured response)
{ data: { requirements: string[], requires_shipping: boolean, payment_methods: { id, label, gateway_id?, icon? }[] } }Common errors
| HTTP status | Meaning |
|---|---|
429 | rate_limited: back off before retrying, especially writes. |