List orders · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/ListOrders

Returns orders one page at a time, with their status, packages and tracking. All filters are optional and can be combined.

You can't filter by your own external_id. To find an order by it, use the external_order filter on ListTrackings.

This endpoint is slow

Bigblue loads fulfillments and trackings for every order on the page. Use long client timeouts. To track status changes, use the order status webhook instead of polling.

Request body

via_apibooleandefault false

Only return orders created by the integration of the calling API key.

countriesstring[]

Only return orders shipping to these countries. Two-letter codes.

date_rangeDateRange

Only return orders submitted in this period.

page_sizeintegerdefault 100

Orders per page.

page_tokenstring

The next_page_token from the previous response.

DateRange

fromstring

Start, RFC 3339 UTC, for example 2026-03-01T00:00:00Z.

RFC 3339 in UTC, for example 2026-03-14T09:30:00Z

tostring

End, RFC 3339 UTC.

RFC 3339 in UTC, for example 2026-03-14T09:30:00Z

Both values must end in Z, without fractional seconds.

Responses

200A page of orders.

ordersOrder[]

The orders on this page.

next_page_tokenstring

Token for the next page. Missing on the last page.

A page can contain fewer orders than page_size, because orders that can't be returned, for example with an unknown currency, are skipped. Keep paging while next_page_token is set.

400A country code or date is invalid.

{
  "code": "invalid_argument",
  "msg": "countries[0] value length must be 2 characters",
  "meta": { "argument": "countries[0]" }
}

POST/bigblue.storeapi.v1.PublicAPI/ListOrders

Request: my orders from one day

{
  "via_api": true,
  "date_range": {
    "from": "2026-03-13T00:00:00Z",
    "to": "2026-03-14T00:00:00Z"
  },
  "page_size": 100
}

Request: Spain and Portugal

{ "countries": ["ES", "PT"], "page_size": 250 }

200

{
  "orders": [
    {
      "id": "BGBL0K3M9XQ2",
      "external_id": "web-10231",
      "submit_time": "2026-03-13T18:04:00Z",
      "currency": "EUR",
      "total": "58.82",
      "status": { "code": "SHIPPED" },
      "tracking_number": "6A12345678901"
    }
  ],
  "next_page_token": "ChgKFgoGb3JkZXJzEgxCR0JMMEszTTlYUTI"
}