Orders

Track checkout started

Changed on

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

post/checkouts

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/checkouts
  • Auth
    HTTP bearer

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"
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • f1d8cfd9faafRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property became not nullable