Skip to main content

ItemApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
itemControllerAggregateIdGET /v1/item/{id}Get item data
itemControllerAggregateSearchGET /v1/itemSearch items by name
itemControllerGetSoldQuantityGET /v1/item/{id}/stockGet inventory of an item

itemControllerAggregateId

ItemClass itemControllerAggregateId(id, store_id)

Get item data

Parameters

NameTypeDescriptionNotes
idStringID of item[default to null]
store_idStringID of store[optional] [default to null]

Return type

ItemClass

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

itemControllerAggregateSearch

ItemsEntity itemControllerAggregateSearch(name, store_id, limit, offset)

Search items by name

Parameters

NameTypeDescriptionNotes
nameStringItem name search key, part of full name[optional] [default to null]
store_idStringFilter items via store ID[optional] [default to null]
limitBigDecimalThe number of record to return, 0 means all will be returned[optional] [default to null]
offsetBigDecimalThe number of records to skip[optional] [default to null]

Return type

ItemsEntity

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

itemControllerGetSoldQuantity

ItemInventoryEntity itemControllerGetSoldQuantity(id, order_date, order_time)

Get inventory of an item

Parameters

NameTypeDescriptionNotes
idStringID of item[default to null]
order_dateStringISO8601 compliant date string, defaults to current server date[optional] [default to null]
order_timeStringOrder time in HH
format, void (omitting it) means order is ASAP (current system, or nearest available time slot)
[optional] [default to null]

Return type

ItemInventoryEntity

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json