v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
commerce
reservation

List all reservations

get/commerce/{connection_id}/reservation

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

location_idstring

The location ID to filter by (reference to CommerceLocation)

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

item_idstring

The item ID to filter by (reference to CommerceItem)

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
location_idstring
start_atstring date-time
end_atstring date-time
sizenumber
status'PENDING' | 'CONFIRMED' | 'CANCELLED' | 'NO_SHOW' | 'COMPLETED'
guest_namestring
guest_phonestring
guest_emailstring
notesstring
item_idstring
item_namestring
staff_user_idstring
staff_namestring
created_atstring date-time
updated_atstring date-time
urlstring
rawobject