Skip to main content
GET
/
v1
/
orders
List orders with filtering and pagination
curl --request GET \
  --url http://localhost:3000/v1/orders
{
  "orders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "<string>",
      "status": "<string>",
      "total_amount": 123,
      "payment_status": "<string>",
      "payment_method": "<string>",
      "order_cutoff_time": "<string>",
      "estimated_pickup_time": "<string>",
      "actual_pickup_time": "<string>",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "notes": "<string>",
      "source": "<string>",
      "currency_code": "<string>",
      "email": "<string>",
      "fulfillment_status": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>",
        "email": "<string>",
        "phone": "<string>"
      },
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sellable_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "quantity": 123,
          "unit_price": 123,
          "fulfilled_quantity": 123,
          "shipped_quantity": 123,
          "is_tax_inclusive": true,
          "return_requested_quantity": 123,
          "return_received_quantity": 123,
          "return_dismissed_quantity": 123,
          "written_off_quantity": 123,
          "product": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "brand": "<string>",
            "image_url": "<string>"
          }
        }
      ],
      "item_count": 123,
      "display_id": 123,
      "deleted_at": "<string>"
    }
  ],
  "total": 123
}

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 500
offset
integer | null
default:0
Required range: x >= 0
status
string
rfc_status
enum<string>

Filter by RFC fulfillment status

Available options:
received,
reserved,
picking,
sweep_hold,
staged,
fulfilling,
arrived,
completed
customer_id
string<uuid>
date
string

Filter by single date (YYYY-MM-DD), use start_date/end_date for ranges

start_date
string

Start date for date range filter (YYYY-MM-DD)

end_date
string

End date for date range filter (YYYY-MM-DD)

q
string

Search by order number or email

Response

200 - application/json

List of orders

orders
object[]
required
total
number
required