| POST | /api/receivingAdvice | Add new ReceivingAdvice |
|---|
export class TokenDto implements ICommandResponse
{
public token: string;
public constructor(init?: Partial<TokenDto>) { (Object as any).assign(this, init); }
}
// @DataContract
export class DocumentIdentification
{
// @DataMember(Name="identifier")
public identifier: string;
// @DataMember(Name="type")
public type: string;
// @DataMember(Name="creationDateAndTime")
public creationDateAndTime: string;
public constructor(init?: Partial<DocumentIdentification>) { (Object as any).assign(this, init); }
}
// @DataContract
export class Identifier
{
// @DataMember(Name="authority")
public authority: string;
// @DataMember(Name="text")
public text: string;
public constructor(init?: Partial<Identifier>) { (Object as any).assign(this, init); }
}
// @DataContract
export class ContactInformation
{
public constructor(init?: Partial<ContactInformation>) { (Object as any).assign(this, init); }
}
// @DataContract
export class Partner
{
// @DataMember(Name="identifier")
public identifier: Identifier;
// @DataMember(Name="contactInformation")
public contactInformation: ContactInformation[] = [];
public constructor(init?: Partial<Partner>) { (Object as any).assign(this, init); }
}
// @DataContract
export class Header
{
// @DataMember(Name="documentIdentification")
public documentIdentification: DocumentIdentification;
// @DataMember(Name="sender")
public sender: Partner;
// @DataMember(Name="receiver")
public receiver: Partner;
public constructor(init?: Partial<Header>) { (Object as any).assign(this, init); }
}
export enum DocumentAction
{
ADD = 'ADD',
CHANGE_BY_REFRESH = 'CHANGE_BY_REFRESH',
DELETE = 'DELETE',
REJECTED = 'REJECTED',
}
export enum DocumentStatus
{
ADDITIONAL_TRANSMISSION = 'ADDITIONAL_TRANSMISSION',
COPY = 'COPY',
ORIGINAL = 'ORIGINAL',
}
export class AvpList
{
public code: string;
public value: string;
public constructor(init?: Partial<AvpList>) { (Object as any).assign(this, init); }
}
export class BaseDocument
{
public currencyCode: string;
public creationDateTime: string;
public documentActionCode: DocumentAction;
public documentStatusCode: DocumentStatus;
public documentStructureVersion: string;
public lastUpdateDateTime?: string;
public revisionNumber?: number;
public avpList: AvpList[] = [];
public constructor(init?: Partial<BaseDocument>) { (Object as any).assign(this, init); }
}
export class CommunicationChannel
{
public communicationChannelCode: string;
public communicationChannelName: string;
public communicationValue: string;
public constructor(init?: Partial<CommunicationChannel>) { (Object as any).assign(this, init); }
}
export class Contact
{
public contactTypeCode: string;
public personName: string;
public departmentName: string;
public jobTitle: string;
public responsibility: string;
public communicationChannel: CommunicationChannel[] = [];
public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}
export class IdentityDocument
{
public identityDocumentIssuer: string;
public identityDocumentNumber: string;
public identityDocumentType: string;
public constructor(init?: Partial<IdentityDocument>) { (Object as any).assign(this, init); }
}
export class Person
{
public dateOfBirth?: string;
public gender: string;
public nationality: string;
public personName: string;
public identityDocument: IdentityDocument[] = [];
public constructor(init?: Partial<Person>) { (Object as any).assign(this, init); }
}
export class ReceivingAdviceTransportInformation
{
public routeID: Identifier;
public transportMeansID: Identifier;
public transportMeansName: string;
public driver: Contact;
public driverID: Person;
public receiver: Contact;
public receiverID: Person;
public constructor(init?: Partial<ReceivingAdviceTransportInformation>) { (Object as any).assign(this, init); }
}
export class DocumentReference
{
public creationDateTime?: string;
public revisionNumber?: number;
public lineItemNumber?: number;
public entityIdentification: string;
public constructor(init?: Partial<DocumentReference>) { (Object as any).assign(this, init); }
}
export class Ecom_PartyIdentificationType
{
public gln: string;
public name: string;
public additionalPartyIdentification: AvpList[] = [];
public constructor(init?: Partial<Ecom_PartyIdentificationType>) { (Object as any).assign(this, init); }
}
export class Address
{
public streetAddressOne: string;
public streetAddressTwo: string;
public streetAddressThree: string;
public city: string;
public postalCode: string;
public provinceCode: string;
public countryCode: string;
public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}
export class FinancialRoutingNumber
{
public number: string;
public numberTypeCode: string;
public constructor(init?: Partial<FinancialRoutingNumber>) { (Object as any).assign(this, init); }
}
export class FinancialAccount
{
public number: string;
public numberTypeCode: string;
public name: string;
public constructor(init?: Partial<FinancialAccount>) { (Object as any).assign(this, init); }
}
export class FinancialInstitutionInformation
{
public financialInstitutionBranchName: string;
public financialInstitutionName: string;
public financialRoutingNumber: FinancialRoutingNumber;
public financialAccount: FinancialAccount;
public swiftCode: string;
public exportersCode: string;
public constructor(init?: Partial<FinancialInstitutionInformation>) { (Object as any).assign(this, init); }
}
export class TransactionalParty extends Ecom_PartyIdentificationType
{
public contact: Contact[] = [];
public address: Address;
public communicationChannel: AvpList[] = [];
public financialInstitutionInformation: FinancialInstitutionInformation;
public dutyFeeTaxRegistration: string;
public entityIdentification: string;
public constructor(init?: Partial<TransactionalParty>) { super(init); (Object as any).assign(this, init); }
}
export class AdditionalConsignmentIdentification
{
public text: string;
public additionalConsignmentIdentificationTypeCode: string;
public constructor(init?: Partial<AdditionalConsignmentIdentification>) { (Object as any).assign(this, init); }
}
export class ConsignmentIdentification
{
public ginc: string;
public additionalConsignmentIdentification: AdditionalConsignmentIdentification;
public constructor(init?: Partial<ConsignmentIdentification>) { (Object as any).assign(this, init); }
}
export class Measurement
{
public value?: number;
public codeListVersion: string;
public measurementUnitCode: string;
public constructor(init?: Partial<Measurement>) { (Object as any).assign(this, init); }
}
export class Dimension
{
public depth: Measurement;
public height: Measurement;
public width: Measurement;
public constructor(init?: Partial<Dimension>) { (Object as any).assign(this, init); }
}
export class UnitMeasurement
{
public measurementType: string;
public measurementValue: Measurement;
public constructor(init?: Partial<UnitMeasurement>) { (Object as any).assign(this, init); }
}
export class LogisticUnitMeasurement
{
public dimension: Dimension;
public unitMeasurement: UnitMeasurement;
public constructor(init?: Partial<LogisticUnitMeasurement>) { (Object as any).assign(this, init); }
}
export class AdditionalReturnableAssetIdentification
{
public value: string;
public additionalReturnableAssetIdentificationTypeCode: string;
public constructor(init?: Partial<AdditionalReturnableAssetIdentification>) { (Object as any).assign(this, init); }
}
export class ReturnableAssetIdentification
{
public additionalReturnableAssetIdentification: AdditionalReturnableAssetIdentification[] = [];
public grai: string;
public constructor(init?: Partial<ReturnableAssetIdentification>) { (Object as any).assign(this, init); }
}
export class ReturnablePackaging
{
public currentHolderRegistration: Identifier;
public newHolderRegistration: Identifier;
public packagingConditionCode: string;
public packagingQuantity?: number;
public individualReturnableAssetIdentification: ReturnableAssetIdentification[] = [];
public returnableAssetIdentification: ReturnableAssetIdentification;
public constructor(init?: Partial<ReturnablePackaging>) { (Object as any).assign(this, init); }
}
export class CarrierTrackAndTraceInformation
{
public carrierTrackAndTraceURL: string;
public packageTrackingNumber: string;
public constructor(init?: Partial<CarrierTrackAndTraceInformation>) { (Object as any).assign(this, init); }
}
export class AdditionalIndividualAssetIdentification
{
public value?: number;
public additionalIndividualAssetIdentificationTypeCode: string;
public constructor(init?: Partial<AdditionalIndividualAssetIdentification>) { (Object as any).assign(this, init); }
}
export class Ecom_IndividualAssetIdentification
{
public additionalIndividualAssetIdentification: AdditionalIndividualAssetIdentification[] = [];
public giai: string;
public constructor(init?: Partial<Ecom_IndividualAssetIdentification>) { (Object as any).assign(this, init); }
}
export class AdditionalLogisticUnitIdentification
{
public value?: number;
public additionalLogisticUnitIdentificationTypeCode: string;
public constructor(init?: Partial<AdditionalLogisticUnitIdentification>) { (Object as any).assign(this, init); }
}
export class Ecom_LogisticUnitIdentification
{
public additionalLogisiticUnitIdentification: AdditionalLogisticUnitIdentification[] = [];
public sscc: string;
public constructor(init?: Partial<Ecom_LogisticUnitIdentification>) { (Object as any).assign(this, init); }
}
export class LogisticUnits
{
public childPackageTypeCode: string;
public levelIdentification?: number;
public packageTypeCode: string;
public parentLevelIdentification?: number;
public quantityOfChildren?: number;
public quantityOfLogisticUnits?: number;
public logisticUnitMeasurement: LogisticUnitMeasurement;
public returnablePackaging: ReturnablePackaging[] = [];
public carrierTrackAndTraceInformation: CarrierTrackAndTraceInformation;
public avpList: AvpList;
public individualAssetIdentification: Ecom_IndividualAssetIdentification[] = [];
public logisticUnitIdentification: Ecom_LogisticUnitIdentification;
public constructor(init?: Partial<LogisticUnits>) { (Object as any).assign(this, init); }
}
export class Quantity
{
public value?: number;
public measurementUnitCode: string;
public codeListVersion: string;
public constructor(init?: Partial<Quantity>) { (Object as any).assign(this, init); }
}
export class ReceivingConditionInformation
{
public receivedGoodsDisposition: string;
public receivingConditionCode: string;
public receivingConditionQuantity: Quantity;
public constructor(init?: Partial<ReceivingConditionInformation>) { (Object as any).assign(this, init); }
}
export class TransactionalItem
{
public measurementUnitCode: string;
public measurementType: string;
public measurementValue: string;
public constructor(init?: Partial<TransactionalItem>) { (Object as any).assign(this, init); }
}
export class SerialNumberRange
{
public maximumValue: string;
public minimumValue: string;
public constructor(init?: Partial<SerialNumberRange>) { (Object as any).assign(this, init); }
}
export class TransactionalItemDimension
{
public measurementUnitCode: string;
public depth: string;
public height: string;
public width: string;
public constructor(init?: Partial<TransactionalItemDimension>) { (Object as any).assign(this, init); }
}
export class TransactionalItemLogisticUnitInformation
{
public numberOfLayers?: number;
public numberOfUnitsPerLayer?: number;
public numberOfUnitsPerPallet?: number;
public packagingTerms: string;
public packageTypeCode: string;
public maximumStackingFactor?: number;
public returnablePackageTransportCostPayment: string;
public dimensionsOfLogisticUnit: TransactionalItemDimension[] = [];
public constructor(init?: Partial<TransactionalItemLogisticUnitInformation>) { (Object as any).assign(this, init); }
}
export class TransactionalItemDataCarrierAndIdentification
{
public gs1TransactionalItemIdentificationKey: string;
public dataCarrier: string;
public constructor(init?: Partial<TransactionalItemDataCarrierAndIdentification>) { (Object as any).assign(this, init); }
}
export class TradeItemWaste
{
public wasteIdentification: string;
public typeOfWaste: AvpList[] = [];
public constructor(init?: Partial<TradeItemWaste>) { (Object as any).assign(this, init); }
}
export class TransactionalItemOrganicInformation
{
public isTradeItemOrganic?: boolean;
public organicCertification: string;
public constructor(init?: Partial<TransactionalItemOrganicInformation>) { (Object as any).assign(this, init); }
}
export class TransactionalItemData
{
public availableForSaleDate?: string;
public batchNumber: string;
public bestBeforeDate?: string;
public countryOfOrigin: string;
public itemExpirationDate?: string;
public lotNumber: string;
public packagingDate?: string;
public productionDate?: string;
public productQualityIndication: string;
public sellByDate?: string;
public serialNumber: string[] = [];
public shelfLife: string;
public tradeItemQuantity?: number;
public itemInContactWithFoodProduct?: boolean;
public transactionalItemWeight: TransactionalItem[] = [];
public transactionalItemVolume: TransactionalItem[] = [];
public serialNumberRange: SerialNumberRange[] = [];
public transactionalItemDimensions: TransactionalItemDimension[] = [];
public transactionalItemLogisticUnitInformation: TransactionalItemLogisticUnitInformation;
public transactionalItemDataCarrierAndIdentification: TransactionalItemDataCarrierAndIdentification;
public tradeItemWaste: TradeItemWaste[] = [];
public transactionalItemOrganicInformation: TransactionalItemOrganicInformation;
public avpList: AvpList[] = [];
public constructor(init?: Partial<TransactionalItemData>) { (Object as any).assign(this, init); }
}
export class Colour
{
public colourCode: string;
public colourDescription: string;
public constructor(init?: Partial<Colour>) { (Object as any).assign(this, init); }
}
export class Size
{
public descriptiveSize: string;
public sizeCode: string;
public constructor(init?: Partial<Size>) { (Object as any).assign(this, init); }
}
export class TradeItemClassification
{
public gpcCategoryCode: string;
public additionalTradeItemClassificationCode: AvpList[] = [];
public gpcCategoryName: string;
public gpcAttribute: AvpList[] = [];
public constructor(init?: Partial<TradeItemClassification>) { (Object as any).assign(this, init); }
}
export class TransactionalTradeItem
{
public gtin: string;
public additionalTradeItemIdentification: AvpList[] = [];
public tradeItemQuantity?: number;
public tradeItemDescription: string;
public productVariantIdentifier: string;
public itemTypeCode: string;
public tradeItemDataOwner: string;
public butterFatReference: string;
public transactionalItemData: TransactionalItemData[] = [];
public colour: Colour[] = [];
public size: Size;
public tradeItemClassification: TradeItemClassification;
public avpList: AvpList[] = [];
public constructor(init?: Partial<TransactionalTradeItem>) { (Object as any).assign(this, init); }
}
export class TradeItemIdentification
{
public additionalTradeItemIdentification: AvpList[] = [];
public gtin: string;
public constructor(init?: Partial<TradeItemIdentification>) { (Object as any).assign(this, init); }
}
export class ReceivingAdviceLineItem
{
public extension: string;
public lineItemNumber?: number;
public note: string;
public parentLineItemNumber?: number;
public quantityAccepted: Quantity;
public quantityDespatched: Quantity;
public quantityReceived: Quantity;
public receivingConditionInformation: ReceivingConditionInformation[] = [];
public transactionalTradeItem: TransactionalTradeItem;
public consignmentIdentification: ConsignmentIdentification;
public avpList: AvpList;
public contract: DocumentReference;
public customerReference: DocumentReference;
public deliveryNote: DocumentReference;
public despatchAdvice: DocumentReference;
public productCertification: DocumentReference;
public promotionalDeal: DocumentReference;
public purchaseConditions: DocumentReference;
public purchaseOrder: DocumentReference;
public requestedItemIdentification: TradeItemIdentification;
public specification: DocumentReference;
public constructor(init?: Partial<ReceivingAdviceLineItem>) { (Object as any).assign(this, init); }
}
export class ReceivingAdviceLogisticUnit extends LogisticUnits
{
public receivingAdviceLineItem: ReceivingAdviceLineItem[] = [];
public constructor(init?: Partial<ReceivingAdviceLogisticUnit>) { super(init); (Object as any).assign(this, init); }
}
export class ReceivingAdvice extends BaseDocument
{
public despatchAdviceDeliveryDateTime?: string;
public note: string;
public paymentDateTime?: string;
public receivingDateTime?: string;
public reportingCode: string;
public totalDepositAmount?: number;
public receivingAdviceTransportInformation: ReceivingAdviceTransportInformation;
public billOfLadingNumber: DocumentReference;
public buyer: TransactionalParty;
public carrier: TransactionalParty;
public consignmentIdentification: ConsignmentIdentification;
public deliveryNote: DocumentReference;
public despatchAdvice: string;
public inventoryLocation: TransactionalParty;
public purchaseOrder: DocumentReference;
public receiver: TransactionalParty;
public receivingAdviceIdentification: string;
public seller: TransactionalParty;
public shipFrom: TransactionalParty;
public shipmentIdentification: ConsignmentIdentification;
public shipper: TransactionalParty;
public shipTo: TransactionalParty;
public receivingAdviceLogisticUnit: ReceivingAdviceLogisticUnit[] = [];
public constructor(init?: Partial<ReceivingAdvice>) { super(init); (Object as any).assign(this, init); }
}
export class ReceivingAdviceMessage
{
public header: Header;
public receivingAdvice: ReceivingAdvice;
public constructor(init?: Partial<ReceivingAdviceMessage>) { (Object as any).assign(this, init); }
}
/** @description Receiving Advice */
// @Api(Description="Receiving Advice")
// @ApiResponse(Description="Add ReceivingAdvice request received", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="ReceivingAdvice not accepted, Confirm Sender GLN", ResponseType="typeof(System.UnauthorizedAccessException)", StatusCode=403)
export class AddReceivingAdvice
{
/** @description ReceivingAdvice model containing all of the ReceivingAdvice data */
// @ApiMember(Description="ReceivingAdvice model containing all of the ReceivingAdvice data", ParameterType="model")
public receivingAdvice: ReceivingAdviceMessage;
public constructor(init?: Partial<AddReceivingAdvice>) { (Object as any).assign(this, init); }
}
TypeScript AddReceivingAdvice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length
{
}