List

GET

/shipping/order_groups/list/v1

GET

/shipping/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.orderGroups.listV1({
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       "_id": "og_9f8e7d6c5b4a3210",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "created_by_org_id": "org_12345provider",
7       "created_by_user_id": "user_67890operator",
8       "last_edited_at_timestamp": "2024-01-20T14:45:00Z",
9       "name": "West Coast Electronics Batch",
10       "owned_by_org_id": "org_12345provider",
11       "schema_version": 1,
12       "short_id": "WCEB2024",
13       "billing_review_status": "not_started",
14       "description": "Order group for electronics shipment to West Coast distribution center.",
15       "order_ids": [
16         "order_abc123",
17         "order_def456",
18         "order_ghi789"
19       ]
20     }
21   ],
22   "total_count": 1
23 }

Lists order groups for the caller’s organization with filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroupListRes)

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_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

Order Groups List V1request Unprocessable Entity Error