Orders API

Retrieve orders placed on your store. Use this to sync orders to your fulfillment system or build custom order management workflows.

Endpoints

GET/orders
List Orders
Get a paginated list of orders
GET/orders/{id}
Get Order
Get detailed information about a specific order

Order Statuses

Orders progress through these statuses:

  • PENDINGOrder placed, awaiting payment confirmation
  • CONFIRMEDPayment confirmed, ready to fulfill
  • PROCESSINGOrder is being prepared
  • SHIPPEDOrder has been shipped
  • DELIVEREDOrder delivered to customer
  • CANCELLEDOrder was cancelled
  • REFUNDEDOrder was refunded

Real-time Notifications

Instead of polling the Orders API, consider using webhooks to receive real-time notifications when orders are placed or their status changes.

API Playground

Select an endpoint from the documentation to try it out here.