Changelog
Every addition within v1 and every new version is listed here, newest first (versioning).
v1: first version
Section titled "v1: first version"- Resources: orders (
GET /orders,GET /orders/{id}; a store app sends its own withPOST /ordersandPOST /orders/batch, store apps), shipments (GET /shipments,GET /shipments/{id},POST /shipments,POST /shipments/{id}/cancel), invoices (GET /invoices,GET /invoices/{id},POST /invoices), integrations (GET /integrations,GET /integrations/{id}), the organization and caller (GET /organization). - Authentication: OAuth 2.0 apps: authorization code with PKCE
S256for public apps, client credentials for private apps. - Scopes:
read_orders,read_shipments,write_shipments,read_invoices,write_invoices,read_integrations,write_orders(asked only beside what the app provides: a store). - Lists: cursor pagination, filters, sorting, syncing with
updated_since. - Conventions: prefixed public ids, money as strings with the currency's minor digits, UTC moments with microseconds, one address shape and the same field names in every resource,
error_codeon shipments and invoices (conventions). - Errors:
application/problem+json(RFC 9457), with stable codes; every response carriesX-Request-Id, repeated in an error asrequest_id. - Idempotency:
Idempotency-Key, required to create a shipment, issue an invoice and cancel; honoured when a store app sends orders. - Rate limits:
X-RateLimit-Limit,X-RateLimit-Remaining,429withRetry-After. - Webhooks: Standard Webhooks, the events
order.created,order.updated,shipment.created,shipment.status_changed,shipment.cancelled,invoice.created,invoice.status_changed,app.uninstalled.