Sync one

POST

/shipping_integrations/atlas/orders/sync_one/v1

POST

/shipping_integrations/atlas/orders/sync_one/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.atlas.orders.syncOneV1({
8         integration_order_id: "integration_order_id",
9         provider_org_id: "provider_org_id",
10     });
11 }
12 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 }

Fetches and mirrors one Atlas order by the provider’s own order ID. | authz: min_org_role=operator | (AtlasOrderSyncOneReq) -> (AtlasOrder1)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

integration_order_idstringRequired>=1 character

provider_org_idstringRequired

Must be a string starting with org_

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

Errors

422

Orders Sync One V1request Unprocessable Entity Error