Skip to content

Orders API

GET /api/v1/orders
Authorization: Bearer <token>

Query parameters:

  • page, per_page — pagination
  • status — filter by status (pending, confirmed, completed, etc.)
GET /api/v1/orders/:id
Authorization: Bearer <token>

Response includes order items, addresses, payment status, fulfillments.

Orders are created through the checkout flow, not directly.

PATCH /api/v1/orders/:id/status
Authorization: Bearer <admin_token>
{ "status": "completed" }
POST /api/v1/orders/:id/fulfillments
Authorization: Bearer <admin_token>
{
"tracking_number": "1Z999AA10123456784",
"carrier": "UPS",
"items": [
{ "order_item_id": "uuid", "quantity": 2 }
]
}
POST /api/v1/orders/:id/notes
Authorization: Bearer <token>
{ "content": "Customer requested gift wrapping", "is_internal": true }
POST /api/v1/payments/:id/refund
Authorization: Bearer <admin_token>
{ "amount": 50.00, "reason": "Customer request" }