Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Items

Get a list of custom items for a specific property.

get/item/v1/custom-items

Query parameters

limitinteger

The maximum number of items to return in the response. Default is 100.

offsetinteger

The number of items to skip before starting to collect the result set. Used for pagination.

This parameter should be formatted as a list of strings separated by ;

{
  "filters": {
    "and": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ],
    "or": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ]
  }
}

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Response

List of custom items.

totalinteger required

Total number of items

Example response

{
  "data": [
    {
      "id": "123456",
      "name": "Coffee",
      "propertyId": "123456",
      "sourceId": "123456",
      "sourceName": "Restaurant POS",
      "appItemId": "ITEM-001",
      "sku": "SKU123",
      "categoryName": "Beverages",
      "description": "Fresh brewed coffee"
    }
  ],
  "total": 100
}