List ungrouped orders

GET

/shipping/orders_and_order_groups/ungrouped_orders/list/v1

GET

/shipping/orders_and_order_groups/ungrouped_orders/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.ungroupedOrdersListV1({
8         sort_by: "draft_started_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12     });
13 }
14 main();

1 {
2   "items": [
3     {
4       "billing_review_status": "not_started",
5       "order": {
6         "_id": "ord_9f8e7d6c5b4a3210",
7         "created_by_org_id": "org_12345provider",
8         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
9         "schema_version": 1,
10         "short_id": "ORD-20240115-001"
11       }
12     }
13   ],
14   "total_count": 1
15 }

Lists the caller’s standalone orders (provider party, non-DRAFT, not in any of the caller’s order groups), each with the caller org’s billing-review status. Filtering, sorting, and pagination use stored Order fields. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (UngroupedOrderListRes)

Authentication

AuthorizationBearer

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

Query parameters

filter_shipping_statusenumOptional

Filter by order status(es).

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

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders and Order Groups Ungrouped Orders List V1request Unprocessable Entity Error