Axisel / docs
Manage keys← Back to Axisel

Orders

Read your store's orders and update their status, tracking, and internal notes.

List orders

GET/api/v1/orders

Scope: orders:read.

Query parameters

  • limit, offset
  • statuspending | confirmed | processing | shipped | delivered | cancelled
  • orderSourceonline | pos | manual | shopify | woocommerce
  • createdAfter, createdBefore

Get an order

GET/api/v1/orders/:id

Update an order

PATCH/api/v1/orders/:id

Scope: orders:write. Pass any combination of:

  • status — transition the order (e.g. "shipped")
  • trackingNumber, shippingCarrier
  • cancellationReason — used when status is cancelled
  • storeNotes — internal notes
curl
curl -X PATCH https://axisel.com/api/v1/orders/67e1234... \ -H "Authorization: Bearer sk_live_..." \ -H "Content-Type: application/json" \ -d '{ "status": "shipped", "trackingNumber": "1Z999AA10123456784", "shippingCarrier": "UPS" }'

Order object

json
{ "id": "67e1...", "orderNumber": "1001", "storeOrderNumber": "SO2605211234", "displayOrderNumber": "1001", "status": "shipped", "orderSource": "online", "customer": { "id": "67d9...", "name": "Jane Doe", "email": "jane@example.com", "phone": "+1..." }, "shippingAddress": { "fullName": "...", "street": "...", "city": "...", "country": "..." }, "items": [ { "productId": "67e0...", "name": "Cardigan", "price": 89, "quantity": 2, "variant": { "color": "Navy", "size": "M" } } ], "subtotal": 178, "discount": 0, "shipping": 12, "tax": 0, "total": 190, "paymentStatus": "paid", "paymentMethod": "STRIPE", "trackingNumber": "1Z999...", "shippingCarrier": "UPS", "createdAt": "2026-05-21T12:30:00.000Z" }

Status transitions

Some transitions are blocked to prevent inventory bugs:

  • You cannot un-cancel an order. cancelled is terminal.
  • You cannot un-deliver an order. delivered is terminal.
  • Cancelling releases inventory reservations automatically.
  • Delivering finalizes stock decrements.