Sync one

POST

/shipping_integrations/ecourier/orders/sync_one/v1

POST

/shipping_integrations/ecourier/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.ecourier.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     "@AmountCharged": "@AmountCharged",
10     "@Auth": "@Auth",
11     "@Caller": "@Caller",
12     "@CallerEmail": "@CallerEmail",
13     "@CallerPhone": "@CallerPhone",
14     "@CreateDate": "@CreateDate",
15     "@CreateUserName": "@CreateUserName",
16     "@CustomerID": "@CustomerID",
17     "@DeliveredDateTime": "@DeliveredDateTime",
18     "@DispatchDateTime": "@DispatchDateTime",
19     "@DueDateTime": "@DueDateTime",
20     "@InvoiceStatus": "@InvoiceStatus",
21     "@LastChanged": "@LastChanged",
22     "@OperationalStatus": "@OperationalStatus",
23     "@OrderAlias": "@OrderAlias",
24     "@OrderDate": "@OrderDate",
25     "@OrderGUID": "@OrderGUID",
26     "@OrderID": "@OrderID",
27     "@OrderNumber": "@OrderNumber",
28     "@OrderStatus": "@OrderStatus",
29     "@PickedUpDateTime": "@PickedUpDateTime",
30     "@Pieces": "@Pieces",
31     "@PodDateTime": "@PodDateTime",
32     "@PodName": "@PodName",
33     "@Service": "@Service",
34     "@ServiceDesc": "@ServiceDesc",
35     "@SiteCode": "@SiteCode",
36     "@TotalMiles": "@TotalMiles",
37     "@Weight": "@Weight",
38     "Customer": {
39       "@CustomerCode": "@CustomerCode",
40       "@CustomerID": "@CustomerID",
41       "@Name": "@Name"
42     },
43     "Stops": [
44       {}
45     ]
46   },
47   "provider_payload_hash": "provider_payload_hash",
48   "schema_version": 1,
49   "shipping_integration": "ecourier",
50   "updated_at_timestamp": "2024-01-15T09:30:00Z"
51 }

Fetches and mirrors one e-Courier order by the provider’s own order number, updating the unified order list alongside it. | authz: min_org_role=operator | (EcourierOrderSyncOneReq) -> (EcourierOrder1)

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-9]{1,20}$"

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

One e-Courier order, including caller contact details and POD signoff.

@UserGUID and OrderEvents are the only attributes deliberately absent, and never to be added. See the module docstring.

provider_payload_hashstring=64 characters

schema_versioninteger

shipping_integration"ecourier"

updated_at_timestampdatetime

Errors

422

Orders Sync One V1request Unprocessable Entity Error