API - Inventory Trade Items

Overview

The API returns the inventory of items that are Trade Items. Every trade item is a unique “individual” of a standard BC item.

No data update is allowed.

Data

Field List

Object Example

{
    "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",
    "pieces": 0,
    "locationCode": "BLUE",
    "stockCenterCode": "BLA",
    "tradeItemsBase": 500,
    "tradeItemBaseUnitOfMeasure": "KG",
    "tradeItems": 500,
    "tradeItemUnitOfMeasure": "KG",
    "quantityBase": 500,
    "baseUnitOfMeasure": "KG",
    "quantity": 500,
    "unitOfMeasure": "KG",
    "qtyPerUnitOfMeasure": 1,
    "weight": 500,
    "weightUnitOfMeasure": "Kg",
    "palletBarcode": "",
    "palletNo": "",
    "physicalPalletID": "",
    "tradeItemBarcode": "",
    "status": "Posted in (BC inv.)",
    "holdStatus": " ",
    "reservedToDocumentType": "Delivery",
    "reservedToDocumentNo": "",
    "postingDateInbound": "2025-03-17",
    "productionDate": "2025-03-17",
    "expirationDate": "0001-01-01",
    "zoneCode": "",
    "binCode": "",
    "mesTransactionId": 0,
    "systemRowVersion": 2584102,
    "lastModified": "2025-03-26T10:11:17.52Z"
}

Procedures

Procedures are called on a specific trade item: POST inventoryTradeItems(<systemId>)/Microsoft.NAV.<procedureName> with a JSON body of parameters. Each procedure returns a text message on success. On failure it returns an error with a readable message.

Palletizing

Add a Trade Item to a Pallet

Procedure addToPallet adds this open trade item to an existing pallet, identified by the pallet barcode.

POST
.../inventoryTradeItems([record-id])/Microsoft.NAV.addToPallet

Body:
{
    "setPalletBarcode" : [barcode of an existing pallet]
}

Possible errors, in the order they are checked:

• The trade item given by the record ID in the URL does not exist (standard Business Central error).

• The pallet does not exist: Pallet with barcode <barcode> does not exist.

• The trade item is already on another pallet: Trade Item <Stage>-<Line No.> is already on pallet with barcode <Current Pallet Barcode> and cannot be added to pallet <Pallet No.>.
  This procedure does not move a trade item from another pallet. Remove it first with removeFromPallet, or use pallets procedure addTradeItem, which moves it.

• The reservation of the trade item and the pallet differ (also when the pallet is reserved and the trade item is not reserved to the same agreement): Trade Item <Stage>-<Line No.> and pallet <Pallet No.> have different reservations. The trade item cannot be added to the pallet.

• The status of the pallet (Full or Reserved) does not allow adding trade items: Pallet <Pallet No.> has status <Status> that does not allow adding trade items.

• The item does not match the key item of the pallet (when the Pallet Mixing setting of the key item does not allow item mixing): Trade Item <Stage>-<Line No.> has item <Item No.>, which does not match key item <Key Item No.> on pallet <Pallet No.>.

• The lot does not match the lot on the pallet (when the Pallet Mixing setting of the key item does not allow lot mixing): Trade Item <Stage>-<Line No.> has lot <Lot>, which does not match lot <Lot> on pallet <Pallet No.>.

Behaviour notes:

• The pallet barcode must be given exactly as it is stored on the pallet (the barcode is not zero-padded).

• The trade item gets the pallet no., physical pallet ID, bin code and loading information (loaded, loading date-time, scheduled trip, transport unit) of the pallet.

• If the pallet is Empty, it gets status Open. If the pallet has no key item, the item of the trade item becomes the key item. If the pallet has a maximum number of trade items and it is exceeded, the pallet gets status Full.

• If the trade item is reserved and the pallet is not, the reservation of the trade item is copied to the pallet.

Remove a Trade Item from a Pallet

Procedure removeFromPallet removes this trade item from the given pallet.

POST
.../inventoryTradeItems([record-id])/Microsoft.NAV.removeFromPallet

Body:
{
    "setPalletBarcode" : [barcode of the pallet the trade item is on]
}

Possible errors, in the order they are checked:

• The trade item given by the record ID in the URL does not exist (standard Business Central error).

• The pallet does not exist: Pallet with barcode <barcode> does not exist.

• The trade item is not on the given pallet: Trade Item <Stage>-<Line No.> is not on pallet <Pallet No.>.

Behaviour notes:

• The pallet barcode must be given exactly as it is stored on the pallet (the barcode is not zero-padded).

• The pallet no., pallet barcode and physical pallet ID are cleared on the trade item, and a pallet history entry is created for it.

• If trade items are still on the pallet, the pallet gets status Open (also if it was Full).

Splitting

Split Trade Items

Procedure splitTradeItems splits this open trade item in two. The quantity is given in the Trade Item Unit of Measure of the item, so the item must have a Trade Item Unit of Measure. The current trade item keeps the given number of trade items, and the rest is moved to a new open trade item with a new line no. The split is posted in the trade item ledger.

POST
.../inventoryTradeItems([record-id])/Microsoft.NAV.splitTradeItems

Body:
{
    "setTradeItems" : [number of trade items to keep on the current trade item]
}

Possible errors, in the order they are checked:

