3.12. List of items
Connection URL
| TEST URL | http://nap.dev.icash.bg/clientapi/v1/get-sale-items |
| ( AL ) PRODUCTION URL | http://v1.icash.al/clientapi/v1/get-sale-items |
| ( BG ) PRODUCTION URL | https://v5.icash.bg/clientapi/v1/get-sale-items |
POST REQUEST
| Param | Description | Field type | Зад./Сорт. |
| api_key | API Key | String | YES |
| nonce | Nonce | Integer | YES |
| signature | Signature | String | YES |
| ses | Session indentificator | String | YES |
| StoreID | Store ID | Integer | No/YES |
| SaleItemID | Item Indentificator | Integer | No/YES |
| SaleItemInventoryID | Inventory number | String(20) | No/YES |
| SaleItemBarcode | Barcode | String(20) | No/YES |
| SaleItemName | Name of item | String(100) | No/YES |
| SaleItemType | Type of item | ENUM(PRODUCT, SERVICE) | No/YES |
| SaleItemCashRegisterName | Name of item for POS | String(100) | No/YES |
| SaleItemStatus | Status of item | ENUM(Normal, Deleted) | No/YES |
| sort | Sort field | String | No |
| order | Order type | ENUM(ASC,DESC)
Default ASC |
No |
| offset | Offset | Integer
Default 0 |
No |
| count | Count | Integer(MAX 100)
Default 10 |
No |
JSON response on success
| Param | Description | Field type | Required |
| nonce | Nonce from request | Integer | YES |
| status | Request status | Integer
1 – successful |
YES |
| data | Result | result | YES |
Structure of type “result”
| Param | Description | Field type | Required |
| TotalRecords | Count of total records | Integer | YES |
| Data | Array of items | Array of saleitem | YES |
Structure of type “saleitem”
| Param | Description | Field type | Required |
| SaleItemID | Indentificator | Integer | YES |
| SaleItemBarcodeBarcode | Barcode | String(20) | YES |
| SaleItemInventoryID | Inventory number | String(20) | YES |
| SaleItemName | Item name | String(100) | YES |
| SaleItemCashRegisterName | Item name for POS | String(100) | YES |
| SaleItemType | Item type | ENUM(PRODUCT, SERVICE) | YES |
| SaleItemPrimaryMeasureUnitID | Unit measure Indentificator | Integer | YES |
| SaleItemTaxGroupID | Tax group Indentificator | Integer | YES |
| SaleItemSellPrice | Sale price | DECIMAL(14,6) | YES |
| SaleItemForbidSupplements | Forbid delivery | ENUM(0,1)
Default 0 |
YES |
| SaleItemForbidSales | Forbid sale | ENUM(0,1)
Default 0 |
YES |
| SaleItemForbidRefund | Forbid return | ENUM(0,1)
Default 0 |
YES |
| SaleItemStatus | Status | ENUM(Normal, Deleted) | YES |
| SaleItemComment | Comment | TEXT | YES |
| SaleItemGroupName | Item Groups name | TEXT | YES |
| SaleItemGroupID | Item Groups ID | TEXT | YES |
Example:
| { „nonce“: „1553005354“, „status“: 1, „data“: { „TotalRecords“: 23672, „Data“: [ { „SaleItemID“: 36913, „SaleItemBarcodeBarcode“: „8411061071809“, „SaleItemInventoryID“: „1“, „SaleItemName“: „item 1 „, „SaleItemCashRegisterName“: „Item 1“, „SaleItemType“: „PRODUCT“, „SaleItemPrimaryMeasureUnitID“: 1, „SaleItemTaxGroupID“: 2, „SaleItemSellPrice“: „66.600000“, „SaleItemForbidSupplements“: 1, „SaleItemForbidSales“: 1, „SaleItemForbidRefund“: 1, „SaleItemStatus“: „Normal“, „SaleItemComment“: „“, „SaleItemGroupName“: „group1, group2“, „SaleItemGroup”:”1,2” }, { „SaleItemID“: 36914, „SaleItemBarcodeBarcode“: „8411061256879“, „SaleItemInventoryID“: „2“, „SaleItemName“: „Item 2“, „SaleItemCashRegisterName“: „item 2“, „SaleItemType“: „PRODUCT“, „SaleItemPrimaryMeasureUnitID“: 1, „SaleItemTaxGroupID“: 2, „SaleItemSellPrice“: „105.770000“, „SaleItemForbidSupplements“: 0, „SaleItemForbidSales“: 0, „SaleItemForbidRefund“: 0, „SaleItemStatus“: „Normal“, „SaleItemComment“: „“, „SaleItemGroupName“: null, „SaleItemGroupID“: null } ] } } |
JSON response on unsuccess
| Param | Description | Field type | Required |
| nonce | Nonce from request | Integer | YES |
| status | Request status | Integer
0 – unsuccess request |
YES |
| error_message | Error Description | String | YES |
Example:
| { „nonce“: „1552990901“, „status“: 0, „error_message“: „Session expired“ } |