Inventory update canonical guidelines

Canonical Element	Type Definition	Description	IDoc mapping	X12 mapping	EDIFACT mapping
data	–	JSon object type/root element.	–	–	–
	controlFileHeader	–	Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages.	–	–	–
	messageBody	–	Payload for canonical forecast plan response message.	–	–	–
		canonicalInventoryUpdateHeader	–	Forecast plan response message header.	IDoc header = E1BP2017_GM_HEAD_01	–	–
			processingFunctionTypeCode	string	Processing function, transaction set purpose code. Valid values include: `RESPONSE` `CREATE` `CHANGE` `CANCEL` `ORIGINAL` `REPLACE` `STATUS` `INFORMATION` `PROPOSED`	–	W1504	BGM030
			messageTypeIdentifierCode	string	Code identifying purpose of EDI message.	–	W1505 = IA inventory	BGM010-010
			externalERPUserName	string	External ERP user name if relevant. Used by SAP to post inventory adjustment.	PR_UNAME	Can be mapped to N902 where N901 = JD	–
			warehouseIdentifier	string	Warehouse id.	–	–	–
			warehouseGroupIdentifier	string	Warehouse group identifier represents a trading group for multiple companies that use the same warehouse-space.	–	–	–
			transactionReferenceIdentifierList	array	Transaction references for inventory adjustment at header level that affects the entire message.	–	–	–
				b2bTransactionIdentifierType	string	Referenced document type. Valid values: `INVENTORYUPDATE` `BOL` `DOCUMENT`	b2bTransactionIdentifierType = INVENTORYUPDATE b2bTransactionIdentifierType = BOL	b2bTransactionIdentifierType = INVENTORYUPDATE b2bTransactionIdentifierType = BOL	b2bTransactionIdentifierType = INVENTORYUPDATE b2bTransactionIdentifierType = BOL
				b2bTransactionIdentifierValue	string	Document identifier for transaction referenced by b2bTransactionIdentifierType.	INVENTORYUPDATE mapping REF_DOC_NO BOL mapping BILL_OF_LADING	INVENTORYUPDATE mapping W1502 (required) BOL mapping N902 where N901 = BM	INVENTORYUPDATE mapping BGM020-010 where BGM010-10 = 78 (inventory movement advice) BOL mapping RFF010-020 where RFF010-010 = BM
				transactionDate	string	Date transaction created.	–	–	–
				epochTransactionDate	integer	Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.	–	–	–
				lineItemNumber	string	Line item number in customer purchase order. Line item level only.	–	–	–
			transactionReferenceInformation	array	Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.	–	–	–
				transactionReferenceType	string	Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include: `PRODUCTTYPE` - Product type `STATUS` - Status `EVENTIDENTIFIER` - Event identifier	–	N901 Use Java call-out to enumeration lookup table CL_TransactionReferenceType	–
				transactionReferenceIdentifier	string	Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.	–	N902	–
				description	string	Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02).	–	N903	–
				transactionReferenceDate	string	Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.	–	N904 & N905	–
				epochTransactionReferenceDate	integer	Transaction reference date and time in EPOCH date time format.	–	–	–
			mpcDates	array	Dates relevant for inventory adjustment header.	–	–	–
				dateType	string	Date type at header level for inventory update. Valid values: `INVENTORYUPDATE` `DOCUMENT`	dateType - INVENTORYUPDATE dateType - DOCUMENT	dateType = INVENTORYUPDATE	dateType = INVENTORYUPDATE = DTM010-010 = 366 dateType = DOCUMENT = DTM010-010 = 137
				dateValue	string	Date defined by referenced date type in date format YYYY-MM-DD.	INVENTORYUPDATE mapping PSTNG_DATE DOCUMENT mapping DOC_DATE	INVENTORYUPDATE mapping W1501 (required)	DTM010-020
				epochDateValue	integer	Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.	–	–	–
				timeZone	string	Time zone for referenced dates.	–	–	–
			customerBusinessInformation	–	Customer party company identifiers and address information.	E1EDKA1 where PARVW = "AG"	N101 = "BT"	NAD010 = "BT"
				businessName	string	Business name for partner or location.	E1EDKA1/NAME1	N102	NAD030-010
				mpcCompanyLocationIdentifierList	array	Identifier list for business party.	–	–	–
					isIdentifierPresentInEvent	boolean	Is identifier present in event boolean.	–	–	–
					companyIdentifierType	string	Company identifier type for business partner.	–	N103	NAD020-030
					companyIdentifierValue	string	Company identifier value for business partner.	–	N104	NAD020-010
					alternateCompanyLocationIdentifierValue	string	Alternate company location identifier value.	–	–	–
				address	–	Party address information.	–	–	–
					address1	string	Main street address.	–	N301	NAD050-010
					address2	string	Supplemental street address.	–	N302	NAD050-020
					city	string	City.	–	N401	NAD060
					district	string	District.	–	–	–
					state	string	State or region code.	–	N402	NAD070-010
					postalCode	string	Postal code.	–	N403	NAD080
					country	string	Country code.	–	N404	NAD090
					telephone	string	Telephone number.	–	–	–
					fax	string	Fax number.	–	–	–
					url	string	Website URL.	–	–	–
					buildingNumber	string	Building number.	–	–	–
					plantNumber	string	Plant number.	–	–	–
					floorNumber	string	Floor number in building.	–	–	–
					lscAddressIdentifier	string	LSC address identifier.	–	–	–
					village	string	Village name.	–	–	–
					houseNumber	string	House number.	–	–	–
					township	string	Township.	–	–	–
					premisesCode	string	Premises code.	–	–	–
				companyLocationContactInformation	–	–	–	Hard code PER01 to "AJ" primary contact	Hard code CTA010 to "RP" responsible person
					contactName	string	Contact name.	–	PER02	CTA020-020
					contactTitle	string	Title of contact.	–	–	–
					contactPhone	string	Contact phone number.	–	PER04 where PER03 = "TE"	COM010-010 where COM010-020 = "TE"
					contactEmail	string	Contact email address.	–	PER06 where PER05 = "EM"	COM010-010 where COM010-020 = "EM"
			siteLocationInformation	–	Site location identifiers and address information.	E1EDKA1 where PARVW = "AG"	N101 = "BT"	NAD010 = "BT"
				businessName	string	Business name for partner or location.	E1EDKA1/NAME1	N102	NAD030-010
				additionalBusinessName	string	Additional business name for partner or location.	E1EDKA1/NAME1	N102	NAD030-010
				mpcCompanyLocationIdentifierList	array	Identifier list for business party.	–	–	–
					isIdentifierPresentInEvent	boolean	Is identifier present in event boolean.	–	–	–
					companyIdentifierType	string	Company identifier type for business partner.	–	N103	NAD020-030
					companyIdentifierValue	string	Company identifier value for business partner.	–	N104	NAD020-010
					alternateCompanyLocationIdentifierValue	string	Alternate company location identifier value.	–	–	–
				address	–	Party address information.	–	–	–
					address1	string	Main street address.	–	N301	NAD050-010
					address2	string	Supplemental street address.	–	N302	NAD050-020
					city	string	City.	–	N401	NAD060
					district	string	District.	–	–	–
					state	string	State or region code.	–	N402	NAD070-010
					postalCode	string	Postal code.	–	N403	NAD080
					country	string	Country code.	–	N404	NAD090
					telephone	string	Telephone number.	–	–	–
					fax	string	Fax number.	–	–	–
					url	string	Website URL.	–	–	–
					buildingNumber	string	Building number.	–	–	–
					plantNumber	string	Plant number.	–	–	–
					floorNumber	string	Floor number in building.	–	–	–
					lscAddressIdentifier	string	LSC address identifier.	–	–	–
					village	string	Village name.	–	–	–
					houseNumber	string	House number.	–	–	–
					township	string	Township.	–	–	–
					premisesCode	string	Premises code.	–	–	–
				mpcAdditionalAddressInformation	–	Additional address information.	–	–	–
					externalERPUserName	string	External ERP system user name for user who generated message.	–	N301	NAD050-010
					organizationCode	string	Code for organization responsible for generating the message.	–	N302	NAD050-020
					organizationDescription	string	Description of the organization responsible for generating the message.	–	N401	NAD060
					groupCode	string	Code identifying group responsible for generating the message.	–	–	–
					language	string	Language key for message.	–	N402	NAD070-010
					languageCode	string	ISO language code for message.	–	N403	NAD080
					telephone	string	Additional telephone number.	–	N404	NAD090
					vatRegistrationNumber	string	VAT registration number.	–	–	–
					taxExemptCode	string	Tax exempt code.	–	–	–
					postalArea	string	Postal area.	–	–	–
					emailAddress	string	Email address.	–	–	–
				companyLocationContactInformation	–	–	–	Hard code PER01 to "AJ" primary contact	Hard code CTA010 to "RP" responsible person
					contactName	string	Contact name.	–	PER02	CTA020-020
					contactTitle	string	Title of contact.	–	N/A	N/A
					contactPhone	string	Contact phone number.	–	PER04 where PER03 = "TE"	COM010-010 where COM010-020 = "TE"
					contactEmail	string	Contact email address.	–	PER06 where PER05 = "EM"	COM010-010 where COM010-020 = "EM"
			supplierBusinessInformation	–	Supplier party company identifiers and address information.	–	N101 = "SU"	NAD010 = "SU"
				businessName	string	Business name for partner or location.	–	N102	NAD030-010
				mpcCompanyLocationIdentifierList	array	Identifier list for business party.	–	–	–
					isIdentifierPresentInEvent	boolean	Is identifier present in event boolean.	–	–	–
					companyIdentifierType	string	Company identifier type for business partner.	–	N103	NAD020-030
					companyIdentifierValue	string	Company identifier value for business partner.	–	N104	NAD020-010
					alternateCompanyLocationIdentifierValue	string	Alternate company location identifier value.	–	–	–
				address	–	Party address information.	–	–	–
					address1	string	Main street address.	–	N301	NAD050-010
					address2	string	Supplemental street address.	–	N302	NAD050-020
					city	string	City.	–	N401	NAD060
					district	string	District	–
					state	string	State or region code	–	N402	NAD070-010
					postalCode	string	Postal code	–	N403	NAD080
					country	string	Country code	–	N404	NAD090
					telephone	string	Telephone number	–	–	–
					fax	string	Fax number	–	–	–
					url	string	Website URL	–	–	–
					buildingNumber	string	Building number	–	–	–
					plantNumber	string	Plant number	–	–	–
					floorNumber	string	Floor number in building	–	–	–
					lscAddressIdentifier	string	LSC address identifier	–	–	–
					village	string	Village name	–	–	–
					houseNumber	string	House number	–	–	–
					township	string	Township	–	–	–
					premisesCode	string	Premises code	–	–	–
				companyLocationContactInformation	–	–	–	Hard code PER01 to "AJ" primary contact	Hard code CTA010 to "RP" responsible person
					contactName	string	Contact name	–	PER02	CTA020-020
					contactTitle	string	Title of contact	–	N/A	N/A
					contactPhone	string	Contact phone number	–	PER04 where PER03 = "TE"	COM010-010 where COM010-020 = "TE"
					contactEmail	string	Contact email address	–	PER06 where PER05 = "EM"	COM010-010 where COM010-020 = "EM"
			shipToLocationInformation	–	Ship to party company identifiers and address information.	–	N101 = "ST"	NAD010 = "ST"
				businessName	string	Business name for partner or location.	–	N102	NAD030-010
				mpcCompanyLocationIdentifierList	array	Identifier list for business party.	–	–	–
					isIdentifierPresentInEvent	boolean	Is identifier present in event boolean.	–	–	–
					companyIdentifierType	string	Company identifier type for business partner.	–	N103	NAD020-030
					companyIdentifierValue	string	Company identifier value for business partner.	–	N104	NAD020-010
					alternateCompanyLocationIdentifierValue	string	Alternate company location identifier value.	–	–	–
				address	–	Party address information.	–	–	–
					address1	string	Main street address.	–	N301	NAD050-010
					address2	string	Supplemental street address.	–	N302	NAD050-020
					city	string	City	–	N401	NAD060
					district	string	District	–	N/A	N/A
					state	string	State or region code	–	N402	NAD070-010
					postalCode	string	Postal code	–	N403	NAD080
					country	string	Country code	–	N404	NAD090
					telephone	string	Telephone number	–	–	–
					fax	string	Fax number	–	–	–
					url	string	Website URL	–	–	–
					buildingNumber	string	Building number	–	–	–
					plantNumber	string	Plant number	–	–	–
					floorNumber	string	Floor number in building	–	–	–
					lscAddressIdentifier	string	LSC address identifier	–	–	–
					village	string	Village name	–	–	–
					houseNumber	string	House number	–	–	–
					township	string	Township	–	–	–
					premisesCode	string	Premises code	–	–	–
				companyLocationContactInformation	–	–	–	Hard code PER01 to "AJ" primary contact	Hard code CTA010 to "RP" responsible person
					contactName	string	Contact name	–	PER02	CTA020-020
					contactTitle	string	Title of contact	–	N/A	N/A
					contactPhone	string	Contact phone number	–	PER04 where PER03 = "TE"	COM010-010 where COM010-020 = "TE"
					contactEmail	string	Contact email address	–	PER06 where PER05 = "EM"	COM010-010 where COM010-020 = "EM"
			freeTextNote	array	Ship to party company identifiers and address information.	IDoc header = E1BP2017_GM_HEAD_01	–	–
				textReferenceCode	string	Text reference or subject code. Will map whatever is found.	–	–	–
				textFunctionCode	string	Text function code. Will map whatever is found.	–	–	–
				language	string	Language of free text.	–	–	–
				textFormatCode	string	Format code for free text.	–	–	–
				freeText	string	Free test string.	HEADER_TXT	–	–
			customFields	array	Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level.	–	–	–
				name	string	Name of mapped field.	–	–	–
				value	string	Value in named field.	–	–	–
		canonicalInventoryUpdateItemDetails	array	Canonical inventory item details.	IDoc line item loop - E1BP2017_GM_ITEM_CREATE	X12 line item loop = 0900 W19	EDIFACT line item loop = Segment Group 9 LIN
			plantIdentifier	string	Customer plant identifier for sales forecast.	PLANT	N902 where N901 = PE	LOC020-010 where LOC01-010 = 19
			storageLocation	string	Location in plant where stock is stored.	STGE_LOC	N902 where N901 = WS (Warrehouse Storage Location)	LOC020-010 where LOC01-010 = 14
			productCodesIdentifiers	array	Product code identifiers list.
				productCodeType	string	Code to qualify product identifier type: `CUSTOMER SUPPLIER`.	productCodeType - CUSTOMER	productCodeType - CUSTOMER = W1905 = BP productCodeType = SUPPLIER = W1905 = VN	productCodeType - CUSTOMER = LIN030-020 = BP productCodeType = SUPPLIER = PIA020-020 = VN
				productCodeValue	string	Product code identifier value.	MATERIAL	CUSTOMER mapping W1906 where W1905 = BP SUPPLIER mapping W1906 where W1905 = VN	CUSTOMER mapping LIN030-010 where LIN030-020 = BP SUPPLIER mapping PIA020-010 where PIA020-020 = VN
			productItemInformation	array	Product item descriptions and information.	–	–	–
				productLanguageCode	string	Language for product description.	–	–	–
				productName	string	Name of product.	ITEM_TEXT	G6901	IMD030-040
				genericName	string	Generic name for product.	–	–	–
				productDescription	string	Description of the product defined by the current product identifier.	–	–	–
			lotNumber	string	Lot or batch identifier (customer).	–	–	–
			customerLotNumber	string	Customer lot number.	BATCH	N902 where N901 = LT	PIA020-010 where PIA010 = 1 (hard code) and PIA020-020 = BB
			supplierLotNumber	string	Supplier lot or batch identifier. For Merck's custom XML this represents the expected batch or lot number from the released process (work) order.	VENDRBATCH	W1909
			expirationDate	string	Expiration date for lot.	EXPIRYDATE	EXPIRATION mapping G6202 where G6201 = 36	EXPIRATION mapping DTM010-020where DTM010-010 = 36
			epochExpirationDate	integer	Expiration date for lot generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.	–	–	–
			manufacturingDate	string	Manufacturing date for lot.	PROD_DATE	MANUFACTURING mapping G6202 where G6201 = BL	MANUFACTURING mapping DTM010-020where DTM010-010 = 94
			epochManfacturingDate	integer	Manufacturing date for lot generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.	–	–	–
			customerIdentifier	string	Customer identifier.	CUSTOMER	N104 where N101 = BY (from header)	NAD020-010 where NAD010 = BY (from header)
			supplierIdentifier	string	Supplier identifier.	VENDOR	N104 where N101 = SU (from header)	NAD020-010 where NAD010 = SU (from header)
			goodsRecipientIdentifier	string	Goods recipient/ship to party location identifier.	GR_RCPT	N104 where N101 = ST (from header or line item)	NAD020-010 where NAD010 = ST (from header or line item)
			productionMaterialState	string	Material type. Valid values: `API` - Active pharmaceutical ingredient `WIP` - Work in process `COMPONENT` - Component material `FINISHEDGOODS` `RAWMATERIAL`	–	–	–
			componentIdentifier	string	Component product identifier. Used in custom maps when components are being consumed after production.	–	–	–
			itemCategory	string	Groups similar articles together (e.g. product group). It has no effect on functionality, but can be used to link articles for queries or reports if necessary.	–	–	–
			itemType	string	Determines the type of articles declared on this order. Item Type links similar articles allowing processes or information for specific groups of articles.	–	–	–
			isStoreSensitiveGoods	boolean	This flag indicates, whether the article needs to be stored in an area for sensitive goods. This is considered in the put-away process. Valid values: `0` - No `1` - Yes	–	–	–
			isTemperatureControlled	boolean	This flag indicates, whether the article needs to be stored in a temperature controlled area. This is considered in the put-away process. Valid values: `0` - No `1` - Yes	–	–	–
			isCaptureSerialNumbers	boolean	This flag indicates whether an article requires serial number capturing. This flag is considered in the RDT-based outbound processes. Valid values: `0` - No `1` - Yes	–	–	–
			stockRotationMethod	string	Determines the sequence in which the stock is allocated in outbound processes. Linked to the stockRotationBasis field.	–	–	–
			stockRotationBasis	string	Determines the basis, with stockRotationMethod, on which stock will be selected and allocated in an outbound process.	–	–	–
			commodityExportTariffCode	string	Export commodity code of the article. Used to derive a customs tariff when the goods are exported.	–	–	–
			commodityImportTariffCode	string	Import commodity code of the article. Used to derive a customs tariff when the goods are imported.	–	–	–
			recipeCode	string	Free-text optional field. It often appears on shipment documentation	–	–	–
			smallNormalFlag	string	This value indicates the type of RDT-workbank-tasks, required for picking/packing. 2 needs to be set if SAP-tasks are to be generated. Valid values: `NORMAL` - 1 `SMALL` - 2	–	–	–
			serialNumberCountBySKU	number	Number of serial stickers needed per SKU box.	–	–	–
			pricingUnitNumerator	string	Specifies how many units of the articles the article value applies to. For Example, if articles are only valued in packs of 10 then the value for 10 articles would be entered in ArticleValue and then value10 would be entered here.	–	–	–
			costValueOfStock	string	The cost value of the stock	–	–	–
			isQuantityReturnToStock	boolean	Specifies for qty return stock (Y= qty return to stock, N= no qty return to stock). Valid values: `True` - Y = Quantity return to stock `False` - N = No quantity return to stock	–	–	–
			customerPlantIdentifier	string	Client Plant code (for Recsup).	–	–	–
			packagingIdentifier	string	External packaging container identifier for parent container.	–	–	–
			carrierTrackingIdentifier	string	Carrier Tracking Number.	–	–	–
			containerIdentifier	string	Identifier of the container.	–	–	–
			containerType	string	The Type of container.	–	–	–
			containerProductCode	string	GTIN of the container.	–	–	–
			warehouseManagementSystemInformation	–	–	–	–	–
				statusCode	string	Alloga's local WMS status code.	–	–	–
				reasonCode	string	Alloga's localWMS reason code.	–	–	–
				transactionCode	string	Alloga's local WMS Transaction code.	–	–	–
				storageLocation	string	Alloga's local WMS Storage Location Code.	–	–	–
			totalItemPriceValue	–	–	–	–	–
				priceValue	number	Total price value for items ordered in message.	–	–	–
				currencyCode	string	Currency code for price value.	–	–	–
			additionalProductReferencesFlag	–	Flags that determine if additional product references and dates are mandatory.	–	–	–
				productReferenceFlag	string	Determines whether an Article Reference is mandatory when a goods item is created, altered or received. Valid values: `NO` - 0 `YES` - 1 `INBOUNDONLY` - 2 `OUTBOUNDONLY` - 3 `ITEMTYPE` - 4 (Take from Item Type)	–	–	–
				productDateFlag	string	Determines whether Article Date 1 is mandatory when a goods item is created, altered or received. Valid values: `NO` - 0 `YES` - 1 `INBOUNDONLY` - 2 `OUTBOUNDONLY` - 3 `ITEMTYPE` - 4 (Take from Item Type)	–	–	–
			additionalProductReferencesFlag2	–	Flags that determine if additional product references and dates are mandatory.	–	–	–
				productReferenceFlag	string	Determines whether an Article Reference is mandatory when a goods item is created, altered or received. Valid values: `NO` - 0 `YES` - 1 `INBOUNDONLY` - 2 `OUTBOUNDONLY` - 3 `ITEMTYPE` - 4 (Take from Item Type)	–	–	–
				productDateFlag	string	Determines whether Article Date 1 is mandatory when a goods item is created, altered or received. Valid values: `NO` - 0 `YES` - 1 `INBOUNDONLY` - 2 `OUTBOUNDONLY` - 3 `ITEMTYPE` - 4 (Take from Item Type)	–	–	–
			additionalProductReferencesFlag3	–	Flags that determine if additional product references and dates are mandatory.	–	–	–
				productReferenceFlag	string	Determines whether an Article Reference is mandatory when a goods item is created, altered or received. Valid values: `NO` - 0 `YES` - 1 `INBOUNDONLY` - 2 `OUTBOUNDONLY` - 3 `ITEMTYPE` - 4 (Take from Item Type)	–	–	–
				productDateFlag	string	Determines whether Article Date 1 is mandatory when a goods item is created, altered or received. Valid values: `NO` - 0 `YES` - 1 `INBOUNDONLY` - 2 `OUTBOUNDONLY` - 3 `ITEMTYPE` - 4 (Take from Item Type)	–	–	–
			productItemDetails	–	Details about the product, container, weight, volume, value, quantity, and other key information at a subline level.	–	–	–
				itemCode	string	Unique identification of goods item.	–	–	–
				consignmentIdentifier	string	Identification of the consignment to which the stock belongs.	–	–	–
				productCodeValue	string	Product code value.	–	–	–
				caseIdentifier	string	Case identifier number.	–	–	–
				masterCaseIdentifier	string	Master case identifier.	–	–	–
				packageType	string	Package type used for this PackKey Level, eg, BOX. Appendix includes full list of qualifiers.	–	–	–
				conditionStatus	string	Status of the product item.	–	–	–
				isBonded	boolean	Specifies whether stock declared on order line is bonded or not. Valid values: `True` - 1 = Product is bonded `False` - 0 = Product is not bonded (default)	–	–	–
				isTaxed	boolean	Specifies whether stock declared on order line is taxed or not. Valid values: `True` - 1 = Product is taxed `False` - 0 = Product is not taxed (default)	–	–	–
				warehouseIdentifier	string	Warehouse / warehouse complex identifier. Identification of warehousing client that is used throughout the system.	–	–	–
				countryOfOrigin	string	Country from which shipment was shipped.	–	–	–
				actualCaseWeight	–	Actual case weight.	–	–	–
					weightType	string	Type of weight recorded. Valid value is `CASE`.	–	–	–
					weightValue	string	Weight of the case as the product item details level.	–	–	–
					unitOfMeasure	string	Weight unit of measure in master data for product.	–	–	–
				actualCaseVolume	–	Actual case volume at the product details level.	–	–	–
					volumeType	string	Type of weight recorded. Valid value is `CASE`.	–	–	–
					volumeValue	number	Volume for item.	–	–	–
					unitOfMeasure	string	Volume unit of measure.	–	–	–
				itemQuantity	–	Quantity of item.	–	–	–
					quantityType	string	Type of quantity recorded. Valid value is `ITEM`.	–	–	–
					quantityValue	string	Quantity of item.	–	–	–
					unitOfMeasure	string	Unit of measure for quantity.	–	–	–
				totalItemPriceValue	–	Segment recording total value of goods in message.	–	–	–
					priceValue	number	Total price value for items ordered in message.	–	–	–
					currencyCode	string	Currency code for price value.	–	–	–
				packagingDimensions	–	Segment recording total value of goods in message.	–	–	–
					packagingLength	number	Packaging length.	–	–	–
					packagingWidth	number	Packaging width.	–	–	–
					packagingHeight	number	Packaging height.	–	–	–
					unitOfMeasure	string	Volume unit of measure.	–	–	–
			stockTransactionBeforeUpdate	–	Information about the stock before the transaction is executed.	–	–	–
				shippingReceivingPoint	string	Identifier code for the depot or site where the inventory is held, normally the warehouse to which the goods will be received.	–	–	–
				warehouseZone	string	Warehouse zone identifier for the from transaction state. Codes in Appendix: broken link, no codes.	–	–	–
				warehouseLocation	string	Warehouse location for the from transaction state. Codes in Appendix.	–	–	–
				caseIdentifier	string	Case identifier number.	–	–	–
				inventoryStatusUpdateCode	string	Stock status code for the from transaction state. Codes in Appendix. Current inventory status before the update. This will not be used to update inventory.	–	–	–
				isBonded	boolean	Specifies whether stock declared on order line is bonded or not. Valid values: `0` - No `1` - Yes	–	–	–
				isTaxed	boolean	Specifies whether stock declared on order line is taxed or not. . Valid values: `0` - No `1` - Yes	–	–	–
				additionalProductReferences	–	Additional product references instance 1.	–	–	–
					additionalProductReference	string	Additional product reference or attribute. Pass thru mapping.	–	–	–
					productDate	string	Additional product reference or attribute date value in date format YYYY-MM-DD.	–	–	–
					epochProductDate	long	Additional product reference or attribute date value in epoch date format.	–	–	–
				additionalProductReferences2	–	Additional product references instance 2.	–	–	–
					additionalProductReference	string	Additional product reference or attribute. Pass thru mapping.	–	–	–
					productDate	string	Additional product reference or attribute date value in date format YYYY-MM-DD.	–	–	–
					epochProductDate	long	Additional product reference or attribute date value in epoch date format.	–	–	–
				additionalProductReferences3	–	Additional product references instance 3.	–	–	–
					additionalProductReference	string	Additional product reference or attribute. Pass thru mapping.	–	–	–
					productDate	string	Additional product reference or attribute date value in date format YYYY-MM-DD.	–	–	–
					epochProductDate	long	Additional product reference or attribute date value in epoch date format	–	–	–
			itemQuantity		Quantity of ORDER.	–	–	–
				quantityType	string	Type of quantity recorded. Valid value is `ORDER`.	–	–	–
				quantityValue	string	Quantity of Order.	–	–	–
				unitOfMeasure	string	Unit of measure for quantity.	–	–	–
			actualTareWeight		Actual Tare weight.	–	–	–
				weightType	string	Type of weight recorded. Valid value is `TARE`.	–	–	–
				weightValue	string	Weight of the shipment as the product item details level.	–	–	–
				unitOfMeasure	string	Weight unit of measure from master data for product.	–	–	–
			inventoryUpdateQuantity	–	Quantity of item scheduled in the forecast.	–	–	–
				quantityValue	number	Quantity of product reported in inventory.	ENTRY_QNT	W1902 If value include - (minus) sign, inventory decreased Else inventory increased	QTY010-020 segment group 12 Need a quantity type in QTY010-010: 501 = qty credited, 502 = qty debited INV010 identifies movement into (1) or out of (2) inventory
				unitOfMeasure	string	Unit or Basis for Measurement Code. Quantity UOM's include: `CA` - Case `CP` - Crate `CT` - Carton `DS` - Display `DZ` - Dozen `EA` - Each `PC` - Piece `PF` - Pallet `PK` - Package `T3` - Thousand Pieces `TH` - Thousand `TY` - Tray `UN` - Unit	ENTRY_UOM	W1903	QTY010-030
				inventoryStatusUpdateCode	string	Code identifying the inventory adjustment or movement type.	MOVE_TYPE	W1901 W1902 (positive or negative amount) W1916
				inventoryStatusUpdateTransactionType	string	Transaction type or document referenced for inventory adjustment.	MVT_IND	–	–
				inventoryStatusUpdateReasonCode	string	Inventory adjustment reason code.	MOVE_REAS	–	–
				stockTypeIndicator	string	Stock type indicator. Pass thru value for SAP, if populated.	STCK_TYPE	–	–
				specialStockIndicator	string	Stock type indicator. Pass thru value for SAP, if populated.	SPEC_STOCK	–	–
				stockTransactionIdentifier	string	Unique identifier for the inventory update transaction.	–	–	–
				stockTransactionType	–	Two character code to identify the type of transaction, ie, whether a change, increase or decrease. Codes in appendix appear to be incomplete.	–	–	–
				shippingReceivingPoint	string	Identifier code for the depot or site where the inventory is held, normally the warehouse to which the goods will be received.	–	–	–
				warehouseZone	string	Warehouse zone identifier for the from transaction state. Codes in Appendix: broken link, no codes.	–	–	–
				warehouseLocation	string	Warehouse location for the from transaction state. Codes in Appendix.	–	–	–
				caseIdentifier	string	Case identifier number.	–	–	–
				isBonded	boolean	Specifies whether stock declared on order line is bonded or not. Valid values: `0` - No `1` - Yes	–	–	–
				isTaxed	boolean	Specifies whether stock declared on order line is taxed or not. . Valid values: `0` - No `1` - Yes	–	–	–
				isIncrease	boolean	Whether the transaction added or subtracted inventory levels, null if stock levels remain static. Either a ‘+’ for adding stock or a ‘-‘ to subtract stock. Null if there is no change in the qty. `True` = + `False` = -	–	–	–
				additionalProductReferences	–	Additional product references instance 1.	–	–	–
					additionalProductReference	string	Additional product reference or attribute. Pass thru mapping.	–	–	–
					productDate	string	Additional product reference or attribute date value in date format YYYY-MM-DD.	–	–	–
					epochProductDate	long	Additional product reference or attribute date value in epoch date format.	–	–	–
				additionalProductReferences2	–	Additional product references instance 2.	–	–	–
					additionalProductReference	string	Additional product reference or attribute. Pass thru mapping.	–	–	–
					productDate	string	Additional product reference or attribute date value in date format YYYY-MM-DD.	–	–	–
					epochProductDate	long	Additional product reference or attribute date value in epoch date format.	–	–	–
				additionalProductReferences3	–	Additional product references instance 3.	–	–	–
					additionalProductReference	string	Additional product reference or attribute. Pass thru mapping.	–	–	–
					productDate	string	Additional product reference or attribute date value in date format YYYY-MM-DD.	–	–	–
					epochProductDate	long	Additional product reference or attribute date value in epoch date format.	–	–	–
			transactionReferenceIdentifierList	–	Transaction references for purchase order number used in the custom IDoc segment.	–	–	–
				b2bTransactionIdentifierType	string	Referenced document type. Valid value: `PURCHASEORDER` `SUPPLIERORDER` `RESERVATION` `WORKORDER`	b2bTransactionIdentifierType = PURCHASEORDER b2bTransactionIdentifierType = WORKORDER b2bTransactionIdentifierType = SUPPLIERORDER b2bTransactionIdentifierType = RESERVATION	PURCHASEORDER mapping N901 = PO WORKORDER mapping N901 = WO DELIVERY mapping N901 = DO RESERVATION mapping N901 = RSN	PURCHASEORDER mapping RFF010-010 = OP WORKORDER mapping RFF010-010 = AOV DELIVERY mapping RFF010-010 = AAK (Despatch Advice) RESERVATION mapping RFF010-010 = AEO
				b2bTransactionIdentifierValue	string	Transaction identifier value corresponding to transaction type identified by b2bTransactionIdentifierType.	PURCHASEORDER mapping PO_ NUMBER WORKORDER mapping ORDERID SUPPLIERORDER mapping SALES_ORD RESERVATION mappiing RESERV_NO	PURCHASEORDER mapping N902 where N901 = PO WORKORDER mapping N902 where N901 = WO DELIVERY mapping N902 where N901 = DO RESERVATION mapping N902 where N901 = RSN	PURCHASEORDER mapping RFF020 where RFF010-010 = OP WORKORDER mapping RFF020 where RFF010-010 = AOV DELIVERY mapping RFF020 where RFF010-010 = AAK (Despatch Advice) RESERVATION mapping RFF020 where RFF010-010 = AEO
				transactionDate	string	Date transaction created	–	–	–
				epochTransactionDate	integer	Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.	–	–	–
				lineItemNumber	string	Line item number	PURCHASEORDER mapping PO_ITEM WORKORDER mapping ORDER_ITNO SUPPLIERORDER mapping S_ORD_ITEM RESERVATION mapping RES_ITEM	PURCHASEORDER mapping N903 where N901 = PO WORKORDER mapping N903 where N901 = WO DELIVERY mapping N903 where N901 = DO RESERVATION mapping N903 where N901 = RSN	PURCHASEORDER mapping RFF030 where RFF010-010 = OP WORKORDER mapping RFF030 where RFF010-010 = AOV DELIVERY mapping RFF030 where RFF010-010 = AAK (Despatch Advice) RESERVATION mapping RFF030 where RFF010-010 = AEO
			transactionReferenceInformation	array	Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.	–	N9	–
				transactionReferenceType	string	Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include: - `PRODUCTTYPE` - Product type `STATUS` - Status `EVENTIDENTIFIER` - Event identifier	–	N901 Use Java call-out to enumeration lookup table CL_TransactionReferenceType	–
				transactionReferenceIdentifier	string	Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.	–	N902	–
				description	string	Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02).	–	N903	–
				transactionReferenceDate	string	Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.	–	N904 & N905	–
				epochTransactionReferenceDate	integer	Transaction reference date and time in EPOCH date time format.	–	–	–
			mpcDates	array	Dates relevant for inventory adjustment line item.	–	–	–
				dateType	string	Date type at header level for inventory update. Valid value is `INVENTORYUPDATE`.	dateType = INVENTORYUPDATE	dateType = INVENTORYUPDATE	dateType = INVENTORYUPDATE = DTM010-010 = 366
				dateValue	string	Date defined by referenced date type in date format YYYY-MM-DD.	INVENTORYUPDATE mapping REF_DATE	INVENTORYUPDATE mapping G6202 where G6201=AB "AB" qualifier describes "Warehouse Inventory Stock"	DTM010-020
				epochDateValue	integer	Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.	–	–	–
				timeZone	string	Time zone for referenced dates	–	–	–
			freeTextNote	array	Ship to party company identifiers and address information.	–	–	–
				textReferenceCode	string	Text reference or subject code. Will map whatever is found.	–	–	–
				textFunctionCode	string	Text function code. Will map whatever is found.	–	–	–
				language	string	Language of free text.	–	–	–
				textFormatCode	string	Format code for free text.	–	–	–
				freeText	string	Free test string.	–	–	–
			customFields	array	Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level.	–	–	–
				name	string	Name of mapped field.	–	–	–
				value	string	Value in named field.	–	–	–

