ItemApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| itemControllerAggregateId | GET /v1/item/{id} | Get item data |
| itemControllerAggregateSearch | GET /v1/item | Search items by name |
| itemControllerGetSoldQuantity | GET /v1/item/{id}/stock | Get inventory of an item |
itemControllerAggregateId
ItemClass itemControllerAggregateId(id, store_id)
Get item data
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | ID of item | [default to null] |
| store_id | String | ID of store | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
itemControllerAggregateSearch
ItemsEntity itemControllerAggregateSearch(name, store_id, limit, offset)
Search items by name
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | Item name search key, part of full name | [optional] [default to null] |
| store_id | String | Filter items via store ID | [optional] [default to null] |
| limit | BigDecimal | The number of record to return, 0 means all will be returned | [optional] [default to null] |
| offset | BigDecimal | The number of records to skip | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
itemControllerGetSoldQuantity
ItemInventoryEntity itemControllerGetSoldQuantity(id, order_date, order_time)
Get inventory of an item
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | ID of item | [default to null] |
| order_date | String | ISO8601 compliant date string, defaults to current server date | [optional] [default to null] |
| order_time | String | Order time in HH format, void (omitting it) means order is ASAP (current system, or nearest available time slot) | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json