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

estimatedTax

object

required

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

Show child attributes

estimatedTax.itemsTaxes

object[]

required

Show child attributes

estimatedTax.itemsTaxes.amount

number

required

Tax amount that is imposed on the total amount

estimatedTax.itemsTaxes.lineItemId

integer

required

Sequence number of the item in the cart

estimatedTax.itemsTaxes.type

string

required

tax-type

estimatedTax.shipToTaxes

object[]

required

Show child attributes

estimatedTax.shipToTaxes.amount

number

required

Tax amount imposed, based on the shipping location, to ship the items.

estimatedTax.shipToTaxes.shipToId

string

required

Unique shipping ID

estimatedTax.shipToTaxes.type

string

required

tax-type

paymentDetails

object[]

required

Show child attributes

paymentDetails.amount

number

Amount to be paid

paymentDetails.attributes

object | null

• Option 1
• Option 2
• Option 3

paymentDetails.billToAddress

object

Billing address

Show child attributes

paymentDetails.billToAddress.city

string

City name of address

paymentDetails.billToAddress.country

string

Country name of address

paymentDetails.billToAddress.customerId

string

Customer profile ID, created by the payment gateway, for payment instruction. This ID is very specific to payment flow.

paymentDetails.billToAddress.email

string

Email id of the receiver

paymentDetails.billToAddress.latitude

number | null

latitude

paymentDetails.billToAddress.longitude

number | null

longitude

paymentDetails.billToAddress.name

object

Name of the individual used for for billing address

Show child attributes

paymentDetails.billToAddress.name.first

string

First name

paymentDetails.billToAddress.name.last

string

Last name

paymentDetails.billToAddress.name.middle

string | null

Middle name

paymentDetails.billToAddress.phone

object

Phone details of the individual for billing purpose

Show child attributes

paymentDetails.billToAddress.phone.kind

string | null

Kind of phone

paymentDetails.billToAddress.phone.number

string

Phone number

paymentDetails.billToAddress.state

string

State name of address

paymentDetails.billToAddress.street1

string

First line of address

paymentDetails.billToAddress.street2

string | null

Second line of address

paymentDetails.billToAddress.street3

string | null

Third line of address

paymentDetails.billToAddress.street4

string | null

Forth line of address

paymentDetails.billToAddress.type

string | null

type of address

paymentDetails.billToAddress.zipCode

string

ZIP code of address

paymentDetails.connectorName

string

Payment gateway service provider

paymentDetails.conversion

number

Currency Conversion (For USD = 1, For Non-USD = conversion ratio to USD)

paymentDetails.currency

string

Currency type

paymentDetails.paymentMethod

string | null

Payment method

paymentDetails.paymentMethodType

string | null

payment method type

paymentDetails.paymentToken

string

Payment token ID associated with the payment flow

customerAccountId

string | null

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

customerEmail

string | null

Email address of the customer

customerName

object

Name of the individual used for for billing address

Show child attributes

customerName.first

string

First name

customerName.last

string

Last name

customerName.middle

string | null

Middle name

customerPhoneNumber

object

Customer phone details

Show child attributes

customerPhoneNumber.kind

string

Kind of number

customerPhoneNumber.number

string

Phone number of the customer

employeeId

string | null

employeeId who helped during Checkout

notes

object[]

Show child attributes

notes.notes

string | null

notes

notes.timestamp

string | null

timestamp

notes.user

string | null

user name

orderSequence

object

Order sequence details

Show child attributes

orderSequence.sequenceKey

string | null

sequenceKey is used to identify prefixValue. If no prefix is needed, it can be null.

orderSequence.sequenceName

string

Sequence module name

orderSubType

string | null

OrderSubType (Android/IOS/International etc)

orderType

string | null

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

shipFrom

object

shipping details for the cart

Show child attributes

shipFrom.city

string

city name

shipFrom.country

string

country name

shipFrom.state

string

state name

shipFrom.street

string

first line of address

shipFrom.zipCode

string

zip code

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

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

paymentResp.orderTotal

number

Total amount of the order. It includes cart amount + taxes

paymentResp.totalAmountCapturable

number

Total amount the user has authorized to pay

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