POST
/
checkout
/
sessions

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id
string

Unique request ID

Body

application/json

Checkout request body

cartId
string
required

Unique cart ID

payments
object[]
required

Payment detail list

tax
object
required

Estimated taxes for items, shipping and fees

customer
object

Customer making payment

orderMetadata
object

Additional order information

Response

200 - application/json

Checkout response details

state
enum<string>

Checkout session state.<br />COMPLETED: Checkout is complete<br />PENDING: Checkout is incomplete

Available options:
COMPLETED,
PENDING
orderId
string | null

Order ID

Was this page helpful?