Skip to content

Get Booking By ID

Bookings Read Only

Retrieve complete details for a specific booking using its unique identifier. Returns booking data along with the associated quote and metadata including invoice and receipt IDs.

Returns

Full booking + quote + meta

Auth

Bearer token required

Use cases

Order details · Invoice lookup · Status check


Endpoint overview

GET Authenticated

URL: {{base_url}}/employee/booking/get-booking/{{booking_id}}

  • Requires a valid bearer token in the Authorization header.
  • Replace {{booking_id}} with the actual booking ID.
  • Returns the complete booking object with quote and metadata.

Required headers

Header Value
Authorization Bearer {{token}}

Path parameters

Parameter Type Required Description
booking_id string Yes The unique identifier of the booking

Sample request

GET /employee/booking/get-booking/69090bfcabc57c5eb35b0f15 HTTP/1.1
Host: {{ base_url }}
Authorization: Bearer {{ token }}
Accept: application/json

Response

{
  "success": true,
  "data": {
    "foundBooking": {
      "_id": "69090bfcabc57c5eb35b0f15",
      "new": false,
      "sourcePlatform": "AAJ-Send",
      "senderHasNoNigerianAddress": false,
      "receiver": {
        "contact": {
          "name": "Rebecca Owolabi",
          "phone": "+442030484377",
          "email": "o.rebecca@gmail.com"
        },
        "addressDetails": {
          "addressLine1": "Flat 3, 14 Oakwood Drive, Leeds, LS11 OAA, United Kingdom.",
          "apartmentNumber": "",
          "city": "Leeds",
          "state": "West Yorkshire",
          "country": "United Kingdom",
          "stateOrProvinceCode": "WE",
          "countryCode": "GB",
          "postalCode": "BD11 1ND",
          "landmark": "",
          "streetLines": [
            "Flat 3, 14 Oakwood Drive, Leeds, LS11 OAA, United Kingdom."
          ]
        }
      },
      "sender": {
        "contact": {
          "owner": "68d3c8bede43d381d3b53dbb",
          "name": "Lanre Ogundele",
          "phone": "+2348036415243",
          "email": "lanre.o@gmail.com"
        },
        "addressDetails": {
          "addressLine1": "40, Landmark Street, Eleyele, Oyo.",
          "apartmentNumber": "",
          "city": "Ibadan",
          "state": "Oyo",
          "country": "Nigeria",
          "countryCode": "NG",
          "stateOrProvinceCode": "OY",
          "postalCode": "202102",
          "landmark": "",
          "streetLines": ["40, Landmark Street, Eleyele, Oyo."]
        }
      },
      "packageInsurance": "NE",
      "packages": {
        "packages": [
          {
            "actualWeight": 25,
            "packageDimension": {
              "length": 32,
              "width": 25,
              "height": 2,
              "weight": 0.32,
              "price": 0,
              "_id": "69090bfcabc57c5eb35b0f17",
              "createdAt": "2025-11-03T20:09:32.056Z",
              "updatedAt": "2025-11-03T20:09:32.056Z"
            },
            "predefinedDimension": "68fb3fa3bec965665202eacf",
            "items": [
              {
                "quantity": 1,
                "price": 20000,
                "hsCode": "62152000",
                "name": "Bow tie",
                "id": null,
                "excludePackingList": false,
                "_id": "69090bfcabc57c5eb35b0f18",
                "createdAt": "2025-11-03T20:09:32.057Z",
                "updatedAt": "2025-11-03T20:09:32.057Z"
              }
            ],
            "_id": "69090bfcabc57c5eb35b0f16",
            "createdAt": "2025-11-03T20:09:32.057Z",
            "updatedAt": "2025-11-03T20:09:32.057Z",
            "multiple": 1
          }
        ],
        "itemsValue": 20000,
        "packageType": "regular",
        "createMultiple": false,
        "type": "regular",
        "addOns": [],
        "items": []
      },
      "weight": 25,
      "addOns": [],
      "collectionMode": {
        "collectionType": "PICKUP",
        "pickupDetails": {
          "pickupDate": "2025-11-05T00:00:00.000Z",
          "pickupTimeRange": {
            "from": "9:00 AM",
            "to": "4:00 PM"
          }
        }
      },
      "customerAcceptanceState": 0,
      "branchName": "Gbagada Phase 1",
      "servedBy": "Olabanji Olaleye",
      "generatedBy": "68d3c8bede43d381d3b53dbb",
      "shipmentRate": "CR",
      "orderState": 1,
      "bookingState": 1,
      "partner": false,
      "numberOfPackages": 1,
      "subTotal": 6500,
      "totalAmount": 6988,
      "promoCode": "",
      "description": "Shipment Booking",
      "paid": true,
      "deliveryType": "DROP_OFF",
      "deliveryMode": "DOOR_STEP",
      "category": "68c2a70190f1fdaabd8c0b8e",
      "shipaOrEcommerce": false,
      "insuredValue": 0,
      "payments": {
        "transaction": {
          "method": "",
          "generateTransaction": "",
          "allowAsynchronousTransaction": false
        },
        "accountNumber": "",
        "customerId": ""
      },
      "serviceType": "AIR_EXPORT",
      "carrier": "AAJ",
      "courier": {
        "rateId": "1^11",
        "token": "DPD TWO DAY",
        "rateIds": []
      },
      "getAcknowledgementCopy": false,
      "bookingDate": "2025-11-03T20:09:32.054Z",
      "collectionEvents": [],
      "createdAt": "2025-11-03T20:09:32.057Z",
      "updatedAt": "2025-11-06T08:15:08.703Z",
      "type": "IN",
      "location": "United Kingdom",
      "packageValueClaim": 20000,
      "searchId": "72285500",
      "__v": 0,
      "extraCharges": {
        "fuelSurcharge": {
          "value": 0,
          "type": "percentage",
          "amount": 0
        },
        "onShippingFee": 6500,
        "packagingFee": {
          "value": 0,
          "type": "price",
          "amount": 0
        }
      },
      "source": {
        "oid": "67f7c951ad794273b8519f8a",
        "name": "AAJ Express",
        "branch": "",
        "accountNumber": "747801"
      },
      "hasDispatch": "69090c0669c9f1950935fc82",
      "shipmentId": null,
      "quote": {
        "_id": "69090bfcabc57c5eb35b0f1c",
        "subTotal": 6500,
        "vat": 7.5,
        "total": 6988,
        "insurance": {
          "type": "NE",
          "fee": 0
        },
        "extraCharges": {
          "fuelSurcharge": {
            "value": 0,
            "type": "percentage",
            "amount": 0
          },
          "onShippingFee": 6500,
          "packagingFee": {
            "value": 0,
            "type": "price",
            "amount": 0
          }
        },
        "eta": {
          "numberOfDays": 5,
          "dateOfArrival": "2025-11-08T20:09:32.000000+01:00"
        },
        "shippingFee": 6500
      }
    },
    "quote": {
      "_id": "69090bfcabc57c5eb35b0f1c",
      "subTotal": 6500,
      "vat": 7.5,
      "total": 6988,
      "insurance": {
        "type": "NE",
        "fee": 0
      },
      "extraCharges": {
        "fuelSurcharge": {
          "value": 0,
          "type": "percentage",
          "amount": 0
        },
        "onShippingFee": 6500,
        "packagingFee": {
          "value": 0,
          "type": "price",
          "amount": 0
        }
      },
      "eta": {
        "numberOfDays": 5,
        "dateOfArrival": "2025-11-08T20:09:32.000000+01:00"
      },
      "shippingFee": 6500
    },
    "meta": {
      "invoice": "690c59080cce5203adb092cc",
      "receipt": "690c590c0cce5203adb092e0"
    }
  },
  "status": 200,
  "message": "Booking fetched successfully",
  "timestamp": "2025-11-09T20:37:37.435Z"
}

