v41

latestOpenAPI 3.0.0UNLICENSEDraw.githubusercontent.com2026-07-0839165177.6 KB
Betas

Create checkout session

Create a new checkout session.

Checkout sessions are hosted checkout forms your shoppers can use to complete their purchases.

post/api/v1/betas/checkout-sessions

Request body

productUrlstring required
quantityinteger required
promoCodesstring[]
discoverPromoCodesboolean
referenceIdstring
layout'default' | 'wizard'

Optional layout for the checkout UI (e.g. "wizard"). Defaults to the standard layout.

Example request

{
  "productUrl": "https://www.amazon.com/dp/B0DFC9MT8Q",
  "quantity": 1,
  "variantSelections": [
    {
      "label": "Size, Color, etc."
    }
  ],
  "constraints": {
    "maxShippingPrice": 500,
    "maxTotalPrice": 100000
  },
  "referenceId": "order-1234",
  "buyer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "1234567890",
    "address1": "123 Main St",
    "address2": "Apt 1",
    "city": "New York",
    "province": "NY",
    "country": "US",
    "postalCode": "10001"
  }
}

Response

Checkout session

urlstring required

URL to send your user to for checkout. This URL is valid for 4 hours.