Retrieve booking record

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.integrations.webcargoBookings.retrieveV1("task_group_id");
}
main();

{
  "schema_version": 1,
  "_id": "_id",
  "org_id": "org_id",
  "task_group_id": "task_group_id",
  "awb_number": "awb_number",
  "message_header": {
    "message_id": "message_id",
    "request_id": "request_id"
  },
  "business_info": {
    "service_method": "service_method",
    "method_reason": "method_reason",
    "parties": [
      {}
    ]
  },
  "document_identifiers": [
    {
      "document_type": "document_type",
      "document_id": "document_id",
      "external_booking_reference_number": "external_booking_reference_number"
    }
  ],
  "booking_rate": {
    "reference_id": "reference_id",
    "shipment_priority_code": "shipment_priority_code",
    "product": {
      "product_code": "product_code",
      "product_description": "product_description"
    },
    "transport_mode": "transport_mode",
    "origin_location": {
      "location_type_code": "location_type_code",
      "location_code": "location_code",
      "location_name": "location_name",
      "country_id": "country_id",
      "country_name": "country_name",
      "postal_code": "postal_code"
    },
    "destination_location": {
      "location_type_code": "location_type_code",
      "location_code": "location_code",
      "location_name": "location_name",
      "country_id": "country_id",
      "country_name": "country_name",
      "postal_code": "postal_code"
    },
    "connection": {
      "general_charges": [
        {}
      ],
      "segments": [
        {}
      ]
    },
    "load": {
      "total_quantity": "total_quantity",
      "packages": [
        {}
      ]
    },
    "time_of_availability": "time_of_availability",
    "latest_acceptance_date": "latest_acceptance_date",
    "price_indicator": {
      "rate_currency": "rate_currency",
      "rate_type": "rate_type",
      "unit_of_measure": "unit_of_measure",
      "unit_rate": "unit_rate",
      "total_charge": "total_charge",
      "valid_from": "valid_from",
      "valid_to": "valid_to"
    },
    "special_handling_codes": [
      "special_handling_codes"
    ],
    "commodity_classification": [
      {}
    ],
    "hash": "hash"
  },
  "synced_at": "2024-01-15T09:30:00Z",
  "shipment": {
    "time_of_availability": "time_of_availability",
    "latest_acceptance_date": "latest_acceptance_date",
    "transport_mode": "transport_mode"
  },
  "response_status": {
    "statuses": [
      {}
    ]
  }
}

Retrieves the stored WebCargo booking record for a task group. Returns 404 if the booking has never been synced. | () -> (WebcargoBookingRecord1)

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Response

Successful Response

schema_versioninteger

_idstring

org_idstring

Must be a string starting with org_

task_group_idstring

awb_numberstring

message_headerobject

business_infoobject

document_identifierslist of objects

booking_rateobject

synced_atdatetime

shipmentobject

response_statusobject

Errors

422

Webcargo Bookings Retrieve V1request Unprocessable Entity Error