Detail

GET

/shipping_integrations/orders/detail/v1/:id

GET

/shipping_integrations/orders/detail/v1/:id

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.detailV1("id");
8 }
9 main();

1 {
2   "_id": "_id",
3   "first_mirrored_at_timestamp": "2024-01-15T09:30:00Z",
4   "integration_order_id": "integration_order_id",
5   "last_mirrored_at_timestamp": "2024-01-15T09:30:00Z",
6   "org_id": "org_id",
7   "provider_org_id": "provider_org_id",
8   "schema_version": 1,
9   "shipping_integration": "xcelerator",
10   "source_provider_payload_hash": "source_provider_payload_hash",
11   "status": "staged",
12   "completed_at_provenance": "reported",
13   "completed_at_timestamp": "2024-01-15T09:30:00Z",
14   "destination": {
15     "label": "label",
16     "city": "city",
17     "company_name": "company_name",
18     "country_code": "country_code",
19     "location": {
20       "geometry": {
21         "type": "GeometryCollection",
22         "geometries": [
23           {
24             "type": "LineString",
25             "coordinates": [
26               []
27             ]
28           }
29         ]
30       },
31       "type": "Feature",
32       "id": 1
33     },
34     "postal_code": "postal_code",
35     "state": "state"
36   },
37   "in_progress_at_provenance": "reported",
38   "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
39   "ordered_at_timestamp": "2024-01-15T09:30:00Z",
40   "origin": {
41     "label": "label",
42     "city": "city",
43     "company_name": "company_name",
44     "country_code": "country_code",
45     "location": {
46       "geometry": {
47         "type": "GeometryCollection",
48         "geometries": [
49           {
50             "type": "LineString",
51             "coordinates": [
52               []
53             ]
54           }
55         ]
56       },
57       "type": "Feature",
58       "id": 1
59     },
60     "postal_code": "postal_code",
61     "state": "state"
62   },
63   "provider_org": {
64     "_id": "_id",
65     "name": "name",
66     "org_id": "org_id",
67     "org_type": "provider",
68     "schema_version": 1,
69     "description": "description",
70     "email_address": "email_address",
71     "handle": "handle",
72     "industry": "industry",
73     "phone_number": "phone_number",
74     "street_address": {
75       "geometry": {
76         "type": "GeometryCollection",
77         "geometries": [
78           {
79             "type": "LineString",
80             "coordinates": [
81               []
82             ]
83           }
84         ]
85       },
86       "type": "Feature",
87       "id": 1
88     }
89   },
90   "provider_status_raw": "provider_status_raw",
91   "reference_numbers": [
92     "reference_numbers"
93   ],
94   "shipper_org": {
95     "_id": "_id",
96     "name": "name",
97     "org_id": "org_id",
98     "org_type": "provider",
99     "schema_version": 1,
100     "description": "description",
101     "email_address": "email_address",
102     "handle": "handle",
103     "industry": "industry",
104     "phone_number": "phone_number",
105     "street_address": {
106       "geometry": {
107         "type": "GeometryCollection",
108         "geometries": [
109           {
110             "type": "LineString",
111             "coordinates": [
112               []
113             ]
114           }
115         ]
116       },
117       "type": "Feature",
118       "id": 1
119     }
120   },
121   "stop_count": 1
122 }

Returns one unified shipping integration order by its Mongo ObjectId with related organizations expanded. | () -> (ShippingIntegrationOrderExpanded1)

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Mongo ObjectId of the unified order document. The provider’s own order ID is the integration_order_id field on the returned order.

Response

Successful Response

_idstring

first_mirrored_at_timestampdatetime

integration_order_idstring

last_mirrored_at_timestampdatetime

org_idstring

Must be a string starting with org_

provider_org_idstring

Must be a string starting with org_

schema_versioninteger

shipping_integrationenum

source_provider_payload_hashstring=64 characters

statusenum

completed_at_provenanceenumOptional

completed_at_timestampdatetimeOptional

destinationobjectOptional

One end of a route.

Only label is guaranteed. Some integrations expose a bare place name with no structured address and no coordinates at all, so every other field is optional. location carries GeoJSON when the provider gives coordinates, which is what makes the place mappable and 2dsphere-indexable.

in_progress_at_provenanceenumOptional

in_progress_at_timestampdatetimeOptional

ordered_at_timestampdatetimeOptional

originobjectOptional

One end of a route.

provider_orgobjectOptional

provider_status_rawstringOptional

reference_numberslist of stringsOptional

shipper_orgobjectOptional

stop_countintegerOptional

Errors

422

Orders Detail V1request Unprocessable Entity Error