Key response fields

Field Type Description
success boolean Indicates whether the request was successful
data.foundBooking object Complete booking object with all details
data.foundBooking._id string Unique booking identifier
data.foundBooking.searchId string Short search-friendly ID
data.foundBooking.sourcePlatform string Platform where booking originated
data.foundBooking.receiver object Receiver contact and address details
data.foundBooking.sender object Sender contact and address details
data.foundBooking.packages object Package details with weight, dimensions, items
data.foundBooking.collectionMode object Collection type and pickup details
data.foundBooking.bookingState number State code. See Booking Enums
data.foundBooking.orderState number Order state code. See Booking Enums
data.foundBooking.subTotal number Subtotal before taxes
data.foundBooking.totalAmount number Total including VAT and fees
data.foundBooking.paid boolean Whether payment is completed
data.foundBooking.branchName string Branch handling the booking
data.foundBooking.servedBy string Staff member who handled booking
data.foundBooking.hasDispatch string Dispatch ID if dispatched
data.foundBooking.quote object Embedded quote with pricing
data.quote object Standalone quote object
data.quote.eta object Estimated delivery time
data.meta object Related document IDs
data.meta.invoice string Invoice document ID
data.meta.receipt string Receipt document ID
status number HTTP status code
message string Response message
timestamp string ISO timestamp

Error responses

Booking Not Found

{
  "success": false,
  "status": 404,
  "message": "Booking not found",
  "timestamp": "2025-11-09T20:37:37.435Z"
}

Unauthorized

{
  "success": false,
  "status": 401,
  "message": "Invalid or expired token",
  "timestamp": "2025-11-09T20:37:37.435Z"
}

Tip: Use the meta.invoice and meta.receipt IDs to retrieve related documents via the Invoice endpoints.