| GET | /api/order/{Id} | Get specific order by Order Id |
|---|
"use strict";
export class DocumentIdentification {
/** @param {{identifier?:string,type?:string,creationDateAndTime?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
identifier;
/** @type {string} */
type;
/** @type {string} */
creationDateAndTime;
}
export class Identifier {
/** @param {{authority?:string,text?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
authority;
/** @type {string} */
text;
}
export class ContactInformation {
constructor(init) { Object.assign(this, init) }
}
export class Partner {
/** @param {{identifier?:Identifier,contactInformation?:ContactInformation[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Identifier} */
identifier;
/** @type {ContactInformation[]} */
contactInformation = [];
}
export class Header {
/** @param {{documentIdentification?:DocumentIdentification,sender?:Partner,receiver?:Partner}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DocumentIdentification} */
documentIdentification;
/** @type {Partner} */
sender;
/** @type {Partner} */
receiver;
}
/** @typedef {'ADD'|'CHANGE_BY_REFRESH'|'DELETE'|'REJECTED'} */
export var DocumentAction;
(function (DocumentAction) {
DocumentAction["ADD"] = "ADD"
DocumentAction["CHANGE_BY_REFRESH"] = "CHANGE_BY_REFRESH"
DocumentAction["DELETE"] = "DELETE"
DocumentAction["REJECTED"] = "REJECTED"
})(DocumentAction || (DocumentAction = {}));
/** @typedef {'ADDITIONAL_TRANSMISSION'|'COPY'|'ORIGINAL'} */
export var DocumentStatus;
(function (DocumentStatus) {
DocumentStatus["ADDITIONAL_TRANSMISSION"] = "ADDITIONAL_TRANSMISSION"
DocumentStatus["COPY"] = "COPY"
DocumentStatus["ORIGINAL"] = "ORIGINAL"
})(DocumentStatus || (DocumentStatus = {}));
export class AvpList {
/** @param {{code?:string,value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
code;
/** @type {string} */
value;
}
export class BaseDocument {
/** @param {{currencyCode?:string,creationDateTime?:string,documentActionCode?:DocumentAction,documentStatusCode?:DocumentStatus,documentStructureVersion?:string,lastUpdateDateTime?:string,revisionNumber?:number,avpList?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
currencyCode;
/** @type {string} */
creationDateTime;
/** @type {DocumentAction} */
documentActionCode;
/** @type {DocumentStatus} */
documentStatusCode;
/** @type {string} */
documentStructureVersion;
/** @type {?string} */
lastUpdateDateTime;
/** @type {?number} */
revisionNumber;
/** @type {AvpList[]} */
avpList = [];
}
export class Ecom_PartyIdentification {
/** @param {{additionalPartyIdentification?:AvpList[],gln?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AvpList[]} */
additionalPartyIdentification = [];
/** @type {string} */
gln;
}
export class Ecom_EntityIdentification {
/** @param {{entityIdentification?:string,contentOwner?:Ecom_PartyIdentification}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
entityIdentification;
/** @type {Ecom_PartyIdentification} */
contentOwner;
}
export class Code {
/** @param {{value?:string,codeDescription?:string,codeListAgencyCodeListVersion?:string,codeListAgencyName?:string,codeListName?:string,codeListUri?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
value;
/** @type {string} */
codeDescription;
/** @type {string} */
codeListAgencyCodeListVersion;
/** @type {string} */
codeListAgencyName;
/** @type {string} */
codeListName;
/** @type {string} */
codeListUri;
}
export class DateRange {
/** @param {{beginDate?:string,beginTime?:string,endDate?:string,endTime?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
beginDate;
/** @type {?string} */
beginTime;
/** @type {?string} */
endDate;
/** @type {?string} */
endTime;
}
export class OrderLogisticalDateInformation {
/** @param {{dateRangeDeliveryDateRange?:DateRange,dateRangeShipDateRange?:DateRange,dateRangeDeliveryDateRangeAtUltimateConsignee?:DateRange,requestedDeliveryDateTime?:string,requestedShipDateTime?:string,requestedPickUpDateTime?:string,requestedDeliveryDateTimeAtUltimateConsignee?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DateRange} */
dateRangeDeliveryDateRange;
/** @type {DateRange} */
dateRangeShipDateRange;
/** @type {DateRange} */
dateRangeDeliveryDateRangeAtUltimateConsignee;
/** @type {?string} */
requestedDeliveryDateTime;
/** @type {string} */
requestedShipDateTime;
/** @type {?string} */
requestedPickUpDateTime;
/** @type {?string} */
requestedDeliveryDateTimeAtUltimateConsignee;
}
export class Ecom_PartyIdentificationType {
/** @param {{gln?:string,name?:string,additionalPartyIdentification?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
gln;
/** @type {string} */
name;
/** @type {AvpList[]} */
additionalPartyIdentification = [];
}
export class CommunicationChannel {
/** @param {{communicationChannelCode?:string,communicationChannelName?:string,communicationValue?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
communicationChannelCode;
/** @type {string} */
communicationChannelName;
/** @type {string} */
communicationValue;
}
export class Contact {
/** @param {{contactTypeCode?:string,personName?:string,departmentName?:string,jobTitle?:string,responsibility?:string,communicationChannel?:CommunicationChannel[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
contactTypeCode;
/** @type {string} */
personName;
/** @type {string} */
departmentName;
/** @type {string} */
jobTitle;
/** @type {string} */
responsibility;
/** @type {CommunicationChannel[]} */
communicationChannel = [];
}
export class Address {
/** @param {{streetAddressOne?:string,streetAddressTwo?:string,streetAddressThree?:string,city?:string,postalCode?:string,provinceCode?:string,countryCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
streetAddressOne;
/** @type {string} */
streetAddressTwo;
/** @type {string} */
streetAddressThree;
/** @type {string} */
city;
/** @type {string} */
postalCode;
/** @type {string} */
provinceCode;
/** @type {string} */
countryCode;
}
export class FinancialRoutingNumber {
/** @param {{number?:string,numberTypeCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
number;
/** @type {string} */
numberTypeCode;
}
export class FinancialAccount {
/** @param {{number?:string,numberTypeCode?:string,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
number;
/** @type {string} */
numberTypeCode;
/** @type {string} */
name;
}
export class FinancialInstitutionInformation {
/** @param {{financialInstitutionBranchName?:string,financialInstitutionName?:string,financialRoutingNumber?:FinancialRoutingNumber,financialAccount?:FinancialAccount,swiftCode?:string,exportersCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
financialInstitutionBranchName;
/** @type {string} */
financialInstitutionName;
/** @type {FinancialRoutingNumber} */
financialRoutingNumber;
/** @type {FinancialAccount} */
financialAccount;
/** @type {string} */
swiftCode;
/** @type {string} */
exportersCode;
}
export class TransactionalParty extends Ecom_PartyIdentificationType {
/** @param {{contact?:Contact[],address?:Address,communicationChannel?:AvpList[],financialInstitutionInformation?:FinancialInstitutionInformation,dutyFeeTaxRegistration?:string,entityIdentification?:string,gln?:string,name?:string,additionalPartyIdentification?:AvpList[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {Contact[]} */
contact = [];
/** @type {Address} */
address;
/** @type {AvpList[]} */
communicationChannel = [];
/** @type {FinancialInstitutionInformation} */
financialInstitutionInformation;
/** @type {string} */
dutyFeeTaxRegistration;
/** @type {string} */
entityIdentification;
}
export class ShipmentTransportationInformation {
/** @param {{carrier?:TransactionalParty,freightForwarder?:TransactionalParty}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TransactionalParty} */
carrier;
/** @type {TransactionalParty} */
freightForwarder;
}
export class OrderLogisticalInformation {
/** @param {{commodityTypeCode?:Code,orderLogisticalDateInformation?:OrderLogisticalDateInformation,inventoryLocation?:TransactionalParty,shipFrom?:TransactionalParty,shipTo?:TransactionalParty,ultimateConsignee?:TransactionalParty,shipmentTransportationInformation?:ShipmentTransportationInformation}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Code} */
commodityTypeCode;
/** @type {OrderLogisticalDateInformation} */
orderLogisticalDateInformation;
/** @type {TransactionalParty} */
inventoryLocation;
/** @type {TransactionalParty} */
shipFrom;
/** @type {TransactionalParty} */
shipTo;
/** @type {TransactionalParty} */
ultimateConsignee;
/** @type {ShipmentTransportationInformation} */
shipmentTransportationInformation;
}
export class AdministrativeUnit {
/** @param {{typeCode?:string,gln?:string,internalIdentification?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
typeCode;
/** @type {string} */
gln;
/** @type {string} */
internalIdentification;
}
export class DeliveryTermsLocation {
/** @param {{unLocationCode?:string,gln?:string,additionalLocationIdentification?:AvpList[],sublocationIdentification?:string,locationName?:string,locationSpecificInstructions?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
unLocationCode;
/** @type {string} */
gln;
/** @type {AvpList[]} */
additionalLocationIdentification = [];
/** @type {string} */
sublocationIdentification;
/** @type {string} */
locationName;
/** @type {string} */
locationSpecificInstructions;
}
export class DeliveryTerms {
/** @param {{incotermsCode?:string,alternateDeliveryTermsCode?:string,deliveryInstructions?:string,deliveryCostPayment?:string,isSignatureRequired?:string,deliveryTermsLocation?:DeliveryTermsLocation}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
incotermsCode;
/** @type {string} */
alternateDeliveryTermsCode;
/** @type {string} */
deliveryInstructions;
/** @type {string} */
deliveryCostPayment;
/** @type {string} */
isSignatureRequired;
/** @type {DeliveryTermsLocation} */
deliveryTermsLocation;
}
export class DocumentReference {
/** @param {{creationDateTime?:string,revisionNumber?:number,lineItemNumber?:number,entityIdentification?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
creationDateTime;
/** @type {?number} */
revisionNumber;
/** @type {?number} */
lineItemNumber;
/** @type {string} */
entityIdentification;
}
export class ReferencedOrder {
/** @param {{orderRelationship?:string,documentReference?:DocumentReference}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
orderRelationship;
/** @type {DocumentReference} */
documentReference;
}
export class AllowanceCharge {
/** @param {{allowanceChargeAmount?:number,allowanceChargePercentage?:number,allowanceChargeType?:string,allowanceOrChargeType?:string,amountPerUnit?:number,baseAmount?:number,baseNumberOfUnits?:string,bracketIdentifier?:string,effectiveDateType?:string,sequenceNumber?:string,settlementType?:string,specialServiceType?:string,allowanceChargeDescription?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
allowanceChargeAmount;
/** @type {?number} */
allowanceChargePercentage;
/** @type {string} */
allowanceChargeType;
/** @type {string} */
allowanceOrChargeType;
/** @type {?number} */
amountPerUnit;
/** @type {?number} */
baseAmount;
/** @type {string} */
baseNumberOfUnits;
/** @type {string} */
bracketIdentifier;
/** @type {?string} */
effectiveDateType;
/** @type {string} */
sequenceNumber;
/** @type {string} */
settlementType;
/** @type {string} */
specialServiceType;
/** @type {string} */
allowanceChargeDescription;
}
export class Quantity {
/** @param {{value?:number,measurementUnitCode?:string,codeListVersion?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
value;
/** @type {string} */
measurementUnitCode;
/** @type {string} */
codeListVersion;
}
export class TransactionalItem {
/** @param {{measurementUnitCode?:string,measurementType?:string,measurementValue?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
measurementUnitCode;
/** @type {string} */
measurementType;
/** @type {string} */
measurementValue;
}
export class SerialNumberRange {
/** @param {{maximumValue?:string,minimumValue?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
maximumValue;
/** @type {string} */
minimumValue;
}
export class TransactionalItemDimension {
/** @param {{measurementUnitCode?:string,depth?:string,height?:string,width?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
measurementUnitCode;
/** @type {string} */
depth;
/** @type {string} */
height;
/** @type {string} */
width;
}
export class TransactionalItemLogisticUnitInformation {
/** @param {{numberOfLayers?:number,numberOfUnitsPerLayer?:number,numberOfUnitsPerPallet?:number,packagingTerms?:string,packageTypeCode?:string,maximumStackingFactor?:number,returnablePackageTransportCostPayment?:string,dimensionsOfLogisticUnit?:TransactionalItemDimension[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
numberOfLayers;
/** @type {?number} */
numberOfUnitsPerLayer;
/** @type {?number} */
numberOfUnitsPerPallet;
/** @type {string} */
packagingTerms;
/** @type {string} */
packageTypeCode;
/** @type {?number} */
maximumStackingFactor;
/** @type {string} */
returnablePackageTransportCostPayment;
/** @type {TransactionalItemDimension[]} */
dimensionsOfLogisticUnit = [];
}
export class TransactionalItemDataCarrierAndIdentification {
/** @param {{gs1TransactionalItemIdentificationKey?:string,dataCarrier?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
gs1TransactionalItemIdentificationKey;
/** @type {string} */
dataCarrier;
}
export class TradeItemWaste {
/** @param {{wasteIdentification?:string,typeOfWaste?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
wasteIdentification;
/** @type {AvpList[]} */
typeOfWaste = [];
}
export class TransactionalItemOrganicInformation {
/** @param {{isTradeItemOrganic?:boolean,organicCertification?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?boolean} */
isTradeItemOrganic;
/** @type {string} */
organicCertification;
}
export class TransactionalItemData {
/** @param {{availableForSaleDate?:string,batchNumber?:string,bestBeforeDate?:string,countryOfOrigin?:string,itemExpirationDate?:string,lotNumber?:string,packagingDate?:string,productionDate?:string,productQualityIndication?:string,sellByDate?:string,serialNumber?:string[],shelfLife?:string,tradeItemQuantity?:number,itemInContactWithFoodProduct?:boolean,transactionalItemWeight?:TransactionalItem[],transactionalItemVolume?:TransactionalItem[],serialNumberRange?:SerialNumberRange[],transactionalItemDimensions?:TransactionalItemDimension[],transactionalItemLogisticUnitInformation?:TransactionalItemLogisticUnitInformation,transactionalItemDataCarrierAndIdentification?:TransactionalItemDataCarrierAndIdentification,tradeItemWaste?:TradeItemWaste[],transactionalItemOrganicInformation?:TransactionalItemOrganicInformation,avpList?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
availableForSaleDate;
/** @type {string} */
batchNumber;
/** @type {?string} */
bestBeforeDate;
/** @type {string} */
countryOfOrigin;
/** @type {?string} */
itemExpirationDate;
/** @type {string} */
lotNumber;
/** @type {?string} */
packagingDate;
/** @type {?string} */
productionDate;
/** @type {string} */
productQualityIndication;
/** @type {?string} */
sellByDate;
/** @type {string[]} */
serialNumber = [];
/** @type {string} */
shelfLife;
/** @type {?number} */
tradeItemQuantity;
/** @type {?boolean} */
itemInContactWithFoodProduct;
/** @type {TransactionalItem[]} */
transactionalItemWeight = [];
/** @type {TransactionalItem[]} */
transactionalItemVolume = [];
/** @type {SerialNumberRange[]} */
serialNumberRange = [];
/** @type {TransactionalItemDimension[]} */
transactionalItemDimensions = [];
/** @type {TransactionalItemLogisticUnitInformation} */
transactionalItemLogisticUnitInformation;
/** @type {TransactionalItemDataCarrierAndIdentification} */
transactionalItemDataCarrierAndIdentification;
/** @type {TradeItemWaste[]} */
tradeItemWaste = [];
/** @type {TransactionalItemOrganicInformation} */
transactionalItemOrganicInformation;
/** @type {AvpList[]} */
avpList = [];
}
export class Colour {
/** @param {{colourCode?:string,colourDescription?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
colourCode;
/** @type {string} */
colourDescription;
}
export class Size {
/** @param {{descriptiveSize?:string,sizeCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
descriptiveSize;
/** @type {string} */
sizeCode;
}
export class TradeItemClassification {
/** @param {{gpcCategoryCode?:string,additionalTradeItemClassificationCode?:AvpList[],gpcCategoryName?:string,gpcAttribute?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
gpcCategoryCode;
/** @type {AvpList[]} */
additionalTradeItemClassificationCode = [];
/** @type {string} */
gpcCategoryName;
/** @type {AvpList[]} */
gpcAttribute = [];
}
export class TransactionalTradeItem {
/** @param {{gtin?:string,additionalTradeItemIdentification?:AvpList[],tradeItemQuantity?:number,tradeItemDescription?:string,productVariantIdentifier?:string,itemTypeCode?:string,tradeItemDataOwner?:string,butterFatReference?:string,transactionalItemData?:TransactionalItemData[],colour?:Colour[],size?:Size,tradeItemClassification?:TradeItemClassification,avpList?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
gtin;
/** @type {AvpList[]} */
additionalTradeItemIdentification = [];
/** @type {?number} */
tradeItemQuantity;
/** @type {string} */
tradeItemDescription;
/** @type {string} */
productVariantIdentifier;
/** @type {string} */
itemTypeCode;
/** @type {string} */
tradeItemDataOwner;
/** @type {string} */
butterFatReference;
/** @type {TransactionalItemData[]} */
transactionalItemData = [];
/** @type {Colour[]} */
colour = [];
/** @type {Size} */
size;
/** @type {TradeItemClassification} */
tradeItemClassification;
/** @type {AvpList[]} */
avpList = [];
}
export class LeviedDutyFeeTax {
/** @param {{dutyFeeTaxAmount?:number,dutyFeeTaxBasisAmount?:number,dutyFeeTaxDescription?:string,dutyFeeTaxPercentage?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
dutyFeeTaxAmount;
/** @type {?number} */
dutyFeeTaxBasisAmount;
/** @type {string} */
dutyFeeTaxDescription;
/** @type {?number} */
dutyFeeTaxPercentage;
}
export class OrderLineItemDetail {
/** @param {{requestedQuantity?:Quantity,orderLogisticalInformation?:OrderLogisticalInformation,avpList?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Quantity} */
requestedQuantity;
/** @type {OrderLogisticalInformation} */
orderLogisticalInformation;
/** @type {AvpList[]} */
avpList = [];
}
export class OrderLineItem {
/** @param {{freeGoodsQuantity?:Quantity,itemPriceBaseQuantity?:Quantity,requestedQuantity?:Quantity,lineItemActionCode?:string,lineItemNumber?:number,listPrice?:number,monetaryAmountExcludingTaxes?:number,monetaryAmountIncludingTaxes?:number,netAmount?:number,netPrice?:number,note?:string,orderLineItemInstructionCode?:string,parentLineItemNumber?:number,recommendedRetailPrice?:number,orderLineItemPriority?:string,additionalOrderLineInstruction?:AvpList[],allowanceCharge?:AllowanceCharge[],administrativeUnit?:AdministrativeUnit[],transactionalTradeItem?:TransactionalTradeItem,leviedDutyFeeTax?:LeviedDutyFeeTax,contract?:DocumentReference,promotionalDeal?:DocumentReference,purchaseConditions?:DocumentReference,avpList?:AvpList[],orderLineItemDetail?:OrderLineItemDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Quantity} */
freeGoodsQuantity;
/** @type {Quantity} */
itemPriceBaseQuantity;
/** @type {Quantity} */
requestedQuantity;
/** @type {string} */
lineItemActionCode;
/** @type {?number} */
lineItemNumber;
/** @type {?number} */
listPrice;
/** @type {?number} */
monetaryAmountExcludingTaxes;
/** @type {?number} */
monetaryAmountIncludingTaxes;
/** @type {?number} */
netAmount;
/** @type {?number} */
netPrice;
/** @type {string} */
note;
/** @type {string} */
orderLineItemInstructionCode;
/** @type {?number} */
parentLineItemNumber;
/** @type {?number} */
recommendedRetailPrice;
/** @type {string} */
orderLineItemPriority;
/** @type {AvpList[]} */
additionalOrderLineInstruction = [];
/** @type {AllowanceCharge[]} */
allowanceCharge = [];
/** @type {AdministrativeUnit[]} */
administrativeUnit = [];
/** @type {TransactionalTradeItem} */
transactionalTradeItem;
/** @type {LeviedDutyFeeTax} */
leviedDutyFeeTax;
/** @type {DocumentReference} */
contract;
/** @type {DocumentReference} */
promotionalDeal;
/** @type {DocumentReference} */
purchaseConditions;
/** @type {AvpList[]} */
avpList = [];
/** @type {OrderLineItemDetail[]} */
orderLineItemDetail = [];
}
export class Order extends BaseDocument {
/** @param {{documentEffectiveDate?:string,additionalOrderInstruction?:string,isApplicationReceiptAcknowledgementRequired?:boolean,isOrderFreeOfExciseTaxDuty?:boolean,note?:string,orderEntryType?:string,orderInstructionCode?:string,orderPriority?:string,orderTypeCode?:string,totalMonetaryAmountExcludingTaxes?:number,totalMonetaryAmountIncludingTaxes?:number,totalTaxAmount?:number,paymentTerms?:string,orderIdentification?:Ecom_EntityIdentification,orderLogisticalInformation?:OrderLogisticalInformation,administrativeUnit?:AdministrativeUnit[],deliveryTerms?:DeliveryTerms,transactionalGenericReference?:AvpList[],referencedOrder?:ReferencedOrder[],billTo?:TransactionalParty,buyer?:TransactionalParty,pickupFrom?:TransactionalParty,seller?:TransactionalParty,ultimateConsignee?:TransactionalParty,contract?:DocumentReference,quoteNumber?:DocumentReference,promotionalDeal?:DocumentReference,tradeAgreement?:DocumentReference,deliveryDateAccordingToSchedule?:string,latestDeliveryDate?:string,allowanceCharge?:AllowanceCharge[],orderLineItem?:OrderLineItem[],currencyCode?:string,creationDateTime?:string,documentActionCode?:DocumentAction,documentStatusCode?:DocumentStatus,documentStructureVersion?:string,lastUpdateDateTime?:string,revisionNumber?:number,avpList?:AvpList[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?string} */
documentEffectiveDate;
/** @type {string} */
additionalOrderInstruction;
/** @type {?boolean} */
isApplicationReceiptAcknowledgementRequired;
/** @type {?boolean} */
isOrderFreeOfExciseTaxDuty;
/** @type {string} */
note;
/** @type {string} */
orderEntryType;
/** @type {string} */
orderInstructionCode;
/** @type {string} */
orderPriority;
/** @type {string} */
orderTypeCode;
/** @type {?number} */
totalMonetaryAmountExcludingTaxes;
/** @type {?number} */
totalMonetaryAmountIncludingTaxes;
/** @type {?number} */
totalTaxAmount;
/** @type {string} */
paymentTerms;
/** @type {Ecom_EntityIdentification} */
orderIdentification;
/** @type {OrderLogisticalInformation} */
orderLogisticalInformation;
/** @type {AdministrativeUnit[]} */
administrativeUnit = [];
/** @type {DeliveryTerms} */
deliveryTerms;
/** @type {AvpList[]} */
transactionalGenericReference = [];
/** @type {ReferencedOrder[]} */
referencedOrder = [];
/** @type {TransactionalParty} */
billTo;
/** @type {TransactionalParty} */
buyer;
/** @type {TransactionalParty} */
pickupFrom;
/** @type {TransactionalParty} */
seller;
/** @type {TransactionalParty} */
ultimateConsignee;
/** @type {DocumentReference} */
contract;
/** @type {DocumentReference} */
quoteNumber;
/** @type {DocumentReference} */
promotionalDeal;
/** @type {DocumentReference} */
tradeAgreement;
/** @type {?string} */
deliveryDateAccordingToSchedule;
/** @type {?string} */
latestDeliveryDate;
/** @type {AllowanceCharge[]} */
allowanceCharge = [];
/** @type {OrderLineItem[]} */
orderLineItem = [];
}
export class OrderMessage {
/** @param {{header?:Header,order?:Order}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Header} */
header;
/** @type {Order} */
order;
}
export class GetOrderById {
/** @param {{id?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Order ID or Token */
id;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}}