Sync one

POST

/shipping_integrations/cxt/orders/sync_one/v1

POST

/shipping_integrations/cxt/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.cxt.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     "bol": "bol",
10     "caller": "caller",
11     "charges": 1.1,
12     "createdBy": "createdBy",
13     "createdWhen": {
14       "key": "value"
15     },
16     "custId": 1,
17     "customer": {
18       "key": "value"
19     },
20     "destIdIsValid": true,
21     "destination": {
22       "key": "value"
23     },
24     "distance": 1.1,
25     "drivers": [
26       {
27         "key": "value"
28       }
29     ],
30     "fleet": {
31       "key": "value"
32     },
33     "flightInfo": {
34       "key": "value"
35     },
36     "forceLocationScanDelivery": "forceLocationScanDelivery",
37     "forceLocationScanPickup": "forceLocationScanPickup",
38     "hasAssociatedRouteStops": true,
39     "hasAuthorizedCreditCard": true,
40     "id": "id",
41     "isParent": true,
42     "items": [
43       {
44         "key": "value"
45       }
46     ],
47     "masterBol": "masterBol",
48     "notes": [
49       {
50         "key": "value"
51       }
52     ],
53     "orderCount": 1,
54     "orderDate": {
55       "key": "value"
56     },
57     "orderStatus": {
58       "key": "value"
59     },
60     "orderType": 1,
61     "orderTypeDescription": "orderTypeDescription",
62     "origin": {
63       "key": "value"
64     },
65     "originIdIsValid": true,
66     "parcelType": {
67       "key": "value"
68     },
69     "parcels": [
70       {
71         "key": "value"
72       }
73     ],
74     "pieces": 1,
75     "podRequired": true,
76     "reference1": "reference1",
77     "reference2": "reference2",
78     "requiredDriverInput": {
79       "key": "value"
80     },
81     "route": 1,
82     "routeStop": "routeStop",
83     "rowVersion": "rowVersion",
84     "signature": {
85       "key": "value"
86     },
87     "signatureRequired": true,
88     "specialInst": "specialInst",
89     "status": "status",
90     "statusCodes": [
91       {
92         "key": "value"
93       }
94     ],
95     "updatedBy": "updatedBy",
96     "updatedWhen": {
97       "key": "value"
98     },
99     "weight": 1.1,
100     "workstation": "workstation"
101   },
102   "provider_payload_hash": "provider_payload_hash",
103   "schema_version": 1,
104   "shipping_integration": "cxt",
105   "updated_at_timestamp": "2024-01-15T09:30:00Z"
106 }

Fetches and mirrors one CXT order by the provider’s own decimal order ID. | authz: min_org_role=operator | (CxtOrderSyncOneReq) -> (CxtOrder1)

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

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"cxt"

updated_at_timestampdatetime

Errors

422

Orders Sync One V1request Unprocessable Entity Error