Sell one-time purchase products with inventory management and order fulfillment.
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
- Customer places order - Cart items are converted to an order with payment
- Order is paid - Payment is processed and order status updates
- Fulfillment - Physical products are shipped, digital products are delivered
- Completion - Order is marked as fulfilled or returned
Example: A customer purchases a book and a branded mug. The system creates an order with two line items, processes payment, and marks the order for fulfillment by your warehouse team.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/core/orders | List all orders |
POST | /api/v1/core/orders | Create an order |
GET | /api/v1/core/orders/{id} | Get an order |
PUT | /api/v1/core/orders/{id} | Update an order |
Order Statuses
| Status | Description |
|---|---|
paid | Payment received, ready for fulfillment |
canceled | Order has been canceled |
fulfilled | All items have been shipped/delivered |
returned | Order has been returned |
Order Object
| Attribute | Type | Description |
|---|---|---|
id | integer | Unique identifier for the order |
user_id | integer | ID of the customer (expandable) |
address_id | integer | ID of the shipping address (expandable) |
amount | integer | Total amount in cents |
currency | string | Three-letter ISO currency code |
status | string | Order status (see statuses above) |
items | array | Array of order items (expandable) |
metadata | object | Key-value pairs for storing additional data |
created_at | timestamp | Unix timestamp of creation |
Related Endpoints
- E-commerce Products - Products available for purchase
- SKUs - Product variants with inventory
- Customers - Customer who placed the order