Get bookings

GET

bookings

curl --request GET \
  --url https://api-alpha.fourvenues.com/integrations/bookings/ \
  --header 'integration_id: <api-key>' \
  --header 'secret: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": [
    {
      "_id": "jl830v6km000pcwrxge2757vyrfpqEsq",
      "channel_id": "ajifs2hke000dwemmurwd3kuqN3Kopcx",
      "code": "XLLF3W73D",
      "commentary_client": "I want the biggest VIP table.",
      "commentary_reserve": "Preferred table for that client is 10.",
      "date": "2022-09-15T23:00:00.000Z",
      "deposit": 0,
      "deposit_method": "online",
      "deposit_paid": 0,
      "duration": 7200,
      "enter": 0,
      "event_id": "nl830t4mw0001cwrxbbg0226j4MgmEUG",
      "event_name": "Saturday Night",
      "for": 5,
      "gender_group": "boys",
      "hour": "2:00",
      "name": "Sergio Centeno Pérez",
      "phone": "+34666666666",
      "price": 0,
      "rate_slug": "",
      "referral_id": "ñeifupjvx000rwe2m2zuba1z9FqyR2dSL",
      "refunded": 0,
      "space_id": "",
      "space_name": "S1",
      "status": "accepted",
      "walkin": true,
      "zone_name": "Terraza",
      "zone_slug": "1658138633506",
      "invoice_reference": "EV24T-TOX2-0000215",
      "corrective_invoice_references": [
        "EV24T-COR-H58Z-0000002",
        "EV24T-COR-H58Z-0000003"
      ]
    }
  ]
}

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)

Query Parameters

date

string

Date of event (ISO 8601).

space_name

string

Space name.

Response

200

application/json

HTTP OK

success

boolean

Example:

true

data

object[]

Array of Booking

data._id

string

Unique ID of the reservation.

Example:

"jl830v6km000pcwrxge2757vyrfpqEsq"

data.channel_id

string

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

Example:

"ajifs2hke000dwemmurwd3kuqN3Kopcx"

data.code

string

Access code (QR) of the reservation.

Example:

"XLLF3W73D"

data.commentary_client

string

Observations sent by the client.

Example:

"I want the biggest VIP table."

data.commentary_reserve

string

Observations made by the organization.

Example:

"Preferred table for that client is 10."

data.date

string

Reservation date in ISO 8601 format.

Example:

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

data.deposit

number

default:0

Value of the reservation advance.

Example:

0

data.deposit_method

enum<string>

default:online

Reservation payment method.

Available options:

online,

cash

Example:

"online"

data.deposit_paid

number

default:0

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

Example:

0

data.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

data.enter

integer

Number of people received from the reservation.

Example:

0

data.event_id

string

Event identifier.

Example:

"nl830t4mw0001cwrxbbg0226j4MgmEUG"

data.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"

data.for

integer

Number of people in the reservation.

Example:

5

data.gender_group

enum<string>

Gender of reservation attendees.

Available options:

mixed,

boys,

girls

Example:

"boys"

data.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"

data.name

string

Reservation name.

Example:

"Sergio Centeno Pérez"

data.phone

string

Phone number of the client.

Example:

"+34666666666"

data.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

data.rate_slug

string

Identifier of the rate used by the reservation.

Example:

""

data.referral_id

string

PPRR identifier.

Example:

"ñeifupjvx000rwe2m2zuba1z9FqyR2dSL"

data.refunded

number

default:0

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

Example:

0

data.space_id

integer

Reservation space identifier.

Example:

""

data.space_name

string

Name of the space where the reservation is located.

Example:

"S1"

data.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"

data.walkin

boolean

default:false

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

Example:

true

data.zone_name

string

Name of the area where the reservation is located.

Example:

"Terraza"

data.zone_slug

integer

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

Example:

"1658138633506"

data.invoice_reference

string

Invoice reference.

Example:

"EV24T-TOX2-0000215"

data.corrective_invoice_references

string[]

Corrective invoice references.

Example:

[
  "EV24T-COR-H58Z-0000002",
  "EV24T-COR-H58Z-0000003"
]

Get events Put bookings status

curl --request GET \
  --url https://api-alpha.fourvenues.com/integrations/bookings/ \
  --header 'integration_id: <api-key>' \
  --header 'secret: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": [
    {
      "_id": "jl830v6km000pcwrxge2757vyrfpqEsq",
      "channel_id": "ajifs2hke000dwemmurwd3kuqN3Kopcx",
      "code": "XLLF3W73D",
      "commentary_client": "I want the biggest VIP table.",
      "commentary_reserve": "Preferred table for that client is 10.",
      "date": "2022-09-15T23:00:00.000Z",
      "deposit": 0,
      "deposit_method": "online",
      "deposit_paid": 0,
      "duration": 7200,
      "enter": 0,
      "event_id": "nl830t4mw0001cwrxbbg0226j4MgmEUG",
      "event_name": "Saturday Night",
      "for": 5,
      "gender_group": "boys",
      "hour": "2:00",
      "name": "Sergio Centeno Pérez",
      "phone": "+34666666666",
      "price": 0,
      "rate_slug": "",
      "referral_id": "ñeifupjvx000rwe2m2zuba1z9FqyR2dSL",
      "refunded": 0,
      "space_id": "",
      "space_name": "S1",
      "status": "accepted",
      "walkin": true,
      "zone_name": "Terraza",
      "zone_slug": "1658138633506",
      "invoice_reference": "EV24T-TOX2-0000215",
      "corrective_invoice_references": [
        "EV24T-COR-H58Z-0000002",
        "EV24T-COR-H58Z-0000003"
      ]
    }
  ]
}

Introduction

API Reference

Recipes

Authorizations

Query Parameters

Response