Retrieve subscription

GET

/integrations/cargoai_track_and_trace/subscription/v1/:awb

GET

/integrations/cargoai_track_and_trace/subscription/v1/:awb

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.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
8 }
9 main();

1 {
2   "_id": "sub_5f8d04a7c9e77a0017b3c123",
3   "active_until": "2024-12-31T23:59:59Z",
4   "awb": "020-12345678",
5   "created_at": "2024-01-15T09:30:00Z",
6   "created_by_org_id": "org_9f8d04a7c9e77a0017b3c456",
7   "created_by_user_id": "user_7a8d04a7c9e77a0017b3c789",
8   "schema_version": 1,
9   "subscribed_at": "2024-01-15T09:30:00Z",
10   "updated_at": "2024-04-10T14:45:00Z",
11   "last_update_received_at": "2024-04-10T14:45:00Z",
12   "subscribed_emails": [
13     "tracking.notifications@cargoai.com"
14   ],
15   "tracking_update_ids": [
16     "upd_20240410_001",
17     "upd_20240410_002"
18   ]
19 }

Retrieves the stored CargoAi tracking subscription for an AWB. | authz: order participant | () -> (CargoAiTrackAndTraceSubscription1)

Authentication

AuthorizationBearer

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

Path parameters

awbstringRequired

Response

Successful Response

_idstring

active_untildatetime

awbstringformat: "^\d{3}-\d{8}$"

IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. ‘020-12345678’.

created_atdatetime

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

schema_versioninteger

subscribed_atdatetime

updated_atdatetime

last_update_received_atdatetime

subscribed_emailslist of strings

tracking_update_idslist of strings

Errors

422

Cargoai Track and Trace Subscription V1request Unprocessable Entity Error