# Find booking by ID

Endpoint: GET /bookings/{bookingId}
Version: 1.0.0
Security: M2X_auth_application

## Path parameters:

  - `bookingId` (string, required)
    The booking Id

## Response 200 fields (application/json):

  - `agent` (object)

  - `agent.email` (string,null)

  - `agent.uid` (string,null)
    M2X user identifier

  - `agent.phone` (string,null)

  - `agent.name` (string,null)

  - `agent.externalId` (string,null)

  - `id` (string)
    The M2X internal booking id

  - `externalReference` (string)

  - `externalNote` (string)

  - `canceled` (boolean)
    Indicates whether the booking has been unallocated from the carrier. Note: This field does not reflect whether the booking itself has been canceled within the enterprise system. It only represents that the carrier is no longer assigned to the booking

  - `completed` (boolean)

  - `acknowledged` (boolean)

  - `tentative` (boolean)

  - `status` (string)

  - `slaQuality` (number)

  - `slaStatus` (string)

  - `awardCreated` (string,null)

  - `requestCreated` (string)

  - `updated` (string)

  - `latestDeliveryTimestamp` (string)

  - `earliestPickupTimestamp` (string)

  - `fulfilments` (array)

  - `fulfilments.fulfilmentRequestId` (string)

  - `fulfilments.fulfilmentId` (string)

  - `acceptanceState` (object,null)

  - `acceptanceState.acceptanceDeadline` (string)
    Deadline to accept the booking,

  - `acceptanceState.actioned` (string)
    When the acceptance was actioned

  - `acceptanceState.accepted` (boolean)

  - `acceptanceState.acceptable` (boolean)

  - `acceptanceState.declined` (boolean)

  - `acceptanceState.declinable` (boolean)

  - `acceptanceState.retractable` (boolean)

  - `noPayment` (boolean)
    Whether upon acceptance the carrier shall get a payment or not (e.g. freight forward)

  - `noPrice` (boolean)
    Whether the booking is free of charge, no offer generated

  - `carrierId` (string,null)
    The M2X carrier id for this booking

  - `carrierExternalId` (string,null)
    External carrier id for this carrier

  - `carrierName` (string,null)
    Carrier name for this job

  - `corporateId` (string)
    The M2X corporate id for this booking

  - `corporateName` (string)
    Corporate name for this booking

  - `corporateSubaccountId` (string)
    The M2X corporate subaccount id for this booking

  - `corporateSubaccountName` (string)
    Corporate subaccount name for this booking

  - `corporateSubaccountIntegrationId` (string)
    The M2X corporate subaccount integration id for this booking

  - `transportRequirementsId` (string)
    M2X internal tracking id for the product type

  - `productCode` (string,null)
    M2X internal tracking id for the product code used

  - `productCodeName` (string,null)
    M2X name for the product code used

  - `productCodeExternalId` (string,null)
    External Id for product tracking

  - `properties` (object,null)
    A key value store containing custom properties

  - `metadata` (object,null)
    Opaque passenger data

  - `content` (any)
    The sub components of the product if present

  - `quantity` (number)
    The product quantity

  - `productSpatialRequirement` (number,null)
    Total volume or area for the booking

  - `productMassKg` (number,null)
    Total weight for the booking

  - `productNetWeightKg` (number,null)
    Net weight for the booking

  - `productTareWeightKg` (number,null)
    Tare weight for the booking

  - `distanceKm` (number)
    The reference distance for the job

  - `sourceId` (string)
    The source of the booking

  - `groupPricingStrategyGroupId` (string,null)
    Pricing group id

  - `priceTransport` (number,null)
    The allocated transport price

  - `priceFaf` (number,null)
    The allocated FAF

  - `offerStatus` (string)
    The offer status

  - `priceFafOffer` (number,null)
    The FAF offered

  - `priceTransportOffer` (number,null)
    The transport price offered

  - `fromLocation` (object)

  - `fromLocation.addressText` (string, required)

  - `fromLocation.latitude` (number, required)

  - `fromLocation.longitude` (number, required)

  - `fromLocation.locationName` (string, required)

  - `fromLocation.locationId` (string,null)
    The M2X internal location id. When a location is manually created in M2X, this is a randomly generated unique identifier. If creating locations via API, the caller can set the Location ID.

  - `fromLocation.locationOwnerId` (string,null)
    The M2X internal location owner id.

  - `fromLocation.locationVersion` (string,null)
    Version of the location for change tracking.

  - `fromLocation.externalId` (string,null)
    An optional external identifier assigned to the location. This ID can be provided when creating the location and is typically used for cross-system referencing or integration with external data sources.

  - `fromLocation.timezone` (string)
    IANA (aka TZ database) timezone name
    Example: "Pacific/Auckland"

  - `fromLocation.properties` (object,null)

  - `fromLocationDistrict` (string)

  - `fromLocationDistrictId` (string,null)

  - `fromLocationRegion` (string)

  - `fromDateAndTimeConstraint` (object)

  - `fromDateAndTimeConstraint.date` (string, required)
    Day required (YYYY-MM-DD)

  - `fromDateAndTimeConstraint.timeConstraint` (any)

  - `fromTimeWindows` (array)

  - `fromTimeWindows.start` (integer, required)
    Epoch timestamp (seconds since 1970), start of the window

  - `fromTimeWindows.end` (integer, required)
    Epoch timestamp (seconds since 1970), end of the window

  - `fromLocationGroup` (object)

  - `fromLocationGroup.groupId` (string)
    Internal M2X Location Id

  - `fromLocationGroup.code` (string)
    Rapid searchable code for front end users
    Example: "C123"

  - `fromLocationGroup.externalId` (string,null)
    Id to map group to an external system
    Example: "asd-asd-asd"

  - `fromLocationGroup.name` (string)
    Group name

  - `fromContactDetails` (object)

  - `toLocation` (object)

  - `toLocationDistrict` (string)

  - `toLocationDistrictId` (string,null)

  - `toLocationRegion` (string)

  - `toDateAndTimeConstraint` (object)

  - `toTimeWindows` (array)

  - `toLocationGroup` (object)

  - `toContactDetails` (object)

  - `masterBooking` (object)
    The relevant master booking information for this booking

  - `masterBooking.masterBookingId` (string)

  - `masterBooking.type` (string)

  - `masterBooking.shipmentId` (string,null)

  - `masterBooking.transportMode` (string,null)

  - `masterBooking.properties` (object,null)
    A key value store containing bespoke properties usable for pricing and optimisation

  - `masterBooking.containerNumber` (string,null)
    The planned container number associated with the FULL booking. This value represents the expected container to be used for the shipment and may be subject to change as the booking progresses

  - `masterBooking.containerSealNumber` (string,null)

  - `masterBooking.shippingBookingReference` (string,null)

  - `masterBooking.customerOrderNumber` (string,null)

  - `masterBooking.salesOrderNumber` (string,null)

  - `masterBooking.purchaseOrderNumber` (string,null)

  - `masterBooking.shippingTemperature` (number,null)

  - `masterBooking.specialInstructions` (string,null)

  - `masterBooking.releaseNumber` (string,null)

  - `masterBooking.feederVessel` (string,null)

  - `masterBooking.feederVoyageNumber` (string,null)

  - `masterBooking.oceanVessel` (string,null)

  - `masterBooking.oceanVoyageNumber` (string,null)

  - `masterBooking.shippingCarrier` (string,null)

  - `masterBooking.dangerousGoods` (boolean,null)

  - `masterBooking.unNumber` (string,null)

  - `masterBooking.activeRefrigeration` (boolean,null)

  - `masterBooking.ambientTimeHours` (number,null)

  - `masterBooking.powerOffDateTime` (string,null)

  - `masterBooking.vesselArrivalDateTime` (string,null)

  - `masterBooking.vesselDepartureDateTime` (string,null)

  - `masterBooking.packDate` (string,null)

  - `masterBooking.availableDate` (string,null)

  - `masterBooking.portEarliestReceivalDateTime` (string,null)

  - `masterBooking.movementSequence` (number,null)

  - `masterBooking.movementType` (string,null)

  - `masterBooking.movementTotal` (number,null)

  - `masterBooking.customerName` (string,null)

  - `masterBooking.productType` (string)
    Enum: "Bulk", "Container", "General", "General Freight", "Hire", "Livestock", "Pallet", "Logs"

  - `masterBooking.emptyReleaseNumber` (string,null)

  - `masterBooking.shipCutOffDateTime` (string,null)

  - `masterBooking.commodityCode` (string,null)

  - `masterBooking.commodityDescription` (string,null)

  - `masterBooking.connectedMovements` (object)

  - `masterBooking.connectedMovements.prior` (object)

  - `masterBooking.connectedMovements.prior.reference` (string,null)

  - `masterBooking.connectedMovements.prior.vehicleExternalId` (string,null)

  - `masterBooking.connectedMovements.next` (object)

  - `exceptionFlagState` (any)
    Status of the Exception Flag Resolution action

## Response 404 fields (application/json):

  - `message` (string)
    Example: "not found"