Get booking list
GET {{baseUrl}}/bookings
Description
This API endpoint allows users to retrieve a list of previously created bookings for any yard.
Notes
Please ensure that you have the necessary authentication and authorization to access this endpoint.
The
isActive,itemsPerPage,pageandsearchparameters are optional and can be utilized for filtering and pagination purposes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
isActive | null | (optional, default: true) Filter bookings based on their active status. | |
itemsPerPage | null | (optional, default: 5) Number of items to be displayed per page. | |
page | null | (optional, default: 1) Page number for pagination. | |
search | null | (optional, default: null) Search term to filter bookings. |
RESPONSES
status: OK
{"bookings":[{"id":1,"code":"24300002","checkIn":"2024-07-26T00:00:00","checkOut":"2024-07-29T00:00:00","nextPaymentDate":"0001-01-01T00:00:00","type":"One-Time","status":"Confirmed","equipmentType":"Container/Chassis 20'/40'/45'","paymentMethod":{"brand":"discover","last4":"9424"},"paymentStatus":"Confirmed","space":2,"usedSpace":0,"invoiceTerm":1,"isPinCodeUsed":false,"createdDate":"2024-07-23T08:28:15.6708045","yard":{"id":1,"name":"Telfair"}}],"totalResults":1}