Get Multipiece Booking By ID¶
Multipiece
Read Only
Retrieve complete details for a specific multipiece booking including all associated booking IDs, combined totals, and foreign exchange conversions.
Returns
Multipiece with FX rates
Auth
Bearer token required
Use cases
Verify contents · Check totals · Invoice prep
Endpoint overview¶
GET
Authenticated
URL: {{base_url}}/employee/booking/multipiece/{{multipiece_id}}
- Requires a valid bearer token in the Authorization header.
- Replace
{{multipiece_id}}with the actual multipiece booking ID. - Returns the complete multipiece object with all associated bookings.
Required headers¶
| Header | Value |
|---|---|
Authorization |
Bearer {{token}} |
Path parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
multipiece_id |
string |
Yes | The unique identifier of the multipiece booking |
Sample request¶
GET /employee/booking/multipiece/6914589406b15ab9ac9e84b9 HTTP/1.1
Host: {{ base_url }}
Authorization: Bearer {{ token }}
Accept: application/json
Response¶
{
"success": true,
"data": {
"multipiece": {
"_id": "6914589406b15ab9ac9e84b9",
"bookings": [
"690d0a040cce5203adb0a9bb",
"690d09cb0cce5203adb0a9af",
"690cf6030cce5203adb0a631"
],
"total": 97709,
"branchName": "Yaba",
"piecesBreakdown": [],
"fx": [
{
"currency": "USD",
"rate": 1500,
"amount": 65.13933333333334
},
{
"currency": "NGN",
"rate": 1,
"amount": 97709
},
{
"currency": "EUR",
"rate": 1700,
"amount": 57.47588235294118
}
],
"createdAt": "2025-11-12T09:51:17.190Z",
"updatedAt": "2025-11-12T09:56:22.902Z",
"__v": 3
}
},
"status": 200,
"message": "Multi-piece booking fetched successfully",
"timestamp": "2025-11-12T09:57:19.404Z"
}
Key response fields¶
| Field | Type | Description |
|---|---|---|
success |
boolean |
Indicates whether the request was successful |
data.multipiece |
object |
The multipiece booking object |
data.multipiece._id |
string |
Unique identifier for the multipiece booking |
data.multipiece.bookings |
array |
List of booking IDs included in this multipiece |
data.multipiece.total |
number |
Combined total cost of all bookings (in NGN) |
data.multipiece.branchName |
string |
Branch where the multipiece was created |
data.multipiece.piecesBreakdown |
array |
Breakdown of individual pieces (if applicable) |
data.multipiece.fx |
array |
Foreign exchange conversions |
data.multipiece.fx[].currency |
string |
Currency code (USD, NGN, EUR) |
data.multipiece.fx[].rate |
number |
Exchange rate used |
data.multipiece.fx[].amount |
number |
Total amount in that currency |
data.multipiece.createdAt |
string |
ISO timestamp of creation |
data.multipiece.updatedAt |
string |
ISO timestamp of last update |
status |
number |
HTTP status code (200 for success) |
message |
string |
Response message |
timestamp |
string |
Response timestamp |
Error responses¶
Multipiece Not Found¶
{
"success": false,
"status": 404,
"message": "Multi-piece booking not found",
"timestamp": "2025-11-12T09:57:19.404Z"
}
Unauthorized¶
{
"success": false,
"status": 401,
"message": "Invalid or expired token",
"timestamp": "2025-11-12T09:57:19.404Z"
}
Tip: To get full details of each booking within the multipiece, use the Get Booking By ID endpoint with each booking ID from the
bookingsarray.