Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB
Orders

Track checkout started

Tracks a started checkout and triggers the ecommerce.checkout_started event, which can power abandoned checkout automations.

post/checkouts

Request body

checkoutIdstring required

Unique checkout identifier in your platform

totalCentsinteger nullable

Checkout total in cents

currencystring nullable

ISO 4217 currency code

checkoutUrlstring nullable

URL the customer can use to resume the checkout

propertiesobject

Extra event properties to attach to the triggered event

Example request

{
  "checkoutId": "checkout-abc123",
  "totalCents": 8850,
  "currency": "USD",
  "checkoutUrl": "https://store.example.com/checkout/abc123",
  "customer": {
    "email": "buyer@example.com",
    "externalId": "user_123",
    "firstName": "Jane",
    "lastName": "Doe",
    "attributes": {
      "acquisitionChannel": "tiktok",
      "country": "US"
    }
  },
  "items": [
    {
      "productId": "SKU-PROTEIN-1KG",
      "variantId": "SKU-PROTEIN-1KG-VANILLA",
      "sku": "VANILLA-1KG",
      "title": "Protein Powder",
      "variantTitle": "Vanilla",
      "quantity": 1,
      "priceCents": 8850
    }
  ]
}

Response

Checkout tracked successfully

successboolean
checkoutIdstring
subscriberIdstring
eventIdstring

Example response

{
  "success": true,
  "checkoutId": "checkout-abc123"
}