Sign in

v41

latestOpenAPI 3.0.0UNLICENSEDraw.githubusercontent.com2026-07-0839165177.6 KB
Checkout Intents

Create checkout intent

Create a checkout intent with the given request body.

post/api/v1/checkout-intents

Request body

referenceIdstring
discoverPromoCodesboolean
promoCodesPromoCode[]
quantityinteger required
productUrlstring required

Example request

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

Response

Created

OR
OR
OR
OR
OR

Example response

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