---
title: "Retrieve booking record"
method: GET
path: "/integrations/webcargo_bookings/retrieve/v1/{task_group_id}"
tags: ["/integrations/webcargo_bookings"]
---

# Retrieve booking record

`GET /integrations/webcargo_bookings/retrieve/v1/{task_group_id}`

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

## Path parameters

- `task_group_id` string, required

## Response `200`

Successful Response

- WebcargoBookingRecord1
  - `schema_version` 1, required
  - `_id` string, required
  - `org_id` string, required — Must be a string starting with `org_`
  - `task_group_id` string, required
  - `awb_number` string, required
  - `message_header` WebcargoMessageHeader, required
    - `message_id` string, nullable
    - `request_id` string, nullable
  - `business_info` WebcargoBusinessInfo, required
    - `service_method` string, nullable
    - `method_reason` string, nullable
    - `parties` WebcargoParty[]
      - `party_type_code` string, nullable
      - `id` string, nullable
      - `name` string, nullable
      - `account_id_list` WebcargoAccountID[]
        - `value` string, nullable
        - `id_source` string, nullable
      - `postal_address` WebcargoPostalAddress
        - `location_type_code` string, nullable
        - `location_name` string, nullable
        - `country_id` string, nullable
        - `country_name` string, nullable
        - `state_or_province` string, nullable
        - `city_id` string, nullable
        - `city_name` string, nullable
        - `street_name` string, nullable
        - `postal_code` string, nullable
      - `contact` WebcargoContact
        - `id` string, nullable
        - `name` string, nullable
        - `telephone` string, nullable
        - `electronic_mail` string, nullable
  - `document_identifiers` WebcargoDocumentIdentifier[], required
    - `document_type` string, nullable
    - `document_id` string, nullable
    - `external_booking_reference_number` string, nullable
  - `booking_rate` WebcargoBookingRate, required
    - `reference_id` string, nullable
    - `shipment_priority_code` string, nullable
    - `product` WebcargoProduct
      - `product_code` string, nullable
      - `product_description` string, nullable
    - `transport_mode` string, nullable
    - `origin_location` WebcargoLocation
      - `location_type_code` string, nullable
      - `location_code` string, nullable
      - `location_name` string, nullable
      - `country_id` string, nullable
      - `country_name` string, nullable
      - `postal_code` string, nullable
    - `destination_location` WebcargoLocation
      - `location_type_code` string, nullable
      - `location_code` string, nullable
      - `location_name` string, nullable
      - `country_id` string, nullable
      - `country_name` string, nullable
      - `postal_code` string, nullable
    - `connection` WebcargoConnection
      - `general_charges` WebcargoFee[]
        - `currency` string, nullable
        - `fee_location_type` string, nullable
        - `fee_type` string, nullable
        - `fee_code` string, nullable
        - `fee_category` string, nullable
        - `fee_name` string, nullable
        - `fee_comment` string, nullable
        - `inclusive` string, nullable
        - `quantity` string, nullable
        - `unit_rate` string, nullable
        - `rate` string, nullable
      - `segments` WebcargoSegment[]
        - `segment_id` string, nullable
        - `status` WebcargoBookStatus
          - `code` string, nullable
          - `reason` string, nullable
        - `vehicle_type` string, nullable
        - `vehicle_number` string, nullable
        - `vehicle_name` string, nullable
        - `itinerary_number` string, nullable
        - `transport_mode` string, nullable
        - `origin` WebcargoLocation
          - `location_type_code` string, nullable
          - `location_code` string, nullable
          - `location_name` string, nullable
          - `country_id` string, nullable
          - `country_name` string, nullable
          - `postal_code` string, nullable
        - `destination` WebcargoLocation
          - `location_type_code` string, nullable
          - `location_code` string, nullable
          - `location_name` string, nullable
          - `country_id` string, nullable
          - `country_name` string, nullable
          - `postal_code` string, nullable
        - `legs` WebcargoLeg[]
          - `origin` WebcargoLocation
            - `location_type_code` string, nullable
            - `location_code` string, nullable
            - `location_name` string, nullable
            - `country_id` string, nullable
            - `country_name` string, nullable
            - `postal_code` string, nullable
          - `destination` WebcargoLocation
            - `location_type_code` string, nullable
            - `location_code` string, nullable
            - `location_name` string, nullable
            - `country_id` string, nullable
            - `country_name` string, nullable
            - `postal_code` string, nullable
          - `scheduled_time_of_departure` string, nullable
          - `scheduled_time_of_arrival` string, nullable
        - `latest_acceptance_date` string, nullable
        - `scheduled_time_of_departure` string, nullable
        - `scheduled_time_of_arrival` string, nullable
        - `operating_carrier` WebcargoCarrier
          - `carrier_code` string, nullable
        - `marketing_carrier` WebcargoCarrier
          - `carrier_code` string, nullable
    - `load` WebcargoLoad
      - `net_weight` WebcargoValueWithUnit — XML element with text content and a unitCode attribute. Parses e.g. ``<Width unitCode="CMT">10.0</Width>`` into ``value="10.0", unit_code="CMT"``.
        - `unit_code` string, nullable
        - `value` string, nullable
      - `net_volume_measure` WebcargoValueWithUnit — XML element with text content and a unitCode attribute. Parses e.g. ``<Width unitCode="CMT">10.0</Width>`` into ``value="10.0", unit_code="CMT"``.
        - `unit_code` string, nullable
        - `value` string, nullable
      - `total_chargeable_weight` WebcargoValueWithUnit — XML element with text content and a unitCode attribute. Parses e.g. ``<Width unitCode="CMT">10.0</Width>`` into ``value="10.0", unit_code="CMT"``.
        - `unit_code` string, nullable
        - `value` string, nullable
      - `total_quantity` string, nullable
      - `packages` WebcargoPackage[]
        - `packaging_type` string, nullable
        - `weight` WebcargoValueWithUnit — XML element with text content and a unitCode attribute. Parses e.g. ``<Width unitCode="CMT">10.0</Width>`` into ``value="10.0", unit_code="CMT"``.
          - `unit_code` string, nullable
          - `value` string, nullable
        - `quantity` string, nullable
        - `dimensions` WebcargoDimension[]
          - `width` WebcargoValueWithUnit — XML element with text content and a unitCode attribute. Parses e.g. ``<Width unitCode="CMT">10.0</Width>`` into ``value="10.0", unit_code="CMT"``.
            - `unit_code` string, nullable
            - `value` string, nullable
          - `length` WebcargoValueWithUnit — XML element with text content and a unitCode attribute. Parses e.g. ``<Width unitCode="CMT">10.0</Width>`` into ``value="10.0", unit_code="CMT"``.
            - `unit_code` string, nullable
            - `value` string, nullable
          - `height` WebcargoValueWithUnit — XML element with text content and a unitCode attribute. Parses e.g. ``<Width unitCode="CMT">10.0</Width>`` into ``value="10.0", unit_code="CMT"``.
            - `unit_code` string, nullable
            - `value` string, nullable
        - `stackable` string, nullable
        - `turnable` string, nullable
    - `time_of_availability` string, nullable
    - `latest_acceptance_date` string, nullable
    - `price_indicator` WebcargoPriceIndicator
      - `rate_currency` string, nullable
      - `rate_type` string, nullable
      - `unit_of_measure` string, nullable
      - `unit_rate` string, nullable
      - `total_charge` string, nullable
      - `valid_from` string, nullable
      - `valid_to` string, nullable
    - `special_handling_codes` string[]
    - `commodity_classification` WebcargoCommodityClass[]
      - `classification_code` string, nullable
      - `commodity_category_code` string, nullable
      - `name` string, nullable
    - `hash` string, nullable
  - `shipment` WebcargoShipment
    - `time_of_availability` string, nullable
    - `latest_acceptance_date` string, nullable
    - `transport_mode` string, nullable
  - `response_status` WebcargoResponseStatus
    - `statuses` WebcargoResponseStatusEntry[]
      - `code` string, nullable
      - `reason` string, nullable
  - `synced_at` string, date-time, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/chrt/apis/chrt-fastapi.md) · [All operations](https://skmtc.dev/chrt/apis/chrt-fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/chrt/chrt-fastapi/revisions/ea04e157edb3/schema)