ShipmentBookingFile (outbound)
In order to exchange Booking data, SupplyX can offer XML data according to this specification.
Interface Description: Shipment Booking File
This interface defines the structure of a Shipment Booking File in XML format. The file is intended for the exchange of shipment booking data between systems. The schema supports multiple bookings and related entities per file.
Root Element:
ShipmentBookingFile
:the root element containing all shipment booking data.
Header (0..unbounded)
->RunDateTime (string, optional): The date and time when the file was generated or processed.
ShipmentBooking (0..unbounded)
BookingNumber (string, optional): The unique identifier for the booking.
Mode (string, optional): The transport mode (e.g., sea, air).
Status (string, optional): The current status of the booking.
PlaceOfReceipt (0..99999)
->LocationCode (string, optional): Code of the place of receipt.
->LocationName (string, optional): Name of the place of receipt.
->CountryCode (string, optional): Country code of the place of receipt.
PortOfArrival (0..99999)
->LocationCode (string, optional): Code of the port of arrival.
->LocationName (string, optional): Name of the port of arrival.
PlaceOfDelivery (0..99999)
->LocationCode (string, optional): Code of the place of delivery.
->LocationName (string, optional): Name of the place of delivery.
Customer (0..99999)
->CustomerID (string, optional): Customer identifier.
->CustomerName (string, optional): Customer name.
Consignee (0..99999)
->ConsigneeID (string, optional): Consignee identifier.
->ConsigneeName (string, optional): Consignee name.
->ConsigneeAddress (string, optional): Consignee address.
->ConsigneeAreaCode (string, optional): Consignee area code.
->ConsigneeCity (string, optional): Consignee city.
->ConsigneeCountry (string, optional): Consignee country.
Consignor (0..99999)
->ConsignorID (string, optional): Consignor identifier.
->ConsignorName (string, optional): Consignor name.
->ConsignorAddress (string, optional): Consignor address.
->ConsignorCity (string, optional): Consignor city.
->ConsignorAreaCode (string, optional): Consignor area code.
->ConsignorCountry (string, optional): Consignor country.
->ConsignorPhoneNumber (string, optional): Consignor phone number.
Factory (0..99999)
->FactoryID (string, optional): Factory identifier.
->FactoryName (string, optional): Factory name.
->FactoryAddress (string, optional): Factory address.
->FactoryCity (string, optional): Factory city.
->FactoryAreaCode (string, optional): Factory area code.
->FactoryCountry (string, optional): Factory country.
LoadType (string, optional): Type of load.
BookingDate (string, optional): Date of booking.
CargoReadyDate (string, optional): Date when cargo is ready (optional).
Incoterm (string, optional): Incoterm of the shipment.
FreightPayment (string, optional): Freight payment information (optional).
WoodPackingMaterial (string, optional): Wood packing material information (optional).
EquipmentRequests (0..99999)
->EquipmentRequest (0..99999)
->->EquipmentType (string, optional): Type of equipment requested.
->->Amount (string, optional): Amount of equipment requested.
ShipmentProducts (0..unbounded)
->ShipmentProduct (0..unbounded)
->->OrderNumber (string, optional): Order number.
->->Product (string, optional): Product identifier or name.
->->OrderPosition (string, optional): Order position.
->->BLItemDescription (string, optional): Bill of Lading item description.
->->Description (string, optional): General description.
->->Quantity (string, optional): Quantity of product.
->->PackType (string, optional): Type of packaging.
->->Cartons (string, optional): Number of cartons.
->->Volume (string, optional): Volume of the shipment.
->->GrossWeight (string, optional): Gross weight of the shipment.
->->HtsNumber (string, optional): Harmonized Tariff Schedule number.\
General Notes:
All fields are optional unless otherwise specified. Elements with maxOccurs greater than 1 can appear multiple times. String data types are used for all fields. The interface is extensible for future requirements. If you need a more detailed description for a specific section or element, please contact us!
Updated 18 days ago
