Sequenzy Orders API
Push orders and checkouts from any e-commerce platform via the Commerce API
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/sequenzy:sequenzy-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Sequenzy Orders API
description: Sequenzy API for managing subscribers, tags, events, sequences, and transactional emails
version: 1.0.0
servers:
- url: https://api.sequenzy.com/api/v1
description: Production server
- url: https://api.sequenzy.com/v1
description: Legacy production server alias
security:
- bearerAuth: []
tags:
- name: Orders
description: Push orders and checkouts from any e-commerce platform via the Commerce API
paths:
/orders:
post:
summary: Push order
description: Pushes a normalized order from any e-commerce platform. Triggers the matching ecommerce.* event (order placed, cancelled, fulfilled, or refunded), updates the customer's revenue attributes (ltv, totalSpent, ordersCount, aov), cancels superseded commerce automations, and schedules replenishment reminders. Processing is asynchronous.
operationId: pushOrder
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- orderId
- totalCents
- currency
- customer
properties:
orderId:
type: string
description: Unique order identifier in your platform. Used for idempotency - pushing the same orderId twice never double counts revenue.
example: order-1001
orderNumber:
type:
- string
- 'null'
description: Human-facing order number, if different from orderId
example: '1001'
status:
type: string
enum:
- placed
- cancelled
- fulfilled
- refunded
default: placed
description: Lifecycle status of this order event
totalCents:
type: integer
minimum: 0
description: Order total in cents
example: 8850
currency:
type: string
description: ISO 4217 currency code
example: USD
orderedAt:
type: string
format: date-time
description: ISO 8601 timestamp of when the order happened. Defaults to now.
example: '2026-06-01T12:00:00.000Z'
customer:
$ref: '#/components/schemas/CommerceCustomer'
items:
type: array
description: Order line items
items:
$ref: '#/components/schemas/CommerceOrderItem'
refundAmountCents:
type:
- integer
- 'null'
description: For refunded orders - refunded amount in cents
customerTotals:
type:
- object
- 'null'
description: Authoritative customer aggregates from your platform. When provided, these override Sequenzy's additive revenue bookkeeping.
properties:
ordersCount:
type: integer
minimum: 0
example: 5
totalSpentCents:
type: integer
minimum: 0
example: 50000
properties:
type: object
additionalProperties: true
description: Extra event properties to attach to the triggered ecommerce.* event
responses:
'202':
description: Order queued for processing
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
queued:
type: boolean
example: true
jobId:
type: string
orderId:
type: string
example: order-1001
status:
type: string
example: placed
'400':
description: Validation error (e.g. invalid orderedAt)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: Failed to queue order
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/checkouts:
post:
summary: Track checkout started
description: Tracks a started checkout and triggers the ecommerce.checkout_started event, which can power abandoned checkout automations.
operationId: trackCheckoutStarted
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- checkoutId
- customer
properties:
checkoutId:
type: string
description: Unique checkout identifier in your platform
example: checkout-abc123
totalCents:
type:
- integer
- 'null'
minimum: 0
description: Checkout total in cents
example: 8850
currency:
type:
- string
- 'null'
description: ISO 4217 currency code
example: USD
checkoutUrl:
type:
- string
- 'null'
description: URL the customer can use to resume the checkout
example: https://store.example.com/checkout/abc123
customer:
$ref: '#/components/schemas/CommerceCustomer'
items:
type: array
description: Checkout line items
items:
$ref: '#/components/schemas/CommerceOrderItem'
properties:
type: object
additionalProperties: true
description: Extra event properties to attach to the triggered event
responses:
'200':
description: Checkout tracked successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
checkoutId:
type: string
example: checkout-abc123
subscriberId:
type: string
eventId:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
CommerceCustomer:
type: object
required:
- email
properties:
email:
type: string
format: email
example: buyer@example.com
externalId:
type: string
description: Customer-owned app/customer/user ID
example: user_123
firstName:
type: string
example: Jane
lastName:
type: string
example: Doe
attributes:
type: object
additionalProperties: true
description: Custom subscriber attributes to merge into the profile. Synced to ClickHouse for segment filtering.
example:
acquisitionChannel: tiktok
country: US
InputIssue:
type: object
properties:
path:
type: string
description: Dotted field path, such as `audience.subscriberIds[0]`. Empty when the problem is with the request body itself.
example: kind
message:
type: string
description: What is wrong with the field.
example: must be "add_tags"
allowedValues:
type: array
description: Accepted values when the field only takes a fixed set of values.
items: {}
example:
- add_tags
required:
- path
- message
CommerceOrderItem:
type: object
required:
- productId
- title
- quantity
properties:
productId:
type: string
description: Your product identifier (same value used when upserting products)
example: SKU-PROTEIN-1KG
variantId:
type:
- string
- 'null'
description: Your variant identifier within the product
example: SKU-PROTEIN-1KG-VANILLA
sku:
type:
- string
- 'null'
example: VANILLA-1KG
title:
type: string
example: Protein Powder
variantTitle:
type:
- string
- 'null'
example: Vanilla
quantity:
type: integer
minimum: 0
example: 1
priceCents:
type:
- integer
- 'null'
description: Unit price in cents
example: 8850
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: string
example: Error message
code:
type: string
description: Optional stable machine-readable error discriminator when available.
example: COMPANY_CREATE_REQUIRES_PERSONAL_KEY
retryable:
type: boolean
description: Whether retrying the request can recover from the error.
issues:
type: array
description: Field-level problems with the request, when the endpoint reports them. Up to ten entries; `error` summarizes the first three.
items:
$ref: '#/components/schemas/InputIssue'
required:
- error
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key passed as Bearer token