data

–

JSon object type/root element.

–

controlFileHeader

–

Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages.

–

messageBody

–

Payload for canonical forecast plan response message.

–

canonicalInventoryUpdateHeader

–

Forecast plan response message header.

IDoc header = E1BP2017_GM_HEAD_01

–

processingFunctionTypeCode

string

Processing function, transaction set purpose code.

Valid values include:

RESPONSE
CREATE
CHANGE
CANCEL
ORIGINAL
REPLACE
STATUS
INFORMATION
PROPOSED

–

W1504

BGM030

messageTypeIdentifierCode

string

Code identifying purpose of EDI message.

–

W1505 = IA inventory

BGM010-010

externalERPUserName

string

External ERP user name if relevant. Used by SAP to post inventory adjustment.

PR_UNAME

Can be mapped to N902 where N901 = JD

–

warehouseIdentifier

string

Warehouse id.

–

warehouseGroupIdentifier

string

Warehouse group identifier represents a trading group for multiple companies that use the same warehouse-space.

–

transactionReferenceIdentifierList

array

Transaction references for inventory adjustment at header level that affects the entire message.

–

b2bTransactionIdentifierType

string

Referenced document type.

Valid values:

INVENTORYUPDATE
BOL
DOCUMENT

b2bTransactionIdentifierType = INVENTORYUPDATE
b2bTransactionIdentifierType = BOL

