Items - EDI Portal Spotworx

CREATE/GET Items

messageType: logistics.items

Create items in logistics management system.

Filename format: <location>_<operative>_IM_<YYYYMMDD>_<uniqueId>.<extensions>

Sample files

XML or XSD
JSON

{
	"messageHeader":{...},
	"items":[{...}]
}

Property	Type	Mandatory	Description
messageHeader	MessageHeader	M	Message header information
items	Array[Item]	M	Item objects

Item

JSON XML

"...": {
		"warehouse": {...},
		"itemCode": "ART-8456",
		"itemDescription1": "Article name",
		"itemDescription2": "Some more",
		"itemDescription3": "",
		"itemDescription4": "",
		"clearingUnit": "156446",
		"itemFamily": "A",
		"itemGroup": "B",
		"itemSubGroup": "C",
		"originCountryCode": "AT",
		"itemConfiguration": {....},
		"packagingUnits": [{....}],
		"dangerousGoods": {....}
	}

Property	Type	Length	Mandatory	Description
warehouse	Warehouse		M	Warehouse information.
itemCode	String	20	M	Item code of customer, used as reference for receipt/dispatch; no leading spaces
itemDescription1	String	35	M	Item description, name
itemDescription2	String	35	O	Item description, additional text
itemDescription3	String	35	O	Item description, additional text
itemDescription4	String	35	O	Item description, additional text
clearingUnit	String	15	O	HS-code for customs clearance
itemFamily	String	3	O	Additional item attribute, can be used as an additional dimension for grouping and filtering reports data
itemGroup	String	3	O	Additional item attribute, can be used as an additional dimension for grouping and filtering reports data
itemSubGroup	String	3	O	Additional item attribute, can be used as an additional dimension for grouping and filtering reports data
originCountryCode	String	2	O	Country code of item origin
itemConfiguration	ItemConfiguration		O	Optional configuration for general item handling
foreignLangDescriptions	Array[foreignLangDescriptions]	0 - 10	O	Foreign language descriptions
substituteItems	Array[substituteItems]	0 - 1	O	Substitute items
symbolicCodes	Array[symbolicCodes]	0 - 10	O	Symbolic codes
receiptInstruction	receiptInstruction		O	Receipt Instruction
packagingUnits	Array[PackagingUnit]	1 - 3	M	Packaging units of the item, level 1 is PCS
dangerousGoods	dangerousGoods		O	Dangerous goods

ItemConfiguration

JSON XML

"...": {
	"receiptDispatchEnabled": true,
	"allocationNumberEnabled": false,
	"batchNumberEnabled": 2,
    "serialNumberEnabled": 4,
	"fifoLifo": "FIFO",
	"fifoDateType": "receipt",
    "overdeliveryReceipt": 0,
    "overdeliveryDispatch": 0,
	"minimalStock": 10,
	"maximalStock": 1000,
	"reorderStock": 50,
	"blockReason": "",
	"wcsItem": true
}

Property	Type	Length	Mandatory	Description
receiptDispatchEnabled	Boolean		O	If enabled, receipt/dispatch of item is allowed
allocationNumberEnabled	Boolean		O	If enabled, the allocation numbers of items need to be recorded/considered on receipt/dispatch
batchNumberEnabled	Integer		M	If enabled, the batch numbers of items need to be recorded on dispatch. Valid values are: `0, 1, 2`
serialNumberEnabled	Integer		O	If enabled, the serial numbers of items need to be recorded on dispatch Valid values are: `0, 1, 2, 3, 4` 0 - no serial number 1 - serial number in stock-out (with picking) 2 - serial number in stock-in and stock-out (with picking) 3 - serial number in stock-out (with packing) 4 - serial number in stock-in and stock-out (with packing)
wcsItem	Boolean		O	Warehouse Control System Item
fifoLifo	String	4	O	FIFO or LIFO
fifoDateType	String	15	O	Distinction on which date the FIFO order depends (expiration/production/receipt)
overdeliveryReceipt	Integer		O	Currently not used
overdeliveryDispatch	Integer		O	Enable over-delivery in Dispatch only during picking without reservation
minimalStock	Integer		O	Minimal stock quantity
maximalStock	Integer		O	Maximal stock quantity
reorderStock	Integer		O	Reorder stock quantity
blockReason	String	3	O	Block Reason, default proposal for items receipt

foreignLangDescriptions

JSON XML

"...": {
	"countryCode": "str",
	"itemDescription1": "Article name",
	"itemDescription2": "some string",
	"itemDescription3": "some string",
	"itemDescription4": "some string"
}

