List

GET

/shipping_integrations/orders/list/v1

GET

/shipping_integrations/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.orders.listV1({
8         filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
9         filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
10         filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
11         filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
12         filter_integration_order_id: "filter_integration_order_id",
13         filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
14         filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
15         filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
16         filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
17         filter_provider_org_id: [
18             "filter_provider_org_id",
19         ],
20         filter_reference_number: "filter_reference_number",
21         filter_shipping_integration: [
22             "xcelerator",
23         ],
24         filter_status: [
25             "staged",
26         ],
27         page: 1,
28         page_size: 1,
29         search: "search",
30         sort_by: "ordered_at_timestamp",
31         sort_order: "asc",
32     });
33 }
34 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "first_mirrored_at_timestamp": "2024-01-15T09:30:00Z",
6       "integration_order_id": "integration_order_id",
7       "last_mirrored_at_timestamp": "2024-01-15T09:30:00Z",
8       "org_id": "org_id",
9       "provider_org_id": "provider_org_id",
10       "schema_version": 1,
11       "shipping_integration": "xcelerator",
12       "source_provider_payload_hash": "source_provider_payload_hash",
13       "status": "staged",
14       "completed_at_provenance": "reported",
15       "completed_at_timestamp": "2024-01-15T09:30:00Z",
16       "destination": {
17         "label": "label"
18       },
19       "in_progress_at_provenance": "reported",
20       "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
21       "ordered_at_timestamp": "2024-01-15T09:30:00Z",
22       "origin": {
23         "label": "label"
24       },
25       "provider_org": {
26         "_id": "_id",
27         "name": "name",
28         "org_id": "org_id",
29         "org_type": "provider",
30         "schema_version": 1
31       },
32       "provider_status_raw": "provider_status_raw",
33       "reference_numbers": [
34         "reference_numbers"
35       ],
36       "shipper_org": {
37         "_id": "_id",
38         "name": "name",
39         "org_id": "org_id",
40         "org_type": "provider",
41         "schema_version": 1
42       },
43       "stop_count": 1
44     }
45   ],
46   "total_count": 1
47 }

Lists the caller’s orders from every shipping integration with provider organizations expanded, filtering, sorting, pagination, and optional search. | () -> (ShippingIntegrationOrderListRes)

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 provider order IDs and reference numbers.

filter_shipping_integrationenumOptional

Filter by shipping integration(s)

filter_provider_org_idstringOptional

Filter by provider org ID(s)

filter_statusenumOptional

Filter by unified status(es)

Allowed values:

filter_integration_order_idstringOptional

Filter by the provider's exact order ID

filter_reference_numberstringOptional

Filter by an exact reference number carried on the order

filter_ordered_at_timestamp_gtedatetimeOptional

Filter ordered_at_timestamp >= value

filter_ordered_at_timestamp_ltedatetimeOptional

Filter ordered_at_timestamp <= value

filter_completed_at_timestamp_gtedatetimeOptional

Filter completed_at_timestamp >= value

filter_completed_at_timestamp_ltedatetimeOptional

Filter completed_at_timestamp <= value

filter_last_mirrored_at_timestamp_gtedatetimeOptional

Filter last_mirrored_at_timestamp >= value

filter_last_mirrored_at_timestamp_ltedatetimeOptional

Filter last_mirrored_at_timestamp <= value

filter_first_mirrored_at_timestamp_gtedatetimeOptional

Filter first_mirrored_at_timestamp >= value

filter_first_mirrored_at_timestamp_ltedatetimeOptional

Filter first_mirrored_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders List V1request Unprocessable Entity Error