| Required permission: | POSMenuList-Enquiry.GET |
| GET | /POSMenus | ||
|---|---|---|---|
| GET | /POSMenus/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /POSMenus/AcPOSMenuID/{AcPOSMenuID} | Get record for given POS Menu ID | |
| GET | /POSMenus/AcLocationID/{AcLocationID} | Get all menus for given Location ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| AcPOSMenuID | path | string | No | POS Menu ID |
| AcLocationID | path | string | No | Location ID to retrieve POS Menu. Return all menus included unassigned location menus if not specified. |
| AcCompanyID | query | string | No | Company ID to retrieve POS Menu. Return all menus if AcCompanyID is not specified. |
| IsReturnImage | query | bool | No | Indicate whether to return image. Default: False |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| POSMenus | form | List<POSMenu> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Menu | form | AcPOSMenu | No | |
| MenuCategoryDetail | form | List<POSMenuCategoryDetail> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcPOSMenuID | form | NVARCHAR(20) | No | POS Menu ID |
| AcPOSMenuDesc | form | NVARCHAR(100) | No | POS Menu Description |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MenuCategoryAs | form | AcPOSMenuCategoryAs | No | |
| MenuCategoryItemAs | form | List<AcPOSMenuCategoryItemAs> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcPOSMenuCategoryAsID | form | NVARCHAR(40) | No | POS Menu Category Record ID |
| AcPOSMenuID | form | NVARCHAR(20) | No | POS Menu ID |
| AcPOSMenuCategoryID | form | NVARCHAR(20) | No | POS Menu Category ID |
| MenuPageNumber | form | INTEGER | No | Menu Page Number. Support up-to 5 pages for menu categories. Each page can consists of up-to 9 categories. |
| PositionInPage | form | INTEGER | No | Category position in a Menu Page. Possible possible value from 1 to 9. |
| AcPOSMenuDesc | form | NVARCHAR(100) | No | POS Menu Description |
| AcPOSMenuCategoryDesc | form | NVARCHAR(100) | No | POS Menu Category Description |
| EditDate | form | DATETIME | No | POS Menu Edit Date |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcPOSMenuCategoryItemAsID | form | NVARCHAR(40) | No | POS Menu Category Item Record ID |
| AcPOSMenuCategoryAsID | form | NVARCHAR(40) | No | POS Menu Category Record ID |
| AcPOSMenuID | form | NVARCHAR(20) | No | POS Menu ID |
| AcPOSMenuDesc | form | NVARCHAR(100) | No | POS Menu Description |
| AcPOSMenuCategoryID | form | NVARCHAR(20) | No | POS Menu Category ID |
| AcPOSMenuCategoryDesc | form | NVARCHAR(100) | No | POS Menu Category Description |
| ItemPageNumber | form | INTEGER | No | Item Page Number. Support up-to 3 pages for a category. Each page can consists 3 columns, each column up-to 8 items. |
| ItemPositionInPage | form | INTEGER | No | Item position in a Menu Category Page. Possible possible value from 1 to 24. 1st Column: 1 to 8; 2nd Column: 9 to 16; 3rd Column: 17 to 24. |
| StockBarcode | form | NVARCHAR(20) | No | Stock Barcode. |
| AcStockID | form | NVARCHAR(20) | No | Stock ID. |
| AcStockUOMID | form | NVARCHAR(20) | No | Stock UOM ID. |
| StockDescription1 | form | NVARCHAR(100) | No | Stock Desription 1. |
| StockDescription2 | form | NVARCHAR(100) | No | Stock Desription 2. |
| StockPosPrice | form | NUMERIC(18,2) | No | Stock POS Price. (POS Price by AcLocationID. Else it default as StockPrice1). |
| ImageDisplayBase64 | form | VARCHAR(MAX) | No | Stock Display Image in Base64 Encoding. |
| IsModifierItemFlow | form | NVARCHAR(1) | No | Is Modifier Item Flow? Y/N. Indicate whether current selected item should follow steps in Modifier Item Flow. If Y, follow the steps for items selection in List |
| AcPOSModifierGroupID01 | form | NVARCHAR(20) | No | POS Modifier Group ID - 01 |
| AcPOSModifierGroupDesc01 | form | NVARCHAR(100) | No | POS Modifier Group Description - 01 |
| ModifierGroupQty01 | form | INT | No | Quantity of POS Modifier Group ID - 01. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID02 | form | NVARCHAR(20) | No | POS Modifier Group ID - 02 |
| AcPOSModifierGroupDesc02 | form | NVARCHAR(100) | No | POS Modifier Group Description - 02 |
| ModifierGroupQty02 | form | INT | No | Quantity of POS Modifier Group ID - 02. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID03 | form | NVARCHAR(20) | No | POS Modifier Group ID - 03 |
| AcPOSModifierGroupDesc03 | form | NVARCHAR(100) | No | POS Modifier Group Description - 03 |
| ModifierGroupQty03 | form | INT | No | Quantity of POS Modifier Group ID - 03. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID04 | form | NVARCHAR(20) | No | POS Modifier Group ID - 04 |
| AcPOSModifierGroupDesc04 | form | NVARCHAR(100) | No | POS Modifier Group Description - 04 |
| ModifierGroupQty04 | form | INT | No | Quantity of POS Modifier Group ID - 04. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID05 | form | NVARCHAR(20) | No | POS Modifier Group ID - 05 |
| AcPOSModifierGroupDesc05 | form | NVARCHAR(100) | No | POS Modifier Group Description - 05 |
| ModifierGroupQty05 | form | INT | No | Quantity of POS Modifier Group ID - 05. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID06 | form | NVARCHAR(20) | No | POS Modifier Group ID - 06 |
| AcPOSModifierGroupDesc06 | form | NVARCHAR(100) | No | POS Modifier Group Description - 06 |
| ModifierGroupQty06 | form | INT | No | Quantity of POS Modifier Group ID - 06. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID07 | form | NVARCHAR(20) | No | POS Modifier Group ID - 07 |
| AcPOSModifierGroupDesc07 | form | NVARCHAR(100) | No | POS Modifier Group Description - 07 |
| ModifierGroupQty07 | form | INT | No | Quantity of POS Modifier Group ID - 07. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID08 | form | NVARCHAR(20) | No | POS Modifier Group ID - 08 |
| AcPOSModifierGroupDesc08 | form | NVARCHAR(100) | No | POS Modifier Group Description - 08 |
| ModifierGroupQty08 | form | INT | No | Quantity of POS Modifier Group ID - 08. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID09 | form | NVARCHAR(20) | No | POS Modifier Group ID - 09 |
| AcPOSModifierGroupDesc09 | form | NVARCHAR(100) | No | POS Modifier Group Description - 09 |
| ModifierGroupQty09 | form | INT | No | Quantity of POS Modifier Group ID - 09. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| AcPOSModifierGroupID10 | form | NVARCHAR(20) | No | POS Modifier Group ID - 10 |
| AcPOSModifierGroupDesc10 | form | NVARCHAR(100) | No | POS Modifier Group Description - 10 |
| ModifierGroupQty10 | form | INT | No | Quantity of POS Modifier Group ID - 10. If 0 mean open for selection; If greater than 0 mean Any of [x] quantity from the modifier group items list. |
| POSModifierGroup01ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 01 - Items |
| POSModifierGroup02ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 02 - Items |
| POSModifierGroup03ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 03 - Items |
| POSModifierGroup04ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 04 - Items |
| POSModifierGroup05ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 05 - Items |
| POSModifierGroup06ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 06 - Items |
| POSModifierGroup07ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 07 - Items |
| POSModifierGroup08ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 08 - Items |
| POSModifierGroup09ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 09 - Items |
| POSModifierGroup10ItemAs | form | List<AcPOSModifierGroupCompanyItem> | No | POS Modifier Group 10 - Items |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcPOSModifierGroupCompanyItemID | form | NVARCHAR(40) | No | POS Modifier Group Item Record ID |
| AcPOSModifierGroupID | form | NVARCHAR(20) | No | POS Modifier Group ID |
| StockBarcode | form | NVARCHAR(20) | No | Stock Barcode |
| ModifierItemIsStock | form | NVARCHAR(1) | No | Modifier Item is Stock? Y/N |
| ModifierItemDesc | form | NVARCHAR(100) | No | Modifier Item Description |
| ModifierItemPrice | form | NUMERIC(18,2) | No | Modifier Item Price |
| AcPOSModifierGroupDesc | form | NVARCHAR(100) | No | POS Modifier Group Description |
| AcStockID | form | NVARCHAR(20) | No | Stock ID. |
| AcStockUOMID | form | NVARCHAR(20) | No | Stock UOM ID. |
| StockDescription1 | form | NVARCHAR(100) | No | Stock Desription 1. |
| StockDescription2 | form | NVARCHAR(100) | No | Stock Desription 2. |
| ImageDisplayBase64 | form | VARCHAR(MAX) | No | Stock Display Image in Base64 Encoding. |
| EditDate | form | DATETIME | No | Edit Date Item |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /POSMenus HTTP/1.1 Host: snr2u.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
POSMenus:
[
{
Menu:
{
AcPOSMenuID: String,
AcPOSMenuDesc: String
},
MenuCategoryDetail:
[
{
MenuCategoryAs:
{
AcPOSMenuCategoryAsID: String,
AcPOSMenuID: String,
AcPOSMenuCategoryID: String,
MenuPageNumber: 0,
PositionInPage: 0,
AcPOSMenuDesc: String,
AcPOSMenuCategoryDesc: String,
EditDate: 0001-01-01
},
MenuCategoryItemAs:
[
{
AcPOSMenuCategoryItemAsID: String,
AcPOSMenuCategoryAsID: String,
AcPOSMenuID: String,
AcPOSMenuDesc: String,
AcPOSMenuCategoryID: String,
AcPOSMenuCategoryDesc: String,
ItemPageNumber: 0,
ItemPositionInPage: 0,
StockBarcode: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
StockPosPrice: 0,
ImageDisplayBase64: String,
IsModifierItemFlow: String,
AcPOSModifierGroupID01: String,
AcPOSModifierGroupDesc01: String,
ModifierGroupQty01: String,
AcPOSModifierGroupID02: String,
AcPOSModifierGroupDesc02: String,
ModifierGroupQty02: String,
AcPOSModifierGroupID03: String,
AcPOSModifierGroupDesc03: String,
ModifierGroupQty03: String,
AcPOSModifierGroupID04: String,
AcPOSModifierGroupDesc04: String,
ModifierGroupQty04: String,
AcPOSModifierGroupID05: String,
AcPOSModifierGroupDesc05: String,
ModifierGroupQty05: String,
AcPOSModifierGroupID06: String,
AcPOSModifierGroupDesc06: String,
ModifierGroupQty06: String,
AcPOSModifierGroupID07: String,
AcPOSModifierGroupDesc07: String,
ModifierGroupQty07: String,
AcPOSModifierGroupID08: String,
AcPOSModifierGroupDesc08: String,
ModifierGroupQty08: String,
AcPOSModifierGroupID09: String,
AcPOSModifierGroupDesc09: String,
ModifierGroupQty09: String,
AcPOSModifierGroupID10: String,
AcPOSModifierGroupDesc10: String,
ModifierGroupQty10: String,
POSModifierGroup01ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup02ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup03ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup04ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup05ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup06ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup07ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup08ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup09ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
],
POSModifierGroup10ItemAs:
[
{
AcPOSModifierGroupCompanyItemID: String,
AcPOSModifierGroupID: String,
StockBarcode: String,
ModifierItemIsStock: String,
ModifierItemDesc: String,
ModifierItemPrice: 0,
AcPOSModifierGroupDesc: String,
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
ImageDisplayBase64: String,
EditDate: 0001-01-01
}
]
}
]
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
TotalRecords: 0,
TotalRecordsInPage: 0
}