Create and complete a checkout session

Create and complete checkout session on all the items in a specific cart, identified by a cartId. Along with cartId, the checkout operation includes merchant account ID, amount to be paid, tax to be imposed on cart items, shipping address, and other details.

Authorizations

Authorization

string

header

required

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

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

payments

object[]

required

Payment detail list

Payment request details.Empty if there is no payment configuration.

Show child attributes

payments.paymentProvider

string

required

Payment gateway service provider

Example:

"authorize.net"

payments.paymentMethod

string | null

Payment method

Example:

"card"

payments.paymentToken

object

Order payment token model

Show child attributes

payments.paymentToken.token

string

Payment token

Example:

"pi_34tr6787rt"

payments.paymentToken.paymentType

string

Payment type, for credit card payments

Example:

"VISA"

payments.amount

number

Payment amount

Example:

150.25

payments.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

payments.billingAddress

object

Billing address

Show child attributes

payments.billingAddress.addressLine1

string

Address line 1

Example:

"123 Main St."

payments.billingAddress.addressLine2

string

Address line 2

Example:

"Suite 100"

payments.billingAddress.addressLine3

string

Address line 3

Example:

"Seventh floor"

payments.billingAddress.addressLine4

string

Address line 4

Example:

"Attention: Pat E. Kake"

payments.billingAddress.city

string

City

Example:

"Seattle"

payments.billingAddress.region

string

Region or state

Example:

"WA"

payments.billingAddress.postalCode

string

Postal or zip code

Example:

"98121"

payments.billingAddress.country

string

Country (can be full name, or ISO 3166-1 alpha-2 or alpha-3 code)

Example:

"US"

payments.billingAddress.name

object

Individual's name

Show child attributes

payments.billingAddress.name.firstName

string

Individual's first name

Example:

"Pat"

payments.billingAddress.name.middleName

string | null

Individual's middle name or initial

Example:

"E"

payments.billingAddress.name.lastName

string

Individual's last name

Example:

"Kake"

payments.billingAddress.phone

object

Individual's phone details (for billing purposes)

Show child attributes

payments.billingAddress.phone.number

string

Phone number

Example:

"123-456-7890"

payments.billingAddress.phone.type

string | null

Phone type

Example:

"office"

payments.billingAddress.email

string

Receiver email ID

Example:

"[e-mail]"

payments.billingAddress.customerId

string | null

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

Example:

"62cffd65e8d7eb868c6a29d6"

payments.billingAddress.type

string | null

Address type

Example:

"residence"

payments.billingAddress.latitude

number | null

Address latitude

Example:

47.6205

payments.billingAddress.longitude

number | null

Address longitude

Example:

-122.3493

payments.attributes

object | null

Additional data passed by the caller

Example:

{ "paymentId": "620d8896058edb0009385311" }

tax

object

required

Estimated taxes for items, shipping and fees

Show child attributes

tax.itemTaxes

object[]

required

Item taxes

Cart line item tax

Show child attributes

tax.itemTaxes.lineItemId

string

Line item ID

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

tax.itemTaxes.position

integer

Item sequence number

Example:

1

tax.itemTaxes.amount

number

Currency amount

Example:

150.25

tax.itemTaxes.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

tax.itemTaxes.name

string | null

Tax name

Example:

"state tax"

tax.itemTaxes.rateType

string | null

Rate type

Example:

"PERCENTAGE"

tax.itemTaxes.rate

number | null

Rate

Example:

10

tax.shippingTaxes

object[]

required

Shipping taxes

Shipping taxes

Show child attributes

tax.shippingTaxes.shippingDetailsId

string | null

required

Unique shipping ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

tax.shippingTaxes.amount

number

Currency amount

Example:

150.25

tax.shippingTaxes.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

tax.shippingTaxes.name

string | null

Tax name

Example:

"state tax"

tax.feeTaxes

object[] | null

Taxes related to fees

Fee taxes

Show child attributes

tax.feeTaxes.feeId

string

required

Unique fee tax ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

tax.feeTaxes.name

string | null

Fee tax type

Example:

"State tax"

tax.feeTaxes.amount

number

Fee tax amount

Example:

150.25

tax.feeTaxes.currency

string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

customer

object

Customer making payment

Show child attributes

customer.name

object

Order contact person's details

Show child attributes

customer.name.firstName

string

Contact person's first name

Example:

"Pat"

customer.name.middleName

string

Contact person's middle name or initial

Example:

"E"

customer.name.lastName

string

Contact person's last name

Example:

"Kake"

customer.email

string

Contact person's email

Example:

"[e-mail]"

customer.phone

object

Contact person's phone number

Show child attributes

customer.phone.number

string

Contact person's phone number

Example:

"5555555555"

customer.phone.type

enum<string>

Contact number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

customer.userId

string

User ID

Example:

"62272e917b12209e68751d94"

customer.accountId

string

Account ID such as loyalty account ID

Example:

"62272e917b12209e68751d94"

customer.employeeId

string

Employee ID used when the customer is the employee

Example:

"62272e917b12209e68751d94"

customer.company

string

Company

Example:

"fabric"

orderMetadata

object

Additional order information

Show child attributes

orderMetadata.orderType

string | null

Order type (WEB, CSC, MOBILE_APP, POS, etc.)

Example:

"MOBILE_APP"

orderMetadata.orderSubtype

string | null

Order subtype (Android, IOS, International, etc.)

Example:

"Android"

orderMetadata.notes

object[]

Customer service representative's notes

Notes section for use by customer service representative only

Show child attributes

orderMetadata.notes.notedAt

string

Time note was created

Example:

"2022-09-06T14:07:17.000Z"

orderMetadata.notes.user

string | null

Customer service representative ID

Example:

"261AF48"

orderMetadata.notes.notes

string | null

Note content

Example:

"Additional notes..."

Response

200

application/json

OK

Checkout response details

state

enum<string>

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

Available options:

COMPLETED,

PENDING

Example:

"COMPLETED"

orderId

string | null

Order ID

Example:

"111-123-4421"