List order groups (expanded)

GET

/shipping/orders_and_order_groups/order_groups/list/v1

GET

/shipping/orders_and_order_groups/order_groups/list/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.ordersAndOrderGroups.orderGroupsListV1({
8         sort_by: "created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_order_id: "filter_order_id",
13         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
14         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
15     });
16 }
17 main();

1 {
2   "items": [
3     {
4       "order_group": {
5         "_id": "grp_9f8e7d6c5b4a3",
6         "created_at_timestamp": "2024-01-15T09:30:00Z",
7         "created_by_org_id": "org_provider_12345",
8         "created_by_user_id": "user_67890",
9         "last_edited_at_timestamp": "2024-01-20T14:45:00Z",
10         "name": "West Coast Distribution Batch",
11         "owned_by_org_id": "org_provider_12345",
12         "schema_version": 1,
13         "short_id": "WCD-20240115"
14       },
15       "orders": [
16         {
17           "_id": "ord_abcdef123456",
18           "created_by_org_id": "org_provider_12345",
19           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
20           "schema_version": 1,
21           "short_id": "ORD-20240115-01",
22           "cancelled_at_timestamp": null,
23           "completed_at_timestamp": null,
24           "coordinator_org_id": "org_coordinator_98765",
25           "created_by_user_id": "user_67890",
26           "creation_idempotency_key": "key-20240115-01",
27           "exception_at_timestamp": null,
28           "executor_org_ids": [
29             "org_executor_11111",
30             "org_executor_22222"
31           ],
32           "in_progress_at_timestamp": null,
33           "off_chrt_executor_org_ids": [],
34           "off_chrt_reference_id": null,
35           "off_chrt_shipper_org_id": null,
36           "order_schedule_id": null,
37           "order_schedule_run_idempotency_key": null,
38           "order_template_id": null,
39           "shipper_org_id": "org_shipper_33333",
40           "staged_at_timestamp": null,
41           "status": "draft",
42           "task_group_ids": []
43         }
44       ],
45       "shipping_status": "draft"
46     }
47   ],
48   "total_count": 1
49 }

Lists the caller’s order groups with member orders nested and a derived shipping-status rollup. Filtering, sorting, and pagination use stored group fields. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroupExpandedListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sort_byenumOptional

Field to sort by.

Allowed values:

sort_orderenumOptional

Sort order (asc or desc).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_billing_review_statusenumOptional

Filter by the group’s billing-review status(es).

Allowed values:

filter_order_idstringOptional

Filter to groups containing this order id.

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value (inclusive).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders and Order Groups Order Groups List V1request Unprocessable Entity Error