Orders

Overview

Orders represent one-time purchases of e-commerce products. Unlike subscriptions, orders are single transactions that can include multiple items (SKUs). Orders track payment status, fulfillment, and shipping information.

How it works

  1. Customer places order — Cart items are converted to an order with payment
  2. Order is paid — Payment is processed and order status updates
  3. Fulfillment — Physical products are shipped, digital products are delivered
  4. Completion — Order is marked as fulfilled or returned

Endpoints

MethodEndpointDescription
GET/ordersList orders
GET/orders/{id}Get order
POST/ordersCreate order
PUT/orders/{id}Update order

Order statuses

StatusDescription
createdOrder created, awaiting payment
paidPayment received, ready for fulfillment
canceledOrder has been canceled
fulfilledAll items have been shipped/delivered
returnedOrder has been returned

Status transitions

FromTo
paidfulfilled
fulfilledreturned

Order object

AttributeTypeDescription
idintegerUnique identifier
user_idintegerCustomer ID (expandable via user)
address_idintegerShipping address ID (expandable via address)
amountintegerTotal amount in cents
currencystringThree-letter ISO currency code
statusstringOrder status
itemsarrayOrder items (expandable)
metadataobjectCustom key-value metadata
created_atintegerUnix timestamp