API - Production Items | Wisefish API

Overview

The API is a light-weight list of the items that are used in production: non-blocked items of trade item type Product or WIP that have no status (not On Hold or Quit). No data update allowed.

The endpoint is made to work fast: it has no child objects, no prices and no inventory or calculated figures. For all items use items, and for updating or for viewing details use itemDetails.

Endpoint name	`productionitems`
Source table	`Item`
Fixed view	Only items used in production: Blocked = No, Trade Item Type = Product or WIP, and Status = blank.
Requests allowed	GET
Primary key	`number`
Record ID	`number`
Child objects	None
Procedures	None

Data

Field List

	Property	Type	Format	Description
1	`systemId`	string	uuid	SystemId	non-editable
2	`number`	string	max 20	Item No.	Record ID primary key
3	`description`	string	max 100	Item Description
4	`description2`	string	max 50	Description 2
5	`packageDescriptionType`	string	enum	Options: blank Trade Item Irregular
6	`packageDescription`	string	max 30	Package Description
7	`tradeItemType`	string	enum	Trade Item Type. On this endpoint it is always one of: Product WIP - produced material that will be used as a consumption for products
8	`itemCategoryCode`	string	max 20	Item Category Code
9	`baseUnitOfMeasure`	string	max 10	Base Unit of Measure
10	`tradeItemUnitOfMeasure`	string	max 10	Trade Item Unit of Measure
11	`weightUnitOfMeasure`	string	max 10	Weight Unit of Measure
12	`palletUnitOfMeasure`	string	max 10	Pallet Unit of Measure

Object Example

JSON

{
    "systemId": "473e5d0f-f6a8-f011-b027-fa32451b10aa",
    "number": "70079",
    "description": "Cod fillets (3 kg box)",
    "description2": "Skinless, boneless",
    "packageDescriptionType": "Trade Item",
    "packageDescription": "1 x 3kg",
    "tradeItemType": "Product",
    "itemCategoryCode": "FISH",
    "baseUnitOfMeasure": "KG",
    "tradeItemUnitOfMeasure": "BOX",
    "weightUnitOfMeasure": "KG",
    "palletUnitOfMeasure": "PALLET"
}

Examples

The URLs below are relative to .../api/wisefish/base/v1.0/companies([company-id])/.

Read production items

Read all production items

Reads all items used in production. The response is a list of objects, as shown in Object Example.

JSON

GET .../productionitems

Read one production item

Reads one item by its Record ID (number). The response is one item object.

Request:

JSON

GET .../productionitems('70079')

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/productionitems/$entity",
    "@odata.etag": "W/\"JzE5OzEyMzQ1Njc4OTAxMjM0NTY3ODkwOzAwOyc=\"",
    "systemId": "473e5d0f-f6a8-f011-b027-fa32451b10aa",
    "number": "70079",
    "description": "Cod fillets (3 kg box)",
    "description2": "Skinless, boneless",
    "packageDescriptionType": "Trade Item",
    "packageDescription": "1 x 3kg",
    "tradeItemType": "Product",
    "itemCategoryCode": "FISH",
    "baseUnitOfMeasure": "KG",
    "tradeItemUnitOfMeasure": "BOX",
    "weightUnitOfMeasure": "KG",
    "palletUnitOfMeasure": "PALLET"
}

Read WIP items in an item category

Returns all production items of trade item type WIP in the item category FISH:

JSON

GET .../productionitems?$filter=tradeItemType eq 'WIP' and itemCategoryCode eq 'FISH'

Read selected properties of production items

Reads only the number, description and trade item unit of products, using $filter and $select (the response is shortened).

Request:

JSON

GET .../productionitems?$filter=tradeItemType eq 'Product'&$select=number,description,tradeItemUnitOfMeasure

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/productionitems(number,description,tradeItemUnitOfMeasure)",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzEyMzQ1Njc4OTAxMjM0NTY3ODkwOzAwOyc=\"",
            "number": "70079",
            "description": "Cod fillets (3 kg box)",
            "tradeItemUnitOfMeasure": "BOX"
        }
    ]
}