Field | Content | Length | Input |
---|---|---|---|
Envelope |
|||
SenderID | Sender ID to identify sender. | 50 | Required |
ReceiverID | Receiver ID to identify receiver. | 100 | Required |
Password | Password as assigned by WWA. | 100 | Required |
Type | Message type, ‘FILEBL_XML_AGENT’. | 40 | Required |
Version | Message version | 8 | Required |
EnvelopeID | Unique ID for message to have a follow up option. | 40 | Required |
Message Body |
|||
FileNumber | File number for manifest. Number used to identify manifest of shipment. | 25 | Required |
TypeOfMove | 'F' for FCL or 'L' for LCL. | 1 | Required |
Coload | 'Y for yes or 'N' for no. | 1 | Required |
Mode | 'O' for Ocean or 'A' for Airfreight. | 1 | Required |
MasterBLNumber | Unique Master b/l number from carrier. | 30 | Required |
SenderEmail | File BL Sender E-mail ID. | 50 | Required |
MasterBarcodeNumber | File BL Sender E-mail ID. | 40 | Optional |
SailingDetails | Details for the sailing | ||
ImoNumber | Lloyds Vessel code for vessel. | 7 | Optional |
SCAC | SCAC code for the ocean carrier. | 4 | Required |
VesselName | VesselName. | 50 | Required |
Voyage | The voyage number. | 10 | Required |
EtdOrigin | ETD (Estimated Time of Departure) at Load port (YYYY-MM-DD). | 10 | Required |
EtsLoadPort | ETS (Estimated Time of Sailing) from Load Port (YYYY-MM-DD). | 10 | Required |
EtaTransshipmentPort1 | ETA Estimated Time of Arrival from Load Port (YYYY-MM-DD). | 10 | Optional |
EtaTransshipmentPort2 | ETA Estimated Time of Arrival from Load Port (YYYY-MM-DD). | 10 | Optional |
EtaTransshipmentPort3 | ETA Estimated Time of Arrival from Load Port (YYYY-MM-DD). | 10 | Optional |
EtaDischarge | ETA (Estimated Time of Arrival) at Discharge Port (YYYY-MM-DD). | 10 | Required |
EtaFinalDestination | ETA (Estimated Time of Arrival) at Final Destination (YYYY-MM-DD). | 10 | Required |
RoutingDetails | Details for the Routing | ||
OriginCode | The Origin of the Sshipment. UN Location Code. | 5 | Required |
OriginName | The Origin Name of the Shipment. | 50 | Required |
LoadCode | The Port of Loading of the Shipment. UN Location Code. | 5 | Required |
LoadName | The Port of Loading Name of the Shipment. | 50 | Required |
TransshipmentPort1 | UN Location code for TransshipmentPort1 | 5 | Optional |
TransshipmentPort1Name | City Name for TransshipmentPort1 | 50 | Optional |
TransshipmentPort2 | UN Location code for TransshipmentPort2 | 5 | Optional |
TransshipmentPort2Name | City Name for TransshipmentPort2 | 50 | Optional |
TransshipmentPort3 | UN Location code for TransshipmentPort3 | 5 | Optional |
TransshipmentPort3Name | City Name for TransshipmentPort3 | 50 | Optional |
DischargeCode | The Discharge Port of the Shipment. UN Location Code. | 5 | Required |
DischargeName | The Discharge Port Name of the Shipment. | 50 | Required |
DestinationCode | The Destination Port of the Shipment. UN Location Code. | 5 | Required |
DestinationName | The Destination Port Name of the Shipment. | 50 | Required |
ContainerDetails | Details of the Containers | ||
ContainerNumber | The Container Number. | 11 | Required |
SealNumber | The seal Number. | 20 | Required |
ContainerSize | The size of container. | 3 | Required |
ContainerType | The type of Container. | 45 | Required |
Weight | The Weight of the Container. | 10 | Required |
Volume | The Volume of the Container. | 10 | Required |
UOM | Unit of Measure. 'E' for imperial or 'M' for Metric. | 1 | Required |
BillOfLadingDetails | Details of the Bill of Lading | ||
BillOfLadingNumber | The Bill of Lading Number. | 20 | Required |
CustomerAlias | Customer Alias | 25 | Optional |
Type | The type of bill. 'L' for Line B/L or 'H' for House B/L. | 1 | Required |
ReleaseType | Defining Type of Release. 'E' for Express or 'O' for Originals Required. | 1 | Required |
FPI | Freight Payment Indicator "P" = Prepaid "C" = Collect | 1 | Required |
NumberOfOriginals | The Number of Original Bills of Lading. | 2 | Required |
Terms | The Terms of the Shipment e.g FOB, EXW etc. | 10 | Optional |
BLReleasePoint | City Name where the Bill of Lading was isseud. | 20 | Required |
HBLDocumentURL | HBL PDF Document Link. | Optional | |
DocumentationDetails | Documentation Details | ||
DocumentType | Code and Description have been provided on below link See Details | 7 | Optional |
ContentType | Type of image i.e application/pdf, application/html, image/png, image/gif, image/jpeg | 999 | Optional |
ImageURL | URL of the pdf, HTML, png, gif or jpeg documentation file | 999 | Optional |
ReferenceDetails | Details of the References | ||
ShipperReference | The Shipper's Reference. | 30 | Optional |
ConsigneeReference | The Consignee's Reference. | 30 | Optional |
NotifyReference | The Notify's Reference. | 30 | Optional |
ForwarderReference | The Forwarder's Reference. | 30 | Optional |
CustomsReference | The Forwarder's Reference. | 30 | Optional |
AddressDetails | The Address Details | ||
AddressID | "SH" = Shipper Exporter Details. | 2 | Required |
"CN" = Consignee Details "NP" = Notify Party Details "AG" = Agent Details "FW" = Forwarder Details | |||
Name | Name of SH/CN/NP/AG/FW | 50 | Required |
Address | Address of SH/CN/NP/AG/FW | 50 | Required |
CityName | City Name of SH/CN/NP/AG/FW | 50 | Required |
StateProvince | State/Province of SH/CN/NP/AG/FW | 50 | Optional |
PostalCode | Postal code of SH/CN/NP/AG/FW | 50 | Optional |
CountryName | Country Name of code of SH/CN/NP/AG/FW | 50 | Required |
GovtReferenceNumber | Two new fields (GovtRefType and GovtRefValue) added to capture and transmit the Govt Reference Number under File BL. Here are some examples of same | 50 | Optional |
<GovtRefType>CIN</GovtRefType> <GovtRefValue>+U60230MH1998PTC112960</GovtRefValue> | |||
<GovtRefType>CVR-NUMBER</GovtRefType> <GovtRefValue>+25584996</GovtRefValue> | |||
<GovtRefType>USCI</GovtRefType> <GovtRefValue>+CN91310000717869985P</GovtRefValue> | |||
<GovtRefType>VAT NUMBER</GovtRefType> <GovtRefValue>+243512587116</GovtRefValue> | |||
<GovtRefType>EUROPEAN VAT NUMBER</GovtRefType> <GovtRefValue>+FR1959205130400240</GovtRefValue> | |||
<GovtRefType>CNPJ</GovtRefType> | |||
<GovtRefValue>58975632/4565-01</GovtRefValue> | |||
RoutingDetails | Details for the Routing | ||
OriginCode | The Origin of the Sshipment. UN Location Code. | 5 | Required |
OriginName | The Origin Name of the Shipment. | 50 | Required |
EtdOrigin | ETD (Estimated Time of Departure) from Origin (YYYY-MM-DD). | 10 | Required |
LoadCode | The Port of Loading of the Shipment. UN Location Code. | 5 | Required |
LoadName | The Port of Loading Name of the Shipment. | 50 | Required |
EtsLoadPort | ETS (Estimated Time of Sailing) from Load Port (YYYY-MM-DD). | 10 | Required |
TransshipmentPort1 | UN Location code for TransshipmentPort1 | 5 | Optional |
TransshipmentPort1Name | City Name for TransshipmentPort1 | 50 | Optional |
TransshipmentPort2 | UN Location code for TransshipmentPort2 | 5 | Optional |
TransshipmentPort2Name | City Name for TransshipmentPort2 | 50 | Optional |
TransshipmentPort3 | UN Location code for TransshipmentPort3 | 5 | Optional |
TransshipmentPort3Name | City Name for TransshipmentPort3 | 50 | Optional |
DischargeCode | The Discharge Port of the Shipment. UN Location Code. | 5 | Required |
DischargeName | The Discharge Port Name of the Shipment. | 50 | Required |
EtaDischarge | Estimated time of Arrival at Discharge. | 10 | Required |
DestinationCode | The Destination Port of the Shipment. UN Location Code. | 5 | Required |
DestinationName | The Destination Port Name of the Shipment. | 50 | Required |
EtaDestination | Estimated time of Arrival at Destination. | 10 | Required |
Container Details at HBL Level | Details of the Booking | ||
ContainerNumber | Container Number. | 11 | Required |
BookingDetails | Details of the Booking | 5 | Optional |
BookingStation | Office where the booking is made. UN Location Code. | 5 | Optional |
BookingNumber | The Booking Number. | 20 | Optional |
WWAShipmentReference | WWA Reference assigned to Shipment. | 25 | Required |
LotNo | The Lot Number. | 20 | Optional |
CargoDetails | The Cargo Details. | ||
Pieces | The Number of Pieces for the Shipment | 6 | Required |
BarcodeNumber | The Number of Pieces for the Shipment | 6 | Optional |
Packaging | The Packaging of the Shipment. | 20 | Required |
Commodity | The Commodity Description of the Shipment. | 85 | Required |
HSCode | The HS Code of the Shipment. | 14 | Required |
NCM | Used for Brazil's Mercosul Common Nomeclature. | 12 | Optional |
Weight | The Weight of the Shipment. | 10 | Required |
Volume | The Volume of the Shipment. | 10 | Required |
UOM | Unit of Measure. 'E' for imperial or 'M' for Metric. | 1 | Required |
Marks | The Marks of the Shipment. | 85 | Required |
CargoImageURL | Cargo Images URL. | Optional | |
HazardousFlag | Flag if Hazardous cargo. 'Y' for Yes and 'N' for No. | 1 | Required |
HazardousDetails | The Hazardous Details. | ||
HazardousClass | The Hazardous Class of the Shipment | 3 | Required |
Flashpoint | The flashpoint of the Shipment. | 10 | Optional |
FlashpointFlag | Flag for Flashpoint. 'F' for Fahrenheit and 'c' for Celsius. | 1 | Optional |
HazardousContent | The Hazardous of the Shipment. | 40 | Optional |
ShippingName | The proper Shipping name of the of the Hazardous Shipment. | 40 | Required |
UNNumber | The UN Number of the Hazardous cargo. | 10 | Required |
PackingGroup | "Class I" = GreatDanger "Class II" = MediumDanger "Class III" = MinorDanger | 3 | Optional |
PackageCount | Package Count | 8 | Optional |
PackageType | Packing Type | 20 | Optional |
NetWeight | Weight of the hazardous shipment | 10 | Optional |
EmergencyPhoneNumber | Emergency Phone Number | 15 | Optional |
HazCargoImageURL | Cargo Images URL. | Optional | |
GeneralBLDetails | General Bill of Lading Details. | ||
Marks | Marks of the shipment. | 85 | Optional |
Description | Description of the shipment. | 85 | Optional |
TaxID | Tax ID. | 85 | Optional |
ChargeDetails | The Charge Details of the Shipment. | ||
ChargeCode | Type of Charge code OFR,SEC etc. | 5 | Optional |
ChargeName | Name of the charge e.g. Ocean Freight etc. | 50 | Optional |
ChargeDescription | Description of the Charge for the Shipment. | 100 | Required |
PrepaidCollect | 'P' for Prepaid or 'C' for Collect. | 1 | Required |
Rate | The Rate of the Shipment. | 25 | Required |
Basis | The Basis of the Rate i.e LS, WM etc. See Details | 7 | Required |
ForeignAmount | The Amount in Named Currency. | 7 | Required |
ExchangeRate | The Excahnge Rate. | 7 | Required |
LocalAmount | The Amount When Converted by the Exchange Rate. | 7 | Required |
Currency | The Currency of the Amountt. | 7 | Required |
PCName | The Name of Collect/Prepaid Payor for the Shipment. | 40 | Required |
CommentDetails | Additional Comment Details of the Shipment. | ||
Remarks | Additional Remarks of the Shipment. | 50 | Required |
ReceiverID
FileNumber
TypeOfMove
MasterBLNumber
ContainerDetails
ContainerNumber
BillOfLadingNumber
HazardousFlag
Hazardous Details – If Hazardous flag is Y then we need to ensure that we receive Hazardous details.
Also, we are validating data as per schema, where data is required. so wherever data is optional, we do not validate it.