Skip to main content
GET
/
admin
/
order-groups
curl 'http://localhost:9000/admin/order-groups?customer_id=cus_01HXYZ&limit=20' \
  -H 'Authorization: Bearer <token>'

{
  "order_groups": [
    {
      "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"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}
Returns order groups — the customer-facing wrappers around per-seller orders created from a multi-seller cart.
Filtering by seller_id narrows results to order groups that contain at least one order belonging to that seller.

​
Query parameters

​
limit
number
default:"50"
Maximum number of records to return.
​
offset
number
default:"0"
Number of records to skip.
​
order
string
Field to sort by, prefix with - for descending order.
​
fields
string
Comma-separated fields to include in the response.
​
q
string
Search term matched against order groups.
​
id
string | string[]
Filter by order group ID(s).
​
customer_id
string | string[]
Filter by customer ID(s).
​
seller_id
string | string[]
Filter to groups containing orders from the given seller(s).
​
status
string | string[]
Filter by order group status.
​
sales_channel_id
string | string[]
Filter by sales channel ID(s).
​
created_at
object
Filter by creation date using operators like $gte and $lte.
​
updated_at
object
Filter by update date using operators like $gte and $lte.

​
Response

​
order_groups
object[]
​
count
number
Total number of matching order groups.
​
offset
number
Number of records skipped.
​
limit
number
Maximum number of records returned.
curl 'http://localhost:9000/admin/order-groups?customer_id=cus_01HXYZ&limit=20' \
  -H 'Authorization: Bearer <token>'

{
  "order_groups": [
    {
      "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"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}