curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
{
"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"
}
}
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>'
{
"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
The order’s ID.
Query parameters
Comma-separated list of fields to include, prefix with
+/- to add or remove from defaults.Response
Show properties
Show properties
The order’s ID.
Human-readable order number.
The order’s status.
The customer’s email.
The order’s currency code.
ID of the order’s region.
ID of the customer.
ID of the sales channel.
The order’s line items, including variant, product, and offer data.
The order’s shipping address.
The order’s billing address.
The order’s shipping methods.
Payment collections with payments and refunds.
The order’s fulfillments.
The order’s returns with items and reasons.
Order totals summary.
Custom key-value data.
Creation timestamp.
Last update timestamp.
Cancellation timestamp, if canceled.
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
{
"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