| POST | /api/order | Add new order |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Order | model | OrderMessage | Yes | Order model containing all of the order data |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Header | form | Header | Yes | |
| Order | form | Order | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentIdentification | form | DocumentIdentification | Yes | |
| Sender | form | Partner | Yes | |
| Receiver | form | Partner | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Identifier | form | string | Yes | |
| Type | form | string | Yes | |
| CreationDateAndTime | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Identifier | form | Identifier | Yes | |
| ContactInformation | form | List<ContactInformation> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Authority | form | string | Yes | |
| Text | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentEffectiveDate | form | DateTime? | No | |
| AdditionalOrderInstruction | form | string | Yes | |
| IsApplicationReceiptAcknowledgementRequired | form | bool? | No | |
| IsOrderFreeOfExciseTaxDuty | form | bool? | No | |
| Note | form | string | Yes | |
| OrderEntryType | form | string | Yes | |
| OrderInstructionCode | form | string | Yes | |
| OrderPriority | form | string | Yes | |
| OrderTypeCode | form | string | Yes | |
| TotalMonetaryAmountExcludingTaxes | form | decimal? | No | |
| TotalMonetaryAmountIncludingTaxes | form | decimal? | No | |
| TotalTaxAmount | form | decimal? | No | |
| PaymentTerms | form | string | Yes | |
| OrderIdentification | form | Ecom_EntityIdentification | Yes | |
| OrderLogisticalInformation | form | OrderLogisticalInformation | Yes | |
| AdministrativeUnit | form | List<AdministrativeUnit> | Yes | |
| DeliveryTerms | form | DeliveryTerms | Yes | |
| TransactionalGenericReference | form | List<AvpList> | Yes | |
| ReferencedOrder | form | List<ReferencedOrder> | Yes | |
| BillTo | form | TransactionalParty | Yes | |
| Buyer | form | TransactionalParty | Yes | |
| PickupFrom | form | TransactionalParty | Yes | |
| Seller | form | TransactionalParty | Yes | |
| UltimateConsignee | form | TransactionalParty | Yes | |
| Contract | form | DocumentReference | Yes | |
| QuoteNumber | form | DocumentReference | Yes | |
| PromotionalDeal | form | DocumentReference | Yes | |
| TradeAgreement | form | DocumentReference | Yes | |
| DeliveryDateAccordingToSchedule | form | DateTime? | No | |
| LatestDeliveryDate | form | DateTime? | No | |
| AllowanceCharge | form | List<AllowanceCharge> | Yes | |
| OrderLineItem | form | List<OrderLineItem> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrencyCode | form | string | Yes | |
| CreationDateTime | form | DateTime | No | |
| DocumentActionCode | form | DocumentAction | No | |
| DocumentStatusCode | form | DocumentStatus | No | |
| DocumentStructureVersion | form | string | Yes | |
| LastUpdateDateTime | form | DateTime? | No | |
| RevisionNumber | form | long? | No | |
| AvpList | form | List<AvpList> | Yes |
| ADD | |
| CHANGE_BY_REFRESH | |
| DELETE | |
| REJECTED |
| ADDITIONAL_TRANSMISSION | |
| COPY | |
| ORIGINAL |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | Yes | |
| Value | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EntityIdentification | form | string | Yes | |
| ContentOwner | form | Ecom_PartyIdentification | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AdditionalPartyIdentification | form | List<AvpList> | Yes | |
| Gln | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommodityTypeCode | form | Code | Yes | |
| OrderLogisticalDateInformation | form | OrderLogisticalDateInformation | Yes | |
| InventoryLocation | form | TransactionalParty | Yes | |
| ShipFrom | form | TransactionalParty | Yes | |
| ShipTo | form | TransactionalParty | Yes | |
| UltimateConsignee | form | TransactionalParty | Yes | |
| ShipmentTransportationInformation | form | ShipmentTransportationInformation | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | string | Yes | |
| CodeDescription | form | string | Yes | |
| CodeListAgencyCodeListVersion | form | string | Yes | |
| CodeListAgencyName | form | string | Yes | |
| CodeListName | form | string | Yes | |
| CodeListUri | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateRangeDeliveryDateRange | form | DateRange | Yes | |
| DateRangeShipDateRange | form | DateRange | Yes | |
| DateRangeDeliveryDateRangeAtUltimateConsignee | form | DateRange | Yes | |
| RequestedDeliveryDateTime | form | DateTime? | No | |
| RequestedShipDateTime | form | string | Yes | |
| RequestedPickUpDateTime | form | DateTime? | No | |
| RequestedDeliveryDateTimeAtUltimateConsignee | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BeginDate | form | DateTime? | No | |
| BeginTime | form | DateTime? | No | |
| EndDate | form | DateTime? | No | |
| EndTime | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Contact | form | List<Contact> | Yes | |
| Address | form | Address | Yes | |
| CommunicationChannel | form | List<AvpList> | Yes | |
| FinancialInstitutionInformation | form | FinancialInstitutionInformation | Yes | |
| DutyFeeTaxRegistration | form | string | Yes | |
| EntityIdentification | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Gln | form | string | Yes | |
| Name | form | string | Yes | |
| AdditionalPartyIdentification | form | List<AvpList> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactTypeCode | form | string | Yes | |
| PersonName | form | string | Yes | |
| DepartmentName | form | string | Yes | |
| JobTitle | form | string | Yes | |
| Responsibility | form | string | Yes | |
| CommunicationChannel | form | List<CommunicationChannel> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommunicationChannelCode | form | string | Yes | |
| CommunicationChannelName | form | string | Yes | |
| CommunicationValue | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StreetAddressOne | form | string | Yes | |
| StreetAddressTwo | form | string | Yes | |
| StreetAddressThree | form | string | Yes | |
| City | form | string | Yes | |
| PostalCode | form | string | Yes | |
| ProvinceCode | form | string | Yes | |
| CountryCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FinancialInstitutionBranchName | form | string | Yes | |
| FinancialInstitutionName | form | string | Yes | |
| FinancialRoutingNumber | form | FinancialRoutingNumber | Yes | |
| FinancialAccount | form | FinancialAccount | Yes | |
| SwiftCode | form | string | Yes | |
| ExportersCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | string | Yes | |
| NumberTypeCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | string | Yes | |
| NumberTypeCode | form | string | Yes | |
| Name | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Carrier | form | TransactionalParty | Yes | |
| FreightForwarder | form | TransactionalParty | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeCode | form | string | Yes | |
| Gln | form | string | Yes | |
| InternalIdentification | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncotermsCode | form | string | Yes | |
| AlternateDeliveryTermsCode | form | string | Yes | |
| DeliveryInstructions | form | string | Yes | |
| DeliveryCostPayment | form | string | Yes | |
| IsSignatureRequired | form | string | Yes | |
| DeliveryTermsLocation | form | DeliveryTermsLocation | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UnLocationCode | form | string | Yes | |
| Gln | form | string | Yes | |
| AdditionalLocationIdentification | form | List<AvpList> | Yes | |
| SublocationIdentification | form | string | Yes | |
| LocationName | form | string | Yes | |
| LocationSpecificInstructions | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderRelationship | form | string | Yes | |
| DocumentReference | form | DocumentReference | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreationDateTime | form | DateTime? | No | |
| RevisionNumber | form | long? | No | |
| LineItemNumber | form | long? | No | |
| EntityIdentification | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowanceChargeAmount | form | decimal? | No | |
| AllowanceChargePercentage | form | decimal? | No | |
| AllowanceChargeType | form | string | Yes | |
| AllowanceOrChargeType | form | string | Yes | |
| AmountPerUnit | form | decimal? | No | |
| BaseAmount | form | decimal? | No | |
| BaseNumberOfUnits | form | string | Yes | |
| BracketIdentifier | form | string | Yes | |
| EffectiveDateType | form | DateTime? | No | |
| SequenceNumber | form | string | Yes | |
| SettlementType | form | string | Yes | |
| SpecialServiceType | form | string | Yes | |
| AllowanceChargeDescription | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FreeGoodsQuantity | form | Quantity | Yes | |
| ItemPriceBaseQuantity | form | Quantity | Yes | |
| RequestedQuantity | form | Quantity | Yes | |
| LineItemActionCode | form | string | Yes | |
| LineItemNumber | form | long? | No | |
| ListPrice | form | decimal? | No | |
| MonetaryAmountExcludingTaxes | form | decimal? | No | |
| MonetaryAmountIncludingTaxes | form | decimal? | No | |
| NetAmount | form | decimal? | No | |
| NetPrice | form | decimal? | No | |
| Note | form | string | Yes | |
| OrderLineItemInstructionCode | form | string | Yes | |
| ParentLineItemNumber | form | decimal? | No | |
| RecommendedRetailPrice | form | decimal? | No | |
| OrderLineItemPriority | form | string | Yes | |
| AdditionalOrderLineInstruction | form | List<AvpList> | Yes | |
| AllowanceCharge | form | List<AllowanceCharge> | Yes | |
| AdministrativeUnit | form | List<AdministrativeUnit> | Yes | |
| TransactionalTradeItem | form | TransactionalTradeItem | Yes | |
| LeviedDutyFeeTax | form | LeviedDutyFeeTax | Yes | |
| Contract | form | DocumentReference | Yes | |
| PromotionalDeal | form | DocumentReference | Yes | |
| PurchaseConditions | form | DocumentReference | Yes | |
| AvpList | form | List<AvpList> | Yes | |
| OrderLineItemDetail | form | List<OrderLineItemDetail> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | decimal? | No | |
| MeasurementUnitCode | form | string | Yes | |
| CodeListVersion | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Gtin | form | string | Yes | |
| AdditionalTradeItemIdentification | form | List<AvpList> | Yes | |
| TradeItemQuantity | form | decimal? | No | |
| TradeItemDescription | form | string | Yes | |
| ProductVariantIdentifier | form | string | Yes | |
| ItemTypeCode | form | string | Yes | |
| TradeItemDataOwner | form | string | Yes | |
| ButterFatReference | form | string | Yes | |
| TransactionalItemData | form | List<TransactionalItemData> | Yes | |
| Colour | form | List<Colour> | Yes | |
| Size | form | Size | Yes | |
| TradeItemClassification | form | TradeItemClassification | Yes | |
| AvpList | form | List<AvpList> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AvailableForSaleDate | form | DateTime? | No | |
| BatchNumber | form | string | Yes | |
| BestBeforeDate | form | DateTime? | No | |
| CountryOfOrigin | form | string | Yes | |
| ItemExpirationDate | form | DateTime? | No | |
| LotNumber | form | string | Yes | |
| PackagingDate | form | DateTime? | No | |
| ProductionDate | form | DateTime? | No | |
| ProductQualityIndication | form | string | Yes | |
| SellByDate | form | DateTime? | No | |
| SerialNumber | form | List<string> | Yes | |
| ShelfLife | form | string | Yes | |
| TradeItemQuantity | form | long? | No | |
| ItemInContactWithFoodProduct | form | bool? | No | |
| TransactionalItemWeight | form | List<TransactionalItem> | Yes | |
| TransactionalItemVolume | form | List<TransactionalItem> | Yes | |
| SerialNumberRange | form | List<SerialNumberRange> | Yes | |
| TransactionalItemDimensions | form | List<TransactionalItemDimension> | Yes | |
| TransactionalItemLogisticUnitInformation | form | TransactionalItemLogisticUnitInformation | Yes | |
| TransactionalItemDataCarrierAndIdentification | form | TransactionalItemDataCarrierAndIdentification | Yes | |
| TradeItemWaste | form | List<TradeItemWaste> | Yes | |
| TransactionalItemOrganicInformation | form | TransactionalItemOrganicInformation | Yes | |
| AvpList | form | List<AvpList> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MeasurementUnitCode | form | string | Yes | |
| MeasurementType | form | string | Yes | |
| MeasurementValue | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MaximumValue | form | string | Yes | |
| MinimumValue | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MeasurementUnitCode | form | string | Yes | |
| Depth | form | string | Yes | |
| Height | form | string | Yes | |
| Width | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NumberOfLayers | form | long? | No | |
| NumberOfUnitsPerLayer | form | long? | No | |
| NumberOfUnitsPerPallet | form | long? | No | |
| PackagingTerms | form | string | Yes | |
| PackageTypeCode | form | string | Yes | |
| MaximumStackingFactor | form | long? | No | |
| ReturnablePackageTransportCostPayment | form | string | Yes | |
| DimensionsOfLogisticUnit | form | List<TransactionalItemDimension> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Gs1TransactionalItemIdentificationKey | form | string | Yes | |
| DataCarrier | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WasteIdentification | form | string | Yes | |
| TypeOfWaste | form | List<AvpList> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsTradeItemOrganic | form | bool? | No | |
| OrganicCertification | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ColourCode | form | string | Yes | |
| ColourDescription | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DescriptiveSize | form | string | Yes | |
| SizeCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GpcCategoryCode | form | string | Yes | |
| AdditionalTradeItemClassificationCode | form | List<AvpList> | Yes | |
| GpcCategoryName | form | string | Yes | |
| GpcAttribute | form | List<AvpList> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DutyFeeTaxAmount | form | decimal? | No | |
| DutyFeeTaxBasisAmount | form | decimal? | No | |
| DutyFeeTaxDescription | form | string | Yes | |
| DutyFeeTaxPercentage | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestedQuantity | form | Quantity | Yes | |
| OrderLogisticalInformation | form | OrderLogisticalInformation | Yes | |
| AvpList | form | List<AvpList> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | form | Guid | No |
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/order HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
order:
{
header:
{
documentIdentification:
{
identifier: String,
type: String
},
sender:
{
identifier:
{
authority: String,
text: String
},
contactInformation:
[
{
}
]
},
receiver:
{
identifier:
{
authority: String,
text: String
},
contactInformation:
[
{
}
]
}
},
order:
{
documentEffectiveDate: 0001-01-01,
additionalOrderInstruction: String,
isApplicationReceiptAcknowledgementRequired: False,
isOrderFreeOfExciseTaxDuty: False,
note: String,
orderEntryType: String,
orderInstructionCode: String,
orderPriority: String,
orderTypeCode: String,
totalMonetaryAmountExcludingTaxes: 0,
totalMonetaryAmountIncludingTaxes: 0,
totalTaxAmount: 0,
paymentTerms: String,
orderIdentification:
{
entityIdentification: String,
contentOwner:
{
additionalPartyIdentification:
[
{
code: String,
value: String
}
],
gln: String
}
},
orderLogisticalInformation:
{
commodityTypeCode:
{
value: String,
codeDescription: String,
codeListAgencyCodeListVersion: String,
codeListAgencyName: String,
codeListName: String,
codeListUri: String
},
orderLogisticalDateInformation:
{
dateRangeDeliveryDateRange:
{
beginDate: 0001-01-01,
beginTime: 0001-01-01,
endDate: 0001-01-01,
endTime: 0001-01-01
},
dateRangeShipDateRange:
{
beginDate: 0001-01-01,
beginTime: 0001-01-01,
endDate: 0001-01-01,
endTime: 0001-01-01
},
dateRangeDeliveryDateRangeAtUltimateConsignee:
{
beginDate: 0001-01-01,
beginTime: 0001-01-01,
endDate: 0001-01-01,
endTime: 0001-01-01
},
requestedDeliveryDateTime: 0001-01-01,
requestedShipDateTime: String,
requestedPickUpDateTime: 0001-01-01,
requestedDeliveryDateTimeAtUltimateConsignee: 0001-01-01
},
inventoryLocation:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
shipFrom:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
shipTo:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
ultimateConsignee:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
shipmentTransportationInformation:
{
carrier:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
freightForwarder:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
}
}
},
administrativeUnit:
[
{
typeCode: String,
gln: String,
internalIdentification: String
}
],
deliveryTerms:
{
incotermsCode: String,
alternateDeliveryTermsCode: String,
deliveryInstructions: String,
deliveryCostPayment: String,
isSignatureRequired: String,
deliveryTermsLocation:
{
unLocationCode: String,
gln: String,
additionalLocationIdentification:
[
{
code: String,
value: String
}
],
sublocationIdentification: String,
locationName: String,
locationSpecificInstructions: String
}
},
transactionalGenericReference:
[
{
code: String,
value: String
}
],
referencedOrder:
[
{
orderRelationship: String,
documentReference:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
}
}
],
billTo:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
buyer:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
pickupFrom:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
seller:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
ultimateConsignee:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
contract:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
},
quoteNumber:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
},
promotionalDeal:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
},
tradeAgreement:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
},
deliveryDateAccordingToSchedule: 0001-01-01,
latestDeliveryDate: 0001-01-01,
allowanceCharge:
[
{
allowanceChargeAmount: 0,
allowanceChargePercentage: 0,
allowanceChargeType: String,
allowanceOrChargeType: String,
amountPerUnit: 0,
baseAmount: 0,
baseNumberOfUnits: String,
bracketIdentifier: String,
effectiveDateType: 0001-01-01,
sequenceNumber: String,
settlementType: String,
specialServiceType: String,
allowanceChargeDescription: String
}
],
orderLineItem:
[
{
freeGoodsQuantity:
{
value: 0,
measurementUnitCode: String,
codeListVersion: String
},
itemPriceBaseQuantity:
{
value: 0,
measurementUnitCode: String,
codeListVersion: String
},
requestedQuantity:
{
value: 0,
measurementUnitCode: String,
codeListVersion: String
},
lineItemActionCode: String,
lineItemNumber: 0,
listPrice: 0,
monetaryAmountExcludingTaxes: 0,
monetaryAmountIncludingTaxes: 0,
netAmount: 0,
netPrice: 0,
note: String,
orderLineItemInstructionCode: String,
parentLineItemNumber: 0,
recommendedRetailPrice: 0,
orderLineItemPriority: String,
additionalOrderLineInstruction:
[
{
code: String,
value: String
}
],
allowanceCharge:
[
{
allowanceChargeAmount: 0,
allowanceChargePercentage: 0,
allowanceChargeType: String,
allowanceOrChargeType: String,
amountPerUnit: 0,
baseAmount: 0,
baseNumberOfUnits: String,
bracketIdentifier: String,
effectiveDateType: 0001-01-01,
sequenceNumber: String,
settlementType: String,
specialServiceType: String,
allowanceChargeDescription: String
}
],
administrativeUnit:
[
{
typeCode: String,
gln: String,
internalIdentification: String
}
],
transactionalTradeItem:
{
gtin: String,
additionalTradeItemIdentification:
[
{
code: String,
value: String
}
],
tradeItemQuantity: 0,
tradeItemDescription: String,
productVariantIdentifier: String,
itemTypeCode: String,
tradeItemDataOwner: String,
butterFatReference: String,
transactionalItemData:
[
{
availableForSaleDate: 0001-01-01,
batchNumber: String,
bestBeforeDate: 0001-01-01,
countryOfOrigin: String,
itemExpirationDate: 0001-01-01,
lotNumber: String,
packagingDate: 0001-01-01,
productionDate: 0001-01-01,
productQualityIndication: String,
sellByDate: 0001-01-01,
serialNumber:
[
String
],
shelfLife: String,
tradeItemQuantity: 0,
itemInContactWithFoodProduct: False,
transactionalItemWeight:
[
{
measurementUnitCode: String,
measurementType: String,
measurementValue: String
}
],
transactionalItemVolume:
[
{
measurementUnitCode: String,
measurementType: String,
measurementValue: String
}
],
serialNumberRange:
[
{
maximumValue: String,
minimumValue: String
}
],
transactionalItemDimensions:
[
{
measurementUnitCode: String,
depth: String,
height: String,
width: String
}
],
transactionalItemLogisticUnitInformation:
{
numberOfLayers: 0,
numberOfUnitsPerLayer: 0,
numberOfUnitsPerPallet: 0,
packagingTerms: String,
packageTypeCode: String,
maximumStackingFactor: 0,
returnablePackageTransportCostPayment: String,
dimensionsOfLogisticUnit:
[
{
measurementUnitCode: String,
depth: String,
height: String,
width: String
}
]
},
transactionalItemDataCarrierAndIdentification:
{
gs1TransactionalItemIdentificationKey: String,
dataCarrier: String
},
tradeItemWaste:
[
{
wasteIdentification: String,
typeOfWaste:
[
{
code: String,
value: String
}
]
}
],
transactionalItemOrganicInformation:
{
isTradeItemOrganic: False,
organicCertification: String
},
avpList:
[
{
code: String,
value: String
}
]
}
],
colour:
[
{
colourCode: String,
colourDescription: String
}
],
size:
{
descriptiveSize: String,
sizeCode: String
},
tradeItemClassification:
{
gpcCategoryCode: String,
additionalTradeItemClassificationCode:
[
{
code: String,
value: String
}
],
gpcCategoryName: String,
gpcAttribute:
[
{
code: String,
value: String
}
]
},
avpList:
[
{
code: String,
value: String
}
]
},
leviedDutyFeeTax:
{
dutyFeeTaxAmount: 0,
dutyFeeTaxBasisAmount: 0,
dutyFeeTaxDescription: String,
dutyFeeTaxPercentage: 0
},
contract:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
},
promotionalDeal:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
},
purchaseConditions:
{
creationDateTime: 0001-01-01,
revisionNumber: 0,
lineItemNumber: 0,
entityIdentification: String
},
avpList:
[
{
code: String,
value: String
}
],
orderLineItemDetail:
[
{
requestedQuantity:
{
value: 0,
measurementUnitCode: String,
codeListVersion: String
},
orderLogisticalInformation:
{
commodityTypeCode:
{
value: String,
codeDescription: String,
codeListAgencyCodeListVersion: String,
codeListAgencyName: String,
codeListName: String,
codeListUri: String
},
orderLogisticalDateInformation:
{
dateRangeDeliveryDateRange:
{
beginDate: 0001-01-01,
beginTime: 0001-01-01,
endDate: 0001-01-01,
endTime: 0001-01-01
},
dateRangeShipDateRange:
{
beginDate: 0001-01-01,
beginTime: 0001-01-01,
endDate: 0001-01-01,
endTime: 0001-01-01
},
dateRangeDeliveryDateRangeAtUltimateConsignee:
{
beginDate: 0001-01-01,
beginTime: 0001-01-01,
endDate: 0001-01-01,
endTime: 0001-01-01
},
requestedDeliveryDateTime: 0001-01-01,
requestedShipDateTime: String,
requestedPickUpDateTime: 0001-01-01,
requestedDeliveryDateTimeAtUltimateConsignee: 0001-01-01
},
inventoryLocation:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
shipFrom:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
shipTo:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
ultimateConsignee:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
shipmentTransportationInformation:
{
carrier:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
freightForwarder:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
}
}
},
avpList:
[
{
code: String,
value: String
}
]
}
]
}
],
currencyCode: String,
documentActionCode: ADD,
documentStatusCode: ADDITIONAL_TRANSMISSION,
documentStructureVersion: String,
lastUpdateDateTime: 0001-01-01,
revisionNumber: 0,
avpList:
[
{
code: String,
value: String
}
]
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}