POST
/
v2
/
checkout

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Authorization
string | null

Authorization token for the user

Body

application/json

Checkout request payload

cartId
string
required

Unique cart ID

customerAccountId
string | null

Merchant account ID that is used in x-site-context

customerName
object

Name of the individual used for for billing address

customerEmail
string | null

Email address of the customer

customerPhoneNumber
object

Customer phone details

paymentDetails
object[]
required
estimatedTax
object
required

Estimated tax details imposed on cart-items and location to which the items are shipped.

shipFrom
object

shipping details for the cart

orderType
string | null

Order Type (WEB, CSC, MOBILE_APP, POS etc)

orderSubType
string | null

OrderSubType (Android/IOS/International etc)

orderSequence
object

Order sequence details

employeeId
string | null

employeeId who helped during Checkout

notes
object[]

Response

200 - application/json

Checkout response details

checkoutComplete
boolean

Status of checkout.<br />true = Checkout is complete<br />false = Checkout is not complete

orderId
string | null

Order ID

pointOfFailure
enum<string>

Checkout dependency failure if checkout is failed due to any of the reasons from the specified values.

Available options:
CART,
PAYMENT,
ORDER
paymentResp
object

Payment mismatch response details. It is displayed when totalAmountCapturable and orderTotal are different. The user must authorize to pay total amount of the order.