Breadcrumbs

API - Items


Overview

The is a light-weight list of Items. No data update allowed. For updating or for viewing details use itemDetails.

Endpoint name

items

Source table

Item

Fixed view

The pages has a fixed filter on non-blocked items.

Requests allowed

GET

Primary key

number

Record ID

number

Procedures

None


Data

Field List

Property

Type

Format

Description


1

systemId

string

uuid



2

number

string

max 20

Item No.

Record ID

primary key

3

description

string

max 50

Item Description


4

packageDescriptionType

string

enum

Options:

  • blank

  • Trade Item

  • Irregular


5

packageDescription

string

max 30



6

tradeItemType

string

enum

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


7

itemCategoryCode

string

max 20



8

rawMaterialReportingCode

string

max 10



9

inventoryPostingGroup

string

max 20



10

status

string

enum

Options:

  • blank

  • On Hold

  • Quit


11

baseUnitOfMeasure

string

max 10

Base Unit of Measure


12

tradeItemUnitOfMeasure

string

max 10



13

palletUnitOfMeasure

string

max 10



14

weightUnitOfMeasure

string

max 10



15

unitPrice

number




16

priceIncludesTax

boolean




17

unitCost

number




18

lastModified

string

date-time



Example Object

JSON
{
    "number": "70079",
    "systemId": "473e5d0f-f6a8-f011-b027-fa32451b10aa",
    "description": "Cod fillets (3 kg box)",
    "packageDescriptionType": "Trade Item",
    "packageDescription": "1 x 3kg",
    "tradeItemType": "Product",
    "itemCategoryCode": "",
    "rawMaterialReportingCode": "001",
    "inventoryPostingGroup": "RESALE",
    "status": " ",
    "baseUnitOfMeasure": "KG",
    "tradeItemUnitOfMeasure": "BOX",
    "palletUnitOfMeasure": "PALLET",
    "weightUnitOfMeasure": "KG",
    "unitPrice": 0,
    "priceIncludesTax": false,
    "unitCost": 0,
    "lastModified": "2025-12-17T16:22:57.803Z"
}

Usage

The following are just some examples of usage.

Read all entries

JSON
GET
.../items

Read all entries with a filter

JSON
GET
.../items?$filter=itemCategoryCode eq 'FISH'

This request would return all Items in the Item Category called FISH.