• The trade item given by the record ID in the URL does not exist (standard Business Central error).

• The item has no Trade Item Unit of Measure on the Item card (standard Business Central error: field WiFi TI Unit of Measure must have a value).

• The user has no User Setup, no User Profile Code in User Setup, or the User Profile does not exist (standard Business Central error).

• The trade item is on a pallet and the User Profile of the user does not allow splitting from a pallet: User Profile <User Profile Code> does not allow you to split from a pallet (<Pallet Barcode>).

• The Item Unit of Measure is missing, or has no Qty. per Unit of Measure, for the units used in the conversion (standard Business Central error).

• More trade items are given than available: Cannot split more trade items than available on the current open trade item.

• Errors from posting the split in Wisefish (standard Wisefish/Business Central errors).

Behaviour notes:

• The weight fields stay zero on the new trade item if they are zero on the current trade item.

Split by Quantity and Unit

Procedure split works the same way as splitTradeItems, but the quantity can be given in any unit of measure of the item. The current trade item keeps the given quantity, and the rest is moved to a new open trade item.

POST
.../inventoryTradeItems([record-id])/Microsoft.NAV.split

Body:
{
    "setQuantity" : [quantity to keep on the current trade item],
    "setUnit" : [a unit of measure of the item]
}

Possible errors, in the order they are checked:

• The trade item given by the record ID in the URL does not exist (standard Business Central error).

• The unit is not a unit of measure of the item: The specified unit of measure <Unit> is not valid for item <Item No.>.

• The user has no User Setup, no User Profile Code in User Setup, or the User Profile does not exist (standard Business Central error).

• The trade item is on a pallet and the User Profile of the user does not allow splitting from a pallet: User Profile <User Profile Code> does not allow you to split from a pallet (<Pallet Barcode>).

• The item has no Trade Item Unit of Measure, or a unit has no Qty. per Unit of Measure (standard Business Central error).

• More is given than available: Cannot split more trade items than available on the current open trade item.

• The same errors as for splitTradeItems, such as splitting more than is available, or splitting from a pallet when the User Profile does not allow it.

• Errors from posting the split in Wisefish (standard Wisefish/Business Central errors).

Behaviour notes:

• The quantity is converted from setUnit to the base unit and to the Trade Item Unit of Measure of the item (rounded to 0.00001), and then split the same way as with splitTradeItems.

Examples

Read trade items

Trade Items in stock on specific Location

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

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

Read a single trade item

Reads one trade item by its Record ID (systemId). The response is one trade item object, as shown in Object Example.

GET .../inventoryTradeItems(e996b124-3003-f011-b01d-f992b2580806)

Read the trade items on a pallet

Reads all trade items in stock on the pallet with barcode 00050000000000001101.

GET .../inventoryTradeItems?$filter=palletBarcode eq '00050000000000001101'

Read trade items that are not on a pallet

Reads the trade items on Location BLUE that are not on any pallet (empty pallet barcode).

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

Read trade items of an item and lot

Reads the trade items of item 70064 with lot LOT0051, and returns only a few fields with $select.

GET .../inventoryTradeItems?$filter=itemNo eq '70064' and lot eq 'LOT0051'&$select=stage,lineNo,tradeItems,tradeItemUnitOfMeasure,palletBarcode

Palletize trade items

Add trade item PRODUCTION-64 to a pallet

Adds trade item PRODUCTION-64 to pallet 00050000000000001101 (pallet no. 000000000110) using addToPallet.

POST .../inventoryTradeItems(e996b124-3003-f011-b01d-f992b2580806)/Microsoft.NAV.addToPallet
{
    "setPalletBarcode": "00050000000000001101"
}

Response:
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Trade Item PRODUCTION-64 added to pallet 000000000110."
}

Add a trade item that is already on the pallet

Calls addToPallet again for trade item PRODUCTION-64, which is already on the pallet. This is not an error.

Request:

POST
.../inventoryTradeItems(e996b124-3003-f011-b01d-f992b2580806)/Microsoft.NAV.addToPallet

Body:
{
    "setPalletBarcode" : "00050000000000001101"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Trade Item PRODUCTION-64 is already on this pallet 000000000110."
}

Remove trade item PRODUCTION-64 from a pallet

Removes trade item PRODUCTION-64 from pallet 00050000000000001101 using removeFromPallet.

POST .../inventoryTradeItems(e996b124-3003-f011-b01d-f992b2580806)/Microsoft.NAV.removeFromPallet
{
    "setPalletBarcode": "00050000000000001101"
}

Response:
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Trade Item PRODUCTION-64 removed from pallet 000000000110."
}

Split a trade item

Keep 200 trade items and split off the rest

Trade item PRODUCTION-64 has 500 KG. With splitTradeItems, 200 stay on it and 300 are moved to a new trade item.

POST .../inventoryTradeItems(e996b124-3003-f011-b01d-f992b2580806)/Microsoft.NAV.splitTradeItems
{
    "setTradeItems": 200
}

Response:
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Split successfully posted"
}

Keep 200 KG and split off the rest

The same split with split, where the quantity is given with a unit of measure.

POST .../inventoryTradeItems(e996b124-3003-f011-b01d-f992b2580806)/Microsoft.NAV.split
{
    "setQuantity": 200,
    "setUnit": "KG"
}

Response:
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Split successfully posted"
}