Orders
Retrieve Order
Retrieve a single order by ID.
GET
/
vendor
/
orders
/
{id}
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { order } = await client.vendor.orders.$id.query({
$id: "order_01HXYZABCDEF",
})
{
"order": {
"id": "order_01HXYZABCDEF",
"display_id": 42,
"status": "pending",
"email": "jane@example.com",
"currency_code": "usd",
"items": [
{
"id": "ordli_01HXYZABCDEF",
"title": "T-Shirt / M",
"quantity": 1,
"unit_price": 2500
}
],
"summary": {
"current_order_total": 2500,
"paid_total": 2500
},
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}
Returns an order belonging to the authenticated seller, including items, addresses, payments, fulfillments, and returns.
Path parameters
string
required
The order’s ID.
Query parameters
string
Comma-separated list of fields to include, prefix with
+/- to add or remove from defaults.Response
object
Show properties
Show properties
string
The order’s ID.
number
Human-readable order number.
string
The order’s status.
string
The customer’s email.
string
The order’s currency code.
string
ID of the order’s region.
string
ID of the customer.
string
ID of the sales channel.
object[]
The order’s line items, including variant, product, and offer data.
object
The order’s shipping address.
object
The order’s billing address.
object[]
The order’s shipping methods.
object[]
Payment collections with payments and refunds.
object[]
The order’s fulfillments.
object[]
The order’s returns with items and reasons.
object
Order totals summary.
object
Custom key-value data.
string
Creation timestamp.
string
Last update timestamp.
string
Cancellation timestamp, if canceled.
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { order } = await client.vendor.orders.$id.query({
$id: "order_01HXYZABCDEF",
})
{
"order": {
"id": "order_01HXYZABCDEF",
"display_id": 42,
"status": "pending",
"email": "jane@example.com",
"currency_code": "usd",
"items": [
{
"id": "ordli_01HXYZABCDEF",
"title": "T-Shirt / M",
"quantity": 1,
"unit_price": 2500
}
],
"summary": {
"current_order_total": 2500,
"paid_total": 2500
},
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}
⌘I
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { order } = await client.vendor.orders.$id.query({
$id: "order_01HXYZABCDEF",
})
{
"order": {
"id": "order_01HXYZABCDEF",
"display_id": 42,
"status": "pending",
"email": "jane@example.com",
"currency_code": "usd",
"items": [
{
"id": "ordli_01HXYZABCDEF",
"title": "T-Shirt / M",
"quantity": 1,
"unit_price": 2500
}
],
"summary": {
"current_order_total": 2500,
"paid_total": 2500
},
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}