Detail by order ID

GET

/shipping_integrations/dispatch_science/orders/by_integration_order_id/detail/v1/:org_id/:integration_order_id

GET

/shipping_integrations/dispatch_science/orders/by_integration_order_id/detail/v1/:org_id/:integration_order_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.dispatchScience.orders.detailByIntegrationOrderIdV1("org_id", "integration_order_id");
8 }
9 main();

1 {
2   "_id": "_id",
3   "created_at_timestamp": "2024-01-15T09:30:00Z",
4   "integration_order_id": "integration_order_id",
5   "mirrored_at_timestamp": "2024-01-15T09:30:00Z",
6   "org_id": "org_id",
7   "provider_org_id": "provider_org_id",
8   "provider_payload": {
9     "orderId": "orderId",
10     "status": 1,
11     "attachments": [
12       {}
13     ],
14     "charges": [
15       {}
16     ],
17     "createdAt": "createdAt",
18     "distance": 1.1,
19     "distanceUnits": "distanceUnits",
20     "dropoffAddress": {
21       "addressLine1": "addressLine1",
22       "addressLine2": "addressLine2",
23       "city": "city",
24       "company": "company",
25       "postalCode": "postalCode",
26       "stateProvince": "stateProvince"
27     },
28     "dropoffContactInfo": {
29       "email": "email",
30       "id": "id",
31       "language": "language",
32       "name": "name",
33       "phoneNumber": "phoneNumber"
34     },
35     "dropoffLocation": {
36       "isValid": true,
37       "latitude": 1.1,
38       "longitude": 1.1
39     },
40     "dropoffNotes": "dropoffNotes",
41     "dropoffTimeZone": {
42       "ianaTimeZoneId": "ianaTimeZoneId",
43       "isDaylightSavingTime": true,
44       "longDisplayName": "longDisplayName",
45       "offset": 1.1,
46       "shortDisplayName": "shortDisplayName",
47       "systemTimeZoneId": "systemTimeZoneId"
48     },
49     "dropoffWindow": {
50       "end": "end",
51       "start": "start"
52     },
53     "isOnHold": true,
54     "notes": "notes",
55     "numberOfPieces": 1,
56     "pickupAddress": {
57       "addressLine1": "addressLine1",
58       "addressLine2": "addressLine2",
59       "city": "city",
60       "company": "company",
61       "postalCode": "postalCode",
62       "stateProvince": "stateProvince"
63     },
64     "pickupContactInfo": {
65       "email": "email",
66       "id": "id",
67       "language": "language",
68       "name": "name",
69       "phoneNumber": "phoneNumber"
70     },
71     "pickupLocation": {
72       "isValid": true,
73       "latitude": 1.1,
74       "longitude": 1.1
75     },
76     "pickupNotes": "pickupNotes",
77     "pickupTimeZone": {
78       "ianaTimeZoneId": "ianaTimeZoneId",
79       "isDaylightSavingTime": true,
80       "longDisplayName": "longDisplayName",
81       "offset": 1.1,
82       "shortDisplayName": "shortDisplayName",
83       "systemTimeZoneId": "systemTimeZoneId"
84     },
85     "pickupWindow": {
86       "end": "end",
87       "start": "start"
88     },
89     "readyAt": "readyAt",
90     "receivedBy": "receivedBy",
91     "referenceNumber1": "referenceNumber1",
92     "referenceNumber2": "referenceNumber2",
93     "referenceNumber3": "referenceNumber3",
94     "serviceLevelId": "serviceLevelId",
95     "vehicleTypeId": "vehicleTypeId",
96     "volume": 1.1,
97     "volumeUnits": "volumeUnits",
98     "weight": 1.1,
99     "weightUnits": "weightUnits"
100   },
101   "provider_payload_hash": "provider_payload_hash",
102   "schema_version": 1,
103   "shipping_integration": "dispatch_science",
104   "updated_at_timestamp": "2024-01-15T09:30:00Z"
105 }

Returns one mirrored DispatchScience order by the provider’s own order ID. | () -> (DispatchScienceOrder1)

Authentication

AuthorizationBearer

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

Path parameters

org_idstringRequired

CHRT org ID of the other party (executor if caller is coordinator, coordinator if caller is executor)

integration_order_idstringRequired

DispatchScience’s own ID for the order (its orderId), as carried on a unified order row

Response

Successful Response

_idstring

created_at_timestampdatetime

integration_order_idstring

mirrored_at_timestampdatetime

org_idstring

Must be a string starting with org_

provider_org_idstring

Must be a string starting with org_

provider_payloadobject

Known fields from a DispatchScience order, retaining all other fields.

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"dispatch_science"

updated_at_timestampdatetime

Errors

422

Orders Detail by Integration Order ID V1request Unprocessable Entity Error