Skip to main content
GET
/
scanner
/
orders
List orders for picking
curl --request GET \
  --url https://api.switchyard.run/scanner/orders \
  --header 'Authorization: Bearer <token>'
{
  "orders": [
    {
      "id": "order_01ABC123",
      "display_id": 1234,
      "status": "<string>",
      "fulfillment_status": "<string>",
      "payment_status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "total": 123,
      "shipping_address": {
        "first_name": "<string>",
        "last_name": "<string>",
        "address_1": "<string>",
        "city": "<string>",
        "postal_code": "<string>"
      }
    }
  ],
  "count": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Supabase JWT token

Query Parameters

status
enum<string>

Filter by order status

Available options:
pending,
processing,
picking,
staged,
delivering,
delivered
limit
integer
default:20

Maximum number of orders to return

Required range: x <= 100
offset
integer
default:0

Number of orders to skip for pagination

Response

200 - application/json

List of orders

orders
object[]
count
integer

Total number of orders matching filter

limit
integer
offset
integer