Booking Request

Submit a New Booking Request

To create a new booking request for a customer, you need to provide the necessary details in the request. This action will initiate the booking process and allow the system to reserve a spot for the customer at the specified workshop.

Requirements:

Ensure that all required fields are included in the request. Missing information could result in an incomplete booking.

Validate the customer's information before submission. This includes verifying that the email is in a valid format, the phone number is correct, and all required customer details are accurately provided.

Booking Creation Confirmation

Once the booking request has been successfully submitted, the system will begin processing the booking details. Upon completion, a confirmation response will be returned. This response will:

Confirm that the booking request has been successfully created and is being handled by the system.

Include a unique bookingId that can be used to track or reference the booking.

Default Notifications

By default, both the workshop and the customer will receive notifications via SMS and email containing the details of the newly created booking.

Skipping Notifications (Optional)

To suppress these notifications in specific scenarios, you may include the optional field:

"skipNotification": true

When set to true, no notification will be sent to either the workshop or the customer.

Note: This setting applies only during booking creation.

Request

Header Params

Body Params application/json

Example

{
    "workshopId": "WID",
    "customerEmail": "adi+cust@repairy.au",
    "carRego": "AAA001",
    "bookingTime": "2025-11-03T03:30:00Z",
    "pickupTime": "2025-11-03T05:30:00Z",
    "customerName": "adi kurniawan",
    "customerPhone": "0400000001",
    "servicePackageType": "tyres",
    "notes": "contains special notes from customer",
    "customerCompany": "CUST corp",
    "jobNotes": [
        "Tyre Purchasing",
        "Nitrogen Inflation",
        "Air Conditioning"
    ],
    "productNotes": [
        "Michelin LTX FORCE 205/70 R15 96T"
    ],
    "tyreQuantities": 4,
    "carVin": "1HGCM82633A004352",
    "carMake": "Honda",
    "carModel": "Accord",
    "carYear": 2003,
    "carBadge": "sport"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Created

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"
    }
}

🟠400Bad Request

Submit a New Booking Request#

Requirements:#

Booking Creation Confirmation#

Default Notifications#

Skipping Notifications (Optional)#