DX STF Client API

AddItemDataNotification

Item Data Notification Requests

Item Data Notification

The following routes are available for this service:
POST	/api/itemDataNotification	Add new ItemDataNotification

**AddItemDataNotification** Parameters:
Name	Parameter	Data Type	Required	Description
ItemDataNotification	model	ItemDataNotificationMessage	Yes	ItemDataNotification model containing all of the ItemDataNotification data

**ItemDataNotificationMessage** Parameters:
Name	Parameter	Data Type	Required
DataRecipient	form	TransactionalParty	Yes
DataSource	form	TransactionalParty	Yes
ItemDataNotificationIdentification	form	string	Yes
ItemDataNotificationLineItem	form	List<ItemDataNotificationLineItem>	Yes

**BaseDocument** Parameters:
Name	Parameter	Data Type	Required
CurrencyCode	form	string	Yes
CreationDateTime	form	DateTime	No
DocumentActionCode	form	DocumentAction	No
DocumentStatusCode	form	DocumentStatus	No
DocumentStructureVersion	form	string	Yes
LastUpdateDateTime	form	DateTime?	No
RevisionNumber	form	long?	No
AvpList	form	List<AvpList>	Yes

**DocumentAction** Enum:
ADD
CHANGE_BY_REFRESH
DELETE
REJECTED

**DocumentStatus** Enum:
ADDITIONAL_TRANSMISSION
COPY
ORIGINAL

**AvpList** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	Yes
Value	form	string	Yes

**TransactionalParty** Parameters:
Name	Parameter	Data Type	Required
Contact	form	List<Contact>	Yes
Address	form	Address	Yes
CommunicationChannel	form	List<AvpList>	Yes
FinancialInstitutionInformation	form	FinancialInstitutionInformation	Yes
DutyFeeTaxRegistration	form	string	Yes
EntityIdentification	form	string	Yes

**Ecom_PartyIdentificationType** Parameters:
Name	Parameter	Data Type	Required
Gln	form	string	Yes
Name	form	string	Yes
AdditionalPartyIdentification	form	List<AvpList>	Yes

**Contact** Parameters:
Name	Parameter	Data Type	Required
ContactTypeCode	form	string	Yes
PersonName	form	string	Yes
DepartmentName	form	string	Yes
JobTitle	form	string	Yes
Responsibility	form	string	Yes
CommunicationChannel	form	List<CommunicationChannel>	Yes

**CommunicationChannel** Parameters:
Name	Parameter	Data Type	Required
CommunicationChannelCode	form	string	Yes
CommunicationChannelName	form	string	Yes
CommunicationValue	form	string	Yes

**Address** Parameters:
Name	Parameter	Data Type	Required
StreetAddressOne	form	string	Yes
StreetAddressTwo	form	string	Yes
StreetAddressThree	form	string	Yes
City	form	string	Yes
PostalCode	form	string	Yes
ProvinceCode	form	string	Yes
CountryCode	form	string	Yes

**FinancialInstitutionInformation** Parameters:
Name	Parameter	Data Type	Required
FinancialInstitutionBranchName	form	string	Yes
FinancialInstitutionName	form	string	Yes
FinancialRoutingNumber	form	FinancialRoutingNumber	Yes
FinancialAccount	form	FinancialAccount	Yes
SwiftCode	form	string	Yes
ExportersCode	form	string	Yes

**FinancialRoutingNumber** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	Yes
NumberTypeCode	form	string	Yes

**FinancialAccount** Parameters:
Name	Parameter	Data Type	Required
Number	form	string	Yes
NumberTypeCode	form	string	Yes
Name	form	string	Yes

**ItemDataNotificationLineItem** Parameters:
Name	Parameter	Data Type	Required
BrandName	form	string	Yes
GpcCategoryCode	form	string	Yes
IsTheProductVariantPreferred	form	bool?	No
LineItemNumber	form	long?	No
ParentLineItemNumber	form	long?	No
ProductVariantIdentifier	form	IdentifierType	Yes
QuantityOfItemTypes	form	decimal?	No
QuantityOfItemUnits	form	decimal?	No
TradeItemDescription	form	List<string>	Yes
TradeItemUnitDescriptorCode	form	string	Yes
ItemDataTradingPartnerNeutral	form	ItemDataTradingPartnerNeutral	Yes
ItemDataTradingPartnerDependent	form	List<ItemDataTradingPartnerDependent>	Yes
LowerLevelTradeItem	form	List<LowerLevelTradeItem>	Yes
AvpList	form	List<AvpList>	Yes

