Thetis IMS
Datakatalog

Trade item

A trade item is a description of a specific object that you purchase, sell and stock. A trade item contains a given quantity of a given product. Trade items containing the same product may contain different variants of the product.

GlobalTradeItem

Constraints

You must supply either the id or the number of a product.

Fields

Id

The brand's unique identification across subscriptions and territories.

id Long Read only

GTIN

The trade items unique identification across all countries and systems. It is typically this number that is encoded in the barcodes used for labeling the item. The value of this field must be unique within the area. Read more on Wikipedia under 'Global Trade Item Number'.

globalTradeItemNumber String Length 0 to 36 Pattern \S*

SKU

Number as this variant of the product is stored below.

stockKeepingUnit String Unique Not Blank Pattern [^\t^\n^\x0B^\f^\r]* Length 1 to 36

Variant

Description of this trade item as a variant of the product.

productVariantKey ProductVariantKey

Qty each

Quantity of the product contained in one piece of the trade item. The quantity is specified in the unit that is applicable to the product.

numUnitsContained Long Not Null Min 1

Dimensions

The circumscribed dimensions of one piece of the trade item. All measures are in meters.

dimensions Dimensions

Weight

Net weight of one piece of the trade item stated in kilograms.

weight BigDecimal Min 0.000 Max 999999.999

Volume

Volume of one piece of merchandise indicated in liters.

volume BigDecimal Min 0.000 Max 999999.999

Product number

The number of the product that this trade item contains.

productNumber String Length 1 to 36 Product

Product ID

Unique identification of the product contained in this trade item.

productId Long Product

Product name

The name of the product that this trade item contains.

productName String Read only

Product group id

Unique identification of the product group that the product contained in the trade item belongs to.

productGroupId Long Read only ProductGroup

Product group

Name of the product group that the product contained in this trade item belongs to.

productGroupName String Read only

Product unit

Unit used for measuring the product contained in this trade item.

productUnit ProductUnit Read only

Std. cost price

Cost price used in standard pricing.

standardCostPrice BigDecimal Min 0.000000 Max 999999.999999

Replenish level

Specifies the stock level to trigger a replenishment of the item's picking location.

replenishLevel Long Min 1 Max 9999999

Excess delivery limit

The percentage allowed for the supplier to hand over with.

overdeliveryTolerance BigDecimal Min 0.00 Max 100.00

Business item no.

The number agreed for this item within the business.

businessItemNumber String

Pick location id

Unique identification of the location where this item is to be picked.

locationId Long Location

Pick location

The number of the location to which this item is to be picked.

locationNumber String Location

Category Name

The name of the product category that this product belongs to.

itemCategoryName String ItemCategory

Sellable stock

The current inventory of this item with status 'Salgbar'

numItemsSaleable Long Read only

Total qty

The total qty on stock across all statuses.

numItems Long Read only

Qty posted

Quantity posted and hence included in the inventory value.

numItemsPosted Long Read only

Stock value

Value of the lots currently in hand.

value BigDecimal Read only

Pickable stock

The current marketable inventory of this item at the picking location.

numItemsPickable Long Read only

Qty reserved

Number of items from the current inventory reserved.

numItemsReserved Long Read only

Qty available

The number available for sale. That is, the number in stock minus the amount already sold.

numItemsAvailable Long Read only

Stocked

Specifies whether the item is stocked.

stocked Boolean Not Null

Available

Indicates whether a non-stocked item is available.

available Boolean Not Null

Cross-dock

Indicates whether this item must be cross-docked and packed along with other items. This field is only relevant for non-stocked items. The fields is used when new shipment lines are created. Changing the value does not have any effect on existing shipment lines.

crossDock Boolean Not Null

Active

Specifies whether the item is active. It is possible to make goods inactive if there is no stock on them.

active Boolean Not Null

Old at (days)

When are lots containing this trade item considered old?

oldWhenAgeInDaysExceeds Integer

HS Code

Harmonized system code of the product contained in this trade item.

harmonizedSystemCode String Read only

Context id

Unique identification of the area within which this trade item is created.

contextId Long Context

Bundle components

List of other items that forms part of this item by bundling.

bundleComponents List BundleComponent

Buffer Locations

Patterns that designate the reserve locations that may be used for storing this product.

bufferLocationPatterns List BufferLocationPattern

Included items

List of items that are always included with this item.

includedItems List IncludedItem

Logistic variants

Variants of this item that is only distinguished by the number of item contained.

logisticVariants List LogisticVariant

Season

Season of the product contained in this trade item.

season String Read only

Product line

Product line of the product contained in this trade item.

productLine String Read only

Brand

Brand of the product contained in this trade item.

brand String Read only

Design

Design of the product contained in this trade item.

design String Read only

Re-order allowed

Indicates whether re-ordering of this item is allowed.

reorderingAllowed Boolean Not Null

Re-order level

Re-order this item when the total stock in hand falls below this level.

reorderLevel Long Min 1

Order up to level

Order a quantity that makes the total stock in hand surpass this level.

orderUpToLevel Long Min 1

Replenish to level

The level that must be pickable after replenishing.

replenishUpToLevel Long Min 1

Order qty.

Quantity recommended to order of this item.

numItemsToOrder Long Min 1

Data document

JSON document containing additional information about this trade item.

dataDocument String JSON

Filter

SKU

Expressions like the SKU of the item should match to the item passing the filter.

stockKeepingUnitMatch String

Picking Location

Show only trade items with a pick location that matches this term.

locationNumberMatch String

Product number

Show only trade items containing a product whose number matches this term.

productNumberMatch String

Product name

Show only trade items containing a product whose name matches this term.

productNameMatch String

Product group name

Show only trade items of product groups that match this term.

productGroupNameMatch String

GTIN

Show only trade items with a barcode that matches this term.

globalTradeItemNumberMatch String

Description

Show only trade items with a description that matches this term.

descriptionMatch String

Colour

Show only trade items with a color that matches this expression.

colorMatch String

Size

Show only trade items with a size that matches this term.

sizeMatch String

Material

Show only trade items made of a material that matches this term.

materialMatch String

Packaging type

Show only trade items with a package type that matches this term.

packagingTypeMatch String

Min. inventory

Show only trade items where the marketable inventory is greater than this value.

minNumItemsSaleable Long

Max. inventory

Show only items where there is no more than this number of sellable back in stock.

maxNumItemsSaleable Long

Only missing

Show only items where the reserved quantity exceeds the saleable quantity.

onlyMissing Boolean

Product categories

Search terms such as the name of the item's category must match.

itemCategoryNameMatch String

Only active

Show only active items.

onlyActive Boolean

Only selected prod.grp

Show only selected product groups.

onlyChosenProductGroups Boolean

Hazard Class

Show only items whose hazard class matches this term.

hazardClassMatch String

Season

Expressions like the product season must match.

seasonMatch String

Brand

Expressions like the product brand must match.

brandMatch String

Only more locations

Only show trade items that is currently in stock at two or more locations.

onlyMoreThanOneLocation Boolean

Inbound shipment

Show only items that were received on an inbound shipment with a number that matches this expression.

inboundShipmentNumberMatch String

Business item no.

Only show trade items with a business item number matching this expression.

businessItemNumberMatch String

Replenishment list

Only show the trade items that were included on the replenishment list with this number.

replenishmentListNumber Long

Order proposal

Only show trade items that were included on this order proposal.

orderProposalNumber Long

Selected prod.grp

Show only trade items from these product groups.

chosenProductGroups Set