Skip to main content
GET
/
v1
/
orders
List
curl --request GET \
  --url https://{defaultHost}/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/orders"
  },
  "data": [
    {
      "id": "fa51d1a3-0c77-4ac1-964a-adec7c79adc5",
      "object": "order",
      "fulfillment_status": "unfulfilled",
      "live_mode": true,
      "number": "0000",
      "order_type": "checkout",
      "return_status": "not_returned",
      "shipment_status": "unshippable",
      "portal_url": "http://app.example.com/portal_redirect/orders/fa51d1a3-0c77-4ac1-964a-adec7c79adc5",
      "statement_url": "http://app.example.com/statements/orders/fa51d1a3-0c77-4ac1-964a-adec7c79adc5",
      "status": "paid",
      "checkout": "3f642d4e-cdaa-47f0-a877-7e0e4c40932e",
      "created_at": 1767909727,
      "updated_at": 1767909727
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

checkout_ids[]
string[]

Only return objects that belong to the given checkouts.

customer_ids[]
string[]

Only return objects that belong to the given customers.

fulfillment_status[]
string[]

Only return objects with the given fulfillment status.

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

live_mode
boolean

Only return objects that are live mode or test mode.

order_type[]
string[]

Only return orders with the given type.

page
integer

The page of items you want returned.

product_ids[]
string[]

Only return objects that belong to the given products.

query
string

The query to be used for full text search of this collection.

return_status[]
string[]

Only return objects with the given return status.

shipment_status[]
string[]

Only return objects with the given shipment status.

status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.