b2bTransactionIdentifierType = INVENTORYUPDATE
b2bTransactionIdentifierType = BOL

b2bTransactionIdentifierType = INVENTORYUPDATE
b2bTransactionIdentifierType = BOL

b2bTransactionIdentifierValue

string

Document identifier for transaction referenced by b2bTransactionIdentifierType.

INVENTORYUPDATE mapping REF_DOC_NO
BOL mapping BILL_OF_LADING

INVENTORYUPDATE mapping W1502 (required)
BOL mapping N902 where N901 = BM

INVENTORYUPDATE mapping BGM020-010 where BGM010-10 = 78 (inventory movement advice)
BOL mapping RFF010-020 where RFF010-010 = BM

transactionDate

string

Date transaction created.

–

epochTransactionDate

integer

Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.

–

lineItemNumber

string

Line item number in customer purchase order. Line item level only.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

–

transactionReferenceType

string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

PRODUCTTYPE - Product type
STATUS - Status
EVENTIDENTIFIER - Event identifier

–

N901 Use Java call-out to enumeration lookup table CL_TransactionReferenceType

–

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N902

–

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02).

–

N903

–

transactionReferenceDate

string

Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

–

N904 & N905

–

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

mpcDates

array

Dates relevant for inventory adjustment header.

–

dateType

