| POST | /api/receivingAdvice | Add new ReceivingAdvice |
|---|
"use strict";
export class TokenDto {
/** @param {{token?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
token;
}
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 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 IdentityDocument {
/** @param {{identityDocumentIssuer?:string,identityDocumentNumber?:string,identityDocumentType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
identityDocumentIssuer;
/** @type {string} */
identityDocumentNumber;
/** @type {string} */
identityDocumentType;
}
export class Person {
/** @param {{dateOfBirth?:string,gender?:string,nationality?:string,personName?:string,identityDocument?:IdentityDocument[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
dateOfBirth;
/** @type {string} */
gender;
/** @type {string} */
nationality;
/** @type {string} */
personName;
/** @type {IdentityDocument[]} */
identityDocument = [];
}
export class ReceivingAdviceTransportInformation {
/** @param {{routeID?:Identifier,transportMeansID?:Identifier,transportMeansName?:string,driver?:Contact,driverID?:Person,receiver?:Contact,receiverID?:Person}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Identifier} */
routeID;
/** @type {Identifier} */
transportMeansID;
/** @type {string} */
transportMeansName;
/** @type {Contact} */
driver;
/** @type {Person} */
driverID;
/** @type {Contact} */
receiver;
/** @type {Person} */
receiverID;
}
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 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 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 AdditionalConsignmentIdentification {
/** @param {{text?:string,additionalConsignmentIdentificationTypeCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
text;
/** @type {string} */
additionalConsignmentIdentificationTypeCode;
}
export class ConsignmentIdentification {
/** @param {{ginc?:string,additionalConsignmentIdentification?:AdditionalConsignmentIdentification}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ginc;
/** @type {AdditionalConsignmentIdentification} */
additionalConsignmentIdentification;
}
export class Measurement {
/** @param {{value?:number,codeListVersion?:string,measurementUnitCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
value;
/** @type {string} */
codeListVersion;
/** @type {string} */
measurementUnitCode;
}
export class Dimension {
/** @param {{depth?:Measurement,height?:Measurement,width?:Measurement}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Measurement} */
depth;
/** @type {Measurement} */
height;
/** @type {Measurement} */
width;
}
export class UnitMeasurement {
/** @param {{measurementType?:string,measurementValue?:Measurement}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
measurementType;
/** @type {Measurement} */
measurementValue;
}
export class LogisticUnitMeasurement {
/** @param {{dimension?:Dimension,unitMeasurement?:UnitMeasurement}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Dimension} */
dimension;
/** @type {UnitMeasurement} */
unitMeasurement;
}
export class AdditionalReturnableAssetIdentification {
/** @param {{value?:string,additionalReturnableAssetIdentificationTypeCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
value;
/** @type {string} */
additionalReturnableAssetIdentificationTypeCode;
}
export class ReturnableAssetIdentification {
/** @param {{additionalReturnableAssetIdentification?:AdditionalReturnableAssetIdentification[],grai?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AdditionalReturnableAssetIdentification[]} */
additionalReturnableAssetIdentification = [];
/** @type {string} */
grai;
}
export class ReturnablePackaging {
/** @param {{currentHolderRegistration?:Identifier,newHolderRegistration?:Identifier,packagingConditionCode?:string,packagingQuantity?:number,individualReturnableAssetIdentification?:ReturnableAssetIdentification[],returnableAssetIdentification?:ReturnableAssetIdentification}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Identifier} */
currentHolderRegistration;
/** @type {Identifier} */
newHolderRegistration;
/** @type {string} */
packagingConditionCode;
/** @type {?number} */
packagingQuantity;
/** @type {ReturnableAssetIdentification[]} */
individualReturnableAssetIdentification = [];
/** @type {ReturnableAssetIdentification} */
returnableAssetIdentification;
}
export class CarrierTrackAndTraceInformation {
/** @param {{carrierTrackAndTraceURL?:string,packageTrackingNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
carrierTrackAndTraceURL;
/** @type {string} */
packageTrackingNumber;
}
export class AdditionalIndividualAssetIdentification {
/** @param {{value?:number,additionalIndividualAssetIdentificationTypeCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
value;
/** @type {string} */
additionalIndividualAssetIdentificationTypeCode;
}
export class Ecom_IndividualAssetIdentification {
/** @param {{additionalIndividualAssetIdentification?:AdditionalIndividualAssetIdentification[],giai?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AdditionalIndividualAssetIdentification[]} */
additionalIndividualAssetIdentification = [];
/** @type {string} */
giai;
}
export class AdditionalLogisticUnitIdentification {
/** @param {{value?:number,additionalLogisticUnitIdentificationTypeCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
value;
/** @type {string} */
additionalLogisticUnitIdentificationTypeCode;
}
export class Ecom_LogisticUnitIdentification {
/** @param {{additionalLogisiticUnitIdentification?:AdditionalLogisticUnitIdentification[],sscc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AdditionalLogisticUnitIdentification[]} */
additionalLogisiticUnitIdentification = [];
/** @type {string} */
sscc;
}
export class LogisticUnits {
/** @param {{childPackageTypeCode?:string,levelIdentification?:number,packageTypeCode?:string,parentLevelIdentification?:number,quantityOfChildren?:number,quantityOfLogisticUnits?:number,logisticUnitMeasurement?:LogisticUnitMeasurement,returnablePackaging?:ReturnablePackaging[],carrierTrackAndTraceInformation?:CarrierTrackAndTraceInformation,avpList?:AvpList,individualAssetIdentification?:Ecom_IndividualAssetIdentification[],logisticUnitIdentification?:Ecom_LogisticUnitIdentification}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
childPackageTypeCode;
/** @type {?number} */
levelIdentification;
/** @type {string} */
packageTypeCode;
/** @type {?number} */
parentLevelIdentification;
/** @type {?number} */
quantityOfChildren;
/** @type {?number} */
quantityOfLogisticUnits;
/** @type {LogisticUnitMeasurement} */
logisticUnitMeasurement;
/** @type {ReturnablePackaging[]} */
returnablePackaging = [];
/** @type {CarrierTrackAndTraceInformation} */
carrierTrackAndTraceInformation;
/** @type {AvpList} */
avpList;
/** @type {Ecom_IndividualAssetIdentification[]} */
individualAssetIdentification = [];
/** @type {Ecom_LogisticUnitIdentification} */
logisticUnitIdentification;
}
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 ReceivingConditionInformation {
/** @param {{receivedGoodsDisposition?:string,receivingConditionCode?:string,receivingConditionQuantity?:Quantity}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
receivedGoodsDisposition;
/** @type {string} */
receivingConditionCode;
/** @type {Quantity} */
receivingConditionQuantity;
}
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 TradeItemIdentification {
/** @param {{additionalTradeItemIdentification?:AvpList[],gtin?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AvpList[]} */
additionalTradeItemIdentification = [];
/** @type {string} */
gtin;
}
export class ReceivingAdviceLineItem {
/** @param {{extension?:string,lineItemNumber?:number,note?:string,parentLineItemNumber?:number,quantityAccepted?:Quantity,quantityDespatched?:Quantity,quantityReceived?:Quantity,receivingConditionInformation?:ReceivingConditionInformation[],transactionalTradeItem?:TransactionalTradeItem,consignmentIdentification?:ConsignmentIdentification,avpList?:AvpList,contract?:DocumentReference,customerReference?:DocumentReference,deliveryNote?:DocumentReference,despatchAdvice?:DocumentReference,productCertification?:DocumentReference,promotionalDeal?:DocumentReference,purchaseConditions?:DocumentReference,purchaseOrder?:DocumentReference,requestedItemIdentification?:TradeItemIdentification,specification?:DocumentReference}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
extension;
/** @type {?number} */
lineItemNumber;
/** @type {string} */
note;
/** @type {?number} */
parentLineItemNumber;
/** @type {Quantity} */
quantityAccepted;
/** @type {Quantity} */
quantityDespatched;
/** @type {Quantity} */
quantityReceived;
/** @type {ReceivingConditionInformation[]} */
receivingConditionInformation = [];
/** @type {TransactionalTradeItem} */
transactionalTradeItem;
/** @type {ConsignmentIdentification} */
consignmentIdentification;
/** @type {AvpList} */
avpList;
/** @type {DocumentReference} */
contract;
/** @type {DocumentReference} */
customerReference;
/** @type {DocumentReference} */
deliveryNote;
/** @type {DocumentReference} */
despatchAdvice;
/** @type {DocumentReference} */
productCertification;
/** @type {DocumentReference} */
promotionalDeal;
/** @type {DocumentReference} */
purchaseConditions;
/** @type {DocumentReference} */
purchaseOrder;
/** @type {TradeItemIdentification} */
requestedItemIdentification;
/** @type {DocumentReference} */
specification;
}
export class ReceivingAdviceLogisticUnit extends LogisticUnits {
/** @param {{receivingAdviceLineItem?:ReceivingAdviceLineItem[],childPackageTypeCode?:string,levelIdentification?:number,packageTypeCode?:string,parentLevelIdentification?:number,quantityOfChildren?:number,quantityOfLogisticUnits?:number,logisticUnitMeasurement?:LogisticUnitMeasurement,returnablePackaging?:ReturnablePackaging[],carrierTrackAndTraceInformation?:CarrierTrackAndTraceInformation,avpList?:AvpList,individualAssetIdentification?:Ecom_IndividualAssetIdentification[],logisticUnitIdentification?:Ecom_LogisticUnitIdentification}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ReceivingAdviceLineItem[]} */
receivingAdviceLineItem = [];
}
export class ReceivingAdvice extends BaseDocument {
/** @param {{despatchAdviceDeliveryDateTime?:string,note?:string,paymentDateTime?:string,receivingDateTime?:string,reportingCode?:string,totalDepositAmount?:number,receivingAdviceTransportInformation?:ReceivingAdviceTransportInformation,billOfLadingNumber?:DocumentReference,buyer?:TransactionalParty,carrier?:TransactionalParty,consignmentIdentification?:ConsignmentIdentification,deliveryNote?:DocumentReference,despatchAdvice?:string,inventoryLocation?:TransactionalParty,purchaseOrder?:DocumentReference,receiver?:TransactionalParty,receivingAdviceIdentification?:string,seller?:TransactionalParty,shipFrom?:TransactionalParty,shipmentIdentification?:ConsignmentIdentification,shipper?:TransactionalParty,shipTo?:TransactionalParty,receivingAdviceLogisticUnit?:ReceivingAdviceLogisticUnit[],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} */
despatchAdviceDeliveryDateTime;
/** @type {string} */
note;
/** @type {?string} */
paymentDateTime;
/** @type {?string} */
receivingDateTime;
/** @type {string} */
reportingCode;
/** @type {?number} */
totalDepositAmount;
/** @type {ReceivingAdviceTransportInformation} */
receivingAdviceTransportInformation;
/** @type {DocumentReference} */
billOfLadingNumber;
/** @type {TransactionalParty} */
buyer;
/** @type {TransactionalParty} */
carrier;
/** @type {ConsignmentIdentification} */
consignmentIdentification;
/** @type {DocumentReference} */
deliveryNote;
/** @type {string} */
despatchAdvice;
/** @type {TransactionalParty} */
inventoryLocation;
/** @type {DocumentReference} */
purchaseOrder;
/** @type {TransactionalParty} */
receiver;
/** @type {string} */
receivingAdviceIdentification;
/** @type {TransactionalParty} */
seller;
/** @type {TransactionalParty} */
shipFrom;
/** @type {ConsignmentIdentification} */
shipmentIdentification;
/** @type {TransactionalParty} */
shipper;
/** @type {TransactionalParty} */
shipTo;
/** @type {ReceivingAdviceLogisticUnit[]} */
receivingAdviceLogisticUnit = [];
}
export class ReceivingAdviceMessage {
/** @param {{header?:Header,receivingAdvice?:ReceivingAdvice}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Header} */
header;
/** @type {ReceivingAdvice} */
receivingAdvice;
}
export class AddReceivingAdvice {
/** @param {{receivingAdvice?:ReceivingAdviceMessage}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ReceivingAdviceMessage}
* @description ReceivingAdvice model containing all of the ReceivingAdvice data */
receivingAdvice;
}
JavaScript AddReceivingAdvice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/receivingAdvice HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"receivingAdvice":{"header":{"documentIdentification":{"identifier":"String","type":"String"},"sender":{"identifier":{"authority":"String","text":"String"},"contactInformation":[{}]},"receiver":{"identifier":{"authority":"String","text":"String"},"contactInformation":[{}]}},"receivingAdvice":{"despatchAdviceDeliveryDateTime":"0001-01-01","note":"String","paymentDateTime":"0001-01-01","receivingDateTime":"0001-01-01","reportingCode":"String","totalDepositAmount":0,"receivingAdviceTransportInformation":{"routeID":{"authority":"String","text":"String"},"transportMeansID":{"authority":"String","text":"String"},"transportMeansName":"String","driver":{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]},"driverID":{"dateOfBirth":"0001-01-01","gender":"String","nationality":"String","personName":"String","identityDocument":[{"identityDocumentIssuer":"String","identityDocumentNumber":"String","identityDocumentType":"String"}]},"receiver":{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]},"receiverID":{"dateOfBirth":"0001-01-01","gender":"String","nationality":"String","personName":"String","identityDocument":[{"identityDocumentIssuer":"String","identityDocumentNumber":"String","identityDocumentType":"String"}]}},"billOfLadingNumber":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"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"}]},"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"}]},"consignmentIdentification":{"ginc":"String","additionalConsignmentIdentification":{"text":"String","additionalConsignmentIdentificationTypeCode":"String"}},"deliveryNote":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"despatchAdvice":"String","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"}]},"purchaseOrder":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"receiver":{"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]},"receivingAdviceIdentification":"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"}]},"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"}]},"shipmentIdentification":{"ginc":"String","additionalConsignmentIdentification":{"text":"String","additionalConsignmentIdentificationTypeCode":"String"}},"shipper":{"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]},"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"}]},"receivingAdviceLogisticUnit":[{"receivingAdviceLineItem":[{"extension":"String","lineItemNumber":0,"note":"String","parentLineItemNumber":0,"quantityAccepted":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"quantityDespatched":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"quantityReceived":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"receivingConditionInformation":[{"receivedGoodsDisposition":"String","receivingConditionCode":"String","receivingConditionQuantity":{"value":0,"measurementUnitCode":"String","codeListVersion":"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"}]},"consignmentIdentification":{"ginc":"String","additionalConsignmentIdentification":{"text":"String","additionalConsignmentIdentificationTypeCode":"String"}},"avpList":{"code":"String","value":"String"},"contract":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"customerReference":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"deliveryNote":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"despatchAdvice":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"productCertification":{"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"},"purchaseOrder":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"},"requestedItemIdentification":{"additionalTradeItemIdentification":[{"code":"String","value":"String"}],"gtin":"String"},"specification":{"creationDateTime":"0001-01-01","revisionNumber":0,"lineItemNumber":0,"entityIdentification":"String"}}],"childPackageTypeCode":"String","levelIdentification":0,"packageTypeCode":"String","parentLevelIdentification":0,"quantityOfChildren":0,"quantityOfLogisticUnits":0,"logisticUnitMeasurement":{"dimension":{"depth":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"height":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"width":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"}},"unitMeasurement":{"measurementType":"String","measurementValue":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"}}},"returnablePackaging":[{"currentHolderRegistration":{"authority":"String","text":"String"},"newHolderRegistration":{"authority":"String","text":"String"},"packagingConditionCode":"String","packagingQuantity":0,"individualReturnableAssetIdentification":[{"additionalReturnableAssetIdentification":[{"value":"String","additionalReturnableAssetIdentificationTypeCode":"String"}],"grai":"String"}],"returnableAssetIdentification":{"additionalReturnableAssetIdentification":[{"value":"String","additionalReturnableAssetIdentificationTypeCode":"String"}],"grai":"String"}}],"carrierTrackAndTraceInformation":{"carrierTrackAndTraceURL":"String","packageTrackingNumber":"String"},"avpList":{"code":"String","value":"String"},"individualAssetIdentification":[{"additionalIndividualAssetIdentification":[{"value":0,"additionalIndividualAssetIdentificationTypeCode":"String"}],"giai":"String"}],"logisticUnitIdentification":{"additionalLogisiticUnitIdentification":[{"value":0,"additionalLogisticUnitIdentificationTypeCode":"String"}],"sscc":"String"}}],"currencyCode":"String","documentActionCode":"ADD","documentStatusCode":"ADDITIONAL_TRANSMISSION","documentStructureVersion":"String","lastUpdateDateTime":"0001-01-01","revisionNumber":0,"avpList":[{"code":"String","value":"String"}]}}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{}