Orders
What a paid cart or invoice becomes: the items, totals, shipments and refunds.
Endpoints
Guides that use it
Quickstart
Go from a new account to a paid test order with curl in about 5 minutes. Create a test token, a product and a cart, then pay with a test card.
Accept payments
Build a checkout with the API. Create a cart, take a card, PayPal or Apple Pay payment, handle 3-D Secure and declines, and capture or void later.
Refunds
Give money back with the API. Refund a whole order or part of it by amount or items, refund one payment, refund to store credit and follow the refund events.
Auto fulfill and capture delay
How fulfillment settings decide when order items are marked fulfilled and when an authorized payment is captured, so you can take the money only after shipping.
Get the invoice shipping item GET
Returns the shipping line of an invoice. Returns `404` when the invoice has no shipping. Takes a secret, trusted or limited token. A limited token must be bound to the invoice and cannot see a draft.
List orders GET
Lists your orders, oldest first unless you send `desc=true`. There is no way to create an order directly: the API makes one when a payment on a cart or an invoice succeeds or is authorized. The list is cursor-based: use `after_item` and `before_item` (or the `next_page_url` and `previous_page_url` in the response). It is ordered by the date named in `date_type` (`date_created` by default; `date_modified` and `date_completed` also work). `sort_by` is ignored. Needs a secret or trusted token. Limited tokens get `403`; a customer reads their own orders with `GET /customers/{customer_id}/orders`.