Skip to main content
GET
/
v1
/
orders
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "cb78435a-157f-490a-8b50-9cebcd24da2c",
  "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/cb78435a-157f-490a-8b50-9cebcd24da2c",
  "statement_url": "http://app.example.com/statements/orders/cb78435a-157f-490a-8b50-9cebcd24da2c",
  "status": "paid",
  "checkout": "3676c8a7-ee17-4f9e-a6be-a979e9875271",
  "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.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
checkout

Expandable – The associated checkout ID.

​
fulfillment_status
string

The overall fulfillment status of this order based on all fulfillments – one of fulfilled, partially_fulfilled, or unfulfilled.

​
live_mode
boolean

Set to true if this order is in live mode, and set to false if it is in test mode.

​
number
string

The unique identifier for this order that is auto generated based on this account's order protocol.

​
order_type
string

One of either checkout or subscription.

​
portal_url
string | null

A URL that will redirect to this order's correct portal page (hosted or external).

​
return_status
string

The overall return status of this order based on all return requests – one of not_returned, partially_returned, return_request_open, or returned.

​
shipment_status
string

The overall shipment status of this order based on all fulfillments – one of unshippable, unshipped, shipped, partially_shipped, or delivered.

​
statement_url
string | null

The link to view and download the "invoice" or "receipt" statement of this order.

​
status
string

The current status of this order, which can be one of draft, paid, payment_failed, processing, or void.

​
fulfillments

Expandable – Property not returned unless expanded.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.