string

Date type at header level for inventory update.

Valid values:

INVENTORYUPDATE
DOCUMENT

dateType - INVENTORYUPDATE
dateType - DOCUMENT

dateType = INVENTORYUPDATE

dateType = INVENTORYUPDATE = DTM010-010 = 366
dateType = DOCUMENT = DTM010-010 = 137

dateValue

string

Date defined by referenced date type in date format YYYY-MM-DD.

INVENTORYUPDATE mapping PSTNG_DATE
DOCUMENT mapping DOC_DATE

INVENTORYUPDATE mapping W1501 (required)

DTM010-020

epochDateValue

integer

Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.

–

timeZone

string

Time zone for referenced dates.

–

customerBusinessInformation

–

Customer party company identifiers and address information.

E1EDKA1 where PARVW = "AG"

N101 = "BT"

NAD010 = "BT"

businessName

string

Business name for partner or location.

E1EDKA1/NAME1

N102

NAD030-010

mpcCompanyLocationIdentifierList

array

Identifier list for business party.

–

isIdentifierPresentInEvent

boolean

Is identifier present in event boolean.

–

companyIdentifierType

string

Company identifier type for business partner.

–

N103

NAD020-030

companyIdentifierValue

string

Company identifier value for business partner.

–

N104

NAD020-010

