| POST | /api/order | Add new order |
|---|
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.Order
Imports DX.STF.Models.Dto.GS1
Imports DX.Framework.Core.Commands.Dto
Namespace Global
Namespace DX.Framework.Core.Commands.Dto
Public Partial Class TokenDto
Implements ICommandResponse
Public Overridable Property Token As Guid
End Class
End Namespace
Namespace DX.STF.Application.ClientApi.Messages.Order
'''<Summary>
'''Order
'''</Summary>
<Api(Description:="Order")>
<ApiResponse(Description:="Add order request received", IsDefaultResponse:=true, StatusCode:=200)>
<ApiResponse(Description:="Order not accepted, Confirm Sender GLN", ResponseType:=GetType(UnauthorizedAccessException), StatusCode:=403)>
Public Partial Class AddOrder
'''<Summary>
'''Order model containing all of the order data
'''</Summary>
<ApiMember(DataType:="OrderMessage", Description:="Order model containing all of the order data", Name:="order", ParameterType:="model")>
Public Overridable Property Order As OrderMessage
End Class
End Namespace
Namespace DX.STF.Models.Dto.GS1
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 AllowanceCharge
Public Overridable Property AllowanceChargeAmount As Decimal?
Public Overridable Property AllowanceChargePercentage As Decimal?
Public Overridable Property AllowanceChargeType As String
Public Overridable Property AllowanceOrChargeType As String
Public Overridable Property AmountPerUnit As Decimal?
Public Overridable Property BaseAmount As Decimal?
Public Overridable Property BaseNumberOfUnits As String
Public Overridable Property BracketIdentifier As String
Public Overridable Property EffectiveDateType As Date?
Public Overridable Property SequenceNumber As String
Public Overridable Property SettlementType As String
Public Overridable Property SpecialServiceType As String
Public Overridable Property AllowanceChargeDescription 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 Code
Public Overridable Property Value As String
Public Overridable Property CodeDescription As String
Public Overridable Property CodeListAgencyCodeListVersion As String
Public Overridable Property CodeListAgencyName As String
Public Overridable Property CodeListName As String
Public Overridable Property CodeListUri As String
End Class
Public Partial Class Colour
Public Overridable Property ColourCode As String
Public Overridable Property ColourDescription As String
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
<DataContract>
Public Partial Class ContactInformation
End Class
Public Partial Class DateRange
Public Overridable Property BeginDate As Date?
Public Overridable Property BeginTime As Date?
Public Overridable Property EndDate As Date?
Public Overridable Property EndTime As Date?
End Class
Public Partial Class DeliveryTerms
Public Overridable Property IncotermsCode As String
Public Overridable Property AlternateDeliveryTermsCode As String
Public Overridable Property DeliveryInstructions As String
Public Overridable Property DeliveryCostPayment As String
Public Overridable Property IsSignatureRequired As String
Public Overridable Property DeliveryTermsLocation As DeliveryTermsLocation
End Class
Public Partial Class DeliveryTermsLocation
Public Overridable Property UnLocationCode As String
Public Overridable Property Gln As String
Public Overridable Property AdditionalLocationIdentification As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property SublocationIdentification As String
Public Overridable Property LocationName As String
Public Overridable Property LocationSpecificInstructions As String
End Class
Public Enum DocumentAction
ADD
CHANGE_BY_REFRESH
DELETE
REJECTED
End Enum
<DataContract>
Public Partial Class DocumentIdentification
<DataMember(Name:="identifier")>
Public Overridable Property Identifier As String
<DataMember(Name:="type")>
Public Overridable Property Type As String
<DataMember(Name:="creationDateAndTime")>
Public Overridable Property CreationDateAndTime As Date
End Class
Public Partial Class DocumentReference
Public Overridable Property CreationDateTime As Date?
Public Overridable Property RevisionNumber As Long?
Public Overridable Property LineItemNumber As Long?
Public Overridable Property EntityIdentification As String
End Class
Public Enum DocumentStatus
ADDITIONAL_TRANSMISSION
COPY
ORIGINAL
End Enum
Public Partial Class Ecom_EntityIdentification
Public Overridable Property EntityIdentification As String
Public Overridable Property ContentOwner As Ecom_PartyIdentification
End Class
Public Partial Class Ecom_PartyIdentification
Public Overridable Property AdditionalPartyIdentification As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property Gln As String
End Class
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 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
<DataContract>
Public Partial Class Header
<DataMember(Name:="documentIdentification")>
Public Overridable Property DocumentIdentification As DocumentIdentification
<DataMember(Name:="sender")>
Public Overridable Property Sender As Partner
<DataMember(Name:="receiver")>
Public Overridable Property Receiver As Partner
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 LeviedDutyFeeTax
Public Overridable Property DutyFeeTaxAmount As Decimal?
Public Overridable Property DutyFeeTaxBasisAmount As Decimal?
Public Overridable Property DutyFeeTaxDescription As String
Public Overridable Property DutyFeeTaxPercentage As Decimal?
End Class
Public Partial Class Order
Inherits BaseDocument
Public Overridable Property DocumentEffectiveDate As Date?
Public Overridable Property AdditionalOrderInstruction As String
Public Overridable Property IsApplicationReceiptAcknowledgementRequired As Boolean?
Public Overridable Property IsOrderFreeOfExciseTaxDuty As Boolean?
Public Overridable Property Note As String
Public Overridable Property OrderEntryType As String
Public Overridable Property OrderInstructionCode As String
Public Overridable Property OrderPriority As String
Public Overridable Property OrderTypeCode As String
Public Overridable Property TotalMonetaryAmountExcludingTaxes As Decimal?
Public Overridable Property TotalMonetaryAmountIncludingTaxes As Decimal?
Public Overridable Property TotalTaxAmount As Decimal?
Public Overridable Property PaymentTerms As String
Public Overridable Property OrderIdentification As Ecom_EntityIdentification
Public Overridable Property OrderLogisticalInformation As OrderLogisticalInformation
Public Overridable Property AdministrativeUnit As List(Of AdministrativeUnit) = New List(Of AdministrativeUnit)
Public Overridable Property DeliveryTerms As DeliveryTerms
Public Overridable Property TransactionalGenericReference As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property ReferencedOrder As List(Of ReferencedOrder) = New List(Of ReferencedOrder)
Public Overridable Property BillTo As TransactionalParty
Public Overridable Property Buyer As TransactionalParty
Public Overridable Property PickupFrom As TransactionalParty
Public Overridable Property Seller As TransactionalParty
Public Overridable Property UltimateConsignee As TransactionalParty
Public Overridable Property Contract As DocumentReference
Public Overridable Property QuoteNumber As DocumentReference
Public Overridable Property PromotionalDeal As DocumentReference
Public Overridable Property TradeAgreement As DocumentReference
Public Overridable Property DeliveryDateAccordingToSchedule As Date?
Public Overridable Property LatestDeliveryDate As Date?
Public Overridable Property AllowanceCharge As List(Of AllowanceCharge) = New List(Of AllowanceCharge)
Public Overridable Property OrderLineItem As List(Of OrderLineItem) = New List(Of OrderLineItem)
End Class
Public Partial Class OrderLineItem
Public Overridable Property FreeGoodsQuantity As Quantity
Public Overridable Property ItemPriceBaseQuantity As Quantity
Public Overridable Property RequestedQuantity As Quantity
Public Overridable Property LineItemActionCode As String
Public Overridable Property LineItemNumber As Long?
Public Overridable Property ListPrice As Decimal?
Public Overridable Property MonetaryAmountExcludingTaxes As Decimal?
Public Overridable Property MonetaryAmountIncludingTaxes As Decimal?
Public Overridable Property NetAmount As Decimal?
Public Overridable Property NetPrice As Decimal?
Public Overridable Property Note As String
Public Overridable Property OrderLineItemInstructionCode As String
Public Overridable Property ParentLineItemNumber As Decimal?
Public Overridable Property RecommendedRetailPrice As Decimal?
Public Overridable Property OrderLineItemPriority As String
Public Overridable Property AdditionalOrderLineInstruction As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property AllowanceCharge As List(Of AllowanceCharge) = New List(Of AllowanceCharge)
Public Overridable Property AdministrativeUnit As List(Of AdministrativeUnit) = New List(Of AdministrativeUnit)
Public Overridable Property TransactionalTradeItem As TransactionalTradeItem
Public Overridable Property LeviedDutyFeeTax As LeviedDutyFeeTax
Public Overridable Property Contract As DocumentReference
Public Overridable Property PromotionalDeal As DocumentReference
Public Overridable Property PurchaseConditions As DocumentReference
Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property OrderLineItemDetail As List(Of OrderLineItemDetail) = New List(Of OrderLineItemDetail)
End Class
Public Partial Class OrderLineItemDetail
Public Overridable Property RequestedQuantity As Quantity
Public Overridable Property OrderLogisticalInformation As OrderLogisticalInformation
Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class OrderLogisticalDateInformation
Public Overridable Property DateRangeDeliveryDateRange As DateRange
Public Overridable Property DateRangeShipDateRange As DateRange
Public Overridable Property DateRangeDeliveryDateRangeAtUltimateConsignee As DateRange
Public Overridable Property RequestedDeliveryDateTime As Date?
Public Overridable Property RequestedShipDateTime As String
Public Overridable Property RequestedPickUpDateTime As Date?
Public Overridable Property RequestedDeliveryDateTimeAtUltimateConsignee As Date?
End Class
Public Partial Class OrderLogisticalInformation
Public Overridable Property CommodityTypeCode As Code
Public Overridable Property OrderLogisticalDateInformation As OrderLogisticalDateInformation
Public Overridable Property InventoryLocation As TransactionalParty
Public Overridable Property ShipFrom As TransactionalParty
Public Overridable Property ShipTo As TransactionalParty
Public Overridable Property UltimateConsignee As TransactionalParty
Public Overridable Property ShipmentTransportationInformation As ShipmentTransportationInformation
End Class
Public Partial Class OrderMessage
Public Overridable Property Header As Header
Public Overridable Property Order As Order
End Class
<DataContract>
Public Partial Class Partner
<DataMember(Name:="identifier")>
Public Overridable Property Identifier As Identifier
<DataMember(Name:="contactInformation")>
Public Overridable Property ContactInformation As List(Of ContactInformation) = New List(Of ContactInformation)
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 ReferencedOrder
Public Overridable Property OrderRelationship As String
Public Overridable Property DocumentReference As DocumentReference
End Class
Public Partial Class SerialNumberRange
Public Overridable Property MaximumValue As String
Public Overridable Property MinimumValue As String
End Class
Public Partial Class ShipmentTransportationInformation
Public Overridable Property Carrier As TransactionalParty
Public Overridable Property FreightForwarder As TransactionalParty
End Class
Public Partial Class Size
Public Overridable Property DescriptiveSize As String
Public Overridable Property SizeCode As String
End Class
Public Partial Class TradeItemClassification
Public Overridable Property GpcCategoryCode As String
Public Overridable Property AdditionalTradeItemClassificationCode As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property GpcCategoryName As String
Public Overridable Property GpcAttribute As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class TradeItemWaste
Public Overridable Property WasteIdentification As String
Public Overridable Property TypeOfWaste As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class TransactionalItem
Public Overridable Property MeasurementUnitCode As String
Public Overridable Property MeasurementType As String
Public Overridable Property MeasurementValue As String
End Class
Public Partial Class TransactionalItemData
Public Overridable Property AvailableForSaleDate As Date?
Public Overridable Property BatchNumber As String
Public Overridable Property BestBeforeDate As Date?
Public Overridable Property CountryOfOrigin As String
Public Overridable Property ItemExpirationDate As Date?
Public Overridable Property LotNumber As String
Public Overridable Property PackagingDate As Date?
Public Overridable Property ProductionDate As Date?
Public Overridable Property ProductQualityIndication As String
Public Overridable Property SellByDate As Date?
Public Overridable Property SerialNumber As List(Of String) = New List(Of String)
Public Overridable Property ShelfLife As String
Public Overridable Property TradeItemQuantity As Long?
Public Overridable Property ItemInContactWithFoodProduct As Boolean?
Public Overridable Property TransactionalItemWeight As List(Of TransactionalItem) = New List(Of TransactionalItem)
Public Overridable Property TransactionalItemVolume As List(Of TransactionalItem) = New List(Of TransactionalItem)
Public Overridable Property SerialNumberRange As List(Of SerialNumberRange) = New List(Of SerialNumberRange)
Public Overridable Property TransactionalItemDimensions As List(Of TransactionalItemDimension) = New List(Of TransactionalItemDimension)
Public Overridable Property TransactionalItemLogisticUnitInformation As TransactionalItemLogisticUnitInformation
Public Overridable Property TransactionalItemDataCarrierAndIdentification As TransactionalItemDataCarrierAndIdentification
Public Overridable Property TradeItemWaste As List(Of TradeItemWaste) = New List(Of TradeItemWaste)
Public Overridable Property TransactionalItemOrganicInformation As TransactionalItemOrganicInformation
Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
End Class
Public Partial Class TransactionalItemDataCarrierAndIdentification
Public Overridable Property Gs1TransactionalItemIdentificationKey As String
Public Overridable Property DataCarrier As String
End Class
Public Partial Class TransactionalItemDimension
Public Overridable Property MeasurementUnitCode As String
Public Overridable Property Depth As String
Public Overridable Property Height As String
Public Overridable Property Width As String
End Class
Public Partial Class TransactionalItemLogisticUnitInformation
Public Overridable Property NumberOfLayers As Long?
Public Overridable Property NumberOfUnitsPerLayer As Long?
Public Overridable Property NumberOfUnitsPerPallet As Long?
Public Overridable Property PackagingTerms As String
Public Overridable Property PackageTypeCode As String
Public Overridable Property MaximumStackingFactor As Long?
Public Overridable Property ReturnablePackageTransportCostPayment As String
Public Overridable Property DimensionsOfLogisticUnit As List(Of TransactionalItemDimension) = New List(Of TransactionalItemDimension)
End Class
Public Partial Class TransactionalItemOrganicInformation
Public Overridable Property IsTradeItemOrganic As Boolean?
Public Overridable Property OrganicCertification As String
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 TransactionalTradeItem
Public Overridable Property Gtin As String
Public Overridable Property AdditionalTradeItemIdentification As List(Of AvpList) = New List(Of AvpList)
Public Overridable Property TradeItemQuantity As Decimal?
Public Overridable Property TradeItemDescription As String
Public Overridable Property ProductVariantIdentifier As String
Public Overridable Property ItemTypeCode As String
Public Overridable Property TradeItemDataOwner As String
Public Overridable Property ButterFatReference As String
Public Overridable Property TransactionalItemData As List(Of TransactionalItemData) = New List(Of TransactionalItemData)
Public Overridable Property Colour As List(Of Colour) = New List(Of Colour)
Public Overridable Property Size As Size
Public Overridable Property TradeItemClassification As TradeItemClassification
Public Overridable Property AvpList As List(Of AvpList) = New List(Of AvpList)
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/order HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"order":{"header":{"documentIdentification":{"identifier":"String","type":"String"},"sender":{"identifier":{"authority":"String","text":"String"},"contactInformation":[{}]},"receiver":{"identifier":{"authority":"String","text":"String"},"contactInformation":[{}]}},"order":{"documentEffectiveDate":"0001-01-01","additionalOrderInstruction":"String","isApplicationReceiptAcknowledgementRequired":false,"isOrderFreeOfExciseTaxDuty":false,"note":"String","orderEntryType":"String","orderInstructionCode":"String","orderPriority":"String","orderTypeCode":"String","totalMonetaryAmountExcludingTaxes":0,"totalMonetaryAmountIncludingTaxes":0,"totalTaxAmount":0,"paymentTerms":"String","orderIdentification":{"entityIdentification":"String","contentOwner":{"additionalPartyIdentification":[{"code":"String","value":"String"}],"gln":"String"}},"orderLogisticalInformation":{"commodityTypeCode":{"value":"String","codeDescription":"String","codeListAgencyCodeListVersion":"String","codeListAgencyName":"String","codeListName":"String","codeListUri":"String"},"orderLogisticalDateInformation":{"dateRangeDeliveryDateRange":{"beginDate":"0001-01-01","beginTime":"0001-01-01","endDate":"0001-01-01","endTime":"0001-01-01"},"dateRangeShipDateRange":{"beginDate":"0001-01-01","beginTime":"0001-01-01","endDate":"0001-01-01","endTime":"0001-01-01"},"dateRangeDeliveryDateRangeAtUltimateConsignee":{"beginDate":"0001-01-01","beginTime":"0001-01-01","endDate":"0001-01-01","endTime":"0001-01-01"},"requestedDeliveryDateTime":"0001-01-01","requestedShipDateTime":"String","requestedPickUpDateTime":"0001-01-01","requestedDeliveryDateTimeAtUltimateConsignee":"0001-01-01"},"inventoryLocation":{"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"}]},"shipFrom":{"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"}]},"shipTo":{"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"}]},"ultimateConsignee":{"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"}]},"shipmentTransportationInformation":{"carrier":{"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"}]},"freightForwarder":{"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"}]}}},"administrativeUnit":[{"typeCode":"String","gln":"String","internalIdentification":"String"}],"deliveryTerms":{"incotermsCode":"String","alternateDeliveryTermsCode":"String","deliveryInstructions":"String","deliveryCostPayment":"String","isSignatureRequired":"String","deliveryTermsLocation":{"unLocationCode":"String","gln":"String","additionalLocationIdentification":[{"code":"String","value":"String"}],"sublocationIdentification":"String","locationName":"String","locationSpecificInstructions":"String"}},"transactionalGenericReference":[{"code":"String","value":"String"}],"referencedOrder":[{"orderRelationship":"String","documentReference":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"}}],"billTo":{"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"}]},"buyer":{"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"}]},"pickupFrom":{"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"}]},"seller":{"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"}]},"ultimateConsignee":{"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"}]},"contract":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"quoteNumber":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"promotionalDeal":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"tradeAgreement":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"deliveryDateAccordingToSchedule":"0001-01-01","latestDeliveryDate":"0001-01-01","allowanceCharge":[{"allowanceChargeAmount":0,"allowanceChargePercentage":0,"allowanceChargeType":"String","allowanceOrChargeType":"String","amountPerUnit":0,"baseAmount":0,"baseNumberOfUnits":"String","bracketIdentifier":"String","effectiveDateType":"0001-01-01","sequenceNumber":"String","settlementType":"String","specialServiceType":"String","allowanceChargeDescription":"String"}],"orderLineItem":[{"freeGoodsQuantity":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"itemPriceBaseQuantity":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"requestedQuantity":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"lineItemActionCode":"String","lineItemNumber":0,"listPrice":0,"monetaryAmountExcludingTaxes":0,"monetaryAmountIncludingTaxes":0,"netAmount":0,"netPrice":0,"note":"String","orderLineItemInstructionCode":"String","parentLineItemNumber":0,"recommendedRetailPrice":0,"orderLineItemPriority":"String","additionalOrderLineInstruction":[{"code":"String","value":"String"}],"allowanceCharge":[{"allowanceChargeAmount":0,"allowanceChargePercentage":0,"allowanceChargeType":"String","allowanceOrChargeType":"String","amountPerUnit":0,"baseAmount":0,"baseNumberOfUnits":"String","bracketIdentifier":"String","effectiveDateType":"0001-01-01","sequenceNumber":"String","settlementType":"String","specialServiceType":"String","allowanceChargeDescription":"String"}],"administrativeUnit":[{"typeCode":"String","gln":"String","internalIdentification":"String"}],"transactionalTradeItem":{"gtin":"String","additionalTradeItemIdentification":[{"code":"String","value":"String"}],"tradeItemQuantity":0,"tradeItemDescription":"String","productVariantIdentifier":"String","itemTypeCode":"String","tradeItemDataOwner":"String","butterFatReference":"String","transactionalItemData":[{"availableForSaleDate":"0001-01-01","batchNumber":"String","bestBeforeDate":"0001-01-01","countryOfOrigin":"String","itemExpirationDate":"0001-01-01","lotNumber":"String","packagingDate":"0001-01-01","productionDate":"0001-01-01","productQualityIndication":"String","sellByDate":"0001-01-01","serialNumber":["String"],"shelfLife":"String","tradeItemQuantity":0,"itemInContactWithFoodProduct":false,"transactionalItemWeight":[{"measurementUnitCode":"String","measurementType":"String","measurementValue":"String"}],"transactionalItemVolume":[{"measurementUnitCode":"String","measurementType":"String","measurementValue":"String"}],"serialNumberRange":[{"maximumValue":"String","minimumValue":"String"}],"transactionalItemDimensions":[{"measurementUnitCode":"String","depth":"String","height":"String","width":"String"}],"transactionalItemLogisticUnitInformation":{"numberOfLayers":0,"numberOfUnitsPerLayer":0,"numberOfUnitsPerPallet":0,"packagingTerms":"String","packageTypeCode":"String","maximumStackingFactor":0,"returnablePackageTransportCostPayment":"String","dimensionsOfLogisticUnit":[{"measurementUnitCode":"String","depth":"String","height":"String","width":"String"}]},"transactionalItemDataCarrierAndIdentification":{"gs1TransactionalItemIdentificationKey":"String","dataCarrier":"String"},"tradeItemWaste":[{"wasteIdentification":"String","typeOfWaste":[{"code":"String","value":"String"}]}],"transactionalItemOrganicInformation":{"isTradeItemOrganic":false,"organicCertification":"String"},"avpList":[{"code":"String","value":"String"}]}],"colour":[{"colourCode":"String","colourDescription":"String"}],"size":{"descriptiveSize":"String","sizeCode":"String"},"tradeItemClassification":{"gpcCategoryCode":"String","additionalTradeItemClassificationCode":[{"code":"String","value":"String"}],"gpcCategoryName":"String","gpcAttribute":[{"code":"String","value":"String"}]},"avpList":[{"code":"String","value":"String"}]},"leviedDutyFeeTax":{"dutyFeeTaxAmount":0,"dutyFeeTaxBasisAmount":0,"dutyFeeTaxDescription":"String","dutyFeeTaxPercentage":0},"contract":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"promotionalDeal":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"purchaseConditions":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"avpList":[{"code":"String","value":"String"}],"orderLineItemDetail":[{"requestedQuantity":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"orderLogisticalInformation":{"commodityTypeCode":{"value":"String","codeDescription":"String","codeListAgencyCodeListVersion":"String","codeListAgencyName":"String","codeListName":"String","codeListUri":"String"},"orderLogisticalDateInformation":{"dateRangeDeliveryDateRange":{"beginDate":"0001-01-01","beginTime":"0001-01-01","endDate":"0001-01-01","endTime":"0001-01-01"},"dateRangeShipDateRange":{"beginDate":"0001-01-01","beginTime":"0001-01-01","endDate":"0001-01-01","endTime":"0001-01-01"},"dateRangeDeliveryDateRangeAtUltimateConsignee":{"beginDate":"0001-01-01","beginTime":"0001-01-01","endDate":"0001-01-01","endTime":"0001-01-01"},"requestedDeliveryDateTime":"0001-01-01","requestedShipDateTime":"String","requestedPickUpDateTime":"0001-01-01","requestedDeliveryDateTimeAtUltimateConsignee":"0001-01-01"},"inventoryLocation":{"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"}]},"shipFrom":{"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"}]},"shipTo":{"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"}]},"ultimateConsignee":{"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"}]},"shipmentTransportationInformation":{"carrier":{"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"}]},"freightForwarder":{"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"}]}}},"avpList":[{"code":"String","value":"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/csv
Content-Length: length
{}