commerce
availability

List all availabilities

Changed on
get/commerce/{connection_id}/availability

Request

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

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)

sizestring

Filter by party size (dining)

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

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
item_idstring

(reference to CommerceItem)

staff_user_idstring

(reference to HrisEmployee)

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

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status