alternateCompanyLocationIdentifierValue

string

Alternate company location identifier value.

–

address

–

Party address information.

–

address1

string

Main street address.

–

N301

NAD050-010

address2

string

Supplemental street address.

–

N302

NAD050-020

city

string

City.

–

N401

NAD060

district

string

District.

–

state

string

State or region code.

–

N402

NAD070-010

postalCode

string

Postal code.

–

N403

NAD080

country

string

Country code.

–

N404

NAD090

telephone

string

Telephone number.

–

fax

string

Fax number.

–

url

string

Website URL.

–

buildingNumber

string

Building number.

–

plantNumber

string

Plant number.

–

floorNumber

string

Floor number in building.

–

lscAddressIdentifier

string

LSC address identifier.

–

village

string

Village name.

–

houseNumber

string

House number.

–

township

string

Township.

–

premisesCode

string

Premises code.

–

companyLocationContactInformation

–

Hard code PER01 to "AJ" primary contact

Hard code CTA010 to "RP" responsible person

contactName

string

Contact name.

–

PER02

CTA020-020

contactTitle

string

Title of contact.

–

contactPhone

string

Contact phone number.

–

PER04 where PER03 = "TE"

COM010-010 where COM010-020 = "TE"

contactEmail

string

Contact email address.

–

PER06 where PER05 = "EM"

COM010-010 where COM010-020 = "EM"

siteLocationInformation

–

Site location identifiers and address information.

E1EDKA1 where PARVW = "AG"

N101 = "BT"

NAD010 = "BT"

businessName

string

Business name for partner or location.

E1EDKA1/NAME1

N102

NAD030-010

additionalBusinessName

string

Additional business name for partner or location.

E1EDKA1/NAME1

N102

NAD030-010

mpcCompanyLocationIdentifierList

array

Identifier list for business party.

–

isIdentifierPresentInEvent

boolean

Is identifier present in event boolean.

–

companyIdentifierType

string

Company identifier type for business partner.

–

N103

NAD020-030

companyIdentifierValue

string

Company identifier value for business partner.

–

N104

NAD020-010

alternateCompanyLocationIdentifierValue

string

Alternate company location identifier value.

–

address

–

Party address information.

–

address1

string

Main street address.

–

N301

NAD050-010

address2

string

Supplemental street address.

–

N302

NAD050-020

city

string

City.

–

N401

NAD060

district

string

District.

–

state

string

State or region code.

–

N402

NAD070-010

postalCode

string

Postal code.

–

N403

NAD080

country

string

Country code.

–

N404

NAD090

telephone

string

Telephone number.

–

fax

string

Fax number.

–

url

string

Website URL.

–

buildingNumber

string

Building number.

–

plantNumber

string

Plant number.

–

floorNumber

string

Floor number in building.

–

lscAddressIdentifier

string

