Get Booking

curl --request GET \
  --url https://{base_url}/Bookings/{id} \
  --header 'X-API-KEY: <x-api-key>'

{
  "bookingId": "<string>",
  "locationId": "<string>",
  "method": "<string>",
  "bookedAt": "<string>",
  "bookingTime": "<string>",
  "duration": 123,
  "people": 123,
  "serviceId": "<string>",
  "serviceName": "<string>",
  "serviceType": "<string>",
  "lastModifiedDate": "<string>",
  "notes": "<string>",
  "customer": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "phoneNational": "<string>",
    "phone2": "<string>",
    "address": "<string>",
    "birthdayDate": "<string>"
  },
  "tables": [
    {
      "tableId": "<string>",
      "tableName": "<string>",
      "sectionId": "<string>",
      "sectionName": "<string>"
    }
  ],
  "tags": [
    {
      "tagType": "<string>",
      "name": "<string>"
    }
  ],
  "status": {
    "statusType": "<string>",
    "code": "<string>",
    "name": "<string>"
  },
  "paymentSummary": {
    "paymentType": "<string>",
    "amount": 123,
    "amountDue": 123,
    "amountPaid": 123,
    "transactionId": "<string>",
    "currencyCode": "<string>",
    "paymentDate": "<string>"
  },
  "items": [
    {
      "name": "<string>",
      "label": "<string>",
      "price": 123,
      "quantity": 123,
      "paymentType": "<string>",
      "extras": [
        {}
      ]
    }
  ]
}

GET

Bookings

{id}

Get Booking

curl --request GET \
  --url https://{base_url}/Bookings/{id} \
  --header 'X-API-KEY: <x-api-key>'

{
  "bookingId": "<string>",
  "locationId": "<string>",
  "method": "<string>",
  "bookedAt": "<string>",
  "bookingTime": "<string>",
  "duration": 123,
  "people": 123,
  "serviceId": "<string>",
  "serviceName": "<string>",
  "serviceType": "<string>",
  "lastModifiedDate": "<string>",
  "notes": "<string>",
  "customer": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "phoneNational": "<string>",
    "phone2": "<string>",
    "address": "<string>",
    "birthdayDate": "<string>"
  },
  "tables": [
    {
      "tableId": "<string>",
      "tableName": "<string>",
      "sectionId": "<string>",
      "sectionName": "<string>"
    }
  ],
  "tags": [
    {
      "tagType": "<string>",
      "name": "<string>"
    }
  ],
  "status": {
    "statusType": "<string>",
    "code": "<string>",
    "name": "<string>"
  },
  "paymentSummary": {
    "paymentType": "<string>",
    "amount": 123,
    "amountDue": 123,
    "amountPaid": 123,
    "transactionId": "<string>",
    "currencyCode": "<string>",
    "paymentDate": "<string>"
  },
  "items": [
    {
      "name": "<string>",
      "label": "<string>",
      "price": 123,
      "quantity": 123,
      "paymentType": "<string>",
      "extras": [
        {}
      ]
    }
  ]
}

X-API-KEY

string

required

Your partner API key.

Path Parameters

string

required

The NowBookIt booking ID. Obtained from List Bookings or Create Booking.

Response

bookingId

string

Unique NowBookIt booking identifier.

locationId

string

NowBookIt venue/location identifier.

method

string

How the booking was created (e.g., "online", "phone", "walkin", "pos").

bookedAt

string

ISO 8601 timestamp of when the booking was originally created.

bookingTime

string

Booking datetime in venue local time.

duration

integer

Duration in minutes.

people

integer

Number of guests.

serviceId

string

NowBookIt service ID.

serviceName

string

Human-readable service name.

serviceType

string

Service type classification.

lastModifiedDate

string

ISO 8601 timestamp of the most recent modification.

notes

string

Booking notes.

customer

object

Customer/guest details. Only populated for subscribed customers.

Show Customer Object

string

NowBookIt customer ID.

firstName

string

First name.

lastName

string

Last name.

company

string

Company name.

string

Email address.

phone

string

Phone number (international format).

phoneNational

string

Phone number (national format).

phone2

string

Secondary phone number.

address

string

Address.

birthdayDate

string

Customer birthday (ISO 8601 date).

tables

array

Tables assigned to this booking.

Show Table Object

tableId

string

NowBookIt table identifier.

tableName

string

Human-readable table name.

sectionId

string

Section the table belongs to.

sectionName

string

Human-readable section name.

Examples

curl https://{base_url}/Bookings/bk_abc123 \
  -H "X-API-KEY: your_api_key"

Example Response (200)

{
  "bookingId": "bk_abc123",
  "locationId": "loc_xyz789",
  "method": "online",
  "bookedAt": "2024-05-28T09:14:22Z",
  "bookingTime": "2024-06-15T19:00:00",
  "duration": 90,
  "people": 4,
  "serviceId": "svc_dinner",
  "serviceName": "Dinner",
  "serviceType": "standard",
  "lastModifiedDate": "2024-06-01T10:30:00Z",
  "notes": "Birthday celebration — window table preferred",
  "customer": {
    "id": "cust_111",
    "firstName": "Jane",
    "lastName": "Smith",
    "company": null,
    "email": "jane.smith@example.com",
    "phone": "+61412345678",
    "phoneNational": "0412 345 678",
    "phone2": null,
    "address": null,
    "birthdayDate": null
  },
  "tables": [
    {
      "tableId": "tbl_001",
      "tableName": "Table 5",
      "sectionId": "sec_main",
      "sectionName": "Main Floor"
    }
  ],
  "tags": [
    { "tagType": "occasion", "name": "Birthday" }
  ],
  "status": {
    "statusType": "confirmed",
    "code": "CNF",
    "name": "Confirmed"
  },
  "paymentSummary": {
    "paymentType": "card",
    "amount": 40.00,
    "amountDue": 0.00,
    "amountPaid": 40.00,
    "transactionId": "txn_9876",
    "currencyCode": "AUD",
    "paymentDate": "2024-05-28T09:14:50Z"
  },
  "items": []
}

Status Codes

Code	Description
`200`	Success
`400`	Invalid request
`401`	Invalid or missing `X-API-KEY`
`404`	Booking not found
`429`	Rate limit exceeded

Create Booking Update Booking

⌘I

​Path Parameters

​Response

​Examples

​Example Response (200)

​Status Codes

Path Parameters

Response

Examples

Example Response (200)

Status Codes