| POST | /api/receivingAdvice | Add new ReceivingAdvice |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.ReceivingAdvice;
using DX.STF.Models.Dto.GS1;
using DX.Framework.Core.Commands.Dto;
namespace DX.Framework.Core.Commands.Dto
{
public partial class TokenDto
: ICommandResponse
{
public virtual Guid Token { get; set; }
}
}
namespace DX.STF.Application.ClientApi.Messages.ReceivingAdvice
{
///<summary>
///Receiving Advice
///</summary>
[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)]
public partial class AddReceivingAdvice
{
///<summary>
///ReceivingAdvice model containing all of the ReceivingAdvice data
///</summary>
[ApiMember(Description="ReceivingAdvice model containing all of the ReceivingAdvice data", ParameterType="model")]
public virtual ReceivingAdviceMessage ReceivingAdvice { get; set; }
}
}
namespace DX.STF.Models.Dto.GS1
{
public partial class AdditionalConsignmentIdentification
{
public virtual string Text { get; set; }
public virtual string AdditionalConsignmentIdentificationTypeCode { get; set; }
}
public partial class AdditionalIndividualAssetIdentification
{
public virtual decimal? Value { get; set; }
public virtual string AdditionalIndividualAssetIdentificationTypeCode { get; set; }
}
public partial class AdditionalLogisticUnitIdentification
{
public virtual decimal? Value { get; set; }
public virtual string AdditionalLogisticUnitIdentificationTypeCode { get; set; }
}
public partial class AdditionalReturnableAssetIdentification
{
public virtual string Value { get; set; }
public virtual string AdditionalReturnableAssetIdentificationTypeCode { get; set; }
}
public partial class Address
{
public virtual string StreetAddressOne { get; set; }
public virtual string StreetAddressTwo { get; set; }
public virtual string StreetAddressThree { get; set; }
public virtual string City { get; set; }
public virtual string PostalCode { get; set; }
public virtual string ProvinceCode { get; set; }
public virtual string CountryCode { get; set; }
}
public partial class AvpList
{
public virtual string Code { get; set; }
public virtual string Value { get; set; }
}
public partial class BaseDocument
{
public virtual string CurrencyCode { get; set; }
public virtual DateTime CreationDateTime { get; set; }
public virtual DocumentAction DocumentActionCode { get; set; }
public virtual DocumentStatus DocumentStatusCode { get; set; }
public virtual string DocumentStructureVersion { get; set; }
public virtual DateTime? LastUpdateDateTime { get; set; }
public virtual long? RevisionNumber { get; set; }
public virtual List<AvpList> AvpList { get; set; } = [];
}
public partial class CarrierTrackAndTraceInformation
{
public virtual string CarrierTrackAndTraceURL { get; set; }
public virtual string PackageTrackingNumber { get; set; }
}
public partial class Colour
{
public virtual string ColourCode { get; set; }
public virtual string ColourDescription { get; set; }
}
public partial class CommunicationChannel
{
public virtual string CommunicationChannelCode { get; set; }
public virtual string CommunicationChannelName { get; set; }
public virtual string CommunicationValue { get; set; }
}
public partial class ConsignmentIdentification
{
public virtual string Ginc { get; set; }
public virtual AdditionalConsignmentIdentification AdditionalConsignmentIdentification { get; set; }
}
public partial class Contact
{
public virtual string ContactTypeCode { get; set; }
public virtual string PersonName { get; set; }
public virtual string DepartmentName { get; set; }
public virtual string JobTitle { get; set; }
public virtual string Responsibility { get; set; }
public virtual List<CommunicationChannel> CommunicationChannel { get; set; } = [];
}
[DataContract]
public partial class ContactInformation
{
}
public partial class Dimension
{
public virtual Measurement Depth { get; set; }
public virtual Measurement Height { get; set; }
public virtual Measurement Width { get; set; }
}
public enum DocumentAction
{
ADD,
CHANGE_BY_REFRESH,
DELETE,
REJECTED,
}
[DataContract]
public partial class DocumentIdentification
{
[DataMember(Name="identifier")]
public virtual string Identifier { get; set; }
[DataMember(Name="type")]
public virtual string Type { get; set; }
[DataMember(Name="creationDateAndTime")]
public virtual DateTime CreationDateAndTime { get; set; }
}
public partial class DocumentReference
{
public virtual DateTime? CreationDateTime { get; set; }
public virtual long? RevisionNumber { get; set; }
public virtual long? LineItemNumber { get; set; }
public virtual string EntityIdentification { get; set; }
}
public enum DocumentStatus
{
ADDITIONAL_TRANSMISSION,
COPY,
ORIGINAL,
}
public partial class Ecom_IndividualAssetIdentification
{
public virtual List<AdditionalIndividualAssetIdentification> additionalIndividualAssetIdentification { get; set; } = [];
public virtual string Giai { get; set; }
}
public partial class Ecom_LogisticUnitIdentification
{
public virtual List<AdditionalLogisticUnitIdentification> additionalLogisiticUnitIdentification { get; set; } = [];
public virtual string Sscc { get; set; }
}
public partial class Ecom_PartyIdentificationType
{
public virtual string Gln { get; set; }
public virtual string Name { get; set; }
public virtual List<AvpList> AdditionalPartyIdentification { get; set; } = [];
}
public partial class FinancialAccount
{
public virtual string Number { get; set; }
public virtual string NumberTypeCode { get; set; }
public virtual string Name { get; set; }
}
public partial class FinancialInstitutionInformation
{
public virtual string FinancialInstitutionBranchName { get; set; }
public virtual string FinancialInstitutionName { get; set; }
public virtual FinancialRoutingNumber FinancialRoutingNumber { get; set; }
public virtual FinancialAccount FinancialAccount { get; set; }
public virtual string SwiftCode { get; set; }
public virtual string ExportersCode { get; set; }
}
public partial class FinancialRoutingNumber
{
public virtual string Number { get; set; }
public virtual string NumberTypeCode { get; set; }
}
[DataContract]
public partial class Header
{
[DataMember(Name="documentIdentification")]
public virtual DocumentIdentification DocumentIdentification { get; set; }
[DataMember(Name="sender")]
public virtual Partner Sender { get; set; }
[DataMember(Name="receiver")]
public virtual Partner Receiver { get; set; }
}
[DataContract]
public partial class Identifier
{
[DataMember(Name="authority")]
public virtual string Authority { get; set; }
[DataMember(Name="text")]
public virtual string Text { get; set; }
}
public partial class IdentityDocument
{
public virtual string IdentityDocumentIssuer { get; set; }
public virtual string IdentityDocumentNumber { get; set; }
public virtual string IdentityDocumentType { get; set; }
}
public partial class LogisticUnitMeasurement
{
public virtual Dimension Dimension { get; set; }
public virtual UnitMeasurement UnitMeasurement { get; set; }
}
public partial class LogisticUnits
{
public virtual string ChildPackageTypeCode { get; set; }
public virtual long? LevelIdentification { get; set; }
public virtual string PackageTypeCode { get; set; }
public virtual long? ParentLevelIdentification { get; set; }
public virtual long? QuantityOfChildren { get; set; }
public virtual long? QuantityOfLogisticUnits { get; set; }
public virtual LogisticUnitMeasurement LogisticUnitMeasurement { get; set; }
public virtual List<ReturnablePackaging> ReturnablePackaging { get; set; } = [];
public virtual CarrierTrackAndTraceInformation CarrierTrackAndTraceInformation { get; set; }
public virtual AvpList AvpList { get; set; }
public virtual List<Ecom_IndividualAssetIdentification> IndividualAssetIdentification { get; set; } = [];
public virtual Ecom_LogisticUnitIdentification LogisticUnitIdentification { get; set; }
}
public partial class Measurement
{
public virtual decimal? Value { get; set; }
public virtual string CodeListVersion { get; set; }
public virtual string MeasurementUnitCode { get; set; }
}
[DataContract]
public partial class Partner
{
[DataMember(Name="identifier")]
public virtual Identifier Identifier { get; set; }
[DataMember(Name="contactInformation")]
public virtual List<ContactInformation> ContactInformation { get; set; } = [];
}
public partial class Person
{
public virtual DateTime? DateOfBirth { get; set; }
public virtual string Gender { get; set; }
public virtual string Nationality { get; set; }
public virtual string PersonName { get; set; }
public virtual List<IdentityDocument> IdentityDocument { get; set; } = [];
}
public partial class Quantity
{
public virtual decimal? Value { get; set; }
public virtual string MeasurementUnitCode { get; set; }
public virtual string CodeListVersion { get; set; }
}
public partial class ReceivingAdvice
: BaseDocument
{
public virtual DateTime? DespatchAdviceDeliveryDateTime { get; set; }
public virtual string Note { get; set; }
public virtual DateTime? PaymentDateTime { get; set; }
public virtual DateTime? ReceivingDateTime { get; set; }
public virtual string ReportingCode { get; set; }
public virtual decimal? TotalDepositAmount { get; set; }
public virtual ReceivingAdviceTransportInformation ReceivingAdviceTransportInformation { get; set; }
public virtual DocumentReference BillOfLadingNumber { get; set; }
public virtual TransactionalParty Buyer { get; set; }
public virtual TransactionalParty Carrier { get; set; }
public virtual ConsignmentIdentification ConsignmentIdentification { get; set; }
public virtual DocumentReference DeliveryNote { get; set; }
public virtual string DespatchAdvice { get; set; }
public virtual TransactionalParty inventoryLocation { get; set; }
public virtual DocumentReference PurchaseOrder { get; set; }
public virtual TransactionalParty Receiver { get; set; }
public virtual string ReceivingAdviceIdentification { get; set; }
public virtual TransactionalParty Seller { get; set; }
public virtual TransactionalParty ShipFrom { get; set; }
public virtual ConsignmentIdentification ShipmentIdentification { get; set; }
public virtual TransactionalParty Shipper { get; set; }
public virtual TransactionalParty ShipTo { get; set; }
public virtual List<ReceivingAdviceLogisticUnit> ReceivingAdviceLogisticUnit { get; set; } = [];
}
public partial class ReceivingAdviceLineItem
{
public virtual string Extension { get; set; }
public virtual long? LineItemNumber { get; set; }
public virtual string note { get; set; }
public virtual long? ParentLineItemNumber { get; set; }
public virtual Quantity QuantityAccepted { get; set; }
public virtual Quantity QuantityDespatched { get; set; }
public virtual Quantity QuantityReceived { get; set; }
public virtual List<ReceivingConditionInformation> ReceivingConditionInformation { get; set; } = [];
public virtual TransactionalTradeItem TransactionalTradeItem { get; set; }
public virtual ConsignmentIdentification ConsignmentIdentification { get; set; }
public virtual AvpList AvpList { get; set; }
public virtual DocumentReference Contract { get; set; }
public virtual DocumentReference CustomerReference { get; set; }
public virtual DocumentReference DeliveryNote { get; set; }
public virtual DocumentReference DespatchAdvice { get; set; }
public virtual DocumentReference ProductCertification { get; set; }
public virtual DocumentReference PromotionalDeal { get; set; }
public virtual DocumentReference PurchaseConditions { get; set; }
public virtual DocumentReference PurchaseOrder { get; set; }
public virtual TradeItemIdentification RequestedItemIdentification { get; set; }
public virtual DocumentReference Specification { get; set; }
}
public partial class ReceivingAdviceLogisticUnit
: LogisticUnits
{
public virtual List<ReceivingAdviceLineItem> ReceivingAdviceLineItem { get; set; } = [];
}
public partial class ReceivingAdviceMessage
{
public virtual Header Header { get; set; }
public virtual ReceivingAdvice ReceivingAdvice { get; set; }
}
public partial class ReceivingAdviceTransportInformation
{
public virtual Identifier RouteID { get; set; }
public virtual Identifier TransportMeansID { get; set; }
public virtual string TransportMeansName { get; set; }
public virtual Contact Driver { get; set; }
public virtual Person DriverID { get; set; }
public virtual Contact Receiver { get; set; }
public virtual Person ReceiverID { get; set; }
}
public partial class ReceivingConditionInformation
{
public virtual string ReceivedGoodsDisposition { get; set; }
public virtual string ReceivingConditionCode { get; set; }
public virtual Quantity ReceivingConditionQuantity { get; set; }
}
public partial class ReturnableAssetIdentification
{
public virtual List<AdditionalReturnableAssetIdentification> AdditionalReturnableAssetIdentification { get; set; } = [];
public virtual string Grai { get; set; }
}
public partial class ReturnablePackaging
{
public virtual Identifier CurrentHolderRegistration { get; set; }
public virtual Identifier NewHolderRegistration { get; set; }
public virtual string PackagingConditionCode { get; set; }
public virtual long? PackagingQuantity { get; set; }
public virtual List<ReturnableAssetIdentification> IndividualReturnableAssetIdentification { get; set; } = [];
public virtual ReturnableAssetIdentification ReturnableAssetIdentification { get; set; }
}
public partial class SerialNumberRange
{
public virtual string MaximumValue { get; set; }
public virtual string MinimumValue { get; set; }
}
public partial class Size
{
public virtual string DescriptiveSize { get; set; }
public virtual string SizeCode { get; set; }
}
public partial class TradeItemClassification
{
public virtual string GpcCategoryCode { get; set; }
public virtual List<AvpList> AdditionalTradeItemClassificationCode { get; set; } = [];
public virtual string GpcCategoryName { get; set; }
public virtual List<AvpList> GpcAttribute { get; set; } = [];
}
public partial class TradeItemIdentification
{
public virtual List<AvpList> AdditionalTradeItemIdentification { get; set; } = [];
public virtual string Gtin { get; set; }
}
public partial class TradeItemWaste
{
public virtual string WasteIdentification { get; set; }
public virtual List<AvpList> TypeOfWaste { get; set; } = [];
}
public partial class TransactionalItem
{
public virtual string MeasurementUnitCode { get; set; }
public virtual string MeasurementType { get; set; }
public virtual string MeasurementValue { get; set; }
}
public partial class TransactionalItemData
{
public virtual DateTime? AvailableForSaleDate { get; set; }
public virtual string BatchNumber { get; set; }
public virtual DateTime? BestBeforeDate { get; set; }
public virtual string CountryOfOrigin { get; set; }
public virtual DateTime? ItemExpirationDate { get; set; }
public virtual string LotNumber { get; set; }
public virtual DateTime? PackagingDate { get; set; }
public virtual DateTime? ProductionDate { get; set; }
public virtual string ProductQualityIndication { get; set; }
public virtual DateTime? SellByDate { get; set; }
public virtual List<string> SerialNumber { get; set; } = [];
public virtual string ShelfLife { get; set; }
public virtual long? TradeItemQuantity { get; set; }
public virtual bool? ItemInContactWithFoodProduct { get; set; }
public virtual List<TransactionalItem> TransactionalItemWeight { get; set; } = [];
public virtual List<TransactionalItem> TransactionalItemVolume { get; set; } = [];
public virtual List<SerialNumberRange> SerialNumberRange { get; set; } = [];
public virtual List<TransactionalItemDimension> TransactionalItemDimensions { get; set; } = [];
public virtual TransactionalItemLogisticUnitInformation TransactionalItemLogisticUnitInformation { get; set; }
public virtual TransactionalItemDataCarrierAndIdentification TransactionalItemDataCarrierAndIdentification { get; set; }
public virtual List<TradeItemWaste> TradeItemWaste { get; set; } = [];
public virtual TransactionalItemOrganicInformation TransactionalItemOrganicInformation { get; set; }
public virtual List<AvpList> AvpList { get; set; } = [];
}
public partial class TransactionalItemDataCarrierAndIdentification
{
public virtual string Gs1TransactionalItemIdentificationKey { get; set; }
public virtual string DataCarrier { get; set; }
}
public partial class TransactionalItemDimension
{
public virtual string MeasurementUnitCode { get; set; }
public virtual string Depth { get; set; }
public virtual string Height { get; set; }
public virtual string Width { get; set; }
}
public partial class TransactionalItemLogisticUnitInformation
{
public virtual long? NumberOfLayers { get; set; }
public virtual long? NumberOfUnitsPerLayer { get; set; }
public virtual long? NumberOfUnitsPerPallet { get; set; }
public virtual string PackagingTerms { get; set; }
public virtual string PackageTypeCode { get; set; }
public virtual long? MaximumStackingFactor { get; set; }
public virtual string ReturnablePackageTransportCostPayment { get; set; }
public virtual List<TransactionalItemDimension> DimensionsOfLogisticUnit { get; set; } = [];
}
public partial class TransactionalItemOrganicInformation
{
public virtual bool? IsTradeItemOrganic { get; set; }
public virtual string OrganicCertification { get; set; }
}
public partial class TransactionalParty
: Ecom_PartyIdentificationType
{
public virtual List<Contact> Contact { get; set; } = [];
public virtual Address Address { get; set; }
public virtual List<AvpList> CommunicationChannel { get; set; } = [];
public virtual FinancialInstitutionInformation FinancialInstitutionInformation { get; set; }
public virtual string DutyFeeTaxRegistration { get; set; }
public virtual string EntityIdentification { get; set; }
}
public partial class TransactionalTradeItem
{
public virtual string Gtin { get; set; }
public virtual List<AvpList> AdditionalTradeItemIdentification { get; set; } = [];
public virtual decimal? TradeItemQuantity { get; set; }
public virtual string TradeItemDescription { get; set; }
public virtual string ProductVariantIdentifier { get; set; }
public virtual string ItemTypeCode { get; set; }
public virtual string TradeItemDataOwner { get; set; }
public virtual string ButterFatReference { get; set; }
public virtual List<TransactionalItemData> TransactionalItemData { get; set; } = [];
public virtual List<Colour> Colour { get; set; } = [];
public virtual Size Size { get; set; }
public virtual TradeItemClassification TradeItemClassification { get; set; }
public virtual List<AvpList> AvpList { get; set; } = [];
}
public partial class UnitMeasurement
{
public virtual string MeasurementType { get; set; }
public virtual Measurement MeasurementValue { get; set; }
}
}
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
{
}