LSC address identifier.

–

village

string

Village name.

–

houseNumber

string

House number.

–

township

string

Township.

–

premisesCode

string

Premises code.

–

mpcAdditionalAddressInformation

–

Additional address information.

–

externalERPUserName

string

External ERP system user name for user who generated message.

–

N301

NAD050-010

organizationCode

string

Code for organization responsible for generating the message.

–

N302

NAD050-020

organizationDescription

string

Description of the organization responsible for generating the message.

–

N401

NAD060

groupCode

string

Code identifying group responsible for generating the message.

–

language

string

Language key for message.

–

N402

NAD070-010

languageCode

string

ISO language code for message.

–

N403

NAD080

telephone

string

Additional telephone number.

–

N404

NAD090

vatRegistrationNumber

string

VAT registration number.

–

taxExemptCode

string

Tax exempt code.

–

postalArea

string

Postal area.

–

emailAddress

string

Email address.

–

companyLocationContactInformation

–

Hard code PER01 to "AJ" primary contact

Hard code CTA010 to "RP" responsible person

contactName

string

Contact name.

–

PER02

CTA020-020

contactTitle

string

Title of contact.

–

N/A

contactPhone

string

Contact phone number.

–

PER04 where PER03 = "TE"

COM010-010 where COM010-020 = "TE"

contactEmail

string

Contact email address.

–

PER06 where PER05 = "EM"

COM010-010 where COM010-020 = "EM"

supplierBusinessInformation

–

Supplier party company identifiers and address information.

–

N101 = "SU"

NAD010 = "SU"

businessName

string

Business name for partner or location.

–

N102

NAD030-010

mpcCompanyLocationIdentifierList

array

Identifier list for business party.

–

isIdentifierPresentInEvent

boolean

Is identifier present in event boolean.

–

companyIdentifierType

string

Company identifier type for business partner.

–

N103

NAD020-030

companyIdentifierValue

string

Company identifier value for business partner.

–

N104

NAD020-010

alternateCompanyLocationIdentifierValue

string

Alternate company location identifier value.

–

address

–

Party address information.

–

address1

string

Main street address.

–

N301

NAD050-010

address2

string

Supplemental street address.

–

N302

NAD050-020

city

string

City.

–

N401

NAD060

district

string

District

–

state

string

State or region code

–

N402

NAD070-010

postalCode

string

Postal code

–

N403

NAD080

country

string

Country code

–

N404

NAD090

telephone

string

Telephone number

–

fax

string

Fax number

–

url

string

Website URL

–

buildingNumber

string

Building number

–

plantNumber

string

Plant number

–

floorNumber

string

Floor number in building

–

lscAddressIdentifier

string

LSC address identifier

–

village

string

Village name

–

houseNumber

string

House number

–

township

string

Township

–

premisesCode

string

Premises code

–

companyLocationContactInformation

–

Hard code PER01 to "AJ" primary contact

Hard code CTA010 to "RP" responsible person

contactName

string

Contact name

–

PER02

CTA020-020

contactTitle

string

Title of contact

–

N/A

contactPhone

string

Contact phone number

–

PER04 where PER03 = "TE"

COM010-010 where COM010-020 = "TE"

contactEmail

string

Contact email address

–

PER06 where PER05 = "EM"

COM010-010 where COM010-020 = "EM"

shipToLocationInformation

–

Ship to party company identifiers and address information.

–

N101 = "ST"

NAD010 = "ST"

businessName

string

Business name for partner or location.

–

N102

NAD030-010

mpcCompanyLocationIdentifierList

array

Identifier list for business party.

–

isIdentifierPresentInEvent

boolean

Is identifier present in event boolean.

–

companyIdentifierType

string

Company identifier type for business partner.

–

N103

NAD020-030

companyIdentifierValue

string

Company identifier value for business partner.

–

N104

NAD020-010

alternateCompanyLocationIdentifierValue

string

Alternate company location identifier value.

–

address

–

Party address information.

–

address1

string

Main street address.

–

N301

NAD050-010

address2

string

Supplemental street address.

–

N302

NAD050-020

city

string

City

–

N401

NAD060

district

string

District

–

N/A

state

string

State or region code

–

N402

NAD070-010

postalCode

string

Postal code

–

N403

NAD080

country

string

Country code

–

N404

NAD090

telephone

string

Telephone number

–

fax

string

Fax number

–

url

string

Website URL

–

buildingNumber

string

Building number

–

plantNumber

string

Plant number

–

floorNumber

string

Floor number in building

–

lscAddressIdentifier

string

LSC address identifier

–

village

string

Village name

–

houseNumber

string

House number

–

township

string

Township

–

premisesCode

string

Premises code

–

companyLocationContactInformation

–

Hard code PER01 to "AJ" primary contact

Hard code CTA010 to "RP" responsible person

contactName

string

Contact name

–

PER02

CTA020-020

contactTitle

string

Title of contact

–

N/A

contactPhone

string

Contact phone number

–

PER04 where PER03 = "TE"

COM010-010 where COM010-020 = "TE"

contactEmail

string

Contact email address

–

PER06 where PER05 = "EM"

COM010-010 where COM010-020 = "EM"

freeTextNote

array

Ship to party company identifiers and address information.

IDoc header = E1BP2017_GM_HEAD_01

–

textReferenceCode

string

Text reference or subject code. Will map whatever is found.

–

textFunctionCode

string

Text function code. Will map whatever is found.

–

language

string

Language of free text.

–

textFormatCode

string

Format code for free text.

–

freeText

string

Free test string.

HEADER_TXT

–

customFields

array

Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level.

–

name

string

Name of mapped field.

–

value

string

Value in named field.

–

canonicalInventoryUpdateItemDetails

array

Canonical inventory item details.

IDoc line item loop - E1BP2017_GM_ITEM_CREATE

X12 line item loop = 0900 W19

EDIFACT line item loop = Segment Group 9 LIN

plantIdentifier

string

Customer plant identifier for sales forecast.

PLANT

N902 where N901 = PE

LOC020-010 where LOC01-010 = 19

storageLocation

string

Location in plant where stock is stored.

STGE_LOC

N902 where N901 = WS (Warrehouse Storage Location)

LOC020-010 where LOC01-010 = 14

productCodesIdentifiers

array

Product code identifiers list.

productCodeType

string

Code to qualify product identifier type: CUSTOMER SUPPLIER.

productCodeType - CUSTOMER

productCodeType - CUSTOMER = W1905 = BP
productCodeType = SUPPLIER = W1905 = VN

productCodeType - CUSTOMER = LIN030-020 = BP
productCodeType = SUPPLIER = PIA020-020 = VN

productCodeValue

string

Product code identifier value.

MATERIAL

CUSTOMER mapping W1906 where W1905 = BP
SUPPLIER mapping W1906 where W1905 = VN

CUSTOMER mapping LIN030-010 where LIN030-020 = BP
SUPPLIER mapping PIA020-010 where PIA020-020 = VN

productItemInformation

array

Product item descriptions and information.

–

productLanguageCode

string

Language for product description.

–

productName

string

Name of product.

ITEM_TEXT

G6901

IMD030-040

genericName

string

Generic name for product.

–

productDescription

string

Description of the product defined by the current product identifier.

–

lotNumber

string

Lot or batch identifier (customer).

–

customerLotNumber

string

Customer lot number.

BATCH

N902 where N901 = LT

PIA020-010 where PIA010 = 1 (hard code) and PIA020-020 = BB

supplierLotNumber

string

Supplier lot or batch identifier. For Merck's custom XML this represents the expected batch or lot number from the released process (work) order.

VENDRBATCH

W1909

expirationDate

string

Expiration date for lot.

EXPIRYDATE

EXPIRATION mapping G6202 where G6201 = 36

EXPIRATION mapping DTM010-020where DTM010-010 = 36

epochExpirationDate

integer

Expiration date for lot generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.

–

manufacturingDate

string

Manufacturing date for lot.

PROD_DATE

MANUFACTURING mapping G6202 where G6201 = BL

MANUFACTURING mapping DTM010-020where DTM010-010 = 94

epochManfacturingDate

integer

Manufacturing date for lot generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.

–

customerIdentifier

string

Customer identifier.

CUSTOMER

N104 where N101 = BY (from header)

NAD020-010 where NAD010 = BY (from header)

supplierIdentifier

string

Supplier identifier.

VENDOR

N104 where N101 = SU (from header)

NAD020-010 where NAD010 = SU (from header)

goodsRecipientIdentifier

string

Goods recipient/ship to party location identifier.

GR_RCPT

N104 where N101 = ST (from header or line item)

