Overview
Sell physical and digital goods alongside subscriptions. Browse a site's catalog of products and their SKUs, preview pricing before checkout, and create (and pay for) orders. Catalog browsing is public; pricing and order creation require an authenticated customer.
How It Works
- Browse the catalog — list a site's products with their in-stock SKUs, or fetch a single SKU.
- Preview pricing — compute an order summary (subtotal, shipping, tax, discount, total) without committing.
- Place the order — create the order and charge the customer's payment method.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /api/v1/sdk/ecommerce/order | Order |
POST | /api/v1/sdk/ecommerce/order-summary | Order summary |
GET | /api/v1/sdk/ecommerce/products/site/{site_id} | List products |
GET | /api/v1/sdk/ecommerce/products/site/{site_id}/skus/{sku_id} | Get product SKU |
Important Behaviors
- Catalog is public; order summary and order creation require an authenticated customer (Bearer JWT) and an active payment gateway on the account.
- The product listing is served from the global edge for fast, low-latency responses and already nests each product's in-stock SKUs.
- All SKUs in a single order must share the same currency.
address_idis required when an order contains shippable items or when e-commerce taxes are enabled.
Webhooks
E-commerce actions fire the following webhook events:
order.created— when an e-commerce order is createdorder.payment.succeeded— when payment for an order succeedsorder.payment.failed— when payment for an order failsorder.fulfilled— when an order is fulfilledorder.canceled— when an order is canceledorder.returned— when an order is returnedorder.updated— when an order is updated