API - Trade Item Inventory | Wisefish Manuals

Overview

The API returns the inventory of items that are Trade Items. No data update is allowed.

Trade Items are items that have the field “Trade Item Type” populated. The options are:

Raw Material
WIP
Product

Endpoint name	`inventoryTradeItems`
Source table	`WiFi Open Trade Item`
Fixed view	The endpoint only lists item that are still in inventory, so to ensure that, there is a fixed filter on empty Closing Type: `"Closing Type" = filter(" "));`
Requests allowed	GET
Primary key	`stage, number`
Record ID	`systemId`
Procedures	None

Data

Field List

	Property	Type	Format	Description
1	`systemId`	string	uuid	They systemID of the entry.	Record ID
2	`stage`	string	max 20	Each trade item was created for a specific Stage.	primary key
3	`lineNo`	integer		Within each stage, the trade items are numbered with a sequential number.	primary key
4	`itemNo`	string	max 20	Every trade item is a unique “individual” of a standard BC item.
5	`description`	string	max 50	Description of the Trade Item.
6	`type`	string	enum	Blank if it is a standard item, if not blank, it is a “trade item”. Options: blank - standard item, can be used if it is not seafood, for example packaging Product Raw Material WIP - produced material that will be used as a consumption for products
7	`lot`	string	max 10
8	`itemDescription`	string	max 50	Description from the Item card.
9	`variantCode`	string	max 20	Every trade item is a unique “individual” of a standard BC item.
10	`packageDescription`	string	max 30
11	`locationCode`	string	max 20
12	`stockCenterCode`	string	max 20
13	`tradeItems`	number
14	`tradeItemUnitOfMeasure`	string	max 10
15	`tradeItemsBase`	number
16	`tradeItemBaseUnitOfMeasure`	string	max 10
17	`quantity`	number
18	`unitOfMeasure`	string	max 10
19	`quantityBase`	number
20	`qtyPerUnitOfMeasure`	number
21	`palletBarcode`	string	max 20
22	`palletNo`	string	max 20
23	`physicalPalletID`	string	max 20
24	`tradeItemBarcode`	string	max 22
25	`inventoryPosted`	boolean		Shows if this inventory has been fully posted to BC Item Ledger Entries
26	`holdStatus`	string	enum
27	`postingDateInbound`	string	date
28	`productionDate`	string	date
29	`expirationDate`	string	date
30	`zoneCode`	string	max 10
31	`binCode`	string	max 10
32	`lastModified`	string	date-time

Example Object

JSON

{
    "systemId": "e996b124-3003-f011-b01d-f992b2580806",
    "stage": "PRODUCTION",
    "lineNo": 64,
    "itemNo": "70064",
    "description": "Cod - raw material",
    "type": "Raw Material",
    "lot": "LOT0051",
    "itemDescription": "Cod - raw material",
    "variantCode": "SV-0002",
    "locationCode": "BLUE",
    "stockCenterCode": "BLA",
    "tradeItems": 500,
    "tradeItemUnitOfMeasure": "KG",
    "tradeItemsBase": 500,
    "tradeItemBaseUnitOfMeasure": "KG",
    "quantity": 500,
    "unitOfMeasure": "KG",
    "quantityBase": 500,
    "qtyPerUnitOfMeasure": 1,
    "palletBarcode": "",
    "palletNo": "",
    "physicalPalletID": "",
    "tradeItemBarcode": "",
    "status": "Posted in (BC inv.)",
    "holdStatus": " ",
    "postingDateInbound": "2025-03-17",
    "productionDate": "2025-03-17",
    "expirationDate": "0001-01-01",
    "zoneCode": "",
    "binCode": "",
    "lastModified": "2025-03-26T10:11:17.52Z"
}

Usage

Trade Items in stock on specific Location

To get the inventory on Location BLUE this request will do:

JSON

GET ../inventoryTradeItems?$filter=locationCode eq 'BLUE'