Checkout (2.0.0)

Download OpenAPI specification:Download

fabric's Checkout API lets you complete the checkout process and place an order on the cart items. This process includes specifying a customer's shipping and payment details, and calculating tax and shipping rates.

Checkout

Checkout endpoint lets you create checkout operation and place an order on the cart items.

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.

Request
header Parameters
required
object (xSiteContext)

JSON object containing stage, account, date, channel, and site.

Authorization
string or null

Authorization token for the user

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4
Request Body schema: application/json
cartId
required
string

Unique cart ID

customerAccountId
string or null

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

customerEmail
string or null

Email address of the customer

object or null

Customer phone details

required
Array of objects (PaymentDetailsRequest)
object (EstimatedTax)

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

Responses
200

OK

400

Client error

404

Not found

500

Internal server error

post/v2/checkout
Request samples
application/json
{
  • "cartId": "d7e78a21-bee3-4448-bf1c-d5b5461dbda2",
  • "customerAccountId": "5f689caa4216e7000750d1ef",
  • "customerEmail": "john.doe@gmail.com",
  • "customerPhoneNumber": {
    },
  • "paymentDetails": [
    ],
  • "estimatedTax": {
    }
}
Response samples
application/json
{
  • "checkoutComplete": true,
  • "orderId": "111-121-1234"
}