DX STF Client API

<back to all web services

GetItemDataNotificationByIdentifier

Item Data Notification Requests

Item Data Notification

Requires Authentication
The following routes are available for this service:
GET/api/itemDataNotification/{OwnerGln}/{ItemDataNotificationIdentification}Get specific ItemDataNotification by ItemDataNotificationIdentification
GetItemDataNotificationByIdentifier Parameters:
NameParameterData TypeRequiredDescription
OwnerGlnpathstringYesOwner GLN
ItemDataNotificationIdentificationpathstringYesItemDataNotification ID or Token
ItemDataNotificationMessage Parameters:
NameParameterData TypeRequiredDescription
DataRecipientformTransactionalPartyYes
DataSourceformTransactionalPartyYes
ItemDataNotificationIdentificationformstringYes
ItemDataNotificationLineItemformList<ItemDataNotificationLineItem>Yes
BaseDocument Parameters:
NameParameterData TypeRequiredDescription
CurrencyCodeformstringYes
CreationDateTimeformDateTimeNo
DocumentActionCodeformDocumentActionNo
DocumentStatusCodeformDocumentStatusNo
DocumentStructureVersionformstringYes
LastUpdateDateTimeformDateTime?No
RevisionNumberformlong?No
AvpListformList<AvpList>Yes
DocumentAction Enum:
ADD
CHANGE_BY_REFRESH
DELETE
REJECTED
DocumentStatus Enum:
ADDITIONAL_TRANSMISSION
COPY
ORIGINAL
AvpList Parameters:
NameParameterData TypeRequiredDescription
CodeformstringYes
ValueformstringYes
TransactionalParty Parameters:
NameParameterData TypeRequiredDescription
ContactformList<Contact>Yes
AddressformAddressYes
CommunicationChannelformList<AvpList>Yes
FinancialInstitutionInformationformFinancialInstitutionInformationYes
DutyFeeTaxRegistrationformstringYes
EntityIdentificationformstringYes
Ecom_PartyIdentificationType Parameters:
NameParameterData TypeRequiredDescription
GlnformstringYes
NameformstringYes
AdditionalPartyIdentificationformList<AvpList>Yes
Contact Parameters:
NameParameterData TypeRequiredDescription
ContactTypeCodeformstringYes
PersonNameformstringYes
DepartmentNameformstringYes
JobTitleformstringYes
ResponsibilityformstringYes
CommunicationChannelformList<CommunicationChannel>Yes
CommunicationChannel Parameters:
NameParameterData TypeRequiredDescription
CommunicationChannelCodeformstringYes
CommunicationChannelNameformstringYes
CommunicationValueformstringYes
Address Parameters:
NameParameterData TypeRequiredDescription
StreetAddressOneformstringYes
StreetAddressTwoformstringYes
StreetAddressThreeformstringYes
CityformstringYes
PostalCodeformstringYes
ProvinceCodeformstringYes
CountryCodeformstringYes
FinancialInstitutionInformation Parameters:
NameParameterData TypeRequiredDescription
FinancialInstitutionBranchNameformstringYes
FinancialInstitutionNameformstringYes
FinancialRoutingNumberformFinancialRoutingNumberYes
FinancialAccountformFinancialAccountYes
SwiftCodeformstringYes
ExportersCodeformstringYes
FinancialRoutingNumber Parameters:
NameParameterData TypeRequiredDescription
NumberformstringYes
NumberTypeCodeformstringYes
FinancialAccount Parameters:
NameParameterData TypeRequiredDescription
NumberformstringYes
NumberTypeCodeformstringYes
NameformstringYes
ItemDataNotificationLineItem Parameters:
NameParameterData TypeRequiredDescription
BrandNameformstringYes
GpcCategoryCodeformstringYes
IsTheProductVariantPreferredformbool?No
LineItemNumberformlong?No
ParentLineItemNumberformlong?No
ProductVariantIdentifierformIdentifierTypeYes
QuantityOfItemTypesformdecimal?No
QuantityOfItemUnitsformdecimal?No
TradeItemDescriptionformList<string>Yes
TradeItemUnitDescriptorCodeformstringYes
ItemDataTradingPartnerNeutralformItemDataTradingPartnerNeutralYes
ItemDataTradingPartnerDependentformList<ItemDataTradingPartnerDependent>Yes
LowerLevelTradeItemformList<LowerLevelTradeItem>Yes
AvpListformList<AvpList>Yes
Ecom_TradeItemIdentification Parameters:
NameParameterData TypeRequiredDescription
AdditionalTradeItemIdentificationformList<AdditionalTradeItemIdentification>Yes
GtinformstringYes
AdditionalTradeItemIdentification Parameters:
NameParameterData TypeRequiredDescription
ValueformstringYes
CodeformstringYes
IdentifierType Parameters:
NameParameterData TypeRequiredDescription
ValueformstringYes
IdentificationSchemeAgencyCodeCodeListVersionformstringYes
IdentificationSchemeAgencyNameformstringYes
IdentificationSchemeNameformstringYes
ItemDataTradingPartnerNeutral Parameters:
NameParameterData TypeRequiredDescription
CancelledDateTimeformDateTime?No
DiscontinuedDateTimeformDateTime?No
EffectiveDateTimeformDateTimeNo
EndAvailabilityDateTimeformDateTime?No
MaximumStackingFactorformint?No
StartAvailabilityDateTimeformDateTimeNo
TradeItemBaseUnitOfMeasureformstringYes
TradeItemClassificationCodeformList<AdditionalTradeItemClassificationCode>Yes
WarehouseABCClassificationCodeformstringYes
ItemDataWeightAndDimensionformItemDataWeightAndDimensionYes
HandlingInstructionformList<HandlingInstruction>Yes
DangerousGoodsInformationformList<DangerousGoodsInformation>Yes
AdministrativeUnitOfLogisticServiceBuyerformAdministrativeUnitYes
AvpListformList<AvpList>Yes
AdditionalTradeItemClassificationCode Parameters:
NameParameterData TypeRequiredDescription
ValueformstringYes
AdditionalTradeItemClassificationCodeListCodeformstringYes
AdditionalTradeItemClassificationCodeListVersionformstringYes
CodeDescriptionformstringYes
ItemDataWeightAndDimension Parameters:
NameParameterData TypeRequiredDescription
DepthformMeasurementYes
DiameterformMeasurementYes
GrossWeightformMeasurementYes
heightformMeasurementYes
NetWeightformMeasurementYes
WidthformMeasurementYes
Measurement Parameters:
NameParameterData TypeRequiredDescription
Valueformdecimal?No
CodeListVersionformstringYes
MeasurementUnitCodeformstringYes
HandlingInstruction Parameters:
NameParameterData TypeRequiredDescription
HandlingInstructionCodeformstringYes
HandlingInstructionTextformstringYes
PrintingInstructionCodeformList<string>Yes
storageTemperatureformTemperatureRangeYes
TransportTemperatureformTemperatureRangeYes
TemperatureRange Parameters:
NameParameterData TypeRequiredDescription
MaximumTemperatureformTemperatureMeasurementYes
MinimumTemperatureformTemperatureMeasurementYes
TemperatureMeasurement Parameters:
NameParameterData TypeRequiredDescription
Valueformdecimal?No
TemperatureMeasurementUnitCodeformstringYes
DangerousGoodsInformation Parameters:
NameParameterData TypeRequiredDescription
DangerousGoodsDescriptionformstringYes
DangerousGoodsShippingNameformstringYes
DangerousGoodsTechnicalNameformstringYes
dangerousGoodsUNIdentifierformIdentifierYes
ContactformList<Contact>Yes
Identifier Parameters:
NameParameterData TypeRequiredDescription
AuthorityformstringYes
TextformstringYes
AdministrativeUnit Parameters:
NameParameterData TypeRequiredDescription
TypeCodeformstringYes
GlnformstringYes
InternalIdentificationformstringYes
ItemDataTradingPartnerDependent Parameters:
NameParameterData TypeRequiredDescription
CountryOfOriginformstringYes
MinimumRemainingShelfLifeInboundformTimeMeasurementYes
MinimumRemainingShelfLifeOutboundformTimeMeasurementYes
OrderQuantityMaximumformQuantityYes
OrderQuantityMinimumformQuantityYes
OrderQuantityMultipleformQuantityYes
QualityControlCodeformstringYes
QuarantinePeriodformTimeMeasurementYes
TradeItemProductionLeadTimeformTimeMeasurementYes
TradeItemShipmentLeadTimeformTimeMeasurementYes
TradeItemSpecificUnitOfMeasureformstringYes
TradeItemSubstitutionDateTimeformDateTime?No
ItemDataLogisticUnitInformationformList<ItemDataLogisticUnitInformation>Yes
ItemDataStockRequirementsformList<ItemDataStockRequirements>Yes
AdministrativeUnitOfReceiverformList<AdministrativeUnit>Yes
AvpListformAvpListYes
originatingPartyformList<TransactionalPartyInRole>Yes
ReceiverformTransactionalPartyYes
ShipperformTransactionalPartyYes
SubstituteItemformEcom_TradeItemIdentificationYes
TimeMeasurement Parameters:
NameParameterData TypeRequiredDescription
TimeMeasurementUnitCodeformstringYes
Valueformdecimal?No
Quantity Parameters:
NameParameterData TypeRequiredDescription
Valueformdecimal?No
MeasurementUnitCodeformstringYes
CodeListVersionformstringYes
ItemDataLogisticUnitInformation Parameters:
NameParameterData TypeRequiredDescription
grossWeightformMeasurementYes
MaximumStackingFactorformlong?No
NetWeightformMeasurementYes
NumberOfLayersformlong?No
PackageLevelCodeformstringYes
PackageTypeCodeformstringYes
TradeItemQuantityformQuantityYes
TradeItemQuantityPerLayerformQuantityYes
AvpListformAvpListYes
dimensionsOfLogisticUnitformList<Dimension>Yes
Dimension Parameters:
NameParameterData TypeRequiredDescription
DepthformMeasurementYes
HeightformMeasurementYes
WidthformMeasurementYes
ItemDataStockRequirements Parameters:
NameParameterData TypeRequiredDescription
requiredStockLevelformQuantityYes
requiredStockLevelValidityDateTimeformDateTime?No
StockRequirementTypeCodeformstringYes
TransactionalPartyInRole Parameters:
NameParameterData TypeRequiredDescription
PartyRoleCodeformstringYes
TransactionalPartyformTransactionalPartyYes
LowerLevelTradeItem Parameters:
NameParameterData TypeRequiredDescription
QuantityOfLowerLevelTradeItemformdecimal?No

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

HTTP + CSV

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

GET /api/itemDataNotification/{OwnerGln}/{ItemDataNotificationIdentification} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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"}]}