API - Item Inventory | Wisefish Manuals

Overview

The API returns the inventory of Items. No data update allowed.

Endpoint name	`inventoryItems`
Source table	`Item`
Fixed view	No filter
Requests allowed	GET
Primary key	`number`
Record ID	`number`
Procedures	None

Data

Field List

	Property	Type	Max Len	Description
1	`number`	string	20	Item No.	Record ID
2	`description`	string	50	Item Description
3	`packageDescription`	string	30
4	`tradeItemType`	string		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
5	`locationFilter`	string	20
6	`inventory`	decimal
7	`baseUnitOfMeasure`	string	10
8	tradeItemInventory	decimal		add this when change is in version
9	`tradeItemUnitOfMeasure`	string	10

Example Object

JSON

{
    "@odata.etag": "W/\"JzE4OzExOTg3Mjk2Njc0NTg4MTcxNTE7MDA7Jw==\"",
    "number": "1.056",
    "description": "Carton sticker 95x100mm ",
    "packageDescription": "",
    "tradeItemType": " ",
    "locationFilter": "",
    "inventory": 14891,
    "baseUnitOfMeasure": "STK",
    "tradeItemUnitOfMeasure": ""
}

Usage

Inventory for specific Location

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

JSON

GET ../inventoryItems?$filter=locationFilter eq 'BLUE'

The response could be like below:

Expand to see the example json

JSON

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/b33a6a3b-244c-4295-84b3-0ad90823c736/AB_Test_191125/api/wisefish/base/v1.0/$metadata#companies(1691e98a-6a95-f011-b41a-6045bde126e9)/inventoryItems",
    "value": [
        {
            "@odata.etag": "W/\"JzE4OzExOTg3Mjk2Njc0NTg4MTcxNTE7MDA7Jw==\"",
            "number": "1.056",
            "description": "Carton sticker 95x100mm ",
            "packageDescription": "",
            "tradeItemType": " ",
            "locationFilter": "BLUE",
            "inventory": 14891,
            "baseUnitOfMeasure": "STK",
            "tradeItemUnitOfMeasure": ""
        },
        {
            "@odata.etag": "W/\"JzE5OzI1NzEzMDY1NjU5NDM1ODg4OTIxOzAwOyc=\"",
            "number": "1.057",
            "description": "Display sticker 23x32",
            "packageDescription": "",
            "tradeItemType": " ",
            "locationFilter": "BLUE",
            "inventory": 0,
            "baseUnitOfMeasure": "STK",
            "tradeItemUnitOfMeasure": ""
        },
        {
            "@odata.etag": "W/\"JzIwOzExODYyNTAwNTc4ODk2MDkwMjEzMTswMDsn\"",
            "number": "1000",
            "description": "Þorsklifur - ósnyrt",
            "packageDescription": "1 x 1",
            "tradeItemType": "Product",
            "locationFilter": "BLUE",
            "inventory": 2989.11,
            "baseUnitOfMeasure": "KG",
            "tradeItemUnitOfMeasure": "KAR"
        },
        {
            "@odata.etag": "W/\"JzIwOzE3NjQzNDM1Mjc5MDgxMjQ5NDMzMTswMDsn\"",
            "number": "1001",
            "description": "Afskurður - forsnyrting",
            "packageDescription": "1 x 0",
            "tradeItemType": "Product",
            "locationFilter": "BLUE",
            "inventory": 100,
            "baseUnitOfMeasure": "KG",
            "tradeItemUnitOfMeasure": "KAR"
        }
  ]
}