Skip to main content
POST
/
checkout
/
single
Single Product Checkout
curl --request POST \
  --url https://api.henrylabs.ai/v0/checkout/single \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <x-user-id>' \
  --data @- <<EOF
{
  "shippingDetails": {
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "phoneNumber": "+1234567890",
    "addressLine1": "350 5th Ave",
    "countryCode": "US",
    "city": "New York",
    "stateOrProvince": "New York",
    "postalCode": "10001",
    "addressLine2": "Apt 1"
  },
  "productDetails": {
    "name": "Men's Trail Runners",
    "price": "100",
    "quantity": 1,
    "productLink": "https://www.on.com/en-us/products/cloud-6-versa-m-3mf1004/mens/black-eclipse-shoes-3MF10040106",
    "productId": "P01145AC2",
    "metadata": {
      "color": "Black",
      "size": "9"
    },
    "affiliateProductLink": "https://www.on.com/en-us/products/cloud-6-versa-m-3mf1004/mens/black-eclipse-shoes-3MF10040106?ref=affiliate123",
    "productImageLink": "https://images.ctfassets.net/hnk2vsx53n6l/2xi62H2BswFpVK0SjUmhXM/0d4a4bb14915c9a5d3228df45c774629/c36d3fd00cf91ec9fb5ff4bc4d4a0093cccbe8cd.png?w=192&h=192&fm=avif&f=center&fit=fill&q=80"
  },
  "batchName": "<string>",
  "batchNumber": 123,
  "region": "<string>"
}
EOF
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": {
    "id": "<string>",
    "status": "<string>",
    "statusMessage": "<string>",
    "orderAmount": "<string>",
    "currency": "<string>",
    "productName": "<string>",
    "quantity": 123,
    "shippingDetails": {
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "+1234567890",
      "addressLine1": "350 5th Ave",
      "countryCode": "US",
      "city": "New York",
      "stateOrProvince": "New York",
      "postalCode": "10001",
      "addressLine2": "Apt 1"
    },
    "productMetadata": {}
  }
}

Authorizations

x-api-key
string
header
required

Headers

x-user-id
string
required

Body

application/json
shippingDetails
object
required
productDetails
object
required
batchName
string

Optional batch name for grouping orders

Example:

"batch-001"

batchNumber
number

Optional batch number

Example:

1

region
string

ISO 3166-1 alpha-2 country code

Required string length: 2
Example:

"us"

Response

Order created successfully

success
boolean
required
Example:

true

status
string
required
Example:

"success"

message
string
required
Example:

"Order created successfully"

data
object