DX STF Client API

<back to all web services

GetOrderById

Order Requests

Order

Requires Authentication
The following routes are available for this service:
GET/api/order/{Id}Get specific order by Order Id
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Order
*/
@Api(Description="Order")
@ApiResponse(Description="Order data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType=IReturnVoid::class, StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=ArgumentOutOfRangeException::class, StatusCode=400)
open class GetOrderById : IGetDocumentById
{
    /**
    * Order ID or Token
    */
    @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
    open var id:UUID? = null
}

open class OrderMessage
{
    open var header:Header? = null
    open var order:Order? = null
}

@DataContract
open class Header
{
    @DataMember(Name="documentIdentification")
    @SerializedName("documentIdentification")
    open var documentIdentification:DocumentIdentification? = null

    @DataMember(Name="sender")
    @SerializedName("sender")
    open var sender:Partner? = null

    @DataMember(Name="receiver")
    @SerializedName("receiver")
    open var receiver:Partner? = null
}

@DataContract
open class DocumentIdentification
{
    @DataMember(Name="identifier")
    @SerializedName("identifier")
    open var identifier:String? = null

    @DataMember(Name="type")
    @SerializedName("type")
    open var Type:String? = null

    @DataMember(Name="creationDateAndTime")
    @SerializedName("creationDateAndTime")
    open var creationDateAndTime:Date? = null
}

@DataContract
open class Partner
{
    @DataMember(Name="identifier")
    @SerializedName("identifier")
    open var identifier:Identifier? = null

    @DataMember(Name="contactInformation")
    @SerializedName("contactInformation")
    open var contactInformation:ArrayList<ContactInformation> = ArrayList<ContactInformation>()
}

@DataContract
open class Identifier
{
    @DataMember(Name="authority")
    @SerializedName("authority")
    open var authority:String? = null

    @DataMember(Name="text")
    @SerializedName("text")
    open var text:String? = null
}

@DataContract
open class ContactInformation
{
}

open class Order : BaseDocument()
{
    open var documentEffectiveDate:Date? = null
    open var additionalOrderInstruction:String? = null
    open var isApplicationReceiptAcknowledgementRequired:Boolean? = null
    open var isOrderFreeOfExciseTaxDuty:Boolean? = null
    open var note:String? = null
    open var orderEntryType:String? = null
    open var orderInstructionCode:String? = null
    open var orderPriority:String? = null
    open var orderTypeCode:String? = null
    open var totalMonetaryAmountExcludingTaxes:BigDecimal? = null
    open var totalMonetaryAmountIncludingTaxes:BigDecimal? = null
    open var totalTaxAmount:BigDecimal? = null
    open var paymentTerms:String? = null
    open var orderIdentification:Ecom_EntityIdentification? = null
    open var orderLogisticalInformation:OrderLogisticalInformation? = null
    open var administrativeUnit:ArrayList<AdministrativeUnit> = ArrayList<AdministrativeUnit>()
    open var deliveryTerms:DeliveryTerms? = null
    open var transactionalGenericReference:ArrayList<AvpList> = ArrayList<AvpList>()
    open var referencedOrder:ArrayList<ReferencedOrder> = ArrayList<ReferencedOrder>()
    open var billTo:TransactionalParty? = null
    open var buyer:TransactionalParty? = null
    open var pickupFrom:TransactionalParty? = null
    open var seller:TransactionalParty? = null
    open var ultimateConsignee:TransactionalParty? = null
    open var contract:DocumentReference? = null
    open var quoteNumber:DocumentReference? = null
    open var promotionalDeal:DocumentReference? = null
    open var tradeAgreement:DocumentReference? = null
    open var deliveryDateAccordingToSchedule:Date? = null
    open var latestDeliveryDate:Date? = null
    open var allowanceCharge:ArrayList<AllowanceCharge> = ArrayList<AllowanceCharge>()
    open var orderLineItem:ArrayList<OrderLineItem> = ArrayList<OrderLineItem>()
}

open class BaseDocument
{
    open var currencyCode:String? = null
    open var creationDateTime:Date? = null
    open var documentActionCode:DocumentAction? = null
    open var documentStatusCode:DocumentStatus? = null
    open var documentStructureVersion:String? = null
    open var lastUpdateDateTime:Date? = null
    open var revisionNumber:Long? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

enum class DocumentAction
{
    Add,
    ChangeByRefresh,
    Delete,
    Rejected,
}

enum class DocumentStatus
{
    AdditionalTransmission,
    Copy,
    Original,
}

open class AvpList
{
    open var code:String? = null
    open var value:String? = null
}

open class Ecom_EntityIdentification
{
    open var entityIdentification:String? = null
    open var contentOwner:Ecom_PartyIdentification? = null
}

open class Ecom_PartyIdentification
{
    open var additionalPartyIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
    open var gln:String? = null
}

open class OrderLogisticalInformation
{
    open var commodityTypeCode:Code? = null
    open var orderLogisticalDateInformation:OrderLogisticalDateInformation? = null
    open var inventoryLocation:TransactionalParty? = null
    open var shipFrom:TransactionalParty? = null
    open var shipTo:TransactionalParty? = null
    open var ultimateConsignee:TransactionalParty? = null
    open var shipmentTransportationInformation:ShipmentTransportationInformation? = null
}

open class Code
{
    open var value:String? = null
    open var codeDescription:String? = null
    open var codeListAgencyCodeListVersion:String? = null
    open var codeListAgencyName:String? = null
    open var codeListName:String? = null
    open var codeListUri:String? = null
}

open class OrderLogisticalDateInformation
{
    open var dateRangeDeliveryDateRange:DateRange? = null
    open var dateRangeShipDateRange:DateRange? = null
    open var dateRangeDeliveryDateRangeAtUltimateConsignee:DateRange? = null
    open var requestedDeliveryDateTime:Date? = null
    open var requestedShipDateTime:String? = null
    open var requestedPickUpDateTime:Date? = null
    open var requestedDeliveryDateTimeAtUltimateConsignee:Date? = null
}

open class DateRange
{
    open var beginDate:Date? = null
    open var beginTime:Date? = null
    open var endDate:Date? = null
    open var endTime:Date? = null
}

open class TransactionalParty : Ecom_PartyIdentificationType()
{
    open var contact:ArrayList<Contact> = ArrayList<Contact>()
    open var address:Address? = null
    open var communicationChannel:ArrayList<AvpList> = ArrayList<AvpList>()
    open var financialInstitutionInformation:FinancialInstitutionInformation? = null
    open var dutyFeeTaxRegistration:String? = null
    open var entityIdentification:String? = null
}

open class Ecom_PartyIdentificationType
{
    open var gln:String? = null
    open var name:String? = null
    open var additionalPartyIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class Contact
{
    open var contactTypeCode:String? = null
    open var personName:String? = null
    open var departmentName:String? = null
    open var jobTitle:String? = null
    open var responsibility:String? = null
    open var communicationChannel:ArrayList<CommunicationChannel> = ArrayList<CommunicationChannel>()
}

open class CommunicationChannel
{
    open var communicationChannelCode:String? = null
    open var communicationChannelName:String? = null
    open var communicationValue:String? = null
}

open class Address
{
    open var streetAddressOne:String? = null
    open var streetAddressTwo:String? = null
    open var streetAddressThree:String? = null
    open var city:String? = null
    open var postalCode:String? = null
    open var provinceCode:String? = null
    open var countryCode:String? = null
}

open class FinancialInstitutionInformation
{
    open var financialInstitutionBranchName:String? = null
    open var financialInstitutionName:String? = null
    open var financialRoutingNumber:FinancialRoutingNumber? = null
    open var financialAccount:FinancialAccount? = null
    open var swiftCode:String? = null
    open var exportersCode:String? = null
}

open class FinancialRoutingNumber
{
    open var number:String? = null
    open var numberTypeCode:String? = null
}

open class FinancialAccount
{
    open var number:String? = null
    open var numberTypeCode:String? = null
    open var name:String? = null
}

open class ShipmentTransportationInformation
{
    open var carrier:TransactionalParty? = null
    open var freightForwarder:TransactionalParty? = null
}

open class AdministrativeUnit
{
    open var typeCode:String? = null
    open var gln:String? = null
    open var internalIdentification:String? = null
}

open class DeliveryTerms
{
    open var incotermsCode:String? = null
    open var alternateDeliveryTermsCode:String? = null
    open var deliveryInstructions:String? = null
    open var deliveryCostPayment:String? = null
    open var isSignatureRequired:String? = null
    open var deliveryTermsLocation:DeliveryTermsLocation? = null
}

open class DeliveryTermsLocation
{
    open var unLocationCode:String? = null
    open var gln:String? = null
    open var additionalLocationIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
    open var sublocationIdentification:String? = null
    open var locationName:String? = null
    open var locationSpecificInstructions:String? = null
}

open class ReferencedOrder
{
    open var orderRelationship:String? = null
    open var documentReference:DocumentReference? = null
}

open class DocumentReference
{
    open var creationDateTime:Date? = null
    open var revisionNumber:Long? = null
    open var lineItemNumber:Long? = null
    open var entityIdentification:String? = null
}

open class AllowanceCharge
{
    open var allowanceChargeAmount:BigDecimal? = null
    open var allowanceChargePercentage:BigDecimal? = null
    open var allowanceChargeType:String? = null
    open var allowanceOrChargeType:String? = null
    open var amountPerUnit:BigDecimal? = null
    open var baseAmount:BigDecimal? = null
    open var baseNumberOfUnits:String? = null
    open var bracketIdentifier:String? = null
    open var effectiveDateType:Date? = null
    open var sequenceNumber:String? = null
    open var settlementType:String? = null
    open var specialServiceType:String? = null
    open var allowanceChargeDescription:String? = null
}

open class OrderLineItem
{
    open var freeGoodsQuantity:Quantity? = null
    open var itemPriceBaseQuantity:Quantity? = null
    open var requestedQuantity:Quantity? = null
    open var lineItemActionCode:String? = null
    open var lineItemNumber:Long? = null
    open var listPrice:BigDecimal? = null
    open var monetaryAmountExcludingTaxes:BigDecimal? = null
    open var monetaryAmountIncludingTaxes:BigDecimal? = null
    open var netAmount:BigDecimal? = null
    open var netPrice:BigDecimal? = null
    open var note:String? = null
    open var orderLineItemInstructionCode:String? = null
    open var parentLineItemNumber:BigDecimal? = null
    open var recommendedRetailPrice:BigDecimal? = null
    open var orderLineItemPriority:String? = null
    open var additionalOrderLineInstruction:ArrayList<AvpList> = ArrayList<AvpList>()
    open var allowanceCharge:ArrayList<AllowanceCharge> = ArrayList<AllowanceCharge>()
    open var administrativeUnit:ArrayList<AdministrativeUnit> = ArrayList<AdministrativeUnit>()
    open var transactionalTradeItem:TransactionalTradeItem? = null
    open var leviedDutyFeeTax:LeviedDutyFeeTax? = null
    open var contract:DocumentReference? = null
    open var promotionalDeal:DocumentReference? = null
    open var purchaseConditions:DocumentReference? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
    open var orderLineItemDetail:ArrayList<OrderLineItemDetail> = ArrayList<OrderLineItemDetail>()
}

open class Quantity
{
    open var value:BigDecimal? = null
    open var measurementUnitCode:String? = null
    open var codeListVersion:String? = null
}

open class TransactionalTradeItem
{
    open var gtin:String? = null
    open var additionalTradeItemIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
    open var tradeItemQuantity:BigDecimal? = null
    open var tradeItemDescription:String? = null
    open var productVariantIdentifier:String? = null
    open var itemTypeCode:String? = null
    open var tradeItemDataOwner:String? = null
    open var butterFatReference:String? = null
    open var transactionalItemData:ArrayList<TransactionalItemData> = ArrayList<TransactionalItemData>()
    open var colour:ArrayList<Colour> = ArrayList<Colour>()
    open var size:Size? = null
    open var tradeItemClassification:TradeItemClassification? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class TransactionalItemData
{
    open var availableForSaleDate:Date? = null
    open var batchNumber:String? = null
    open var bestBeforeDate:Date? = null
    open var countryOfOrigin:String? = null
    open var itemExpirationDate:Date? = null
    open var lotNumber:String? = null
    open var packagingDate:Date? = null
    open var productionDate:Date? = null
    open var productQualityIndication:String? = null
    open var sellByDate:Date? = null
    open var serialNumber:ArrayList<String> = ArrayList<String>()
    open var shelfLife:String? = null
    open var tradeItemQuantity:Long? = null
    open var itemInContactWithFoodProduct:Boolean? = null
    open var transactionalItemWeight:ArrayList<TransactionalItem> = ArrayList<TransactionalItem>()
    open var transactionalItemVolume:ArrayList<TransactionalItem> = ArrayList<TransactionalItem>()
    open var serialNumberRange:ArrayList<SerialNumberRange> = ArrayList<SerialNumberRange>()
    open var transactionalItemDimensions:ArrayList<TransactionalItemDimension> = ArrayList<TransactionalItemDimension>()
    open var transactionalItemLogisticUnitInformation:TransactionalItemLogisticUnitInformation? = null
    open var transactionalItemDataCarrierAndIdentification:TransactionalItemDataCarrierAndIdentification? = null
    open var tradeItemWaste:ArrayList<TradeItemWaste> = ArrayList<TradeItemWaste>()
    open var transactionalItemOrganicInformation:TransactionalItemOrganicInformation? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class TransactionalItem
{
    open var measurementUnitCode:String? = null
    open var measurementType:String? = null
    open var measurementValue:String? = null
}

open class SerialNumberRange
{
    open var maximumValue:String? = null
    open var minimumValue:String? = null
}

open class TransactionalItemDimension
{
    open var measurementUnitCode:String? = null
    open var depth:String? = null
    open var height:String? = null
    open var width:String? = null
}

open class TransactionalItemLogisticUnitInformation
{
    open var numberOfLayers:Long? = null
    open var numberOfUnitsPerLayer:Long? = null
    open var numberOfUnitsPerPallet:Long? = null
    open var packagingTerms:String? = null
    open var packageTypeCode:String? = null
    open var maximumStackingFactor:Long? = null
    open var returnablePackageTransportCostPayment:String? = null
    open var dimensionsOfLogisticUnit:ArrayList<TransactionalItemDimension> = ArrayList<TransactionalItemDimension>()
}

open class TransactionalItemDataCarrierAndIdentification
{
    open var gs1TransactionalItemIdentificationKey:String? = null
    open var dataCarrier:String? = null
}

open class TradeItemWaste
{
    open var wasteIdentification:String? = null
    open var typeOfWaste:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class TransactionalItemOrganicInformation
{
    open var isTradeItemOrganic:Boolean? = null
    open var organicCertification:String? = null
}

open class Colour
{
    open var colourCode:String? = null
    open var colourDescription:String? = null
}

open class Size
{
    open var descriptiveSize:String? = null
    open var sizeCode:String? = null
}

open class TradeItemClassification
{
    open var gpcCategoryCode:String? = null
    open var additionalTradeItemClassificationCode:ArrayList<AvpList> = ArrayList<AvpList>()
    open var gpcCategoryName:String? = null
    open var gpcAttribute:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class LeviedDutyFeeTax
{
    open var dutyFeeTaxAmount:BigDecimal? = null
    open var dutyFeeTaxBasisAmount:BigDecimal? = null
    open var dutyFeeTaxDescription:String? = null
    open var dutyFeeTaxPercentage:BigDecimal? = null
}

open class OrderLineItemDetail
{
    open var requestedQuantity:Quantity? = null
    open var orderLogisticalInformation:OrderLogisticalInformation? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

Kotlin GetOrderById DTOs

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.

GET /api/order/{Id} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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