**Ecom_TradeItemIdentification** Parameters:
Name	Parameter	Data Type	Required	Description
AdditionalTradeItemIdentification	form	List<AdditionalTradeItemIdentification>	Yes
Gtin	form	string	Yes

**AdditionalTradeItemIdentification** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	Yes
Code	form	string	Yes

**IdentifierType** Parameters:
Name	Parameter	Data Type	Required
Value	form	string	Yes
IdentificationSchemeAgencyCodeCodeListVersion	form	string	Yes
IdentificationSchemeAgencyName	form	string	Yes
IdentificationSchemeName	form	string	Yes

**ItemDataTradingPartnerNeutral** Parameters:
Name	Parameter	Data Type	Required
CancelledDateTime	form	DateTime?	No
DiscontinuedDateTime	form	DateTime?	No
EffectiveDateTime	form	DateTime	No
EndAvailabilityDateTime	form	DateTime?	No
MaximumStackingFactor	form	int?	No
StartAvailabilityDateTime	form	DateTime	No
TradeItemBaseUnitOfMeasure	form	string	Yes
TradeItemClassificationCode	form	List<AdditionalTradeItemClassificationCode>	Yes
WarehouseABCClassificationCode	form	string	Yes
ItemDataWeightAndDimension	form	ItemDataWeightAndDimension	Yes
HandlingInstruction	form	List<HandlingInstruction>	Yes
DangerousGoodsInformation	form	List<DangerousGoodsInformation>	Yes
AdministrativeUnitOfLogisticServiceBuyer	form	AdministrativeUnit	Yes
AvpList	form	List<AvpList>	Yes

**AdditionalTradeItemClassificationCode** Parameters:
Name	Parameter	Data Type	Required
Value	form	string	Yes
AdditionalTradeItemClassificationCodeListCode	form	string	Yes
AdditionalTradeItemClassificationCodeListVersion	form	string	Yes
CodeDescription	form	string	Yes

**ItemDataWeightAndDimension** Parameters:
Name	Parameter	Data Type	Required
Depth	form	Measurement	Yes
Diameter	form	Measurement	Yes
GrossWeight	form	Measurement	Yes
height	form	Measurement	Yes
NetWeight	form	Measurement	Yes
Width	form	Measurement	Yes

**Measurement** Parameters:
Name	Parameter	Data Type	Required
Value	form	decimal?	No
CodeListVersion	form	string	Yes
MeasurementUnitCode	form	string	Yes

**HandlingInstruction** Parameters:
Name	Parameter	Data Type	Required
HandlingInstructionCode	form	string	Yes
HandlingInstructionText	form	string	Yes
PrintingInstructionCode	form	List<string>	Yes
storageTemperature	form	TemperatureRange	Yes
TransportTemperature	form	TemperatureRange	Yes

**TemperatureRange** Parameters:
Name	Parameter	Data Type	Required	Description
MaximumTemperature	form	TemperatureMeasurement	Yes
MinimumTemperature	form	TemperatureMeasurement	Yes

**TemperatureMeasurement** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	decimal?	No
TemperatureMeasurementUnitCode	form	string	Yes

**DangerousGoodsInformation** Parameters:
Name	Parameter	Data Type	Required
DangerousGoodsDescription	form	string	Yes
DangerousGoodsShippingName	form	string	Yes
DangerousGoodsTechnicalName	form	string	Yes
dangerousGoodsUNIdentifier	form	Identifier	Yes
Contact	form	List<Contact>	Yes

**Identifier** Parameters:
Name	Parameter	Data Type	Required	Description
Authority	form	string	Yes
Text	form	string	Yes

**AdministrativeUnit** Parameters:
Name	Parameter	Data Type	Required
TypeCode	form	string	Yes
Gln	form	string	Yes
InternalIdentification	form	string	Yes

