DX STF Client API

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
				}
			]
		}
	}
}