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_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
9         filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
10         filter_integration_order_id: "filter_integration_order_id",
11         filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
12         filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
13         filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
14         filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
15         filter_provider_org_id: [
16             "filter_provider_org_id",
17         ],
18         filter_reference_number: "filter_reference_number",
19         filter_shipping_integration: [
20             "xcelerator",
21         ],
22         filter_status: [
23             "staged",
24         ],
25         page: 1,
26         page_size: 1,
27         sort_by: "ordered_at_timestamp",
28         sort_order: "asc",
29     });
30 }
31 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       "destination": {
15         "label": "label"
16       },
17       "ordered_at_timestamp": "2024-01-15T09:30:00Z",
18       "origin": {
19         "label": "label"
20       },
21       "provider_status_raw": "provider_status_raw",
22       "reference_numbers": [
23         "reference_numbers"
24       ],
25       "stop_count": 1
26     }
27   ],
28   "total_count": 1
29 }

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

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Field to sort by.

Allowed values:

sort_orderenum or nullOptional

Sort order (asc or desc).

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_shipping_integrationenum or nullOptional

Filter by shipping integration(s)

Allowed values:

filter_provider_org_idstring or nullOptional

Filter by provider org ID(s)

filter_statusenum or nullOptional

Filter by unified status(es)

Allowed values:

filter_integration_order_idstring or nullOptional

Filter by the provider's exact order ID

filter_reference_numberstring or nullOptional

Filter by an exact reference number carried on the order

filter_ordered_at_timestamp_gtedatetime or nullOptional

Filter ordered_at_timestamp >= value

filter_ordered_at_timestamp_ltedatetime or nullOptional

Filter ordered_at_timestamp <= value

filter_last_mirrored_at_timestamp_gtedatetime or nullOptional

Filter last_mirrored_at_timestamp >= value

filter_last_mirrored_at_timestamp_ltedatetime or nullOptional

Filter last_mirrored_at_timestamp <= value

filter_first_mirrored_at_timestamp_gtedatetime or nullOptional

Filter first_mirrored_at_timestamp >= value

filter_first_mirrored_at_timestamp_ltedatetime or nullOptional

Filter first_mirrored_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Orders List V1request Unprocessable Entity Error