List Order Groups

GET

admin

order-groups

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

const { order_groups, count } = await client.admin.orderGroups.query({
  customer_id: "cus_01HXYZ",
  limit: 20,
})

{
  "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

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated fields to include in the response.

string

Search term matched against order groups.

string | string[]

Filter by order group ID(s).

string | string[]

Filter by customer ID(s).

string | string[]

Filter to groups containing orders from the given seller(s).

string | string[]

Filter by order group status.

string | string[]

Filter by sales channel ID(s).

object

Filter by creation date using operators like $gte and $lte.

object

Filter by update date using operators like $gte and $lte.

Response

object[]

Show properties

string

The order group’s ID.

string

ID of the customer who placed the order.

number

Number of sellers in the group.

number

The group’s total amount.

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching order groups.

number

Number of records skipped.

number

Maximum number of records returned.

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

const { order_groups, count } = await client.admin.orderGroups.query({
  customer_id: "cus_01HXYZ",
  limit: 20,
})

{
  "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
}

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

const { order_groups, count } = await client.admin.orderGroups.query({
  customer_id: "cus_01HXYZ",
  limit: 20,
})

{
  "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
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response