Skip to main content
GET
Get a stable order-first submission outcome

Authorizations

X-Cart-Token
string
header
required

Purpose-limited capability returned for a guest cart.

Path Parameters

locationId
string
required
Required string length: 1 - 128
cartId
string
required
Required string length: 1 - 128
attemptId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Current stable order-first submission outcome.

attemptId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
collectionMode
enum<string>
required
Available options:
ONLINE,
PAY_AT_STORE
orderId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
settlementAdapter
enum<string>
required
Available options:
STRIPE,
SQUARE,
CLOVER,
TOAST
status
enum<string>
required
Available options:
CUSTOMER_ACTION_REQUIRED
clientSecret
string
required
Minimum string length: 1
connectedAccountId
string
required
Required string length: 1 - 255
mode
enum<string>
required
Available options:
test,
live
nextAction
enum<string>
required
Available options:
COLLECT_PAYMENT_METHOD,
CONFIRM_PAYMENT,
HANDLE_NEXT_ACTION,
WAIT,
NONE
catering
object | null