API - Item Units | Wisefish API

Overview

The list page that contains the item units of measure codes.

Endpoint name	`itemUnits`
Source table	`Item Unit of Measure`
Fixed view	No filter
Requests allowed	GET, POST, PATCH, DELETE
Primary key	`itemNo, code`
Record ID	`systemId`
Procedures

Data

Field List

	Property	Type	Format	Description
1	`systemId`	string	uuid	SystemId	Record ID non-editable
2	`itemNo`	string	max 20	Item No.	primary key mandatory
3	`code`	string	max 10	Code	primary key mandatory
4	`qtyPerUnit`	number		Qty. per Unit of Measure	mandatory
5	`qtyRoundingPrecision`	number	decimal	Qty. Rounding Precision	optional
6	`height`	number	decimal	Height	optional
7	`width`	number	decimal	Width	optional
8	`length`	number	decimal	Length	optional
9	`systemRowVersion`	integer		System row version. Increments every time the record is modified.	non-editable
10	`lastModified`	string	date-time	SystemModifiedAt	non-editable

Object Example

JSON

{
    "systemId": "cd7e1ad7-9ea1-ef11-b017-aa2d6f3d6955",
    "itemNo": "0900",
    "code": "BOX",
    "qtyPerUnit": 10,
    "qtyRoundingPrecision": 0,
    "height": 0,
    "width": 0,
    "length": 0,
    "systemRowVersion": 2579012,
    "lastModified": "2024-11-13T09:13:54.54Z"
}

Examples

Read item units

Read the units of one item

Reads all units of measure of item 0900 with $filter (the response is shortened to one unit).

Request:

JSON

GET .../itemUnits?$filter=itemNo eq '0900'

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemUnits",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzE0NTY3ODkwMTIzNDU2Nzg5MDE7MDA7Jw==\"",
            "systemId": "cd7e1ad7-9ea1-ef11-b017-aa2d6f3d6955",
            "itemNo": "0900",
            "code": "BOX",
            "qtyPerUnit": 10,
            "qtyRoundingPrecision": 0,
            "height": 0,
            "width": 0,
            "length": 0,
            "systemRowVersion": 2579012,
            "lastModified": "2024-11-13T09:13:54.54Z"
        }
    ]
}

Read one item unit

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

Request:

JSON

GET .../itemUnits(cd7e1ad7-9ea1-ef11-b017-aa2d6f3d6955)

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemUnits/$entity",
    "@odata.etag": "W/\"JzE5OzE0NTY3ODkwMTIzNDU2Nzg5MDE7MDA7Jw==\"",
    "systemId": "cd7e1ad7-9ea1-ef11-b017-aa2d6f3d6955",
    "itemNo": "0900",
    "code": "BOX",
    "qtyPerUnit": 10,
    "qtyRoundingPrecision": 0,
    "height": 0,
    "width": 0,
    "length": 0,
    "systemRowVersion": 2579012,
    "lastModified": "2024-11-13T09:13:54.54Z"
}

Read selected properties of box units

Reads only the item number and quantity per unit of all BOX units, using $filter and $select (the response is shortened).

Request:

JSON

GET .../itemUnits?$filter=code eq 'BOX'&$select=itemNo,code,qtyPerUnit

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemUnits(itemNo,code,qtyPerUnit)",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzE0NTY3ODkwMTIzNDU2Nzg5MDE7MDA7Jw==\"",
            "itemNo": "0900",
            "code": "BOX",
            "qtyPerUnit": 10
        }
    ]
}

Create, change and delete item units

Create a new item unit

Adds the unit of measure PALLET, with 400 base units per pallet, to item 0900. The unit code must exist in the Units of Measure table.

Request:

JSON

POST .../itemUnits

Body:
{
    "itemNo": "0900",
    "code": "PALLET",
    "qtyPerUnit": 400
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemUnits/$entity",
    "@odata.etag": "W/\"JzIwOzE3MjM0NTY3ODkwMTIzNDU2Nzg5MTswMDsn\"",
    "systemId": "5b2c4e1a-7d3f-f011-b02a-8bca792786d1",
    "itemNo": "0900",
    "code": "PALLET",
    "qtyPerUnit": 400,
    "qtyRoundingPrecision": 0,
    "height": 0,
    "width": 0,
    "length": 0,
    "systemRowVersion": 2581901,
    "lastModified": "2025-12-18T14:21:07.113Z"
}

Change an item unit

Sets the dimensions of the BOX unit of item 0900. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

JSON

PATCH .../itemUnits(cd7e1ad7-9ea1-ef11-b017-aa2d6f3d6955)
If-Match: *

Body:
{
    "height": 0.15,
    "width": 0.3,
    "length": 0.4
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemUnits/$entity",
    "@odata.etag": "W/\"JzIwOzE4MjM0NTY3ODkwMTIzNDU2Nzg5MjswMDsn\"",
    "systemId": "cd7e1ad7-9ea1-ef11-b017-aa2d6f3d6955",
    "itemNo": "0900",
    "code": "BOX",
    "qtyPerUnit": 10,
    "qtyRoundingPrecision": 0,
    "height": 0.15,
    "width": 0.3,
    "length": 0.4,
    "systemRowVersion": 2581912,
    "lastModified": "2025-12-18T14:25:43.250Z"
}

Delete an item unit

Deletes the PALLET unit of item 0900. On success the response is empty (HTTP status 204 No Content).

JSON

DELETE .../itemUnits(5b2c4e1a-7d3f-f011-b02a-8bca792786d1)