| GET | /api/itemDataNotification/gtin/{Gtin} | Get specific ItemDataNotification by Gtin |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.ItemDataNotification
Imports DX.STF.Models.Dto.GS1
Namespace Global
Namespace DX.STF.Application.ClientApi.Messages.ItemDataNotification
'''<Summary>
'''Item Data Notification
'''</Summary>
<Api(Description:="Item Data Notification")>
<ApiResponse(Description:="ItemDataNotification data", IsDefaultResponse:=true, StatusCode:=200)>
<ApiResponse(Description:="No Content", ResponseType:=GetType(IReturnVoid), StatusCode:=204)>
<ApiResponse(Description:="Specified argument was out of the range of valid values.", ResponseType:=GetType(ArgumentOutOfRangeException), StatusCode:=400)>
Public Partial Class GetItemDataNotificationByGtin
'''<Summary>
'''Global Trade Item Number (GTIN)
'''</Summary>
<ApiMember(Description:="Global Trade Item Number (GTIN)", ExcludeInSchema:=true, ParameterType:="path")>
Public Overridable Property Gtin As String
End Class
End Namespace
Namespace DX.STF.Models.Dto.GS1
Public Partial Class AdditionalTradeItemClassificationCode
Public Overridable Property Value As String
Public Overridable Property AdditionalTradeItemClassificationCodeListCode As String
Public Overridable Property AdditionalTradeItemClassificationCodeListVersion As String
Public Overridable Property CodeDescription As String
End Class
Public Partial Class AdditionalTradeItemIdentification
Public Overridable Property Value As String
Public Overridable Property Code As String
End Class
Public Partial Class Address
Public Overridable Property StreetAddressOne As String
Public Overridable Property StreetAddressTwo As String
Public Overridable Property StreetAddressThree As String
Public Overridable Property City As String
Public Overridable Property PostalCode As String
Public Overridable Property ProvinceCode As String
Public Overridable Property CountryCode As String
End Class
Public Partial Class AdministrativeUnit
Public Overridable Property TypeCode As String
Public Overridable Property Gln As String
Public Overridable Property InternalIdentification As String
End Class
Public Partial Class AvpList
Public Overridable Property Code As String
Public Overridable Property Value As String
End Class
Public Partial Class BaseDocument
Public Overridable Property CurrencyCode As String
Public Overridable Property CreationDateTime As Date
Public Overridable Property DocumentActionCode As DocumentAction
Public Overridable Property DocumentStatusCode As DocumentStatus
Public Overridable Property DocumentStructureVersion As String
Public Overridable Property LastUpdateDateTime As Date?
Public Overridable Property RevisionNumber As Long?
Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class CommunicationChannel
Public Overridable Property CommunicationChannelCode As String
Public Overridable Property CommunicationChannelName As String
Public Overridable Property CommunicationValue As String
End Class
Public Partial Class Contact
Public Overridable Property ContactTypeCode As String
Public Overridable Property PersonName As String
Public Overridable Property DepartmentName As String
Public Overridable Property JobTitle As String
Public Overridable Property Responsibility As String
Public Overridable Property CommunicationChannel As List(Of CommunicationChannel) = New List(Of CommunicationChannel)
End Class
Public Partial Class DangerousGoodsInformation
Public Overridable Property DangerousGoodsDescription As String
Public Overridable Property DangerousGoodsShippingName As String
Public Overridable Property DangerousGoodsTechnicalName As String
Public Overridable Property dangerousGoodsUNIdentifier As Identifier
Public Overridable Property Contact As List(Of Contact) = New List(Of Contact)
End Class
Public Partial Class Dimension
Public Overridable Property Depth As Measurement
Public Overridable Property Height As Measurement
Public Overridable Property Width As Measurement
End Class
Public Enum DocumentAction
ADD
CHANGE_BY_REFRESH
DELETE
REJECTED
End Enum
Public Enum DocumentStatus
ADDITIONAL_TRANSMISSION
COPY
ORIGINAL
End Enum
Public Partial Class Ecom_PartyIdentificationType
Public Overridable Property Gln As String
Public Overridable Property Name As String
Public Overridable Property AdditionalPartyIdentification As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class Ecom_TradeItemIdentification
Public Overridable Property AdditionalTradeItemIdentification As List(Of AdditionalTradeItemIdentification) = New List(Of AdditionalTradeItemIdentification)
Public Overridable Property Gtin As String
End Class
Public Partial Class FinancialAccount
Public Overridable Property Number As String
Public Overridable Property NumberTypeCode As String
Public Overridable Property Name As String
End Class
Public Partial Class FinancialInstitutionInformation
Public Overridable Property FinancialInstitutionBranchName As String
Public Overridable Property FinancialInstitutionName As String
Public Overridable Property FinancialRoutingNumber As FinancialRoutingNumber
Public Overridable Property FinancialAccount As FinancialAccount
Public Overridable Property SwiftCode As String
Public Overridable Property ExportersCode As String
End Class
Public Partial Class FinancialRoutingNumber
Public Overridable Property Number As String
Public Overridable Property NumberTypeCode As String
End Class
Public Partial Class HandlingInstruction
Public Overridable Property HandlingInstructionCode As String
Public Overridable Property HandlingInstructionText As String
Public Overridable Property PrintingInstructionCode As List(Of String) = New List(Of String)
Public Overridable Property storageTemperature As TemperatureRange
Public Overridable Property TransportTemperature As TemperatureRange
End Class
<DataContract>
Public Partial Class Identifier
<DataMember(Name:="authority")>
Public Overridable Property Authority As String
<DataMember(Name:="text")>
Public Overridable Property Text As String
End Class
Public Partial Class IdentifierType
Public Overridable Property Value As String
Public Overridable Property IdentificationSchemeAgencyCodeCodeListVersion As String
Public Overridable Property IdentificationSchemeAgencyName As String
Public Overridable Property IdentificationSchemeName As String
End Class
Public Partial Class ItemDataLogisticUnitInformation
Public Overridable Property grossWeight As Measurement
Public Overridable Property MaximumStackingFactor As Long?
Public Overridable Property NetWeight As Measurement
Public Overridable Property NumberOfLayers As Long?
Public Overridable Property PackageLevelCode As String
Public Overridable Property PackageTypeCode As String
Public Overridable Property TradeItemQuantity As Quantity
Public Overridable Property TradeItemQuantityPerLayer As Quantity
Public Overridable Property AvpList As AvpList
Public Overridable Property dimensionsOfLogisticUnit As List(Of Dimension) = New List(Of Dimension)
End Class
Public Partial Class ItemDataNotificationLineItem
Inherits Ecom_TradeItemIdentification
Public Overridable Property BrandName As String
Public Overridable Property GpcCategoryCode As String
Public Overridable Property IsTheProductVariantPreferred As Boolean?
Public Overridable Property LineItemNumber As Long?
Public Overridable Property ParentLineItemNumber As Long?
Public Overridable Property ProductVariantIdentifier As IdentifierType
Public Overridable Property QuantityOfItemTypes As Decimal?
Public Overridable Property QuantityOfItemUnits As Decimal?
Public Overridable Property TradeItemDescription As List(Of String) = New List(Of String)
Public Overridable Property TradeItemUnitDescriptorCode As String
Public Overridable Property ItemDataTradingPartnerNeutral As ItemDataTradingPartnerNeutral
Public Overridable Property ItemDataTradingPartnerDependent As List(Of ItemDataTradingPartnerDependent) = New List(Of ItemDataTradingPartnerDependent)
Public Overridable Property LowerLevelTradeItem As List(Of LowerLevelTradeItem) = New List(Of LowerLevelTradeItem)
Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class ItemDataNotificationMessage
Inherits BaseDocument
Public Overridable Property DataRecipient As TransactionalParty
Public Overridable Property DataSource As TransactionalParty
Public Overridable Property ItemDataNotificationIdentification As String
Public Overridable Property ItemDataNotificationLineItem As List(Of ItemDataNotificationLineItem) = New List(Of ItemDataNotificationLineItem)
End Class
Public Partial Class ItemDataStockRequirements
Public Overridable Property requiredStockLevel As Quantity
Public Overridable Property requiredStockLevelValidityDateTime As Date?
Public Overridable Property StockRequirementTypeCode As String
End Class
Public Partial Class ItemDataTradingPartnerDependent
Public Overridable Property CountryOfOrigin As String
Public Overridable Property MinimumRemainingShelfLifeInbound As TimeMeasurement
Public Overridable Property MinimumRemainingShelfLifeOutbound As TimeMeasurement
Public Overridable Property OrderQuantityMaximum As Quantity
Public Overridable Property OrderQuantityMinimum As Quantity
Public Overridable Property OrderQuantityMultiple As Quantity
Public Overridable Property QualityControlCode As String
Public Overridable Property QuarantinePeriod As TimeMeasurement
Public Overridable Property TradeItemProductionLeadTime As TimeMeasurement
Public Overridable Property TradeItemShipmentLeadTime As TimeMeasurement
Public Overridable Property TradeItemSpecificUnitOfMeasure As String
Public Overridable Property TradeItemSubstitutionDateTime As Date?
Public Overridable Property ItemDataLogisticUnitInformation As List(Of ItemDataLogisticUnitInformation) = New List(Of ItemDataLogisticUnitInformation)
Public Overridable Property ItemDataStockRequirements As List(Of ItemDataStockRequirements) = New List(Of ItemDataStockRequirements)
Public Overridable Property AdministrativeUnitOfReceiver As List(Of AdministrativeUnit) = New List(Of AdministrativeUnit)
Public Overridable Property AvpList As AvpList
Public Overridable Property originatingParty As List(Of TransactionalPartyInRole) = New List(Of TransactionalPartyInRole)
Public Overridable Property Receiver As TransactionalParty
Public Overridable Property Shipper As TransactionalParty
Public Overridable Property SubstituteItem As Ecom_TradeItemIdentification
End Class
Public Partial Class ItemDataTradingPartnerNeutral
Public Overridable Property CancelledDateTime As Date?
Public Overridable Property DiscontinuedDateTime As Date?
Public Overridable Property EffectiveDateTime As Date
Public Overridable Property EndAvailabilityDateTime As Date?
Public Overridable Property MaximumStackingFactor As Integer?
Public Overridable Property StartAvailabilityDateTime As Date
Public Overridable Property TradeItemBaseUnitOfMeasure As String
Public Overridable Property TradeItemClassificationCode As List(Of AdditionalTradeItemClassificationCode) = New List(Of AdditionalTradeItemClassificationCode)
Public Overridable Property WarehouseABCClassificationCode As String
Public Overridable Property ItemDataWeightAndDimension As ItemDataWeightAndDimension
Public Overridable Property HandlingInstruction As List(Of HandlingInstruction) = New List(Of HandlingInstruction)
Public Overridable Property DangerousGoodsInformation As List(Of DangerousGoodsInformation) = New List(Of DangerousGoodsInformation)
Public Overridable Property AdministrativeUnitOfLogisticServiceBuyer As AdministrativeUnit
Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class ItemDataWeightAndDimension
Public Overridable Property Depth As Measurement
Public Overridable Property Diameter As Measurement
Public Overridable Property GrossWeight As Measurement
Public Overridable Property height As Measurement
Public Overridable Property NetWeight As Measurement
Public Overridable Property Width As Measurement
End Class
Public Partial Class LowerLevelTradeItem
Inherits Ecom_TradeItemIdentification
Public Overridable Property QuantityOfLowerLevelTradeItem As Decimal?
End Class
Public Partial Class Measurement
Public Overridable Property Value As Decimal?
Public Overridable Property CodeListVersion As String
Public Overridable Property MeasurementUnitCode As String
End Class
Public Partial Class Quantity
Public Overridable Property Value As Decimal?
Public Overridable Property MeasurementUnitCode As String
Public Overridable Property CodeListVersion As String
End Class
Public Partial Class TemperatureMeasurement
Public Overridable Property Value As Decimal?
Public Overridable Property TemperatureMeasurementUnitCode As String
End Class
Public Partial Class TemperatureRange
Public Overridable Property MaximumTemperature As TemperatureMeasurement
Public Overridable Property MinimumTemperature As TemperatureMeasurement
End Class
Public Partial Class TimeMeasurement
Public Overridable Property TimeMeasurementUnitCode As String
Public Overridable Property Value As Decimal?
End Class
Public Partial Class TransactionalParty
Inherits Ecom_PartyIdentificationType
Public Overridable Property Contact As List(Of Contact) = New List(Of Contact)
Public Overridable Property Address As Address
Public Overridable Property CommunicationChannel As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property FinancialInstitutionInformation As FinancialInstitutionInformation
Public Overridable Property DutyFeeTaxRegistration As String
Public Overridable Property EntityIdentification As String
End Class
Public Partial Class TransactionalPartyInRole
Public Overridable Property PartyRoleCode As String
Public Overridable Property TransactionalParty As TransactionalParty
End Class
End Namespace
End Namespace
VB.NET GetItemDataNotificationByGtin DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/itemDataNotification/gtin/{Gtin} HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}