commerce
reservation

Retrieve a reservation

Changed on
get/commerce/{connection_id}/reservation/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/commerce/{connection_id}/reservation/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Reservation

Query parameters

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

(reference to CommerceLocation)

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sizenumber
status'PENDING' | 'CONFIRMED' | 'CANCELLED' | 'NO_SHOW' | 'COMPLETED'
guest_namestring
guest_phonestring
guest_emailstring
notesstring
item_idstring

(reference to CommerceItem)

item_namestring
staff_user_idstring

(reference to HrisEmployee)

staff_namestring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

urlstring
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status