NAD020-010 where NAD010 = ST (from header or line item)

productionMaterialState

string

Material type.

Valid values:

API - Active pharmaceutical ingredient
WIP - Work in process
COMPONENT - Component material
FINISHEDGOODS
RAWMATERIAL

–

componentIdentifier

string

Component product identifier. Used in custom maps when components are being consumed after production.

–

itemCategory

string

Groups similar articles together (e.g. product group). It has no effect on functionality, but can be used to link articles for queries or reports if necessary.

–

itemType

string

Determines the type of articles declared on this order.

Item Type links similar articles allowing processes or information for specific groups of articles.

–

isStoreSensitiveGoods

boolean

This flag indicates, whether the article needs to be stored in an area for sensitive goods. This is considered in the put-away process.

Valid values:

0 - No
1 - Yes

–

isTemperatureControlled

boolean

This flag indicates, whether the article needs to be stored in a temperature controlled area. This is considered in the put-away process.

Valid values:

0 - No
1 - Yes

–

isCaptureSerialNumbers

boolean

This flag indicates whether an article requires serial number capturing. This flag is considered in the RDT-based outbound processes.

Valid values:

0 - No
1 - Yes

–

stockRotationMethod

string

Determines the sequence in which the stock is allocated in outbound processes. Linked to the stockRotationBasis field.

–

stockRotationBasis

string

Determines the basis, with stockRotationMethod, on which stock will be selected and allocated in an outbound process.

–

commodityExportTariffCode

string

Export commodity code of the article. Used to derive a customs tariff when the goods are exported.

–

commodityImportTariffCode

string

Import commodity code of the article. Used to derive a customs tariff when the goods are imported.

–

recipeCode

string

Free-text optional field. It often appears on shipment documentation

–

smallNormalFlag

string

This value indicates the type of RDT-workbank-tasks, required for picking/packing. 2 needs to be set if SAP-tasks are to be generated.

Valid values:

NORMAL - 1
SMALL - 2

–

serialNumberCountBySKU

number

Number of serial stickers needed per SKU box.

–

pricingUnitNumerator

string

Specifies how many units of the articles the article value applies to.

For Example, if articles are only valued in packs of 10 then the value for 10 articles would be entered in ArticleValue and then value10 would be entered here.

–

costValueOfStock

string

The cost value of the stock

–

isQuantityReturnToStock

boolean

Specifies for qty return stock (Y= qty return to stock, N= no qty return to stock).

Valid values:

True - Y = Quantity return to stock
False - N = No quantity return to stock

–

customerPlantIdentifier

string

Client Plant code (for Recsup).

–

packagingIdentifier

string

External packaging container identifier for parent container.

–

carrierTrackingIdentifier

string

Carrier Tracking Number.

–

containerIdentifier

string

Identifier of the container.

–

containerType

string

The Type of container.

–

containerProductCode

string

GTIN of the container.

–

warehouseManagementSystemInformation

–

statusCode

string

Alloga's local WMS status code.

–

reasonCode

string

Alloga's localWMS reason code.

–

transactionCode

string

Alloga's local WMS Transaction code.

–

storageLocation

string

Alloga's local WMS Storage Location Code.

–

totalItemPriceValue

–

priceValue

number

Total price value for items ordered in message.

–

currencyCode

string

Currency code for price value.

–

additionalProductReferencesFlag

–

Flags that determine if additional product references and dates are mandatory.

–

productReferenceFlag

string

Determines whether an Article Reference is mandatory when a goods item is created, altered or received.

Valid values:

NO - 0
YES - 1
INBOUNDONLY - 2
OUTBOUNDONLY - 3
ITEMTYPE - 4 (Take from Item Type)

–

productDateFlag

string

Determines whether Article Date 1 is mandatory when a goods item is created, altered or received.

Valid values:

NO - 0
YES - 1
INBOUNDONLY - 2
OUTBOUNDONLY - 3
ITEMTYPE - 4 (Take from Item Type)

–

additionalProductReferencesFlag2

–

Flags that determine if additional product references and dates are mandatory.

–

productReferenceFlag

string

Determines whether an Article Reference is mandatory when a goods item is created, altered or received.

Valid values:

NO - 0
YES - 1
INBOUNDONLY - 2
OUTBOUNDONLY - 3
ITEMTYPE - 4 (Take from Item Type)

–

productDateFlag

string

Determines whether Article Date 1 is mandatory when a goods item is created, altered or received.

Valid values:

NO - 0
YES - 1
INBOUNDONLY - 2
OUTBOUNDONLY - 3
ITEMTYPE - 4 (Take from Item Type)

–

additionalProductReferencesFlag3

–

Flags that determine if additional product references and dates are mandatory.

–

productReferenceFlag

string

Determines whether an Article Reference is mandatory when a goods item is created, altered or received.

Valid values:

NO - 0
YES - 1
INBOUNDONLY - 2
OUTBOUNDONLY - 3
ITEMTYPE - 4 (Take from Item Type)

–

productDateFlag

string

Determines whether Article Date 1 is mandatory when a goods item is created, altered or received.

Valid values:

NO - 0
YES - 1
INBOUNDONLY - 2
OUTBOUNDONLY - 3
ITEMTYPE - 4 (Take from Item Type)

–

productItemDetails

–

Details about the product, container, weight, volume, value, quantity, and other key information at a subline level.

–

itemCode

string

Unique identification of goods item.

–

consignmentIdentifier

string

Identification of the consignment to which the stock belongs.

–

productCodeValue

string

Product code value.

–

caseIdentifier

string

Case identifier number.

–

masterCaseIdentifier

string

Master case identifier.

–

packageType

string

Package type used for this PackKey Level, eg, BOX. Appendix includes full list of qualifiers.

–

conditionStatus

string

Status of the product item.

–

isBonded

boolean

Specifies whether stock declared on order line is bonded or not.

Valid values:

True - 1 = Product is bonded
False - 0 = Product is not bonded (default)

–

isTaxed

boolean

Specifies whether stock declared on order line is taxed or not.

Valid values:

True - 1 = Product is taxed
False - 0 = Product is not taxed (default)

–

warehouseIdentifier

string

Warehouse / warehouse complex identifier. Identification of warehousing client that is used throughout the system.

–

countryOfOrigin

string

Country from which shipment was shipped.

–

actualCaseWeight

–

Actual case weight.

–

weightType

string

Type of weight recorded.

Valid value is CASE.

–

weightValue

string

Weight of the case as the product item details level.

–

unitOfMeasure

string

Weight unit of measure in master data for product.

–

actualCaseVolume

–

Actual case volume at the product details level.

–

volumeType

string

Type of weight recorded.

Valid value is CASE.

–

volumeValue

number

Volume for item.

–

unitOfMeasure

string

Volume unit of measure.

–

itemQuantity

–

Quantity of item.

–

quantityType

string

Type of quantity recorded.

Valid value is ITEM.

–

quantityValue

string

Quantity of item.

–

unitOfMeasure

string

Unit of measure for quantity.

–

totalItemPriceValue

–

Segment recording total value of goods in message.

–

priceValue

number

Total price value for items ordered in message.

–

currencyCode

string

Currency code for price value.

–

packagingDimensions

–

Segment recording total value of goods in message.

–

packagingLength

number

Packaging length.

–

packagingWidth

number

Packaging width.

–

packagingHeight

number

Packaging height.

–

unitOfMeasure

string

Volume unit of measure.

–

stockTransactionBeforeUpdate

–

Information about the stock before the transaction is executed.

–

shippingReceivingPoint

string

Identifier code for the depot or site where the inventory is held, normally the warehouse to which the goods will be received.

–

warehouseZone

string

Warehouse zone identifier for the from transaction state. Codes in Appendix: broken link, no codes.

–

warehouseLocation

string

Warehouse location for the from transaction state. Codes in Appendix.

–

caseIdentifier

string

Case identifier number.

–

inventoryStatusUpdateCode

string

Stock status code for the from transaction state. Codes in Appendix. Current inventory status before the update.

This will not be used to update inventory.

–

isBonded

boolean

Specifies whether stock declared on order line is bonded or not.

Valid values:

0 - No
1 - Yes

–

isTaxed

boolean

Specifies whether stock declared on order line is taxed or not. .

Valid values:

0 - No
1 - Yes

–

additionalProductReferences

–

Additional product references instance 1.

–

additionalProductReference

string

Additional product reference or attribute. Pass thru mapping.

–

productDate

string

Additional product reference or attribute date value in date format YYYY-MM-DD.

–

epochProductDate

long

Additional product reference or attribute date value in epoch date format.

–

additionalProductReferences2

–

