TradeItem Domain Model

Interactive treeview — generated from the OpenAPI specification.

type data type Schema nested schema (click to expand) REQUIRED required field format format hint A | B enum values
Trade Item
Complete trade item information including identification, details, ordering, pricing, logistics, and related data. St…
supplierIdGlnGlnrequiredGlobal Location Number (GLN) of the supplier. Primary key component.
supplierItemNumberstringrequiredmin: 1, max: 35Supplier's unique item number. Primary key component.
detailsTradeItemDetailsrequiredTrade item identification and operational details, combining fields from ETIM xChange `ItemIdentification` and `ItemD…
Trade item identification and details information without composite key fields. Combines fields from ETIM xChange `It…
manufacturerIdGlnGlnrequiredGlobal Location Number (GLN) of the manufacturer. 13-digit GS1 identifier. Required product key reference - together …
manufacturerProductNumberstringrequiredmin: 1, max: 35Manufacturer's product number. Required product key reference - together with `manufacturerIdGln` identifies the pare…
itemValidityDatestringdaterequiredDate from which the trade item is valid for ordering. ISO 8601 date format (YYYY-MM-DD). Defaults to CatalogueValidit…
supplierAltItemNumberstring | nullmin: 1, max: 35Alternative supplier item number. Used when the supplier has multiple numbering systems or legacy item numbers.
manufacturerItemNumberstring | nullmin: 1, max: 35Manufacturer's item number. May differ from supplier's number if supplier is a distributor.
itemGtinsarray | nullArray of Global Trade Item Numbers (GTIN-8, GTIN-12, GTIN-13, or GTIN-14) for the item. Multiple GTINs may exist for …
buyerItemNumberstring | nullmin: 1, max: 35Buyer's specific item number. Used when buyer has assigned their own numbering to supplier items.
discountGroupIdstring | nullmin: 1, max: 20Identifier for the discount group this item belongs to. Used for pricing and discount calculations.
bonusGroupIdstring | nullmin: 1, max: 20Identifier for the bonus group this item belongs to. Used for bonus/rebate calculations.
itemObsolescenceDatestring | nulldateDate when the trade item becomes obsolete and is no longer available for ordering. ISO 8601 date format (YYYY-MM-DD).
itemStatusItemStatus | nullPRE-LAUNCH | ACTIVE | ON HOLD | PLANNED WITHDRAWAL | OBSOLETECurrent lifecycle status of the trade item in the supplier's catalog.
itemConditionItemCondition | nullNEW | USED | REFURBISHEDPhysical condition of the trade item.
stockItemboolean | nullIndicates whether the item is a stock item (true) or made-to-order (false). Stock items are typically available for i…
shelfLifePeriodinteger | null≥ 0, ≤ 999Shelf life period of the item in days. Indicates how long the item remains usable after production. Applicable for it…
orderingTradeItemOrderingrequiredOrdering information for the trade item.
Ordering information for the trade item including order unit, minimum quantities, and lead time. Extracted from ETIM …
orderUnitUnitCodesrequiredANN | DAY | HUR | MIN | SEC | WEE | GRM | KGM | MGM | TNE | LTN | LBR | ONZ | CMT | KTM | MMT | MTR | FOT | INH | SMI | YRD | CMK | CMQ | MMK | MMQ | MTK | MTQ | FTQ | INQ | LTR | MLT | HLT | BE | BG | BO | BX | CA | CI | CL | CQ | CR | CS | CT | DR | C62 | DZN | NMP | NPL | NRL | PA | PF | PK | PL | PR | PU | RG | RL | RO | SA | SET | ST | TN | TU | Z2 | Z3 | D99 | KGUnit in which the item can be ordered (e.g., pieces, boxes, meters).
minimumOrderQuantitynumberdecimalrequired≥ 0, ≤ 999999999999.9999Minimum quantity that must be ordered (converted from ETIM xChange string to number).
orderStepSizenumberdecimalrequired≥ 0, ≤ 999999999999.9999Quantity increment for orders beyond minimum (converted from ETIM xChange string to number). For example, if minimum …
standardOrderLeadTimeinteger | null≥ 0Standard lead time for orders in days.
useUnitUnitCodes | nullANN | DAY | HUR | MIN | SEC | WEE | GRM | KGM | MGM | TNE | LTN | LBR | ONZ | CMT | KTM | MMT | MTR | FOT | INH | SMI | YRD | CMK | CMQ | MMK | MMQ | MTK | MTQ | FTQ | INQ | LTR | MLT | HLT | BE | BG | BO | BX | CA | CI | CL | CQ | CR | CS | CT | DR | C62 | DZN | NMP | NPL | NRL | PA | PF | PK | PL | PR | PU | RG | RL | RO | SA | SET | ST | TN | TU | Z2 | Z3 | D99 | KGUnit in which the item is used or consumed (may differ from order unit, nullable).
useUnitConversionFactornumber | nulldecimal≥ 0, ≤ 999999999999.9999Conversion factor from order unit to use unit (converted from ETIM xChange string to number).
singleUseUnitQuantitynumber | nulldecimal≥ 0, ≤ 999999999999.9999Quantity of use units in a single order unit (converted from ETIM xChange string to number).
alternativeUseUnitUnitCodes | nullANN | DAY | HUR | MIN | SEC | WEE | GRM | KGM | MGM | TNE | LTN | LBR | ONZ | CMT | KTM | MMT | MTR | FOT | INH | SMI | YRD | CMK | CMQ | MMK | MMQ | MTK | MTQ | FTQ | INQ | LTR | MLT | HLT | BE | BG | BO | BX | CA | CI | CL | CQ | CR | CS | CT | DR | C62 | DZN | NMP | NPL | NRL | PA | PF | PK | PL | PR | PU | RG | RL | RO | SA | SET | ST | TN | TU | Z2 | Z3 | D99 | KGAlternative unit in which the item can be used or consumed (nullable).
alternativeUseUnitConversionFactornumber | nulldecimal≥ 0, ≤ 999999999999.9999Conversion factor from order unit to alternative use unit (converted from ETIM xChange string to number).
descriptionsarray | nullArray of multilingual item descriptions. Each item contains descriptions in a specific language.
Item description in a specific language. Extracted from ETIM xChange `TradeItem.ItemDetails.ItemDescriptions[]` struc…
descriptionLanguageLanguageCoderequiredLanguage code for the description in ISO 639-1 and ISO 3166-1 format (e.g., "en-GB", "de-DE"). Sourced from ETIM xCha…
minimalItemDescriptionstringrequiredmin: 1, max: 80Minimal description of the trade item (short description).
uniqueMainItemDescriptionstring | nullmin: 1, max: 255Extended unique description of the trade item (long description).
discountGroupDescriptionstring | nullmin: 1, max: 100Human-readable description of the discount group in this language.
bonusGroupDescriptionstring | nullmin: 1, max: 100Human-readable description of the bonus group in this language.
pricingsarray | nullArray of pricing information for different conditions or customer groups.
Pricing information for a trade item including prices, price unit, and validity dates. Extracted from ETIM xChange `T…
priceUnitUnitCodesrequiredANN | DAY | HUR | MIN | SEC | WEE | GRM | KGM | MGM | TNE | LTN | LBR | ONZ | CMT | KTM | MMT | MTR | FOT | INH | SMI | YRD | CMK | CMQ | MMK | MMQ | MTK | MTQ | FTQ | INQ | LTR | MLT | HLT | BE | BG | BO | BX | CA | CI | CL | CQ | CR | CS | CT | DR | C62 | DZN | NMP | NPL | NRL | PA | PF | PK | PL | PR | PU | RG | RL | RO | SA | SET | ST | TN | TU | Z2 | Z3 | D99 | KGUnit for which the price applies (e.g., pieces, boxes, meters).
priceQuantitynumberdecimalrequired≥ 0, ≤ 99999.9999Quantity for which the price applies (converted from ETIM xChange string to number).
currencyCodeCurrencyCoderequiredEUR | USD | GBP | CHF | SEK | NOK | DKK | PLN | CZKCurrency code for all monetary values in this pricing entry. Sourced from ETIM xChange `CurrencyCode` at catalog level.
priceValidityDatestringdaterequiredDate from which the price is valid. ISO 8601 date format (YYYY-MM-DD). Defaults to CatalogueValidityStart if not over…
priceUnitFactornumber | nulldecimal≥ 0, ≤ 99999999999.9999Factor to convert price unit to order unit (converted from ETIM xChange string to number).
priceOnRequestboolean | nullIndicates whether the price is available only on request.
grossListPricenumber | nulldecimal≥ 0, ≤ 99999999999.9999Gross list price (before discounts) (converted from ETIM xChange string to number).
netPricenumber | nulldecimal≥ 0, ≤ 99999999999.9999Net price (after discounts, before tax) (converted from ETIM xChange string to number).
recommendedRetailPricenumber | nulldecimal≥ 0, ≤ 99999999999.9999Recommended retail price (MSRP) (converted from ETIM xChange string to number).
vatnumber | nulldecimal≥ 0, ≤ 99.99VAT/tax percentage (converted from ETIM xChange string to number).
priceExpiryDatestring | nulldateDate when the price expires. ISO 8601 date format (YYYY-MM-DD).
allowanceSurchargesarray | nullAllowances and surcharges applied to this pricing entry. Returns `null` when no allowances or surcharges are defined …
Allowance or surcharge applied to trade item pricing, including fixed and percentage-based adjustments.
allowanceSurchargeIndicatorstringrequiredALLOWANCE | SURCHARGEIndicates whether this price adjustment is an allowance (discount) or a surcharge (additional charge).
allowanceSurchargeTypeAllowanceSurchargeTypesrequiredAAT | ABL | ADO | ADR | ADZ | AEM | AEO | AEP | AEQ | CAI | DAE | DBD | FC | HD | INS | MAC | MAT | PAD | PI | QD | RAD | SH | TD | WHE | X21Code describing the reason for the allowance or surcharge. Uses shared enumeration aligned with ETIM codes.
allowanceSurchargeValidityDatestring | nulldateDate from which the allowance or surcharge becomes valid. ISO 8601 date format (YYYY-MM-DD).
allowanceSurchargeAmountnumber | nulldecimal≥ 0, ≤ 99999999999.9999Fixed monetary amount of the allowance or surcharge (converted from ETIM string pattern to numeric form).
allowanceSurchargeSequenceNumberinteger | null≥ 1Sequence number used to order multiple allowances or surcharges applied to the same price.
allowanceSurchargePercentagenumber | nulldecimal≥ 0, ≤ 999.999Percentage rate of the allowance or surcharge (converted from ETIM string pattern to numeric form).
allowanceSurchargeMinimumQuantitynumber | nulldecimal≥ 0, ≤ 999999999999.9999Minimum ordered quantity required for the allowance or surcharge to apply (converted from ETIM string pattern to nume…
relationsarray | nullArray of relationships to other trade items (accessories, spare parts, etc.).
Defines a relationship between trade items (e.g., accessories, spare parts, related products). Extracted from ETIM xC…
relatedSupplierItemNumberstringrequiredmin: 1, max: 35Supplier item number of the related trade item.
relationTypeRelationTyperequiredACCESSORY | CONSISTS_OF | CONSUMABLES | CROSS-SELLING | MAIN_PRODUCT | MANDATORY | PREDECESSOR | REFURBISHED | SELECT | SIMILAR | SPAREPART | SUCCESSOR | UPSELLING | USED | OTHERType of relationship between this item and the related item.
relatedItemQuantityintegerrequired≥ 1Quantity of the related item required or recommended (converted from ETIM xChange string to integer).
relatedManufacturerItemNumberstring | nullmin: 1, max: 35Manufacturer item number of the related trade item.
relatedItemGtinsarray | nullArray of GTINs for the related trade item.
logisticDetailsarray | nullArray of logistic details including dimensions and weights.
Logistic details including dimensions, weight, and volume of the base item. Extracted from ETIM xChange `TradeItem.It…
baseItemNetLengthnumber | nulldecimal≥ 0, ≤ 999999999999.9999Net length of the base item in specified unit (converted from ETIM xChange string to number).
baseItemNetWidthnumber | nulldecimal≥ 0, ≤ 999999999999.9999Net width of the base item in specified unit (converted from ETIM xChange string to number).
baseItemNetHeightnumber | nulldecimal≥ 0, ≤ 999999999999.9999Net height of the base item in specified unit (converted from ETIM xChange string to number).
baseItemNetDiameternumber | nulldecimal≥ 0, ≤ 999999999999.9999Net diameter of the base item in specified unit (for cylindrical items) (converted from ETIM xChange string to number).
netDimensionUnitstring | nullCMT | DMT | KMT | MMT | MTR | FOT | INH | SMI | YRD | nullUnit of measurement for net dimensions (CMT=centimeter, MTR=meter, etc.).
baseItemNetWeightnumber | nulldecimal≥ 0, ≤ 999999999999.9999Net weight of the base item in specified unit (converted from ETIM xChange string to number).
netWeightUnitstring | nullGRM | KGM | MGM | TNE | LTN | LBR | ONZ | nullUnit of measurement for net weight (GRM=gram, KGM=kilogram, etc.).
baseItemNetVolumenumber | nulldecimal≥ 0, ≤ 999999999999.9999Net volume of the base item in specified unit (converted from ETIM xChange string to number).
netVolumeUnitstring | nullFTQ | INQ | MTQ | MMQ | OZA | GLL | LTR | MLT | PT | QT | nullUnit of measurement for net volume (LTR=liter, MTQ=cubic meter, etc.).
attachmentsarray | nullArray of attachments (images, documents, certificates, etc.).
Attachment information for trade items (images, documents, certificates, etc.). Extracted from ETIM xChange `TradeIte…
attachmentTypeAttachmentTyperequiredATX001 | ATX002 | ATX003 | ATX004 | ATX010 | ATX011 | ATX012 | ATX013 | ATX014 | ATX015 | ATX016 | ATX017 | ATX018 | ATX019 | ATX020 | ATX021 | ATX022 | ATX023 | ATX024 | ATX025 | ATX026 | ATX099Type of attachment (image, document, certificate, etc.).
attachmentUristringurirequiredURI/URL to the attachment file.
attachmentTypeSpecificationAttachmentTypeSpecificationMDX002 | MDX005 | MDX007 | MDX008 | MDX010 | MDX012 | MDX013 | MDX014 | MDX015 | MDX016 | MDX017 | MDX018 | MDX019 | MDX020 | MDX021 | MDX022 | MDX023 | MDX024 | MDX025 | MDX026 | MDX027 | MDX028 | MDX029 | MDX030 | MDX033 | MDX034 | MDX035 | MDX037 | MDX038 | MDX039 | MDX041 | MDX042 | MDX045 | MDX047 | MDX048 | MDX049 | MDX050 | MDX051 | MDX052 | MDX053 | MDX054 | MDX055 | MDX057 | MDX058 | MDX059 | MDX060 | MDX061 | MDX062 | MDX063 | MDX064 | MDX065 | MDX100 | MDX101 | MDX102 | MDX103 | MDX104 | MDX105 | MDX106 | MDX107 | MDX108 | MDX109 | MDX999 | nullAdditional specification code providing more detail about the attachment type.
attachmentLanguagesarray | nullLanguages for which the attachment is applicable (e.g., 'en-GB', 'de-DE').
attachmentFilenamestring | nullmin: 1, max: 100Filename of the attachment.
attachmentDescriptionstring | nullmin: 1, max: 255Human-readable description of the attachment. Flattened from multilingual array.
attachmentIssueDatestring | nulldateDate when the attachment was issued. ISO 8601 date format (YYYY-MM-DD).
attachmentExpiryDatestring | nulldateDate when the attachment expires. ISO 8601 date format (YYYY-MM-DD).
packagingUnitsarray | nullArray of packaging unit information for different packaging levels.
Packaging unit information describing hierarchical packaging levels (e.g., piece, box, pallet). Extracted from ETIM x…
packagingTypeCodePackagingTypeCoderequiredBE | BG | BJ | BO | BR | BX | C62 | CA | CL | CQ | CR | CS | CT | CY | D99 | DR | EV | KG | NE | PA | PF | PK | PL | PR | PU | RG | RL | RO | SA | SET | TN | TU | WR | Z2 | Z3Type of packaging (box, pallet, etc.).
supplierPackagingNumberstring | nullmin: 1, max: 35Supplier's packaging number for this packaging unit.
manufacturerPackagingNumberstring | nullmin: 1, max: 35Manufacturer's packaging number for this packaging unit.
packagingGtinsarray | nullArray of GTINs for this packaging unit.
packagingUnitNamestring | nullmin: 1, max: 20Human-readable name of the packaging unit. Flattened from multilingual array.
packagingQuantitynumber | nulldecimal≥ 0, ≤ 999999999999.9999Quantity of base items in this packaging unit (converted from ETIM xChange string to number).
tradeItemPrimaryPackagingboolean | nullIndicates whether this is the primary/consumer packaging.
packagingGs1Code128string | nullmin: 1, max: 48GS1-128 barcode for the packaging unit.
grossLengthnumber | nulldecimal≥ 0, ≤ 999999999999.9999Gross length of the packaging in specified unit (converted from ETIM xChange string to number).
grossWidthnumber | nulldecimal≥ 0, ≤ 999999999999.9999Gross width of the packaging in specified unit (converted from ETIM xChange string to number).
grossHeightnumber | nulldecimal≥ 0, ≤ 999999999999.9999Gross height of the packaging in specified unit (converted from ETIM xChange string to number).
grossDiameternumber | nulldecimal≥ 0, ≤ 999999999999.9999Gross diameter of the packaging in specified unit (for cylindrical packaging) (converted from ETIM xChange string to …
grossDimensionUnitstring | nullCMT | DMT | KMT | MMT | MTR | FOT | INH | SMI | YRD | nullUnit of measurement for gross dimensions (CMT=centimeter, MTR=meter, etc.).
grossWeightnumber | nulldecimal≥ 0, ≤ 999999999999.9999Gross weight of the packaging in specified unit (converted from ETIM xChange string to number).
grossWeightUnitstring | nullGRM | KGM | MGM | TNE | LTN | LBR | ONZ | nullUnit of measurement for gross weight (GRM=gram, KGM=kilogram, etc.).
tradeItemEnclosedarray | nullArray of trade items enclosed within this packaging unit. Describes which other trade items are physically contained …
An item enclosed within a packaging unit, describing which trade items are physically contained in a specific package.
enclosedSupplierItemNumberstringrequiredmin: 1, max: 35Supplier item number of the enclosed trade item.
enclosedItemQuantityintegerrequired≥ 1Quantity of this enclosed item within the packaging unit.
enclosedManufacturerItemNumberstring | nullmin: 1, max: 35Manufacturer item number of the enclosed trade item.
enclosedItemGtinsarray | nullArray of GTINs for the enclosed trade item.