List Order Groups

GET

store

order-groups

curl 'http://localhost:9000/store/order-groups?limit=10' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ' \
  -H 'Authorization: Bearer <customer_token>'

const { order_groups, count } = await client.store.orderGroups.query({ limit: 10 })

{
  "order_groups": [
    {
      "id": "og_01JB2KE7NP",
      "customer_id": "cus_01JB2KE8QR",
      "seller_count": 2,
      "total": 9900,
      "orders": [
        {
          "id": "order_01JB2KH1WX",
          "seller_id": "sel_01JB2K8A1B",
          "items": [{ "id": "ordli_01JB2KH2YZ", "title": "M", "quantity": 1 }]
        },
        {
          "id": "order_01JB2KH3AB",
          "seller_id": "sel_01JB2KF9ST",
          "items": [{ "id": "ordli_01JB2KH4CD", "title": "One Size", "quantity": 1 }]
        }
      ],
      "created_at": "2026-05-01T10:05:00.000Z",
      "updated_at": "2026-05-01T10:05:00.000Z"
    }
  ],
  "count": 4,
  "offset": 0,
  "limit": 10
}

Returns a paginated list of the logged-in customer’s order groups, the multi-seller wrappers created when a cart is completed.

Customer authentication is required (Authorization: Bearer <customer_token> or a session cookie); results are always scoped to the authenticated customer.

Query parameters

number

default:"50"

Maximum number of order groups to return.

number

default:"0"

Number of order groups to skip before collecting results.

string

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

string

Comma-separated fields to include; only fields from the route’s allowed list are accepted.

string | string[]

Filter by one or more order group IDs.

object

Filter by creation date using operators like $gt, $gte, $lt, $lte.

object

Filter by update date using operators like $gt, $gte, $lt, $lte.

Response

object[]

Show properties

string

The order group’s ID.

string

ID of the purchasing customer.

number

Number of per-seller orders in the group.

number

Combined total across all child orders.

object[]

Child orders, each with seller_id and its items (including each item’s variant, product, and seller).

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching order groups.

number

Number of skipped order groups.

number

Maximum number of returned order groups.

curl 'http://localhost:9000/store/order-groups?limit=10' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ' \
  -H 'Authorization: Bearer <customer_token>'

const { order_groups, count } = await client.store.orderGroups.query({ limit: 10 })

{
  "order_groups": [
    {
      "id": "og_01JB2KE7NP",
      "customer_id": "cus_01JB2KE8QR",
      "seller_count": 2,
      "total": 9900,
      "orders": [
        {
          "id": "order_01JB2KH1WX",
          "seller_id": "sel_01JB2K8A1B",
          "items": [{ "id": "ordli_01JB2KH2YZ", "title": "M", "quantity": 1 }]
        },
        {
          "id": "order_01JB2KH3AB",
          "seller_id": "sel_01JB2KF9ST",
          "items": [{ "id": "ordli_01JB2KH4CD", "title": "One Size", "quantity": 1 }]
        }
      ],
      "created_at": "2026-05-01T10:05:00.000Z",
      "updated_at": "2026-05-01T10:05:00.000Z"
    }
  ],
  "count": 4,
  "offset": 0,
  "limit": 10
}

curl 'http://localhost:9000/store/order-groups?limit=10' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ' \
  -H 'Authorization: Bearer <customer_token>'

const { order_groups, count } = await client.store.orderGroups.query({ limit: 10 })

{
  "order_groups": [
    {
      "id": "og_01JB2KE7NP",
      "customer_id": "cus_01JB2KE8QR",
      "seller_count": 2,
      "total": 9900,
      "orders": [
        {
          "id": "order_01JB2KH1WX",
          "seller_id": "sel_01JB2K8A1B",
          "items": [{ "id": "ordli_01JB2KH2YZ", "title": "M", "quantity": 1 }]
        },
        {
          "id": "order_01JB2KH3AB",
          "seller_id": "sel_01JB2KF9ST",
          "items": [{ "id": "ordli_01JB2KH4CD", "title": "One Size", "quantity": 1 }]
        }
      ],
      "created_at": "2026-05-01T10:05:00.000Z",
      "updated_at": "2026-05-01T10:05:00.000Z"
    }
  ],
  "count": 4,
  "offset": 0,
  "limit": 10
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response