Create checkout

Create checkout operation on all the items of a specific cart which is identified by a unique cartId. Along with cartId, checkout operation includes merchant account Id, amount to be paid, tax to be imposed on cart items and shipping address, and some other details.

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

paymentDetails

object[]

required

Show child attributes

estimatedTax

object

required

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

Show child attributes

customerAccountId

string | null

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

customerName

object

Name of the individual used for for billing address

Show child attributes

customerEmail

string | null

Email address of the customer

customerPhoneNumber

object

Customer phone details

Show child attributes

shipFrom

object

shipping details for the cart

Show child attributes

orderType

string | null

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

orderSubType

string | null

OrderSubType (Android/IOS/International etc)

orderSequence

object

Order sequence details

Show child attributes

employeeId

string | null

employeeId who helped during Checkout

notes

object[]

Show child attributes

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.

Show child attributes