Status summary

GET

/shipping_integrations/orders/status_summary/v1

GET

/shipping_integrations/orders/status_summary/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.statusSummaryV1({
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     });
28 }
29 main();

1 {
2   "cancelled_count": 1,
3   "completed_count": 1,
4   "exception_count": 1,
5   "in_progress_count": 1,
6   "staged_count": 1,
7   "total_count": 1
8 }

Counts the caller’s shipping integration orders by unified status. | () -> (ShippingIntegrationOrderStatusSummaryRes)

Authentication

AuthorizationBearer

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

Query parameters

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

cancelled_countinteger

completed_countinteger

exception_countinteger

in_progress_countinteger

staged_countinteger

total_countinteger

Errors

422

Orders Status Summary V1request Unprocessable Entity Error