**ItemDataTradingPartnerDependent** Parameters:
Name	Parameter	Data Type	Required
CountryOfOrigin	form	string	Yes
MinimumRemainingShelfLifeInbound	form	TimeMeasurement	Yes
MinimumRemainingShelfLifeOutbound	form	TimeMeasurement	Yes
OrderQuantityMaximum	form	Quantity	Yes
OrderQuantityMinimum	form	Quantity	Yes
OrderQuantityMultiple	form	Quantity	Yes
QualityControlCode	form	string	Yes
QuarantinePeriod	form	TimeMeasurement	Yes
TradeItemProductionLeadTime	form	TimeMeasurement	Yes
TradeItemShipmentLeadTime	form	TimeMeasurement	Yes
TradeItemSpecificUnitOfMeasure	form	string	Yes
TradeItemSubstitutionDateTime	form	DateTime?	No
ItemDataLogisticUnitInformation	form	List<ItemDataLogisticUnitInformation>	Yes
ItemDataStockRequirements	form	List<ItemDataStockRequirements>	Yes
AdministrativeUnitOfReceiver	form	List<AdministrativeUnit>	Yes
AvpList	form	AvpList	Yes
originatingParty	form	List<TransactionalPartyInRole>	Yes
Receiver	form	TransactionalParty	Yes
Shipper	form	TransactionalParty	Yes
SubstituteItem	form	Ecom_TradeItemIdentification	Yes

**TimeMeasurement** Parameters:
Name	Parameter	Data Type	Required	Description
TimeMeasurementUnitCode	form	string	Yes
Value	form	decimal?	No

**Quantity** Parameters:
Name	Parameter	Data Type	Required
Value	form	decimal?	No
MeasurementUnitCode	form	string	Yes
CodeListVersion	form	string	Yes

**ItemDataLogisticUnitInformation** Parameters:
Name	Parameter	Data Type	Required
grossWeight	form	Measurement	Yes
MaximumStackingFactor	form	long?	No
NetWeight	form	Measurement	Yes
NumberOfLayers	form	long?	No
PackageLevelCode	form	string	Yes
PackageTypeCode	form	string	Yes
TradeItemQuantity	form	Quantity	Yes
TradeItemQuantityPerLayer	form	Quantity	Yes
AvpList	form	AvpList	Yes
dimensionsOfLogisticUnit	form	List<Dimension>	Yes

**Dimension** Parameters:
Name	Parameter	Data Type	Required
Depth	form	Measurement	Yes
Height	form	Measurement	Yes
Width	form	Measurement	Yes

**ItemDataStockRequirements** Parameters:
Name	Parameter	Data Type	Required
requiredStockLevel	form	Quantity	Yes
requiredStockLevelValidityDateTime	form	DateTime?	No
StockRequirementTypeCode	form	string	Yes

**TransactionalPartyInRole** Parameters:
Name	Parameter	Data Type	Required	Description
PartyRoleCode	form	string	Yes
TransactionalParty	form	TransactionalParty	Yes

**LowerLevelTradeItem** Parameters:
Name	Parameter	Data Type	Required	Description
QuantityOfLowerLevelTradeItem	form	decimal?	No

