¶ INTRODUCTION
- In this module, WWA can accept a Booking request in XML format
- In return, a Booking confirmation containing a WWA Booking number will be sent.
- File Naming Convention when the following files are submitted to WWA:
- a. Initial Booking Confirmation XML: BOOKINGCONFIRMATION.YYYYMMDD.hhmmss.milisecond_initial.xml
- b. Final Booking Confirmation XML:: BOOKINGCONFIRMATION.YYYYMMDD.hhmmss.milisecond_final.xml
¶ Functional flow of Booking Request/Conformation Module
¶ Booking Request XML Schema
WWA Booking Request Version 1.0.9
WWA Booking Request Version _1.1.0_Final
WWA Booking Request Version 2.0.1
¶ Booking Request XML Sample File
Sample Booking Request XML (version 1.0.9)
Sample Booking Request XML (version 1.1.0)
Sample Booking Request XML (version 2.0.1)
¶ Description of Booking Request XML (version 2.0.1)
| Field | Content | Length | Input |
|---|---|---|---|
| Envelope | |||
| SenderID | Sender ID to identify sender. | 11 | Required |
| ReceiverID | Receiver ID to identify receiver. | 100 | Required |
| Password | Password as assigned by WWA. | 100 | Required |
| Type | Message type, ‘BookingRequest’. | 50 | Required |
| Version | Message version | 8 | Required |
| EnvelopeID | Unique ID for message to have a follow up option. | 40 | Required |
| Message Body | |||
| ApplicationType | This is determining the booking request source type 'WE'(WWA EDI), 'WO'(WWA Online), 'WS'(Web Service). Customer does not need to send this segment | 2 | Required |
| BookingType | This is determining the booking type 'F'(Full Container Load), 'L'(Less than Container Load), 'A'(Air Booking). | 1 | Required |
| BookingDate | Date of request New, Update, Cancellation (YYYY-MM-DD). | 10 | Required |
| LastSentDate | Date of last request New, Update, Cancellation (YYYY-MM-DD). | 10 | Required |
| RequestType | This is the type of request, whether 'N' (New), 'U' (Updated) or 'C' (Cancellation). | 1 | Required |
| BookingNumber | This is the unique booking number which is generated by the WWA member. | 20 | Optional |
| WWAShipmentReference | This is the unique WWA Reference Number which is generated by WWA. | 30 | Optional |
| CustomerControlCode | This is the unique reference for the customer. I.e customer office location. | 20 | Required |
| BookingOffice | Customer Booking office location. Valid UN CODE. | 5 | Optional |
| FPI | FPI data,"P" = Prepaid "C" = Collect . | 1 | Optional |
| CommunicationReference | This is internal reference for the customer. | 30 | Optional |
| CustomerReference | Customer Reference number. | 20 | Required |
| ShipperReference | The Shipper Reference. | 30 | Optional |
| ForwarderReference | The forwarder reference. | 30 | Optional |
| ConsigneeReference | The consignee reference. | 30 | Optional |
| AddressDetails | Details for the Address | ||
| AddressID | Identifier for the address type. | 2 | Optional |
| "SH" = Shipper Address | |||
| "CN" = Consignee Address | |||
| "N1" = Notify Party 1 Address | |||
| "N2" = Notify Party 2 Address | |||
| "FW" = Forwarder address | |||
| AddressLine1 | Address line one. | 40 | Optional |
| AddressLine2 | Address line two. | 40 | Optional |
| AddressLine3 | Address line three. | 40 | Optional |
| AddressLine4 | Address line four. | 40 | Optional |
| AddressLine5 | Address line five. | 40 | Optional |
| AddressLine6 | Address line six. | 40 | Optional |
| Phone | Telephone number. | 20 | Optional |
| Fax | Fax Details. | 20 | Optional |
| Email address. | 50 | Optional | |
| CustomerContact | Contact details of the customer. | 50 | Optional |
| CustomerPhone | Phone number of the customer. | 20 | Optional |
| CustomerEmail | E-Mail address of the customer. | 50 | Optional |
| BUCustomerEmail | This is the customer's Business Unit's E-Mail address. | 50 | Optional |
| OnHold | It indicates whether the booking is on hold 'Y'(Yes) or 'N'(No). | 1 | Required |
| HVC | This indicates if cargo is High Value Cargo , 'Y' (Yes) or 'N' (No). | 1 | Required |
| BondedCargo | This indicates if cargo is Bonded Cargo 'Y' (Yes) or 'N' (No). | 1 | Required |
| CFSOrigin | The Container Freight Station(CFS) origin for the shipment. UN Location Code. | 5 | Required |
| PortOfLoading | The Port of Loading for the shipment. UN Location Code. | 5 | Required |
| CFSDestination | The Container Freight Station(CFS) destination of the shipment. UN Location Code. | 5 | Required |
| PortOfDischarge | The Port of Discharge for the shipment. UN Location Code. | 5 | Optional |
| FinalDestination | The final destination of the shipment. UN Location Code. | 5 | Optional |
| FinalDestinationPlace | The final destination place city name. | 35 | Optional |
| FinalDestinationType | Final Destination type. | 10 | Optional |
| FinalDestinationCountry | Country for the final destination. | 20 | Optional |
| OncarriageFlag | This indicates if booking have an Oncarriage 'Y' (Yes) or 'N' (No). | 1 | Required |
| OncarriagePlace | Oncarriage Place 'Free Text'. | 20 | Optional |
| AmsFlag | AMS flag, if calling a US port 'Y' (Yes) or 'N' (No). | 1 | Required |
| AesFlag | AES flag, if US origin bookings value > $2500 = 'Y', otherwise 'N'. | 1 | Required |
| ColoadCommodity | Coload/commodity, US origin bookings, values ‘C’ or ‘F’, otherwise ‘N’. | 1 | Optional |
| Remarks | Comments, if any. | 2048 | Optional |
| PickupFlag | This indicates if a pick up is required for the shipment 'Y' (Yes) or 'N' (No). | 1 | Required |
| PickupDetails | Details for the Pick Up | ||
| CombinedCompanyNameandAddress | Name and address of the company. Number of lines is 5 where maximum character is 35 per line. | Optional | |
| PickupReference | Reference details for the pickup. | 254 | Optional |
| CompanyName | Name of the company. | 64 | Optional |
| Address | Address of the company. | 192 | Optional |
| City | City of the company. | 64 | Optional |
| PostalCode | Postal Code for the company. | 64 | Optional |
| StateProvince | State and Province for the company. | 64 | Optional |
| Country | Country. | 64 | Optional |
| Contact | Concerned person name. | 64 | Optional |
| Phone | Phone Number. | 64 | Optional |
| Email Address. | 50 | Optional | |
| Date | Date for the pickup (YYYY-MM-DD). | 10 | Required |
| Time | Time for the pickup (HH:MM). | 5 | Required |
| Remarks | Comments if any. | 2048 | Optional |
| SailingDetails | Details for the Sailing | ||
| VesselVoyageID | The unique reference number for Vessel(ship) and the voyage number. | 40 | Optional |
| VesselName | Name of the ship. | 50 | Required |
| IMONumber | Lloyd’s register number. | 7 | Optional |
| Voyage | Reference number assigned by the carrier of the vessel. | 10 | Required |
| ETDCFS | Estimated Time of Departure at Container Freight Station(CFS) (YYYY-MM-DD). | 10 | Required |
| ETACFS | Estimated Time of Arrival at Container Freight Station(CFS) (YYYY-MM-DD). | 10 | Required |
| ETSOrigin | Estimated Time of Sailing at origin (YYYY-MM-DD). | 10 | Required |
| ETSPoL | Estimated Time of Sailing at Port of Loading (YYYY-MM-DD). | 10 | Required |
| CargoDetails | Details for the Cargo. | ||
| Pieces | Number of pieces. | 3 | Required |
| ShippingMarks | Shipping marks. | 2048 | Required |
| Packaging | Type of package i.e boxes, pallets, cartons etc. | 20 | Required |
| Commodity | Type of commodity. | 254 | Required |
| HSCode | Harmonized code. | 14-Aug | Optional |
| Weight | Line item weight based on UOM i.e kg or lbs. | 12 | Required |
| Volume | Line item volume based on UOM i.e cbm or cbf. | 12 | Required |
| UOM | Unit of Measurement 'E' (English) or 'M' (Metric). | 1 | Required |
| HazardousFlag | This indicates if the shipment contains any hazardous material 'Y' (Yes) or 'N' (No) If 'y' Details below. | 1 | Required |
| HazardousDetails | Details for the Hazardous Component | ||
| HazardousClass | The Hazardous Class. | 4 | Optional |
| Flashpoint | The maximum point at which the hazard can be reached. | 10 | Optional |
| FlashpointFlag | This indicates if 'F' Fahrenheit or 'C' Centigrade. | 1 | Optional |
| ShippingName | Hazardous shipping name. | 150 | Optional |
| UNNumber | Hazardous UN number. | 10 | Optional |
| PackingGroup | Hazardous packing group. The data must be provided only in Roman Numerals eg. I, II, III | 3 | Optional |
| Pieces | Number of pieces pertaining to hazard. | 6 | Optional |
| Packaging | Type of packaging. | 10 | Optional |
| Weight | Line item weight based on UOM i.e kg or lbs. | 8 | Optional |
| ShipmentRelatedData | Shipment Dimensions Data. (Expected to receive in centimeter) | Optional | |
| Quantity | Cargo Quantity. | 3 | Optional |
| Length | Cargo Length. | 6 | Optional |
| Width | Cargo Width. | 6 | Optional |
| Height | Cargo Height. | 6 | Optional |
| OverDimensionFlag | Flag if cargo is over dimension 'Y' (Yes) or 'N' (No). | 3 | Required |
| OverHeightFlag | Flag if height is more than 230 cm / 90 inches 'Y' (Yes) or 'N' (No). | 3 | Required |
| OverLengthFlag | Flag if length is more than 590 cm / 232 inches 'Y' (Yes) or 'N' (No). | 3 | Required |
| OverWeightFlag | Flag if weight is more than 3000 kg / 6613 lbs 'Y' (Yes) or 'N' (No). | 3 | Required |
| OverWidthFlag | Flag if width is more than 230 cm / 90 inches 'Y' (Yes) or 'N' (No). | 3 | Required |
| TransportTemperatureRangeFrom | The temperature at which cargo is to be kept while it is under transport. | 6 | Optional |
| TransportTemperatureRangeTo | The temperature at which cargo is to be kept while it is under transport. | 6 | Optional |
| CustomsRelatedData | Customs related information. | 255 | Optional |
| CTCCode | CTC Code. See Details | 3 | Optional |
| CTCDescription | CTC Description. | 255 | Optional |
| CustomsContact | Customs Contact. | 64 | Optional |
| CustomsPhone | Customs Phone. | 64 | Optional |
| CustomerControlCode | This is the unique reference for the customer. I.e customer office location. | 40 | Required |
| TSRType | DD=Door to Door, DP=Door to Port, PD=Port to Door, PP=Port to Port | 2 | Optional |
| ShipmentType | 1=Consolidation, 2=Master, 3=Direct, 4=House | 2 | Optional |
| MemberSCAC | Member SCAC code | 5 | Optional |
| CustomerSCAC | Customer SCAC code | 5 | Optional |
| CustomerAlias | Customer Alias | 15 | Optional |
| GovtReferences | If customer wants to provide any specific references against the parties. Example: Type=ACID, Reference=123456 | ||
| Type | Type of Reference. Example: Type=ACID | 20 | Optional |
| Reference | Reference Number. Example: Reference=123456 | 50 | Optional |
| OnwardGateway | Onward Gateway flag | 1 | Optional |
| TransportationDetails | Details for the Transportation | ||
| CarriageType | Pre=PreCarriage, On=OnCarriage | 20 | Optional |
| Mode | 1=Road, 2=Rail | 20 | Optional |
| PortOfLoading | Port of loading | 5 | Optional |
| EstimatedDeparture | Estimated departure details | optional | |
| Date | Estimated date of departure (YYYY-MM-DD). | Optional | |
| Time | Estimated time of departure (HH:MM). | Optional | |
| TimeZone | Time Zone. | 4 | Optional |
| PortOfDischarge | Port of Discharge | 5 | Optional |
| EstimatedArrival | Estimated Arrival details | optional | |
| Date | Estimated date of arrival (YYYY-MM-DD). | Optional | |
| Time | Estimated time of arrival (HH:MM). | Optional | |
| TimeZone | Time Zone. | 4 | Optional |
| WarehouseCutoffDate | Warehouse Cutoff Date (YYYY:MM:DD). | Optional | |
| WarehouseCutoffTime | Warehouse Cutoff Time (HH:MM). | Optional | |
| ETDCFSTime | Estimated Time of Departure at Container Freight Station(CFS) (HH:MM:SS). | Optional | |
| ETACFSTime | Estimated Time of Arrival at Container Freight Station(CFS) (HH:MM:SS). | Optional | |
| ETSOriginTime | Estimated Time of Sailing at origin (HH:MM:SS). | Optional | |
| ETSPoLTime | Estimated Time of Sailing at Port of Loading (HH:MM:SS). | Optional | |
| TransshipmentSailingDetailsFlag | Transshipment Sailing Details Flag, "Y"=Yes; "N"=No | 1 | Required |
| TransshipmentSailingDetails | If Transshipment Sailing Details Flag is "Y" then TransshipmentSailingDetails are mandatory! | ||
| TSPortIdentifier | Transshipment Port Identifier | 3 | Optional |
| TSMode | Vessel, Rail, Road. | 50 | Optional |
| TSVesselName | Transshipment Vessel Name | 50 | Optional |
| TSVesselIMO | Transshipment Vessel IMO number | 8 | Optional |
| TSVesselvoyage | Transshipment Vessel Voyage | 50 | Optional |
| TSContainerNumber | Transshipment Container Number | 12 | Optional |
| TSSealNumber | Transshipment Seal Number | 50 | Optional |
| TSPort | UN code | 5 | Optional |
| TSPortName | If UN code is not available, Name should be printed. | 80 | Optional |
| EtaTSPort | Estimated date of Arrival at transshipment port (YYYY-MM-DD). | Optional | |
| EtdTSPort | Estimated date of departure at transshipment port (YYYY-MM-DD). | Optional | |
| EtaTSPortTime | Estimated time of Arrival at transshipment port (HH:MM:SS). | Optional | |
| EtdTSPortTime | Estimated time of departure at transshipment port (HH:MM:SS). | Optional | |
| Stackable | "Y"=Yes; "N"=No | 1 | Optional |
| Marinepollutant | "Y"=Yes; "N"=No | 1 | Optional |
| LimitedQuntity | "Y"=Yes; "N"=No | 1 | Optional |
| ExceptedQuntity | "Y"=Yes; "N"=No | 1 | Optional |
| EMSNumber | EMS Number | 13 | Optional |
| NetWeight | Net Weight | Optional | |
| EmergencyContact | Emergency contact name. | 100 | Optional |
| EmergencyPhoneNo | Emergency contact number. | 100 | Optional |
| InnerPieceCount | Inner Piece Count detail. | 6 | Optional |
| InnerPackingGroup | Roman Numerals only (I, II, III). | 3 | Optional |
| HazComponentInducer | Harzardous Component Inducer detail. | 110 | Optional |
| HazDocument | Customer can provide any specific Haz document URL with booking request. | Optional | |
| HazDocumentType | Hazardous document type. | 20 | Optional |
| DocURL | Hazardous document URL. | 256 | Optional |
| ImageData | Image Date. | Optional | |
| MeasurementUnit | "IN"=Inch"; FT"=Feet; "CM"=centimetres; "M"=meters. | Optional | |
| ChargeDetails | If ChargeDetails are available, then details are mandatory. | Optional | |
| ChargeCode | Charge Code. | 4 | Optional |
| ChargeName | Name of the Charge. | 50 | Optional |
| Rate | Charge Rate. | 8 | Optional |
| Currency | Charge Rate Currency. | 3 | Optional |
| Basis | Charge Basis. | 2 | Optional |
| ESTCharge | EST Charge. | 10 | Optional |
| MarkupRate | Markup Rate. | 4 | Optional |
| TotalCost | Total Cost. | 10 | Optional |
| Remarks | Comments. | 50 | Optional |
¶ Booking Confirmation XML Schema
WWA Booking Confirmation Version 1.0.8
WWA Booking Confirmation Version 1.0.9
WWA Booking Confirmation Version 2.0.1
¶ Booking Confirmation XML Sample Files
Sample Booking Confirmation XML (Initial)(Version 1.0.8)
Sample Booking Confirmation XML (Final)(Version 1.0.8)
Sample Booking Confirmation XML (Version 1.0.9)
¶ Description of Booking Confirmation XML (version 2.0.1)
| Field | Content | Length | Input |
|---|---|---|---|
| HouseBillOfLadingNumber | HouseBillOfLadingNumber can be provided by members if available (which would not change in subsequent stages) | 30 | Optional |
| TSRType | DD=Door to Door, DP=Door to Port, PD=Port to Door, PP=Port to Port | 2 | Optional |
| ShipmentType | DD=1=Consolidation, 2=Master, 3=Direct, 4=House | 2 | Optional |
| MemberSCAC | 5 | Optional | |
| CarrierSCAC | as reqeusted by customer, members can provide actual carrier SCAC in this segnment | 10 | Optional |
| CustomerAlias | Unique Alias set for every customer | 15 | Required |
| CustomerBookingBranch | UN code. | 5 | String |
| CustomerEmail | E-Mail address of the customer | 50 | Optional |
| VesselVoyageID | The unique reference number for Vessel(ship) and the voyage number | 40 | Optional |
| CustomerControlCode | This is the unique reference for the customer. I.e customer office location | 40 | Optional |
| SailingDetails | Details for the Sailing | ||
| WarehouseCutoffDate | Warehouse Cutoff Date (YYYY:MM:DD) | Optional | |
| WarehouseCutoffTime | Warehouse Cutoff Time (HH:MM) | Optional | |
| ETDCFSTime | Estimated Time of Departure at Container Freight Station(CFS) (HH:MM:SS) | Optional | |
| ETSOriginTime | Estimated Time of Sailing at origin (HH:MM:SS) | Optional | |
| ETSPoLTime | Estimated Time of Sailing at Port of Loading (HH:MM:SS) | Optional | |
| TransportationDetails | Details for the Transportation | ||
| CarriageType | Pre=PreCarriage"; "On=OnCarriage | 20 | Optional |
| Mode | 1=Road"; "2=Rail | 20 | Optional |
| PortOfLoading | The Port of Loading for the shipment. UN Location Code. | 5 | Optional |
| EstimatedDeparture | Estimated departure details | 4 | Optional |
| Date | Estimated date of departure (YYYY-MM-DD) | 4 | Optional |
| Time | Estimated time of departure (HH:MM) | 4 | Optional |
| TimeZone | Time Zone | 4 | Optional |
| PortOfDischarge | The Port of Discharge for the shipment. UN Location Code | 5 | Optional |
| EstimatedArrival | Estimated Arrival details | 4 | Optional |
| Date | Estimated date of arrival (YYYY-MM-DD) | 4 | Optional |
| Time | Estimated time of arrival (HH:MM) | 4 | Optional |
| TimeZone | Time Zone | 4 | Optional |
| TransshipmentSailingDetailsFlag | "Y"=Yes; "N"=No | 1 | Required |
| TransshipmentSailingDetails | If TransshipmentSailingDetailsFlag="Y" then TransshipmentSailingDetails are mandatory! | 3 | Optional |
| TSPortIdentifier | Transshipment Port Identifier | 3 | Optional |
| TSMode | Vessel, RAIL, ROAD | 50 | Optional |
| TSVesselName | Transshipment Vessel Name | 50 | Optional |
| TSVesselIMO | Transshipment Vessel IMO number | 8 | Optional |
| TSVesselvoyage | Transshipment Vessel Voyage | 50 | Optional |
| TSContainerNumber | Container number | 12 | Optional |
| TSSealNumber | Transshipment Seal Number | 50 | Optional |
| TSPort | UN code. | 5 | Optional |
| TSPortName | If UN code is not available, Name should be printed. | 80 | Optional |
| EtaTSPort | Estimated Time of Arrival at Transshipment Port | 80 | Optional |
| EtdTSPort | Estimated Time of Departure at Transshipment Port | Optional | |
| EtaTSPortTime | Estimated Time of Arrival at Transshipment Port | Optional | |
| CargoDetails | Required | ||
| Pieces | Number of pieces | 3 | Required |
| ShippingMarks | Shipping marks | 2048 | Required |
| Packaging | Type of packaging. | 20 | Required |
| Commodity | Type of commodity | 254 | Required |
| HSCode | Harmonized code | 14 | Required |
| Weight | Line item weight based on UOM i.e kg or lbs | Required | |
| Volume | Line item volume based on UOM i.e cbm or cbf | Required | |
| UOM | "E"=English; "M"=Metric | 1 | Required |
| HazardousFlag | "Y"=Yes; "N"=No | 1 | Required |
| HazardousDetails | If HazardousFlag="Y" then HazadousDetails is mandatory! | ||
| HazardousClass | The Hazardous Class | 4 | optional |
| Flashpoint | The maximum point at which the hazard can be reached | 10 | Optional |
| FlashpointFlag | "F" = Fahrenheit "C" = Centigrade | 1 | optional |
| ShippingName | Hazardous shipping name | 150 | optional |
| UNNumber | Hazardous UN number | 10 | optional |
| PackingGroup | Roman Numerals only (I, II, III) | 3 | optional |
| Pieces | Number of pieces pertaining to hazard | 6 | Optional |
| Packaging | Type of packaging | 10 | Optional |
| Weight | Line item weight based on UOM i.e kg or lbs. | 8 | Optional |
| Stackable | "Y"=Yes; "N"=No | 1 | Optional |
| Marinepollutant | "Y"=Yes; "N"=No | 1 | Optional |
| LimitedQuntity | "Y"=Yes; "N"=No | 1 | Optional |
| ExceptedQuntity | "Y"=Yes; "N"=No | 1 | Optional |
| EMSNumber | EMS Number | 13 | Optional |
| NetWeight | Net Weight | Optional | |
| EmergencyContact | The Emergency Contact Name | 100 | Optional |
| EmergencyPhoneNo | The Emergency contact's Phone Number | 100 | Optional |
| InnerPieceCount | Number of Inner Piece | 6 | Optional |
| InnerPackingGroup | Roman Numerals only (I, II, III) | 3 | Optional |
| HazComponentInducer | Harzardous Component Inducer detail | 110 | Optional |
| HazDocument | Customer can provide any specific Haz document URL with booking request | ||
| HazDocumentType | Hazardous document type | 20 | |
| DocURL | Hazardous document URL | 256 | |
| ImageData | Image Data | 256 | Optional |
| ShipmentRelatedData | Shipment Dimensions Data (Expected to receive in centimeter) | ||
| Quantity | Cargo Quantity | 3 | |
| Length | Cargo Length | 6 | Optional |
| Width | Cargo Width | 6 | Optional |
| Height | Cargo Height | 6 | Optional |
| OverDimensionFlag | Flag if cargo is over dimension 'Y' (Yes) or 'N' (No) | 3 | Required |
| OverHeightFlag | Not to exceed 230 cm/90 inches | 3 | Required |
| OverLengthFlag | Not to exceed 590 cm/232 inches | 3 | Required |
| OverWeightFlag | Not to exceed 3000 kg/6613 pounds | 3 | Required |
| OverWidthFlag | Not to exceed 230 cm/90 inches | 3 | Required |
| Address | shipper, Consignee, forwarder customer name/deatils | ||
| AddressID | "SH" = Shipper "CN" = Consignee "N1" = Notify 1 "N2" = Notify 2 "FW" = Forwarder "AG" = Agent Details | 2 | Optional |
| AddressLine1 | 40 | Optional | |
| AddressLine2 | 40 | Optional | |
| AddressLine3 | 40 | Optional | |
| AddressLine4 | 40 | Optional | |
| AddressLine5 | 40 | Optional | |
| AddressLine6 | 40 | Optional | |
| Phone | Phone Number | 20 | Optional |
| Fax | Fax Number | 20 | Optional |
| Email Address | 50 | Optional | |
| GovtReferences | If member wants to provide any specific references against the parties. | ||
| Type | Example: Type=ACID | 20 | |
| Reference | EX: Reference=123456 | 50 |