Reservations
Authorizations
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
get
GET /v1/flow/reservations HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
200Success
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"items": [
{
"type": "queue",
"code": "text",
"businessDate": "text",
"time": "text",
"numberOfGuests": 1,
"actualNumberOfGuests": 1,
"status": "canceled",
"duration": 1,
"seatedAt": "text",
"leftAt": "text",
"note": "text",
"areaId": "text",
"reference": "text",
"internalNote": "text",
"paid": true,
"ages": [
{
"id": "text",
"count": 1
}
],
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"branchId": "text",
"customerUid": "text",
"customer": {
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"phoneCountry": "text",
"phoneCountryCalling": "text",
"sequence": 1,
"number": "text",
"cityId": "text",
"birthDate": "text",
"gender": {},
"passcode": "text",
"unsubscribed": true,
"internalNote": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"roleAssignments": [
{
"endDate": "text",
"id": "text"
}
]
},
"tableIds": [
"text"
],
"can": [
"cancel"
],
"recommendedTableIds": [
"text"
],
"labels": [
{
"uid": "text",
"labelUid": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text"
}
],
"feeOrderUid": "text",
"scheduledOrderUid": "text",
"experienceUids": [
"text"
]
}
]
}
}
Authorizations
Header parameters
organization-idstringRequired
Organization ID
Body
Responses
200Success
application/json
400
Functional Error
application/json
post
POST /v1/flow/reservations HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 300
{
"params": {
"branchId": "text",
"customerId": "text",
"time": "text",
"numberOfGuests": 1,
"status": "canceled",
"duration": 1,
"seatedAt": "text",
"leftAt": "text",
"note": "text",
"areaId": "text",
"tableIds": [
"text"
],
"reference": "text",
"internalNote": "text",
"experienceUids": [
"text"
],
"ages": [
{
"id": "text",
"count": 1
}
]
}
}
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"item": {
"type": "queue",
"code": "text",
"businessDate": "text",
"time": "text",
"numberOfGuests": 1,
"actualNumberOfGuests": 1,
"status": "canceled",
"duration": 1,
"seatedAt": "text",
"leftAt": "text",
"note": "text",
"areaId": "text",
"reference": "text",
"internalNote": "text",
"paid": true,
"ages": [
{
"id": "text",
"count": 1
}
],
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"branchId": "text",
"customerUid": "text",
"customer": {
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"phoneCountry": "text",
"phoneCountryCalling": "text",
"sequence": 1,
"number": "text",
"cityId": "text",
"birthDate": "text",
"gender": {},
"passcode": "text",
"unsubscribed": true,
"internalNote": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"roleAssignments": [
{
"endDate": "text",
"id": "text"
}
]
},
"tableIds": [
"text"
],
"can": [
"cancel"
],
"recommendedTableIds": [
"text"
],
"labels": [
{
"uid": "text",
"labelUid": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text"
}
],
"feeOrderUid": "text",
"scheduledOrderUid": "text",
"experienceUids": [
"text"
]
}
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
400
Functional Error
application/json
get
GET /v1/flow/reservations/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"item": {
"type": "queue",
"code": "text",
"businessDate": "text",
"time": "text",
"numberOfGuests": 1,
"actualNumberOfGuests": 1,
"status": "canceled",
"duration": 1,
"seatedAt": "text",
"leftAt": "text",
"note": "text",
"areaId": "text",
"reference": "text",
"internalNote": "text",
"paid": true,
"ages": [
{
"id": "text",
"count": 1
}
],
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"branchId": "text",
"customerUid": "text",
"customer": {
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"phoneCountry": "text",
"phoneCountryCalling": "text",
"sequence": 1,
"number": "text",
"cityId": "text",
"birthDate": "text",
"gender": {},
"passcode": "text",
"unsubscribed": true,
"internalNote": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"roleAssignments": [
{
"endDate": "text",
"id": "text"
}
]
},
"tableIds": [
"text"
],
"can": [
"cancel"
],
"recommendedTableIds": [
"text"
],
"labels": [
{
"uid": "text",
"labelUid": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text"
}
],
"feeOrderUid": "text",
"scheduledOrderUid": "text",
"experienceUids": [
"text"
]
}
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
delete
DELETE /v1/flow/reservations/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
200Success
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"succeed": true
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Body
Responses
200Success
application/json
400
Functional Error
application/json
patch
PATCH /v1/flow/reservations/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 223
{
"params": {
"time": "text",
"numberOfGuests": 1,
"status": "canceled",
"duration": 1,
"seatedAt": "text",
"leftAt": "text",
"note": "text",
"areaId": "text",
"tableIds": {},
"internalNote": "text",
"paid": true,
"ages": [
{
"id": "text",
"count": 1
}
]
}
}
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"item": {
"type": "queue",
"code": "text",
"businessDate": "text",
"time": "text",
"numberOfGuests": 1,
"actualNumberOfGuests": 1,
"status": "canceled",
"duration": 1,
"seatedAt": "text",
"leftAt": "text",
"note": "text",
"areaId": "text",
"reference": "text",
"internalNote": "text",
"paid": true,
"ages": [
{
"id": "text",
"count": 1
}
],
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"branchId": "text",
"customerUid": "text",
"customer": {
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"phoneCountry": "text",
"phoneCountryCalling": "text",
"sequence": 1,
"number": "text",
"cityId": "text",
"birthDate": "text",
"gender": {},
"passcode": "text",
"unsubscribed": true,
"internalNote": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"roleAssignments": [
{
"endDate": "text",
"id": "text"
}
]
},
"tableIds": [
"text"
],
"can": [
"cancel"
],
"recommendedTableIds": [
"text"
],
"labels": [
{
"uid": "text",
"labelUid": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text"
}
],
"feeOrderUid": "text",
"scheduledOrderUid": "text",
"experienceUids": [
"text"
]
}
}
}
Authorizations
Query parameters
updatedSincestringOptional
offsetstringOptional
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
get
GET /v1/flow/reservations/export HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
200Success
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"items": [
{
"type": "queue",
"code": "text",
"businessDate": "text",
"time": "text",
"numberOfGuests": 1,
"actualNumberOfGuests": 1,
"status": "canceled",
"duration": 1,
"seatedAt": "text",
"leftAt": "text",
"note": "text",
"areaId": "text",
"reference": "text",
"internalNote": "text",
"paid": true,
"ages": [
{
"id": "text",
"count": 1
}
],
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"uid": "text",
"branchId": "text",
"customerUid": "text",
"customer": {
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"phoneCountry": "text",
"phoneCountryCalling": "text",
"sequence": 1,
"number": "text",
"cityId": "text",
"birthDate": "text",
"gender": {},
"passcode": "text",
"unsubscribed": true,
"internalNote": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text",
"id": "text",
"roleAssignments": [
{
"endDate": "text",
"id": "text"
}
]
},
"tableIds": [
"text"
],
"can": [
"cancel"
],
"recommendedTableIds": [
"text"
],
"labels": [
{
"uid": "text",
"labelUid": "text",
"createdAt": "text",
"createdVia": "text",
"createdBy": "text",
"updatedAt": "text",
"updatedVia": "text",
"updatedBy": "text"
}
],
"feeOrderUid": "text",
"scheduledOrderUid": "text",
"experienceUids": [
"text"
]
}
],
"next": "text"
}
}
Authorizations
Query parameters
branchIdstringRequired
businessDatestringOptional
numberOfGuestsnumberRequired
durationnumberOptional
timestringOptional
areaIdstringOptional
tableIdsstring[]Optional
updatedSourceIdstringOptional
experienceUidsstring[]Optional
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
400
Functional Error
application/json
get
GET /v1/flow/reservations/availability?branchId=text&numberOfGuests=1 HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"businessDate": "text",
"slots": [
{
"time": "text",
"isoTime": "text",
"tables": [
{
"name": "text",
"x": 1,
"y": 1,
"width": 1,
"height": 1,
"circle": true,
"minSeats": 1,
"maxSeats": 1,
"archived": true,
"active": true,
"id": "text",
"areaId": "text"
}
],
"experienceUids": [
"text"
]
}
]
}
}
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired
Organization ID
Responses
200Success
application/json
get
GET /v1/flow/reservations/by-customer/{uid} HTTP/1.1
Host:
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
200Success
{
"app": "text",
"service": "text",
"warnings": [
{}
],
"instanceId": "text",
"requestId": "text",
"data": {
"items": [
{}
],
"next": "text"
}
}
Was this helpful?