Order Groups
Retrieve Order Group
Retrieve an order group by ID.
GET
/
admin
/
order-groups
/
{id}
curl 'http://localhost:9000/admin/order-groups/og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { order_group } = await client.admin.orderGroups.$id.query({
$id: "og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"order_group": {
"id": "og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"customer_id": "cus_01HXYZ",
"seller_count": 2,
"total": 7400,
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}
Returns a single order group.
Path parameters
string
required
The order group’s ID.
Query parameters
string
Comma-separated fields to include in the response.
Response
object
curl 'http://localhost:9000/admin/order-groups/og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { order_group } = await client.admin.orderGroups.$id.query({
$id: "og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"order_group": {
"id": "og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"customer_id": "cus_01HXYZ",
"seller_count": 2,
"total": 7400,
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}
⌘I
curl 'http://localhost:9000/admin/order-groups/og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { order_group } = await client.admin.orderGroups.$id.query({
$id: "og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"order_group": {
"id": "og_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"customer_id": "cus_01HXYZ",
"seller_count": 2,
"total": 7400,
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}