Skip to main content
POST
cURL

Authorizations

integration_id
string
header
required

Identifier of the integration (Auth v1)

secret
string
header
required

Secret of the organization (Auth v1)

x-api-key
string
header
required

API key (Auth v2)

Body

application/json

Body of the request

created_at
string<date-time>

Booking creation instant (ISO 8601). If omitted, the server uses the current time.

Example:

"2024-06-01T18:30:00.000Z"

event_id
string

Event identifier.

Example:

"nl830t4mw0001cwrxbbg0226j4MgmEUG"

space_names
string

Space names for the reservation. Separated by commas.

Example:

"1, 2, 3"

for
integer

Number of people in the reservation.

Example:

5

price
number

Reservation price. Required for a discount_code to apply (the discount is computed over this amount).

Example:

20

discount_code
string

Discount code (bookings type) to apply to the reservation. Requires price; the discount is subtracted from it. Sending it without price returns 400.

Example:

"BOOKDESC"

Response

HTTP OK

_id
string

Unique ID of the reservation.

Example:

"jl830v6km000pcwrxge2757vyrfpqEsq"

channel_id
string

Unique identifier of the channel. (It can be the same or other organization).

Example:

"ajifs2hke000dwemmurwd3kuqN3Kopcx"

code
string

Access code (QR) of the reservation.

Example:

"XLLF3W73D"

commentary_client
string

Observations sent by the client.

Example:

"I want the biggest VIP table."

commentary_reserve
string

Observations made by the organization.

Example:

"Preferred table for that client is 10."

date
string<date-time>

Reservation date in ISO 8601 format.

Example:

"2022-09-15T23:00:00.000Z"

deposit
number
default:0

Value of the reservation advance.

Example:

0

deposit_method
enum<string>
default:online

Reservation payment method.

Available options:
online,
cash
Example:

"online"

deposit_paid
number
default:0

Value of the advance payment of the reservation already paid in the currency of the organization.

Example:

0

discount_code_name
string | null

Code of the discount applied to the reservation, or null if none was applied.

Example:

"BOOKDESC"

discount_code_id
string | null

Unique identifier of the discount code applied to the reservation, or null if none was applied.

Example:

"dc4gr63f00xkq01i1d8jh5ohuzaZhvoE"

discount_quantity_subtract
number
default:0

Total amount of the discount subtracted from the reservation price.

Example:

0

duration
integer
default:0

Estimated reservation duration in seconds. If the configuration zone does not support duration, the default value will be 0.

Example:

7200

enter
integer

Number of people received from the reservation.

Example:

0

event_id
string

Event identifier.

Example:

"nl830t4mw0001cwrxbbg0226j4MgmEUG"

event_name
string

Reservation event name. Empty if it is a reservation by calendar, not associated with an event but with a date.

Example:

"Saturday Night"

for
integer

Number of people in the reservation.

Example:

5

gender_group
enum<string>

Gender of reservation attendees.

Available options:
mixed,
boys,
girls
Example:

"boys"

hour
string
default:""

Time in “HH:mm” format of the reservation. If there is no time indicated, the field will be empty.

Example:

"2:00"

name
string

Reservation name.

Example:

"Sergio Centeno Pérez"

phone
string

Phone number of the client.

Example:

"+34666666666"

price
number

Reservation price. It does not have to coincide with the advance. Ex: a reservation of €100 can have an advance of €50, the remaining €50 would be paid on the premises, if the advance (deposit_paid) is paid.

Example:

0

rate_slug
string

Identifier of the rate used by the reservation.

Example:

""

referral_id
string

PPRR identifier.

Example:

"ñeifupjvx000rwe2m2zuba1z9FqyR2dSL"

refunded
number
default:0

Amount refunded from the online advance, in the currency of the organization.

Example:

0

space_id
integer

Reservation space identifier.

Example:

""

space_name
string

Name of the space where the reservation is located.

Example:

"S1"

status
enum<string>[]

Reservation status:

- Pending: If a reservation is in pending status, a verification is necessary in order to be accepted. This verification can be done manually for the users of Fourvenues Pro. In case of an automatic verification, the reservation must have an advance included.

- Accepted: A reservation is considered as accepted when there is no additional action by the organizer. This reservation is prepared to be attended on the event day.

- Rejected: In order to classify the reservation as rejected, a manual action is necessary from Fourvenues Pro. When a reservation is in this status, it will not record the whole amount nor the advance paid by cash. In case of a confirmed advance paid by card and no reimbursement, it will be recorded on event dashboard.

- Arrival: The arrival status can be used when the clients arrive at the venue. It is possible to use this status in case that the clients don’t get a seat and they are waiting to be seated.

- Sitting: With the sitting status, the clients have an assigned place.

- Released: The last status of a reservation is when the clients leave the venue. This status leaves the place vacant and it is possible to sell the place again.

Available options:
pending,
accepted,
rejected,
arrival,
sitting,
released
Example:

"accepted"

walkin
boolean
default:false

True if the reservation is entered as a walking, false otherwise.

Example:

true

zone_name
string

Name of the area where the reservation is located.

Example:

"Terraza"

zone_slug
integer

Zone identifier. The same zone for two different days (or events) has the same zone_slug but different id.

Example:

"1658138633506"

normalized_zone_name
string

Normalized zone name.

Example:

"terraza"

email
string

Email of the client.

Example:

"example@example.com"

invoice_reference
string

Invoice reference.

Example:

"EV24T-TOX2-0000215"

corrective_invoice_references
string[]

Corrective invoice references.

Example:
created_at
string

Creation timestamp.

Example:

"2024-11-19T09:59:53.763Z"

currency
string

Currency of the organization.

Example:

"EUR"

state
string

State of the reservation.

Example:

"accepted"

updated_at
string

Last update timestamp.

Example:

"2024-11-19T09:59:53.763Z"

local_date
string

Local creation date of the reservation.

Example:

"2025-05-19 10:59:53"

client_id
string

Client ID.

Example:

"kfnwkjbjkwb1jbr4bkhb5334"

billing_info
object

Billing information.

external_payments
object[]
refunds
object[]
payments
object[]
pos_payments
object[]
source
enum<string>

Source of the reservation.

Available options:
web,
pro
Example:

"web"

pos_total_service_charge
number

Total service charge.

Example:

200

pos_total_tips
number

Total tips.

Example:

50

pos_ticket_total
number

Pos Ticket Total

Example:

400

pos_products
object[]