Property	Type	Length	Mandatory	Description
countryCode	String	3	O	Country code of foreign language
itemDescription1	String	35	O	Item description in foreign language
itemDescription2	String	35	O	Item description in foreign language
itemDescription3	String	35	O	Item description in foreign language
itemDescription4	String	35	O	Item description in foreign language

substituteItems

JSON XML

"...": {
	"substitute": "string"
}

Property	Type	Length	Mandatory	Description
substitute	String	20	O	Substitute items

symbolicCodes

JSON XML

"...": {
	"labelType": "str",
	"symbolicCode": "string"
}

Property	Type	Length	Mandatory	Description
labelType	String	3	O	Symbolic code type
symbolicCode	String	35	O	Symbolic code

receiptInstruction

JSON XML

"...": {
	"receiptInstructionText1": "string",
	"receiptInstructionText2": "string",
	"pickingInstructionText1": "string",
	"pickingInstructionText2": "string",
	"fullPallet": true,
	"splitPallet": true
}

Property	Type	Length	Mandatory	Description
receiptInstructionText1	String	60	O	Receipt instruction
receiptInstructionText2	String	60	O	Receipt instruction
pickingInstructionText1	String	60	O	Picking instruction
pickingInstructionText2	String	60	O	Picking instruction
fullPallet	Boolean		M	Stock out full pallet overrules FIFO (true/false)
splitPallet	Boolean		M	Stock out split pallet overrules FIFO (true/false)

dangerousGoods

JSON XML

"...": {
	"dgShippingMode": "str",
    "dgUNNumber": 0,
    "dgClass": "str",
    "dgText1": "string",
    "dgText2": "string",
    "dgText3": "string",
    "dgText4": "string"
}

Property	Type	Length	Mandatory	Description
dgShippingMode	String	3	O	Shipping mode of dangerous goods
dgUNNumber	Integer		O	Dangerous goods identification (ADR/UN-number)
dgClass	String	3	O	Dangerous goods classification
dgText1	String	60	O	Dangerous goods additional text
dgText2	String	60	O	Dangerous goods additional text
dgText3	String	60	O	Dangerous goods additional text
dgText4	String	60	O	Dangerous goods additional text

PackagingUnit

JSON XML

Property	Type	Length	Mandatory	Description
packagingType	String	3	M	Packaging type codes: PCS, BOX, PAL. By default PCS is for packagingLevel 1, but further type need to be defined with the operational business contact.
packagingLevel	Integer		M	Packaging level 1-6 (smallest to largest unit, level 1 is PCS). By default only packaging level 1/3/6 are used and need to be defined with the operational business contact.
pieces	Integer		M	Quantity of pieces of lowest packaging level within current level
eanCode	String	13	O	EAN-13 code
packagingTypeClient	String	3	O	Packaging type codes of client
nextPackagingType	String	3	O	Next lowest packaging unit
weight	BigDecimal	10,4	O	Total weight of packaging unit (will be converted/stored in kg)
grossWeight	BigDecimal	10,4	O	Gross weight of packaging unit
netWeight	BigDecimal	10,4	O	Net weight of packaging unit
measureOfWeight	String	3	O	Measure of weight. Default is kg, if not otherwise specified (t, kg, g, lbs)
length	Integer		O	Length dimension (will be converted/stored in mm/cm)
width	Integer		O	Width dimension (will be converted/stored in mm/cm)
height	Integer		O	Height dimension (will be converted/stored in mm/cm)
measureOfDimension	String	2	O	Measure of dimensions. Default is cm, if not otherwise specified (m,cm, mm, ft, in)
turnoverClass	String	1	O	Optional classification based on inventory turnover ratio of the item.
stockRestriction	String	20	O	Optional stock restriction for specific item storage (e.g. temperature controlled). Only certain values are allowed. Please align with warehouse before sending.
noSplitAllowed	String		M	No split allowed in stock out, on packaging level 2, 3, 4, 5
itemPrices	Array[itemPrices]	0-10	O	Item price

itemPrices

JSON XML

"...": {
    "priceCode": "str",
    "priceValidFrom": 0,
    "pricePerUnit": 0,
    "currencyCode": "str"
}

Property	Type	Length	Mandatory	Description
priceCode	String	3	O	Item price code
priceValidFrom	Integer		O	Item price start of validity period
pricePerUnit	Number		O	Item price per unit
currencyCode	String	3	O	Item price currency code

Shipment Data Item Master Update