Skip to main content
POST
Push Order
Push an order from any e-commerce platform. This is the core of the Commerce API: one call gives you the same behavior as a native Shopify/WooCommerce order webhook. When an order is pushed, Sequenzy:
  1. Upserts the customer as a subscriber (with names and custom attributes)
  2. Triggers the matching event (ecommerce.order_placed, ecommerce.order_cancelled, ecommerce.order_fulfilled, or ecommerce.order_refunded) for automations and segments
  3. Updates revenue attributes on the subscriber: ltv, totalSpent, ordersCount, aov (placed orders only)
  4. Cancels superseded automations (e.g. a replenishment or back-in-stock sequence for a product the customer just bought)
  5. Schedules replenishment reminders for products with replenishment enabled
Processing is asynchronous - the endpoint returns 202 Accepted immediately.

Idempotency

Pushing the same orderId twice never double counts revenue. Retries are safe.

Request Body

string
required
Unique order identifier in your platform. Used for idempotency.
string
Human-facing order number, if different from orderId.
string
default:"placed"
Lifecycle status of this order event: placed, cancelled, fulfilled, or refunded.
integer
required
Order total in cents.
string
required
ISO 4217 currency code (e.g. USD).
string
ISO 8601 timestamp of when the order happened. Defaults to now.
object
required
The customer who placed the order. Requires email; also accepts externalId, firstName, lastName, and attributes (custom subscriber attributes, synced for segment filtering).
array
Order line items. Each item has productId (required), title (required), quantity (required), variantId, sku, variantTitle, and priceCents. Use the same productId values as your product catalog so replenishment and product matching work.
integer
For refunded orders: refunded amount in cents.
object
Authoritative customer aggregates from your platform: ordersCount and totalSpentCents. When provided, these override Sequenzy’s additive revenue bookkeeping (recommended if your platform tracks lifetime totals).
object
Extra event properties to attach to the triggered ecommerce.* event. Available in sequence emails as {{event.*}} merge tags. Reserved normalized keys (provider, orderId, lineItems, orderedAt, etc.) cannot be overridden.

Refund example

Responses