Detail by order ID

GET

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

GET

/shipping_integrations/atlas/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.atlas.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     "id": "id",
10     "clientReference": "clientReference",
11     "dateCreated": "dateCreated",
12     "dateEnd": "dateEnd",
13     "destination": "destination",
14     "numStops": 1,
15     "origin": "origin",
16     "status": "status",
17     "stops": [
18       {}
19     ],
20     "trailer": "trailer"
21   },
22   "provider_payload_hash": "provider_payload_hash",
23   "schema_version": 1,
24   "shipping_integration": "atlas",
25   "updated_at_timestamp": "2024-01-15T09:30:00Z",
26   "provider_org": {
27     "_id": "_id",
28     "name": "name",
29     "org_id": "org_id",
30     "org_type": "provider",
31     "schema_version": 1,
32     "description": "description",
33     "email_address": "email_address",
34     "handle": "handle",
35     "industry": "industry",
36     "phone_number": "phone_number",
37     "street_address": {
38       "geometry": {
39         "type": "GeometryCollection",
40         "geometries": [
41           {
42             "type": "LineString",
43             "coordinates": [
44               []
45             ]
46           }
47         ]
48       },
49       "type": "Feature",
50       "id": 1
51     }
52   }
53 }

Returns one mirrored Atlas order by the provider’s own order ID with the provider organization expanded. | () -> (AtlasOrderExpanded1)

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

Atlas's own ID for the order, 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 an Atlas shipment payload, retaining all other fields.

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"atlas"

updated_at_timestampdatetime

provider_orgobjectOptional

Errors

422

Orders Detail by Integration Order ID V1request Unprocessable Entity Error