Bl/Shipping Instructions XML Schema Definition:
WWA Bl instructions version 1.1.0.xsd
WWA BL instructions version 1.1.1.xsd
<?xml version="1.0" encoding="UTF-8"?>
<OBLInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.wwalliance.com/wiki/images/8/8a/WWA_Bl_instructions_version_1.1.1.xsd">
<OBLInstructionEnvelope>
<SenderID>edi_test_prod</SenderID>
<ReceiverID>wwalliance</ReceiverID>
<Password>test</Password>
<Type>BL_Instructions_XML_Customer</Type>
<Version>1.1.1</Version>
<EnvelopeID>691</EnvelopeID>
</OBLInstructionEnvelope>
<OBLInstructionDetails>
<ApplicationType>WE</ApplicationType>
<BookingNumber>2546786</BookingNumber>
<CustomerControlCode>USNYC01</CustomerControlCode>
<CommunicationReference>NYCS14814879</CommunicationReference>
<CustomerReference>6310999920401200</CustomerReference>
<ShipperReference></ShipperReference>
<ForwarderReference></ForwarderReference>
<ConsigneeReference></ConsigneeReference>
<CustomerContact>Eric Dsouza</CustomerContact>
<CustomerPhone>2014135673</CustomerPhone>
<CustomerEmail>edsouza@shipco.com</CustomerEmail>
<BLRemarks>Test BL uploaded on WWA Wiki</BLRemarks>
<BLRemarks>uploaded on</BLRemarks>
<BLRemarks>WWA Wiki</BLRemarks>
<Instruction>
<TransportType>1</TransportType>
<OBLType>2</OBLType>
<OBLNumber></OBLNumber>
<AESNumber></AESNumber>
<FPI>P</FPI>
<DocumentationDetails>
<DocumentationDetailsType>1</DocumentationDetailsType>
<NumberOfDocuments>1</NumberOfDocuments>
<DocumentsRated>Y</DocumentsRated>
</DocumentationDetails>
<DisbursementCurrency></DisbursementCurrency>
<DisbursementAmount></DisbursementAmount>
<PlaceofIssueCode>USNYC</PlaceofIssueCode>
<PlaceofIssueName>NEW YORK, NY</PlaceofIssueName>
<BookingOffice>USNYC</BookingOffice>
<DateofIssue>2015-10-01</DateofIssue>
</Instruction>
<Address>
<AddressID>FW</AddressID>
<AddressLine1>KUEHNE + NAGEL, INC. FMC1162F</AddressLine1>
<AddressLine2>10 EXCHANGE PLACE CHB4455</AddressLine2>
<AddressLine3>19TH FLOOR</AddressLine3>
<AddressLine4>JERSEY CITY, NJ 07302 USA</AddressLine4>
<AddressLine5>AS AGENT OF BLUE ANCHOR LINE</AddressLine5>
<AddressLine6>AS AGENT OF BLUE ANCHOR LINE</AddressLine6>
<Phone>234567</Phone>
<Fax></Fax>
<Email></Email>
</Address>
<Address>
<AddressID>SH</AddressID>
<AddressLine1>KUEHNE + NAGEL, INC. FMC1162F</AddressLine1>
<AddressLine2>10 EXCHANGE PLACE CHB4455</AddressLine2>
<AddressLine3>19TH FLOOR</AddressLine3>
<AddressLine4>JERSEY CITY, NJ 07302 USA</AddressLine4>
<AddressLine5>AS AGENT OF BLUE ANCHOR LINE</AddressLine5>
<AddressLine6>AS AGENT OF BLUE ANCHOR LINE</AddressLine6>
<Phone>234567</Phone>
<Fax></Fax>
<Email></Email>
</Address>
<Address>
<AddressID>CN</AddressID>
<AddressLine1>KUEHNE + NAGEL (AG & CO) KG</AddressLine1>
<AddressLine2>GROSSER GRASBROOK 11-13</AddressLine2>
<AddressLine3>D 20457 HAMBURG</AddressLine3>
<AddressLine4>GERMANY, EORI 2020939</AddressLine4>
<AddressLine5>AS AGENT OF BLUE ANCHOR LINE</AddressLine5>
<AddressLine6>AS AGENT OF BLUE ANCHOR LINE</AddressLine6>
<Phone>234567</Phone>
<Fax></Fax>
<Email></Email>
</Address>
<Address>
<AddressID>N1</AddressID>
<AddressLine1>KUEHNE + NAGEL (AG & CO) KG</AddressLine1>
<AddressLine2>GROSSER GRASBROOK 11-13</AddressLine2>
<AddressLine3>D 20457 HAMBURG</AddressLine3>
<AddressLine4>GERMANY, EORI 2020939</AddressLine4>
<AddressLine5>AS AGENT OF BLUE ANCHOR LINE</AddressLine5>
<AddressLine6>AS AGENT OF BLUE ANCHOR LINE</AddressLine6>
<Phone>234567</Phone>
<Fax></Fax>
<Email></Email>
</Address>
<Routing>
<VesselVoyageID>TEST123</VesselVoyageID>
<VesselName>COMMANDER</VesselName>
<ETD>2015-10-02</ETD>
<ETA>2015-10-25</ETA>
<Voyage>123</Voyage>
<OriginOfGoods></OriginOfGoods>
<PrecarriageBy></PrecarriageBy>
<PlaceofReceiptCode>USNYC</PlaceofReceiptCode>
<PlaceofReceiptName>New York, NY</PlaceofReceiptName>
<CFSOriginCode>USNYC</CFSOriginCode>
<CFSOriginName>New York, NY</CFSOriginName>
<PortofLoadingCode>USNYC</PortofLoadingCode>
<PortofLoadingName>New York, NY</PortofLoadingName>
<PortofTransshipmentCode></PortofTransshipmentCode>
<PortofTransshipmentName></PortofTransshipmentName>
<PortofDischargeCode>DEHAM</PortofDischargeCode>
<PortofDischargeName>Hamburg, Germany</PortofDischargeName>
<CFSDestinationCode>DEHAM</CFSDestinationCode>
<CFSDestinationName>Hamburg, Germany</CFSDestinationName>
<PlaceofDeliveryCode>DEHAM</PlaceofDeliveryCode>
<PlaceofDeliveryName>Street No.10, Hamburg city</PlaceofDeliveryName>
</Routing>
<CarrierSeal></CarrierSeal>
<CustomsSeal></CustomsSeal>
<QuarantineAgencySeal></QuarantineAgencySeal>
<ShipperSeal></ShipperSeal>
<TerminalOperatorSeal></TerminalOperatorSeal>
<CargoDescription>
<CargoID>0001</CargoID>
<Level>1</Level>
<PackageCount>000004</PackageCount>
<PackageType>PLT</PackageType>
<HSCode>510510</HSCode>
<HSCode>510610</HSCode>
<UOM>M</UOM>
<Weight>00106000</Weight>
<Volume>00007245</Volume>
<Commodity>Wool, carded</Commodity>
<Commodity>55 CARTON(S)</Commodity>
<Commodity>HS-CODE:510510</Commodity>
<Commodity>Carded wool yarn</Commodity>
<Commodity>55 CARTON(S)</Commodity>
<Commodity>HS-CODE:510610</Commodity>
<Marks>TEST BL</Marks>
<Marks>TEST</Marks>
<Marks>BL on WWA wiki</Marks>
<Fumigation>N</Fumigation>
<HazardousFlag>N</HazardousFlag>
</CargoDescription>
<CargoDescription>
<CargoID>0001</CargoID>
<Level>1</Level>
<PackageCount>000004</PackageCount>
<PackageType>PLT</PackageType>
<HSCode>640411</HSCode>
<HSCode>640620</HSCode>
<UOM>M</UOM>
<Weight>00106000</Weight>
<Volume>00007245</Volume>
<Commodity>sports footwear, incl. tennis shoes, basketball shoes, gym shoes</Commodity>
<Commodity>55 CARTON(S)</Commodity>
<Commodity>HS-CODE:640411</Commodity>
<Commodity>Outer soles and heels, of rubber or plastics</Commodity>
<Commodity>55 CARTON(S)</Commodity>
<Commodity>HS-CODE:640620</Commodity>
<Marks>TEST</Marks>
<Marks>TEST BL</Marks>
<Marks>BL on WWA wiki</Marks>
<Fumigation>N</Fumigation>
<HazardousFlag>N</HazardousFlag>
</CargoDescription>
<CargoDescription>
<CargoID>0001</CargoID>
<Level>1</Level>
<PackageCount>000004</PackageCount>
<PackageType>PLT</PackageType>
<HSCode>720230</HSCode>
<HSCode>722300</HSCode>
<UOM>M</UOM>
<Weight>00106000</Weight>
<Volume>00007245</Volume>
<Commodity>Ferro-silico-manganese</Commodity>
<Commodity>55 CARTON(S)</Commodity>
<Commodity>HS-CODE:720230</Commodity>
<Commodity>Wire of stainless steel, in coils</Commodity>
<Commodity>55 CARTON(S)</Commodity>
<Commodity>HS-CODE:722300</Commodity>
<Marks>12345671234567123</Marks>
<Marks>TEST</Marks>
<Marks>BL on WWA wiki</Marks>
<Fumigation>N</Fumigation>
<HazardousFlag>N</HazardousFlag>
</CargoDescription>
</OBLInstructionDetails>
</OBLInstruction>
Field | Content | Length | Input |
---|---|---|---|
Envelope | |||
SenderID | Sender ID to identify sender. | 50 | Required |
ReceiverID | Receiver ID to identify receiver. Should be wwalliance by default | 100 | Required |
Password | Password as assigned by WWA. | 100 | Required |
Type | Message type, ‘WWA_BL_Instruction_XML’. | 50 | Required |
Version | Message version | 8 | Required |
EnvelopeID | Unique ID for message to have a follow up option. | 40 | Required |
Message Body | |||
OBLInstructionDetails | Details for BL Instructions | ||
ApplicationType | This is determining the booking request source type 'WE'(WWA EDI), 'WO'(WWA Online), 'WS'(Web Service). | 2 | Optional |
BookingNumber | WWA Booking Number sent with the Booking Confirmation | 20 | Required |
CustomerControlCode | WWA customer control reference. | 20 | Required |
CommunicationReference | Customer internal reference. | 15 | Optional |
CustomerReference | Customer reference. | 20 | Optional |
ShipperReference | The Shipper Reference. | 30 | Optional |
ForwarderReference | The forwarder reference. | 30 | Optional |
ConsigneeReference | The consignee reference. | 30 | Optional |
CustomerContact | Customer Contact Name. | 50 | Optional |
CustomerPhone | Customer Contact Phone. | 20 | Optional |
CustomerEmail | Customer Contact eMail address. | 50 | Optional |
BLRemarks | Remarks should be printed on BL. | 30 | Optional |
InstructionDetails | Details for the instruction | ||
TransportType | Identifier for the type of transport. | 1 | Optional |
OBLType | Identifier for the bill of lading type. | 1 | Optional |
OBLNumber | Information field for preadvised OBL numbers. | 20 | Optional |
AESNumber | Information field for AES Number. | 15 | Optional |
FPI | Freight Payment Indicator (Prepaid/Collect). | 1 | Required |
DocumentationDetails | Details for the Documentation | ||
DocumentationDetailsType | Type of Documentation '1'=Originals '2'=non-negotiables. | 1 | Required |
NumberOfDocuments | Number of needed originals / non-negotiables. | 2 | Required |
DocumentRated | Rated Documents Yes (Y) or No (N). | 2 | Required |
DisbursementCurrency | Currency for Disbursements. | 3 | Optional |
DisbursememtAmount | Amount of Disbursements. | 8 | Optional |
PlaceofIssueCode | Place of issue per UN Location Code. | 5 | Optional |
PlaceofIssueName | Place of issue name, if no code is provided. | 30 | Optional |
BookingOffice | Customer Booking office location. Valid UN CODE. | 5 | Optional |
DateofIssue | Date of issue -> should be printed on BL. Date format must be YYYY-MM-DD | 10 | Optional |
AddressDetails | Details for the Address | ||
AddressID | Identifier for the address type. | 2 | Required |
"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 |
GovtReferenceNumber | Government Reference Number | 50 | Optional |
Phone | Telephone number. | 20 | Optional |
Fax | Fax Details. | 20 | Optional |
Email address. | 50 | Optional | |
RoutingDetails | Details for the Routing | ||
VesselVoyageID | Unique Identifier received with XML schedule. | 20 | Optional |
VesselName | Actual Name of the Vessel. | 50 | Optional |
ETD | Estimated Time of Departure (YYYY-MM-DD). | 10 | Date |
ETA | Estimated Time of Arrival (YYYY-MM-DD). | 10 | Optional |
Voyage | Voyage number received with XML schedule. | 10 | Optional |
OriginOfGoods | UN Location Code or specific location for Point and Country of Origin of Goods. (eg: USNYC or East Hanover, NJ). | 30 | Optional |
PrecarriageBy | Precarriage effected by … (Vessel, Truck, …). | 20 | Optional |
PlaceofReceiptCode | Place of receipt per UN Location Code. | 5 | Optional |
PlaceofReceiptName | Place of receipt name if code is not provided. | 30 | Optional |
CFSOriginCode | CFS Origin per UN Location Code. | 5 | Optional |
CFSOriginName | CFS Origin name if no code is provided. | 30 | Optional |
PortofLoadingCode | Port of Loading per UN Location Code. | 5 | Optional |
PortofLoadingName | Port of Loading if code is not provided. | 30 | Optional |
PortofTransshipmentCode | Port of Transshipment per UN Location Code. | 5 | Optional |
PortofTransshipmentName | Port of Transshipment if no code is provided. | 30 | Optional |
PortofDischargeCode | Port of Discharge per UN Location Code. | 5 | Optional |
PortofDischargeName | Port of Discharge if no code is provided. | 30 | Optional |
CFSDestinationCode | CFS Destination per UN Location Code. | 5 | Optional |
CFSDestinationName | CFS Destination if no code is provided. | 30 | Optional |
PlaceofDeliveryCode | Place of Delivery per UN Location Code. | 5 | Optional |
PlaceofDeliveryName | Place of Delivery if no code is provided. | 30 | Optional |
CarrierSeal | 15 | Optional | |
CustomsSeal | 15 | Optional | |
QuarantineAgencySeal | 15 | Optional | |
ShipperSeal | 15 | Optional | |
TerminalOperatorSeal | 15 | Optional | |
CargoDescription | Details for the Cargo Description | ||
CargoID | ID for cargo grouping. | 4 | Optional |
Level | Package level per cargo grouping. | 4 | Optional |
PackageCount | Piece count. | 8 | Optional |
PackageType | Kind of package. | 20 | Optional |
HSCode | Harmonized code. | 10 | Optional |
UOM | Line item unit of measure, either ‘E’ (English) or ‘M’ (Metric). | 1 | Required |
Weight | Line item weight,based on UOM,in kg or lbs. | 8 | Required |
Volume | Line item volume,based on UOM,in cbm or cbf. | 6 | Required |
Commodity | Commodity description. | 50 | Required |
Marks | Shipping Marks. | 20 | Optional |
Fumigation | Fumigation done to cargo ('Y'=Yes, 'N'=No) | 1 | Optional |
HazardousFlag | Flag if the cargo contains hazmat ('Y'=Yes, 'N'=No). | 1 | Required |
HazardousDetails | Details for the Hazardous | ||
HazardousClass | International IMDG Class. | 4 | Optional |
ShippingName | Comments about the Hazardous goods. For e.g.ENVIRONMENTALLY HAZARDOUS SUBSTANCE, LIQUID, N.O.S. | 150 | Optional |
UNNumber | International UN Number. | 4 | Optional |
TechnicalDescription | Technical description of IMDG cargo. | 180 | Optional |
Characteristic | Characteristic description of IMDG cargo. | 70 | Optional |
EMSNumber | IMDG cargo EMS number. | 7 | Optional |
PackingGroup | IMDG cargo packing group: | 3 | Optional |
Class I:GreatDanger | |||
Class II:MediumDanger | |||
Class III:MinorDanger | |||
MarinePolutionFlag | MarinePolutionFlag Y/N. | 1 | Optional |
PrimaryRisk | Sub risk label. | 4 | Optional |
Flashpoint | Flashpoint temperature. | 10 | Optional |
FlashpointFlag | Flag centigrade or fahrenheit (“C” or “F”). | 1 | Required |
DocumentationDetails | |||
ImageLink | HTTP URL to the pdf, HTML, png, gif or jpeg documentation file. | 999 | IF <ImageLink> is specified, <Image> is Optional |
Image | Base64binary encode pdf, html, png, gif, jpeg. | 999 | IF <Image> is specified, <ImageLink> is Optional |
ContentType | Type of image I.e application/pdf, application/html, image/png, image/gif, image/jpeg | 999 | Required |
ShipperReference | The Shipper Reference. | 30 | Optional |
ForwarderReference | The forwarder reference. | 30 | Optional |
ConsigneeReference | The consignee reference. | 30 | Optional |
DocumentationDetailsType | Type of Documentation '1'=Originals '2'=non-negotiables. | 1 | Required |
NumberOfDocuments | Number of needed originals / non-negotiables. | 2 | Required |
DocumentRated | Rated Documents Yes (Y) or No (N). | 2 | Required |
BookingOffice | Customer Booking office location. Valid UN CODE. | 5 | Optional |
AddressLine6 | Address line six. | 40 | Optional |
Phone | Telephone number. | 20 | Optional |
Fax | Fax Details. | 20 | Optional |
Email address. | 50 | Optional | |
GovtReferenceNumber | Government Reference Number | 50 | Optional |
CarrierSeal | Carrier Seal | 15 | Optional |
CustomsSeal | Customs Seal | 15 | Optional |
QuarantineAgencySeal | Quarantine Agency Seal | 15 | Optional |
ShipperSeal | Shipper Seal | 15 | Optional |
TerminalOperatorSeal | Terminal Operator Seal | 15 | Optional |
Fumigation | Fumigation done to cargo ('Y'=Yes, 'N'=No) | 1 | Optional |
ShippingName | Comments about the Hazardous goods. For e.g.ENVIRONMENTALLY HAZARDOUS SUBSTANCE, LIQUID, N.O.S. | 150 | Optional |
<Image>+<ContentType> OR <ImageLink>+<ContentType>.
<DocumentationDetails>
<Image>
<ContentType>
<DocumentationDetails>
OR
<DocumentationDetails>
<ImageLink>
<ContentType>
<DocumentationDetails>
(Example: <ContentType>application/pdf</ContentType> )
Option | Tag Used | Data Included in Tag Used | Text in <ContentType> |
---|---|---|---|
1 | <ImageLink> | valid url to pdf | application/pdf |
2 | <Image> | base64binary encoded pdf | application/pdf |
3 | <ImageLink> | valid url to html | application/html |
4 | <Image> | base64binary encoded html | application/html |
5 | <ImageLink> | valid url to png | image/png |
6 | <Image> | base64binary encoded png | image/png |
7 | <ImageLink> | valid url to gif | image/gif |
8 | <Image> | base64binary encoded gif | image/gif |
9 | <ImageLink> | valid url to jpeg | image/jpeg |
10 | <Image> | base64binary encoded jpeg | image/jpeg |
Upon receiving the BL from any party, an acknowledgment is sent to the sender via an ACK XML file, indicating whether the BL has been accepted or rejected.
Please refer to the sample ACK XML file provided below for reference.
Accepted Case:
<Acknowledgement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.wwalliance.com/wiki/images/f/fc/Acknowledgement_version_1.0.0.xsd">
<AcknowledgementEnvelope>
<SenderID>wwalliance</SenderID>
<ReceiverID>edi_test_prod</ReceiverID>
<Password>test</Password>
<Type>Acknowledgement_XML</Type>
<Version>1.0</Version>
<EnvelopeID>836141</EnvelopeID>
</AcknowledgementEnvelope>
<AcknowledgementDetails>
<CustomerReference>C2500771803</CustomerReference>
<CommunicationReference>WWA0000827457</CommunicationReference>
<AcknowledgementType>BOL</AcknowledgementType>
<BookingNumber>82196038</BookingNumber>
<AcknowledgementStatus>A</AcknowledgementStatus>
<Remarks>Accepted</Remarks>
</AcknowledgementDetails>
</Acknowledgement>
Rejected Case:
<Acknowledgement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.wwalliance.com/wiki/images/f/fc/Acknowledgement_version_1.0.0.xsd">
<AcknowledgementEnvelope>
<SenderID>wwalliance</SenderID>
<ReceiverID>edi_test_prod</ReceiverID>
<Password>test</Password>
<Type>Acknowledgement_XML</Type>
<Version>1.0</Version>
<EnvelopeID>835478</EnvelopeID>
</AcknowledgementEnvelope>
<AcknowledgementDetails>
<CustomerReference>C2501260458</CustomerReference>
<CommunicationReference>WWA0000835478</CommunicationReference>
<AcknowledgementType>BOL</AcknowledgementType>
<BookingNumber>S.B.NO.2283612</BookingNumber>
<AcknowledgementStatus>R</AcknowledgementStatus>
<Remarks>BookingNumber is Invalid</Remarks>
</AcknowledgementDetails>
</Acknowledgement>