Sync one

POST

/shipping_integrations/ontime360/orders/sync_one/v1

POST

/shipping_integrations/ontime360/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.ontime360.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     "BasePrice": 1.1,
11     "CODAmount": 1.1,
12     "CollectionArrivalDate": "CollectionArrivalDate",
13     "CollectionArrivalWindow": {
14       "EarliestTime": "EarliestTime",
15       "LatestTime": "LatestTime",
16       "Length": "Length"
17     },
18     "CollectionAssignedDriver": "CollectionAssignedDriver",
19     "CollectionContactName": "CollectionContactName",
20     "CollectionLocation": {
21       "AddressLine1": "AddressLine1",
22       "AddressLine2": "AddressLine2",
23       "City": "City",
24       "CompanyName": "CompanyName",
25       "ContactName": "ContactName",
26       "Country": "Country",
27       "ID": "ID",
28       "LatitudeLongitude": "LatitudeLongitude",
29       "PostalCode": "PostalCode",
30       "State": "State"
31     },
32     "CollectionSignatureRequired": true,
33     "Comments": "Comments",
34     "Customer": "Customer",
35     "DateSubmitted": "DateSubmitted",
36     "DeclaredValue": 1.1,
37     "DeliveryArrivalDate": "DeliveryArrivalDate",
38     "DeliveryArrivalWindow": {
39       "EarliestTime": "EarliestTime",
40       "LatestTime": "LatestTime",
41       "Length": "Length"
42     },
43     "DeliveryAssignedDriver": "DeliveryAssignedDriver",
44     "DeliveryContactName": "DeliveryContactName",
45     "DeliveryLocation": {
46       "AddressLine1": "AddressLine1",
47       "AddressLine2": "AddressLine2",
48       "City": "City",
49       "CompanyName": "CompanyName",
50       "ContactName": "ContactName",
51       "Country": "Country",
52       "ID": "ID",
53       "LatitudeLongitude": "LatitudeLongitude",
54       "PostalCode": "PostalCode",
55       "State": "State"
56     },
57     "DeliverySignatureRequired": true,
58     "Description": "Description",
59     "Dispatcher": "Dispatcher",
60     "Distance": 1.1,
61     "DriverCoordinatesOnCollection": "DriverCoordinatesOnCollection",
62     "DriverCoordinatesOnDelivery": "DriverCoordinatesOnDelivery",
63     "DriverCurrentlyAssigned": "DriverCurrentlyAssigned",
64     "Height": 1.1,
65     "IncomingTrackingNumber": "IncomingTrackingNumber",
66     "Items": [
67       {}
68     ],
69     "Length": 1.1,
70     "OutgoingTrackingNumber": "OutgoingTrackingNumber",
71     "PriceAdjustment": 1.1,
72     "PriceModifierTotalCost": 1.1,
73     "PriceModifiers": [
74       {}
75     ],
76     "PurchaseOrderNumber": "PurchaseOrderNumber",
77     "Quantity": 1,
78     "ReferenceNumber": "ReferenceNumber",
79     "RequestedBy": "RequestedBy",
80     "RouteName": "RouteName",
81     "Status": {
82       "Description": "Description",
83       "ID": "ID",
84       "Level": 1,
85       "Name": "Name",
86       "Timestamp": "Timestamp"
87     },
88     "StatusLevel": 1,
89     "SubmissionSource": "SubmissionSource",
90     "Subtotal": 1.1,
91     "TaxTotal": 1.1,
92     "TotalCost": 1.1,
93     "TrackingNumber": "TrackingNumber",
94     "Weight": 1.1,
95     "Width": 1.1
96   },
97   "provider_payload_hash": "provider_payload_hash",
98   "schema_version": 1,
99   "shipping_integration": "ontime360",
100   "updated_at_timestamp": "2024-01-15T09:30:00Z"
101 }

Fetches and mirrors one OnTime360 order by the provider’s own order GUID, updating the unified order list alongside it. | authz: min_org_role=operator | (OnTime360OrderSyncOneReq) -> (OnTime360Order1)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

integration_order_idstringRequiredformat: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"

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 OnTime360 order, retaining all other fields.

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"ontime360"

updated_at_timestampdatetime

Errors

422

Orders Sync One V1request Unprocessable Entity Error