The set of Products that could be reserved can be limited. We call this group Reservable Products. You can get the details of Reservable Products and search within this group by this resource.
All available methods for resource reservable products.
| HTTP method | Endpoint | Description |
|---|---|---|
| [badge-blue GET] | /reservable-products | Collection of available reservable products |
| [badge-blue GET] | /reservable-products/{reservable_product_id} | Detail of reservable product |
Action method for resource reservable-products
| HTTP method | Endpoint | Description |
|---|---|---|
| [badge-blue POST] | /reservable-products/actions/search-reservable-products | Searching in reservable products |
Get the information as a list of reservable products
[badge-blue GET] /reservable-products
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| count | integer | The number of records to return. Default value is 100. |
No |
| offset | integer | The number of records from a collection to skip. Default value is 0. | No |
| sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
| sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
| name | string | Name of the reservable product | No |
| code | string | Code of the reservable product | No |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| reservable_products | Product[] | List of reservable products |
| total_items | integer | Count of all found reservable products |
Get information about a specific reservable product
[badge-blue GET] /reservable-products/{reservable_product_id}
| Parameter name | Type | Description |
|---|---|---|
| reservable_product_id | string | The unique id for the reservable product |
Status code: 200 OK
Output structure : Product
[badge-green POST] /reservable-products/actions/search-reservable-products
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| count | integer | The number of records to return. Default value is 100. |
No |
| offset | integer | The number of records from a collection to skip. Default value is 0. | No |
| sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
| sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
| Parameter name | Type | Description | Mandatory (Yes/No) |
|---|---|---|---|
| search_string | string | String used for searching the results | Yes |
Status code: 200 OK
Output structure : object
| Parameter name | Type | Description |
|---|---|---|
| search_results | SearchResult[] | List of the results |
| total_items | integer | Count of the results |