Additional product references instance 2.

–

additionalProductReference

string

Additional product reference or attribute. Pass thru mapping.

–

productDate

string

Additional product reference or attribute date value in date format YYYY-MM-DD.

–

epochProductDate

long

Additional product reference or attribute date value in epoch date format.

–

additionalProductReferences3

–

Additional product references instance 3.

–

additionalProductReference

string

Additional product reference or attribute. Pass thru mapping.

–

productDate

string

Additional product reference or attribute date value in date format YYYY-MM-DD.

–

epochProductDate

long

Additional product reference or attribute date value in epoch date format

–

itemQuantity

Quantity of ORDER.

–

quantityType

string

Type of quantity recorded.

Valid value is ORDER.

–

quantityValue

string

Quantity of Order.

–

unitOfMeasure

string

Unit of measure for quantity.

–

actualTareWeight

Actual Tare weight.

–

weightType

string

Type of weight recorded.

Valid value is TARE.

–

weightValue

string

Weight of the shipment as the product item details level.

–

unitOfMeasure

string

Weight unit of measure from master data for product.

–

inventoryUpdateQuantity

–

Quantity of item scheduled in the forecast.

–

quantityValue

number

Quantity of product reported in inventory.

ENTRY_QNT

W1902 If value include - (minus) sign, inventory decreased Else inventory increased

QTY010-020 segment group 12 Need a quantity type in QTY010-010: 501 = qty credited, 502 = qty debited INV010 identifies movement into (1) or out of (2) inventory

unitOfMeasure

string

Unit or Basis for Measurement Code.

Quantity UOM's include:

CA - Case
CP - Crate
CT - Carton
DS - Display
DZ - Dozen
EA - Each
PC - Piece
PF - Pallet
PK - Package
T3 - Thousand Pieces
TH - Thousand
TY - Tray
UN - Unit

ENTRY_UOM

W1903

QTY010-030

inventoryStatusUpdateCode

string

Code identifying the inventory adjustment or movement type.

MOVE_TYPE

W1901 W1902 (positive or negative amount) W1916

inventoryStatusUpdateTransactionType

string

Transaction type or document referenced for inventory adjustment.

MVT_IND

–

inventoryStatusUpdateReasonCode

string

Inventory adjustment reason code.

MOVE_REAS

–

stockTypeIndicator

string

Stock type indicator. Pass thru value for SAP, if populated.

STCK_TYPE

–

specialStockIndicator

string

Stock type indicator. Pass thru value for SAP, if populated.

SPEC_STOCK

–

stockTransactionIdentifier

string

Unique identifier for the inventory update transaction.

–

stockTransactionType

–

Two character code to identify the type of transaction, ie, whether a change, increase or decrease. Codes in appendix appear to be incomplete.

–

shippingReceivingPoint

string

Identifier code for the depot or site where the inventory is held, normally the warehouse to which the goods will be received.

–

warehouseZone

string

Warehouse zone identifier for the from transaction state. Codes in Appendix: broken link, no codes.

–

warehouseLocation

string

Warehouse location for the from transaction state. Codes in Appendix.

–

caseIdentifier

string

Case identifier number.

–

isBonded

boolean

Specifies whether stock declared on order line is bonded or not.

Valid values:

0 - No
1 - Yes

–

isTaxed

boolean

Specifies whether stock declared on order line is taxed or not. .

Valid values:

0 - No
1 - Yes

–

isIncrease

boolean

Whether the transaction added or subtracted inventory levels, null if stock levels remain static. Either a ‘+’ for adding stock or a ‘-‘ to subtract stock. Null if there is no change in the qty.

True = +
False = -

–

additionalProductReferences

–

Additional product references instance 1.

–

additionalProductReference

string

Additional product reference or attribute. Pass thru mapping.

–

productDate

string

Additional product reference or attribute date value in date format YYYY-MM-DD.

–

epochProductDate

long

Additional product reference or attribute date value in epoch date format.

–

additionalProductReferences2

–

Additional product references instance 2.

–

additionalProductReference

string

Additional product reference or attribute. Pass thru mapping.

–

productDate

string

Additional product reference or attribute date value in date format YYYY-MM-DD.

–

epochProductDate

long

Additional product reference or attribute date value in epoch date format.

–

additionalProductReferences3

–

Additional product references instance 3.

–

additionalProductReference

string

Additional product reference or attribute. Pass thru mapping.

–

productDate

string

Additional product reference or attribute date value in date format YYYY-MM-DD.

–

epochProductDate

long

Additional product reference or attribute date value in epoch date format.

–

transactionReferenceIdentifierList

–

Transaction references for purchase order number used in the custom IDoc segment.

–

b2bTransactionIdentifierType

string

Referenced document type. Valid value:

PURCHASEORDER
SUPPLIERORDER
RESERVATION
WORKORDER

b2bTransactionIdentifierType = PURCHASEORDER
b2bTransactionIdentifierType = WORKORDER
b2bTransactionIdentifierType = SUPPLIERORDER
b2bTransactionIdentifierType = RESERVATION

PURCHASEORDER mapping N901 = PO
WORKORDER mapping N901 = WO
DELIVERY mapping N901 = DO
RESERVATION mapping N901 = RSN

PURCHASEORDER mapping RFF010-010 = OP
WORKORDER mapping RFF010-010 = AOV
DELIVERY mapping RFF010-010 = AAK (Despatch Advice)
RESERVATION mapping RFF010-010 = AEO

b2bTransactionIdentifierValue

string

Transaction identifier value corresponding to transaction type identified by b2bTransactionIdentifierType.

PURCHASEORDER mapping PO_
NUMBER WORKORDER mapping ORDERID
SUPPLIERORDER mapping SALES_ORD
RESERVATION mappiing RESERV_NO

PURCHASEORDER mapping N902 where N901 = PO
WORKORDER mapping N902 where N901 = WO
DELIVERY mapping N902 where N901 = DO
RESERVATION mapping N902 where N901 = RSN

PURCHASEORDER mapping RFF020 where RFF010-010 = OP
WORKORDER mapping RFF020 where RFF010-010 = AOV
DELIVERY mapping RFF020 where RFF010-010 = AAK (Despatch Advice)
RESERVATION mapping RFF020 where RFF010-010 = AEO

transactionDate

string

Date transaction created

–

epochTransactionDate

integer

Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.

–

lineItemNumber

string

Line item number

PURCHASEORDER mapping PO_ITEM
WORKORDER mapping ORDER_ITNO
SUPPLIERORDER mapping S_ORD_ITEM
RESERVATION mapping RES_ITEM

PURCHASEORDER mapping N903 where N901 = PO
WORKORDER mapping N903 where N901 = WO
DELIVERY mapping N903 where N901 = DO
RESERVATION mapping N903 where N901 = RSN

PURCHASEORDER mapping RFF030 where RFF010-010 = OP
WORKORDER mapping RFF030 where RFF010-010 = AOV
DELIVERY mapping RFF030 where RFF010-010 = AAK (Despatch Advice)
RESERVATION mapping RFF030 where RFF010-010 = AEO

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents.

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

–

N9

–

transactionReferenceType

string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include: -

PRODUCTTYPE - Product type
STATUS - Status
EVENTIDENTIFIER - Event identifier

–

N901 Use Java call-out to enumeration lookup table CL_TransactionReferenceType

–

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N902

–

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02).

–

N903

–

transactionReferenceDate

string

Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

–

N904 & N905

–

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

mpcDates

array

Dates relevant for inventory adjustment line item.

–

dateType

string

Date type at header level for inventory update.

Valid value is INVENTORYUPDATE.

dateType = INVENTORYUPDATE

dateType = INVENTORYUPDATE = DTM010-010 = 366

dateValue

string

Date defined by referenced date type in date format YYYY-MM-DD.

INVENTORYUPDATE mapping REF_DATE

INVENTORYUPDATE mapping G6202 where G6201=AB "AB" qualifier describes "Warehouse Inventory Stock"

DTM010-020

epochDateValue

integer

Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.

–

timeZone

string

Time zone for referenced dates

–

freeTextNote

array

Ship to party company identifiers and address information.

–

textReferenceCode

string

Text reference or subject code. Will map whatever is found.

–

textFunctionCode

string

Text function code. Will map whatever is found.

–

language

string

Language of free text.

–

textFormatCode

string

Format code for free text.

–

freeText

string

Free test string.

–

customFields

array

Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level.

–

name

string

Name of mapped field.

–

value

string

Value in named field.

–

Inventory update canonical guidelines

Table of contents

Table of contents

Inventory update canonical guidelines

Table of contents

Table of contents

Cookie Settings