How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Withlocals Bookings API

Reserve, confirm, amend, cancel, and read bookings.

Withlocals Bookings API is one of 5 APIs that Withlocals publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Booking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, and 6 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://test-api.withlocals.com/v1/partner.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://test-api.withlocals.com/v1/partner
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Withlocals Bookings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (opaque) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Per-partner opaque API token issued by Withlocals. Send on every request as: Authorization: Bearer

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Bookings 5

Reserve, confirm, amend, cancel, and read bookings.

GET
/bookings
List bookings
listBookings 4 params → 200400401
POST
/bookings
Create a confirmed booking
createBooking 1 param body → 201400401404409
GET
/bookings/{bookingId}
Get a single booking by id
getBooking 1 param → 200401404
PATCH
/bookings/{bookingId}
Amend a booking (date / time and / or party size)
amendBooking 1 param body → 200400401404412
DELETE
/bookings/{bookingId}
Cancel a booking
cancelBooking 2 params body → 200400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Booking (16 properties), CreateBookingRequest (10 properties), MeetingPoint (5 properties), AmendRequest (4 properties). Each schema is shown below with its type and property counts.

MeetingPoint
object
Where the experience starts.
5 properties 1 required
GuestCancellationReason
string
Why the guest is cancelling. Sent on partner-initiated cancellations (DELETE /bookings/{bookingId}). | Value | Meaning | |---|---| | MYPLANSCHANGED | My plans…
CancelRequest
object
Optional body of DELETE /bookings/{bookingId}.
1 property
Booking
object
A partner booking. Returned by create, amend, cancel, and read. When status=CANCELLED, cancellationReason is set and the record persists for partner refund han…
16 properties 8 required
Guest
object
A single guest on a booking.
4 properties 1 required
Error
object
Error envelope.
3 properties 2 required
CreateBookingRequest
object
Body of POST /bookings — creates a CONFIRMED booking.
10 properties 5 required
AmendRequest
object
Body of PATCH /bookings/{bookingId}. Any subset of fields may be supplied.
4 properties
BookingStatus
string
Partner-facing booking lifecycle. Translated from the internal TripStatus by a single mapper (PartnerBookingStatus.fromTripStatus). v1 lifecycle (no holds — PO…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

withlocals-bookings-api-openapi.yml Raw ↑

Other APIs Withlocals publishes across the network.

Withlocals Availability API
Withlocals Products API
Withlocals Supplier API
Withlocals Webhooks API
Where this information came from

This is an independent, third-party profile of Withlocals Bookings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.