API - Item Variants | Wisefish API

Overview

The list page that contains the item variants.

Endpoint name	`itemVariants`
Source table	`Item Variant`
Fixed view	No filter
Requests allowed	GET, POST, PATCH, DELETE
Primary key	`itemNo, code`
Record ID	`systemId`
Procedures	None

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 of this variant	primary key mandatory
4	`description`	string		Description of this variant	recommended
5	`tradeItemUnitOfMeasure`	string	max 10	Trade Item unit of measure for this variant.	mandatory
6	`qualityGrade`	string	max 10	Quality Grade	optional
7	`sizeGrade`	string	max 10	Size Grade	optional
8	`itemId`	string	uuid	The systemId of the Item. This is shown here to make possible to use the standard API for Item. Can be used instead of itemNo when inserting.	optional
9	`itemType`	string		Trade Item Type. Inherited from the Item card. Options: RawMat, WIP and Product	non-editable
10	`systemRowVersion`	integer		System row version. Increments every time the record is modified.	non-editable
11	`lastModified`	string	date-time	SystemModifiedAt	non-editable

Object Example

JSON

{
    "systemId": "824110c9-4c03-f011-b01d-ffa54ac57a8e",
    "itemNo": "70070",
    "itemId": "e3fe3205-4903-f011-b01d-ffa54ac57a8e",
    "code": "SV-0003",
    "description": "Size group: Big",
    "itemType": "Raw Material",
    "tradeItemUnitOfMeasure": "KG",
    "qualityGrade": "",
    "sizeGrade": "BIG",
    "systemRowVersion": 2580455,
    "lastModified": "2025-05-06T10:25:34.5Z"
}

Examples

Read item variants

Read the variants of one item

Reads all variants of item 70070 with $filter (the response is shortened to one variant).

Request:

JSON

GET .../itemVariants?$filter=itemNo eq '70070'

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemVariants",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzEzNTc5MjQ2ODAxMzU3OTI0NjgxOzAwOyc=\"",
            "systemId": "824110c9-4c03-f011-b01d-ffa54ac57a8e",
            "itemNo": "70070",
            "itemId": "e3fe3205-4903-f011-b01d-ffa54ac57a8e",
            "code": "SV-0003",
            "description": "Size group: Big",
            "itemType": "Raw Material",
            "tradeItemUnitOfMeasure": "KG",
            "qualityGrade": "",
            "sizeGrade": "BIG",
            "systemRowVersion": 2580455,
            "lastModified": "2025-05-06T10:25:34.5Z"
        }
    ]
}

Read one item variant

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

Request:

JSON

GET .../itemVariants(824110c9-4c03-f011-b01d-ffa54ac57a8e)

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemVariants/$entity",
    "@odata.etag": "W/\"JzE5OzEzNTc5MjQ2ODAxMzU3OTI0NjgxOzAwOyc=\"",
    "systemId": "824110c9-4c03-f011-b01d-ffa54ac57a8e",
    "itemNo": "70070",
    "itemId": "e3fe3205-4903-f011-b01d-ffa54ac57a8e",
    "code": "SV-0003",
    "description": "Size group: Big",
    "itemType": "Raw Material",
    "tradeItemUnitOfMeasure": "KG",
    "qualityGrade": "",
    "sizeGrade": "BIG",
    "systemRowVersion": 2580455,
    "lastModified": "2025-05-06T10:25:34.5Z"
}

Read selected properties of variants in a size grade

Reads only the item number, code and description of all variants with size grade BIG, using $filter and $select (the response is shortened).

Request:

JSON

GET .../itemVariants?$filter=sizeGrade eq 'BIG'&$select=itemNo,code,description

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemVariants(itemNo,code,description)",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzEzNTc5MjQ2ODAxMzU3OTI0NjgxOzAwOyc=\"",
            "itemNo": "70070",
            "code": "SV-0003",
            "description": "Size group: Big"
        }
    ]
}

Create, change and delete item variants

Create a new item variant

Creates the variant SV-0004 for item 70070. The item type (itemType) is inherited from the item, and itemId is filled in from the item.

Request:

JSON

POST .../itemVariants

Body:
{
    "itemNo": "70070",
    "code": "SV-0004",
    "description": "Size group: Small",
    "tradeItemUnitOfMeasure": "KG",
    "sizeGrade": "SMALL"
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemVariants/$entity",
    "@odata.etag": "W/\"JzIwOzE5MjM0NTY3ODkwMTIzNDU2Nzg5MzswMDsn\"",
    "systemId": "9c2a7f31-1e3f-f011-b02a-8bca792786d1",
    "itemNo": "70070",
    "itemId": "e3fe3205-4903-f011-b01d-ffa54ac57a8e",
    "code": "SV-0004",
    "description": "Size group: Small",
    "itemType": "Raw Material",
    "tradeItemUnitOfMeasure": "KG",
    "qualityGrade": "",
    "sizeGrade": "SMALL",
    "systemRowVersion": 2581930,
    "lastModified": "2025-12-18T14:40:12.367Z"
}

Change an item variant

Changes the description of variant SV-0003 of item 70070. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

JSON

PATCH .../itemVariants(824110c9-4c03-f011-b01d-ffa54ac57a8e)
If-Match: *

Body:
{
    "description": "Size group: Big (over 5 kg)"
}

Response:

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#itemVariants/$entity",
    "@odata.etag": "W/\"JzIwOzIwMjM0NTY3ODkwMTIzNDU2Nzg5NDswMDsn\"",
    "systemId": "824110c9-4c03-f011-b01d-ffa54ac57a8e",
    "itemNo": "70070",
    "itemId": "e3fe3205-4903-f011-b01d-ffa54ac57a8e",
    "code": "SV-0003",
    "description": "Size group: Big (over 5 kg)",
    "itemType": "Raw Material",
    "tradeItemUnitOfMeasure": "KG",
    "qualityGrade": "",
    "sizeGrade": "BIG",
    "systemRowVersion": 2581936,
    "lastModified": "2025-12-18T14:44:51.020Z"
}

Delete an item variant

Deletes variant SV-0004 of item 70070. On success the response is empty (HTTP status 204 No Content).

JSON

DELETE .../itemVariants(9c2a7f31-1e3f-f011-b02a-8bca792786d1)