List

GET

/shipping_integrations/dispatch_science/orders/list/v1

GET

/shipping_integrations/dispatch_science/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.shippingIntegrations.dispatchScience.orders.listV1({
8         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
9         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
10         filter_integration_order_id: "filter_integration_order_id",
11         filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
12         filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
13         filter_provider_org_id: [
14             "filter_provider_org_id",
15         ],
16         filter_provider_status: 1,
17         filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
19         page: 1,
20         page_size: 1,
21         search: "search",
22         sort_by: "mirrored_at_timestamp",
23         sort_order: "asc",
24     });
25 }
26 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "integration_order_id": "integration_order_id",
7       "mirrored_at_timestamp": "2024-01-15T09:30:00Z",
8       "org_id": "org_id",
9       "provider_org_id": "provider_org_id",
10       "provider_payload": {
11         "orderId": "orderId",
12         "status": 1
13       },
14       "provider_payload_hash": "provider_payload_hash",
15       "schema_version": 1,
16       "shipping_integration": "dispatch_science",
17       "updated_at_timestamp": "2024-01-15T09:30:00Z"
18     }
19   ],
20   "total_count": 1
21 }

Lists mirrored DispatchScience orders for the caller’s organization with filtering, sorting, pagination, and optional search. | () -> (DispatchScienceOrderListRes)

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

searchstringOptional

Search DispatchScience order IDs.

filter_provider_org_idstringOptional

Filter by provider org ID(s)

filter_integration_order_idstringOptional

Filter by DispatchScience's exact order ID

filter_provider_statusintegerOptional

Filter by DispatchScience’s raw status integer (0 Received, 1 Assigned, 2 PickedUp, 3 EnRoute, 4 Delivered, 91 Cancelled)

filter_mirrored_at_timestamp_gtedatetimeOptional

Filter mirrored_at_timestamp >= value

filter_mirrored_at_timestamp_ltedatetimeOptional

Filter mirrored_at_timestamp <= value

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value

filter_updated_at_timestamp_gtedatetimeOptional

Filter updated_at_timestamp >= value

filter_updated_at_timestamp_ltedatetimeOptional

Filter updated_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders List V1request Unprocessable Entity Error