Skip to main content
GET
/
orders
{
  "orders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "max_price": 123,
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "quantity": 123,
          "status": "pending",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "shipping_address": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}
Retrieve a list of all orders associated with your account. Orders are returned in reverse chronological order (most recent first).

​
Response

Returns an array of order objects, each containing:
  • id - Order UUID
  • status - Current order status
  • items - Products in the order
  • shipping_address - Delivery address
  • job_result - Processing results (for completed/failed orders)
  • created_at - Order creation timestamp
  • updated_at - Last update timestamp

​
Order Statuses

StatusDescription
pendingOrder queued, not yet processing
in_progressOrder is being placed
orderedSuccessfully placed with retailer
shippedOrder shipped (tracking available)
deliveredOrder delivered to address
cancelledOrder was cancelled
failedOrder processing failed

​
Pagination

Currently, all orders are returned in a single response. Pagination will be added in a future update.

Headers

​
authorization
string | null

Response

Successful Response

List of orders for a particular user_id

​
orders
OrderResponse · object[]
required