Skip to main content
POST
Prepare hosted checkout with separate read-only return authority

Authorizations

X-Cart-Token
string
header
required

Purpose-limited capability returned for a guest cart.

Headers

Idempotency-Key
string
required

Caller-stable key reused only for retries of this exact request.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9._:-]{16,128}$
If-Match
string
required

Current cart ETag returned by the API.

Pattern: ^(?:W/)?"cart-(?:0|[1-9][0-9]*)"$

Path Parameters

locationId
string
required
Required string length: 1 - 128
cartId
string
required
Required string length: 1 - 128

Body

application/json

The body is of type object.

Response

Persist result authority before navigation. Fixed expiry; never include it in a URL.

checkoutUrl
string<uri>
required
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
resultAccessToken
string
required
Pattern: ^[A-Za-z0-9_-]{43}$
resultExpiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$