Skip to main content
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>'
{
  "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

limit
number
default:"50"
Maximum number of order groups to return.
offset
number
default:"0"
Number of order groups to skip before collecting results.
order
string
Field to sort by, prefixed with - for descending order.
fields
string
Comma-separated fields to include; only fields from the route’s allowed list are accepted.
id
string | string[]
Filter by one or more order group IDs.
created_at
object
Filter by creation date using operators like $gt, $gte, $lt, $lte.
updated_at
object
Filter by update date using operators like $gt, $gte, $lt, $lte.

Response

order_groups
object[]
count
number
Total number of matching order groups.
offset
number
Number of skipped order groups.
limit
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>'
{
  "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
}