**TokenDto** Parameters:
Name	Parameter	Data Type	Required	Description
Token	form	Guid	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/itemDataNotification HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	itemDataNotification: 
	{
		dataRecipient: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		dataSource: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		itemDataNotificationIdentification: String,
		itemDataNotificationLineItem: 
		[
			{
				brandName: String,
				gpcCategoryCode: String,
				isTheProductVariantPreferred: False,
				lineItemNumber: 0,
				parentLineItemNumber: 0,
				productVariantIdentifier: 
				{
					value: String,
					identificationSchemeAgencyCodeCodeListVersion: String,
					identificationSchemeAgencyName: String,
					identificationSchemeName: String
				},
				quantityOfItemTypes: 0,
				quantityOfItemUnits: 0,
				tradeItemDescription: 
				[
					String
				],
				tradeItemUnitDescriptorCode: String,
				itemDataTradingPartnerNeutral: 
				{
					cancelledDateTime: 0001-01-01,
					discontinuedDateTime: 0001-01-01,
					endAvailabilityDateTime: 0001-01-01,
					maximumStackingFactor: 0,
					tradeItemBaseUnitOfMeasure: String,
					tradeItemClassificationCode: 
					[
						{
							value: String,
							additionalTradeItemClassificationCodeListCode: String,
							additionalTradeItemClassificationCodeListVersion: String,
							codeDescription: String
						}
					],
					warehouseABCClassificationCode: String,
					itemDataWeightAndDimension: 
					{
						depth: 
						{
							value: 0,
							codeListVersion: String,
							measurementUnitCode: String
						},
						diameter: 
						{
							value: 0,
							codeListVersion: String,
							measurementUnitCode: String
						},
						grossWeight: 
						{
							value: 0,
							codeListVersion: String,
							measurementUnitCode: String
						},
						height: 
						{
							value: 0,
							codeListVersion: String,
							measurementUnitCode: String
						},
						netWeight: 
						{
							value: 0,
							codeListVersion: String,
							measurementUnitCode: String
						},
						width: 
						{
							value: 0,
							codeListVersion: String,
							measurementUnitCode: String
						}
					},
					handlingInstruction: 
					[
						{
							handlingInstructionCode: String,
							handlingInstructionText: String,
							printingInstructionCode: 
							[
								String
							],
							storageTemperature: 
							{
								maximumTemperature: 
								{
									value: 0,
									temperatureMeasurementUnitCode: String
								},
								minimumTemperature: 
								{
									value: 0,
									temperatureMeasurementUnitCode: String
								}
							},
							transportTemperature: 
							{
								maximumTemperature: 
								{
									value: 0,
									temperatureMeasurementUnitCode: String
								},
								minimumTemperature: 
								{
									value: 0,
									temperatureMeasurementUnitCode: String
								}
							}
						}
					],
					dangerousGoodsInformation: 
					[
						{
							dangerousGoodsDescription: String,
							dangerousGoodsShippingName: String,
							dangerousGoodsTechnicalName: String,
							dangerousGoodsUNIdentifier: 
							{
								authority: String,
								text: String
							},
							contact: 
							[
								{
									contactTypeCode: String,
									personName: String,
									departmentName: String,
									jobTitle: String,
									responsibility: String,
									communicationChannel: 
									[
										{
											communicationChannelCode: String,
											communicationChannelName: String,
											communicationValue: String
										}
									]
								}
							]
						}
					],
					administrativeUnitOfLogisticServiceBuyer: 
					{
						typeCode: String,
						gln: String,
						internalIdentification: String
					},
					avpList: 
					[
						{
							code: String,
							value: String
						}
					]
				},
				itemDataTradingPartnerDependent: 
				[
					{
						countryOfOrigin: String,
						minimumRemainingShelfLifeInbound: 
						{
							timeMeasurementUnitCode: String,
							value: 0
						},
						minimumRemainingShelfLifeOutbound: 
						{
							timeMeasurementUnitCode: String,
							value: 0
						},
						orderQuantityMaximum: 
						{
							value: 0,
							measurementUnitCode: String,
							codeListVersion: String
						},
						orderQuantityMinimum: 
						{
							value: 0,
							measurementUnitCode: String,
							codeListVersion: String
						},
						orderQuantityMultiple: 
						{
							value: 0,
							measurementUnitCode: String,
							codeListVersion: String
						},
						qualityControlCode: String,
						quarantinePeriod: 
						{
							timeMeasurementUnitCode: String,
							value: 0
						},
						tradeItemProductionLeadTime: 
						{
							timeMeasurementUnitCode: String,
							value: 0
						},
						tradeItemShipmentLeadTime: 
						{
							timeMeasurementUnitCode: String,
							value: 0
						},
						tradeItemSpecificUnitOfMeasure: String,
						tradeItemSubstitutionDateTime: 0001-01-01,
						itemDataLogisticUnitInformation: 
						[
							{
								grossWeight: 
								{
									value: 0,
									codeListVersion: String,
									measurementUnitCode: String
								},
								maximumStackingFactor: 0,
								netWeight: 
								{
									value: 0,
									codeListVersion: String,
									measurementUnitCode: String
								},
								numberOfLayers: 0,
								packageLevelCode: String,
								packageTypeCode: String,
								tradeItemQuantity: 
								{
									value: 0,
									measurementUnitCode: String,
									codeListVersion: String
								},
								tradeItemQuantityPerLayer: 
								{
									value: 0,
									measurementUnitCode: String,
									codeListVersion: String
								},
								avpList: 
								{
									code: String,
									value: String
								},
								dimensionsOfLogisticUnit: 
								[
									{
										depth: 
										{
											value: 0,
											codeListVersion: String,
											measurementUnitCode: String
										},
										height: 
										{
											value: 0,
											codeListVersion: String,
											measurementUnitCode: String
										},
										width: 
										{
											value: 0,
											codeListVersion: String,
											measurementUnitCode: String
										}
									}
								]
							}
						],
						itemDataStockRequirements: 
						[
							{
								requiredStockLevel: 
								{
									value: 0,
									measurementUnitCode: String,
									codeListVersion: String
								},
								requiredStockLevelValidityDateTime: 0001-01-01,
								stockRequirementTypeCode: String
							}
						],
						administrativeUnitOfReceiver: 
						[
							{
								typeCode: String,
								gln: String,
								internalIdentification: String
							}
						],
						avpList: 
						{
							code: String,
							value: String
						},
						originatingParty: 
						[
							{
								partyRoleCode: String,
								transactionalParty: 
								{
									contact: 
									[
										{
											contactTypeCode: String,
											personName: String,
											departmentName: String,
											jobTitle: String,
											responsibility: String,
											communicationChannel: 
											[
												{
													communicationChannelCode: String,
													communicationChannelName: String,
													communicationValue: String
												}
											]
										}
									],
									address: 
									{
										streetAddressOne: String,
										streetAddressTwo: String,
										streetAddressThree: String,
										city: String,
										postalCode: String,
										provinceCode: String,
										countryCode: String
									},
									communicationChannel: 
									[
										{
											code: String,
											value: String
										}
									],
									financialInstitutionInformation: 
									{
										financialInstitutionBranchName: String,
										financialInstitutionName: String,
										financialRoutingNumber: 
										{
											number: String,
											numberTypeCode: String
										},
										financialAccount: 
										{
											number: String,
											numberTypeCode: String,
											name: String
										},
										swiftCode: String,
										exportersCode: String
									},
									dutyFeeTaxRegistration: String,
									entityIdentification: String,
									gln: String,
									name: String,
									additionalPartyIdentification: 
									[
										{
											code: String,
											value: String
										}
									]
								}
							}
						],
						receiver: 
						{
							contact: 
							[
								{
									contactTypeCode: String,
									personName: String,
									departmentName: String,
									jobTitle: String,
									responsibility: String,
									communicationChannel: 
									[
										{
											communicationChannelCode: String,
											communicationChannelName: String,
											communicationValue: String
										}
									]
								}
							],
							address: 
							{
								streetAddressOne: String,
								streetAddressTwo: String,
								streetAddressThree: String,
								city: String,
								postalCode: String,
								provinceCode: String,
								countryCode: String
							},
							communicationChannel: 
							[
								{
									code: String,
									value: String
								}
							],
							financialInstitutionInformation: 
							{
								financialInstitutionBranchName: String,
								financialInstitutionName: String,
								financialRoutingNumber: 
								{
									number: String,
									numberTypeCode: String
								},
								financialAccount: 
								{
									number: String,
									numberTypeCode: String,
									name: String
								},
								swiftCode: String,
								exportersCode: String
							},
							dutyFeeTaxRegistration: String,
							entityIdentification: String,
							gln: String,
							name: String,
							additionalPartyIdentification: 
							[
								{
									code: String,
									value: String
								}
							]
						},
						shipper: 
						{
							contact: 
							[
								{
									contactTypeCode: String,
									personName: String,
									departmentName: String,
									jobTitle: String,
									responsibility: String,
									communicationChannel: 
									[
										{
											communicationChannelCode: String,
											communicationChannelName: String,
											communicationValue: String
										}
									]
								}
							],
							address: 
							{
								streetAddressOne: String,
								streetAddressTwo: String,
								streetAddressThree: String,
								city: String,
								postalCode: String,
								provinceCode: String,
								countryCode: String
							},
							communicationChannel: 
							[
								{
									code: String,
									value: String
								}
							],
							financialInstitutionInformation: 
							{
								financialInstitutionBranchName: String,
								financialInstitutionName: String,
								financialRoutingNumber: 
								{
									number: String,
									numberTypeCode: String
								},
								financialAccount: 
								{
									number: String,
									numberTypeCode: String,
									name: String
								},
								swiftCode: String,
								exportersCode: String
							},
							dutyFeeTaxRegistration: String,
							entityIdentification: String,
							gln: String,
							name: String,
							additionalPartyIdentification: 
							[
								{
									code: String,
									value: String
								}
							]
						},
						substituteItem: 
						{
							additionalTradeItemIdentification: 
							[
								{
									value: String,
									code: String
								}
							],
							gtin: String
						}
					}
				],
				lowerLevelTradeItem: 
				[
					{
						quantityOfLowerLevelTradeItem: 0,
						additionalTradeItemIdentification: 
						[
							{
								value: String,
								code: String
							}
						],
						gtin: String
					}
				],
				avpList: 
				[
					{
						code: String,
						value: String
					}
				],
				additionalTradeItemIdentification: 
				[
					{
						value: String,
						code: String
					}
				],
				gtin: String
			}
		],
		currencyCode: String,
		documentActionCode: ADD,
		documentStatusCode: ADDITIONAL_TRANSMISSION,
		documentStructureVersion: String,
		lastUpdateDateTime: 0001-01-01,
		revisionNumber: 0,
		avpList: 
		[
			{
				code: String,
				value: String
			}
		]
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}