Documentation Powered by ReDoc

External Reservation Service (0.1.0)

Download OpenAPI specification:Download

API for managing external reservations in the enfore platform

External Reservation Proxy

Retrieve external reservation proxies

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

External reservation proxies retrieved successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/external-reservation-proxies

Production

https://external.apis.enfore.com/reservations/org/{org-id}/external-reservation-proxies

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new external reservation proxy or update an existing one

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
number
required
string

A human-readable number, that identifies the reservation inside the enfore platform.

external_reference
required
object (ExternalReservationReference)
last_update_in_external_system
required
string <date-time>

The date and time when the reservation was last updated in the external system.

origin
required
string (ReservationOrigin)
Enum: "ONLINE" "PHONE" "MAIL" "WALK_IN" "OTHER" "API" "EXTERNAL_SYSTEM" "ENFORE_ONLINE_PRESENCE" "COMMUNICATION_CHANNEL" "SALES_CHANNEL"

An enumeration of common reservation origins.

service_location
string 24 characters

the technical identifier of the enfore platform ServiceLocation where the restaurant is located.

reservation_time
required
string <date-time>

The time when the reservation is scheduled to start.

guest_info
required
object (ReservationGuestInformation)

Information about a guest associated with a reservation

status_info
required
object (ReservationStatusInformation)

Information about the status of a reservation

assigned_tables
Array of objects (ReservationTableInformation)

The tables that are assigned to the reservation. This list may be empty if no tables have been assigned yet.

order_information
object (ReservationOrderInformation)

Information about orders created for a reservation.

annotations
object (ReservationAnnotations)

Annotations for a reservation, either made by the guest, the venue or the external system.

tags
Array of strings

A list of tags that have been associated with the reservation in the external system.

Responses

200

External reservation proxy was updated successfully

201

External reservation proxy was created successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

post/org/{org-id}/external-reservation-proxies

Production

https://external.apis.enfore.com/reservations/org/{org-id}/external-reservation-proxies

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "number": "string",
  • "external_reference":
    {
    },
  • "last_update_in_external_system": "2025-04-22T14:41:55Z",
  • "origin": "ONLINE",
  • "service_location": "stringstringstringstring",
  • "reservation_time": "2025-04-22T14:41:55Z",
  • "guest_info":
    {
    },
  • "status_info":
    {
    },
  • "assigned_tables":
    [
    ],
  • "order_information":
    {
    },
  • "annotations":
    {
    },
  • "tags":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "number": "string",
  • "external_reference":
    {
    },
  • "last_update_in_external_system": "2025-04-22T14:41:55Z",
  • "origin": "ONLINE",
  • "service_location": "stringstringstringstring",
  • "reservation_time": "2025-04-22T14:41:55Z",
  • "guest_info":
    {
    },
  • "status_info":
    {
    },
  • "assigned_tables":
    [
    ],
  • "order_information":
    {
    },
  • "annotations":
    {
    },
  • "tags":
    [
    ]
}

Load an external reservation proxy by its external identifier

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

reservation-id
required
string

ID of the reservation

Responses

200

External reservation proxy is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/externalreservationproxies/{reservation-id}

Production

https://external.apis.enfore.com/reservations/org/{org-id}/externalreservationproxies/{reservation-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}