Booking Information

Fetch Booking Information

To retrieve detailed information about a booking, you need to make a request using the Booking ID. This ID is crucial to ensure you’re fetching the correct booking data from the system.

Requirements

Before making the request, please ensure you meet the following requirements:

Valid Booking ID: You must provide a valid Booking ID in the request URL. This ID uniquely identifies the booking you want to retrieve.

Permissions: Your API key must have the appropriate permissions to access booking information. Without proper authorization, the system will not return the booking details.

Response

Upon successfully fetching the booking data, the response will include important details, such as:

Status: The current status of the booking (e.g., processing, done, pending, canceled). This helps you understand the current state of the booking.

Customer Info: Information about the customer who made the booking, such as their name, contact details, and any other relevant information associated with them.

Scheduled Time: The scheduled date and time for the booking. This will tell you when the service or event is planned to occur.

By using this endpoint and following the requirements, you can easily fetch and display booking details for your system or application.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Headers

Body

Example

{
    "success": true,
    "booking": {
        "id": "",
        "code": "",
        "carId": "",
        "customerId": "",
        "workshopId": "",
        "externalId": "",
        "car": {
            "id": "",
            "customerId": "",
            "rego": "",
            "year": 0,
            "make": "",
            "model": "",
            "badge": "",
            "vin": ""
        },
        "customer": {
            "id": "",
            "workshopId": "",
            "name": "",
            "firstName": "",
            "lastName": "",
            "email": "",
            "phone": "",
            "company": "",
            "address": "",
            "postcode": "",
            "suburb": ""
        },
        "status": "pending",
        "date": "2025-11-03T03:30:00Z",
        "servicePackageType": "tyres",
        "customerCompany": "",
        "notes": "",
        "interval": 0,
        "jobNotes": [
            "Tyre Purchasing",
            "Nitrogen Inflation"
        ],
        "productNotes": [],
        "tyreQuantities": 0,
        "createdAt": "2025-11-03T03:30:00Z",
        "updatedAt": "2025-11-03T03:30:00Z"
    }
}

🟠404Record Not Found

Fetch Booking Information#

Requirements#

Response#

Request

Request Code Samples

Responses

Fetch Booking Information

Requirements

Response