¶ Shipment Status Module Overview
- In this module, WWA Members can send and receive shipment status files
- Members are required to provide below details correctly in milestones XML files while sending shipment status:
- Status Code - Valid WWA status code
- Status Location - Valid UNCODE (5 character)
- Routing Details
- Shipment numbers w.r.t status codes.
- Listed below are Mandatory/Optional shipment numbers based on different status codes:
¶ Export statuses
| Status Code | Status Description | Mandatory Numbers | Optional Numbers | Status Type |
|---|---|---|---|---|
| 1 | Booking Confirmed (Direct Loading) | BookingNumber | Optional | |
| 2 | Truck Booking Confirmed | BookingNumber | Optional | |
| 8 | Rail Booking Confirmed | BookingNumber | Optional | |
| 10 | Booking Confirmed | BookingNumber | Mandatory | |
| 11 | Booking Cancelled | BookingNumber | Optional | |
| 12 | Booking Updated | BookingNumber | Optional | |
| 13 | Booking Rejected | BookingNumber | Optional | |
| 14 | Returned to Shipper | BookingNumber | Optional | |
| 19 | Cargo Picked up by Trucker | BookingNumber | Optional | |
| 20 | Received In Warehouse | BookingNumber, LotNumber | Mandatory | |
| 21 | Received In Warehouse with Discrepancy | BookingNumber, LotNumber | Optional | |
| 22 | Received In Warehouse With Delay | BookingNumber | Optional | |
| 23 | Lot Terminated | BookingNumber | Optional | |
| 30 | Container Loaded And Sealed | LotNumber | BookingNumber | Mandatory |
| 31 | Customers Own Container Loaded And Sealed | LotNumber | BookingNumber | Optional |
| 32 | Coload Loaded and Sealed | LotNumber | BookingNumber | Optional |
| 33 | Truck Loaded and Sealed | LotNumber | BookingNumber | Optional |
| 35 | Container Delay/Roll | LotNumber | BookingNumber | Optional |
| 40 | Confirmed On Board | LotNumber | BookingNumber | Mandatory |
| 49 | Preliminary Bill Of Lading Printed | LotNumber | BookingNumber | Optional |
| 50 | Bill of Lading Printed | BookingNumber, HouseBillOfLadingNumber | LotNumber | Mandatory |
| 51 | Arrived at Transshipment port To see Transshipment schema |
BookingNumber, HouseBillOfLadingNumber | LotNumber | Optional |
| 52 | Container Loaded and Sealed Transshipment port To see Transshipment schema |
BookingNumber, HouseBillOfLadingNumber | LotNumber | Optional |
| 53 | Confirmed on Board Transshipment port To see Transshipment schema |
BookingNumber, HouseBillOfLadingNumber | LotNumber | Optional |
¶ Import statuses
| Status Code | Status Description | Mandatory Numbers | Optional Numbers | Status Type |
|---|---|---|---|---|
| 59 | Preliminary Arrival Notice Issued | ArrivalNoticeNumber, HouseBillOfLadingNumber | Optional | |
| 60 | Arrival Notice Issued | ArrivalNoticeNumber, HouseBillOfLadingNumber | Mandatory | |
| 61 | Arrived at deconsolidation CFS | ArrivalNoticeNumber | Mandatory | |
| 62 | Container Devanned at deconsolidation CFS | ArrivalNoticeNumber | Mandatory | |
| 63 | Available at deconsolidation CFS | ArrivalNoticeNumber | Optional | |
| 64 | Arrived at Inland CFS | ArrivalNoticeNumber | Optional | |
| 68 | Arrived at Destination CFS | ArrivalNoticeNumber | Optional | |
| 70 | Freight Available | ArrivalNoticeNumber | HouseBillOfLadingNumber, BookingNumber, LotNumber | Mandatory |
| 71 | Delivery/Release Order Issued | ArrivalNoticeNumber | Optional | |
| 80 | Freight Picked up | ArrivalNoticeNumber | HouseBillOfLadingNumber, BookingNumber, LotNumber | Mandatory |
| 81 | Freight Delivered | ArrivalNoticeNumber | HouseBillOfLadingNumber, BookingNumber, LotNumber | Mandatory |
- In order not to process any files that are being uploaded/downloaded, there is a clear need to indicate when files are ready to be processed.
- It is needed to create a 0 byte file with the original filename but with the suffix of '.ok'.
- For example, if your filename would be 'SHIPMENT_STATUS_20031021_211847_432.gz' the control file would be called 'SHIPMENT_STATUS_20031021_211847_432.gz.ok'.
- Our watchdog programs are written only to process files with an .ok suffix and it is important that you treat the files the same.
¶ Shipment Status, XML formatted. (WWA Member)
wwa_shipment_status_version_1.0.0.xsd
wwa_shipment_status_version_1.1.0.xsd
wwa_shipment_status_version_1.1.1.xsd
wwa_shipment_status_version_v2.0.1.xsd
¶ Sample Shipment Status XML (version 1.0.0)
<ShipmentStatus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNameSpaceSchemaLocation="http://
isnet.shipco.com/Documents/STi-Online%20(external)/STi-EI/Documentation/Schemas/Shipment_Status_version_1.0.0.xsd">
<Envelope>
<SenderID>edi_shipco_prod</SenderID>
<ReceiverID>wwalliance</ReceiverID>
<Password>password</Password>
<Type>Shipment_Status_XML_1.0.0</Type>
<Version>1.0.0</Version>
<EnvelopeID>1315378998879</EnvelopeID>
</Envelope>
<ShipmentStatusDetails>
<ShipperReference></ShipperReference>
<ForwarderReference></ForwarderReference>
<ConsigneeReference></ConsigneeReference>
<CommunicationReference>500431</CommunicationReference>
<PickupReference></PickupReference>
<BookingNumber>100131</BookingNumber>
<HouseBillOfLadingNumber></HouseBillOfLadingNumber>
<CarrierBookingNumber></CarrierBookingNumber>
<CarrierBillofladingNumber></CarrierBillofladingNumber>
<FileNumber></FileNumber>
<ContainerNumber></ContainerNumber>
<ContainerSize>123</ContainerSize>
<ContainerType></ContainerType>
<ContainerCode></ContainerCode>
<SealNumber></SealNumber>
<OceanVessel>MAERSK PECEM</OceanVessel>
<Voyage>123TEST</Voyage>
<IMONumber>56756756</IMONumber>
<CustomerAlias>WWAONLINE</CustomerAlias>
<StatusCode>10</StatusCode>
<StatusLocationCode>BEANR</StatusLocationCode>
<StatusLocationName>Antwerp</StatusLocationName>
<RoutingDetails>
<ReceivingWarehouse>BEANR</ReceivingWarehouse>
<CutoffReceivingWarehouse>2011-09-14</CutoffReceivingWarehouse>
<PlaceOfReceipt>BEANR</PlaceOfReceipt>
<ETSPlaceOfReceipt>2011-09-14</ETSPlaceOfReceipt>
<PortOfLoading></PortOfLoading>
<ETSPortOfLoading></ETSPortOfLoading>
<PortOfDischarge></PortOfDischarge>
<ETAPortOfDischarge>2011-09-22</ETAPortOfDischarge>
<PlaceOfDelivery>USNYC</PlaceOfDelivery>
<ETAPlaceOfDelivery>2011-09-22</ETAPlaceOfDelivery>
</RoutingDetails>
<StatusDateTimeDetails>
<Date>2011-09-07</Date>
<Time>06:10:14</Time>
<TimeZone>GMT</TimeZone>
</StatusDateTimeDetails>
<DocumentationDetails>
<ImageLink></ImageLink>
<Image></Image>
<ContentType>application/pdf</ContentType>
</DocumentationDetails>
</ShipmentStatusDetails>
</ShipmentStatus>
¶ Sample Shipment Status XML (version 1.1.0)
<?xml version="1.0" encoding="UTF-8"?>
<ShipmentStatus xsi:noNamespaceSchemaLocation="http://www.wwalliance.com/wiki/images/d/d4/WWA_Shipment_Status_version_1.1.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Envelope>
<SenderID>edi_test_prod</SenderID>
<ReceiverID>wwalliance</ReceiverID>
<Password>test</Password>
<Type>Shipment_Status_XML_1.1.0</Type>
<Version>1.1.0</Version>
<EnvelopeID>15213272</EnvelopeID>
</Envelope>
<ShipmentStatusDetails>
<ApplicationType>WE</ApplicationType>
<TypeOfMove>L</TypeOfMove>
<ShipperReference>TEST52840801600</ShipperReference>
<ForwarderReference></ForwarderReference>
<ConsigneeReference></ConsigneeReference>
<CommunicationReference>TEST15213272001</CommunicationReference>
<PickupReference></PickupReference>
<BookingNumber>TESTCMB560491</BookingNumber>
<WWAShipmentReference>2983864363</WWAShipmentReference>
<LotNumber>TESTCMB560491</LotNumber>
<HouseBillOfLadingNumber>TESTCGP206618</HouseBillOfLadingNumber>
<CarrierBookingNumber></CarrierBookingNumber>
<CarrierBillofladingNumber></CarrierBillofladingNumber>
<FileNumber></FileNumber>
<ReleaseType>E</ReleaseType>
<ArrivalNoticeNumber></ArrivalNoticeNumber>
<ContainerNumber>TEST9391734</ContainerNumber>
<ContainerSize>123</ContainerSize>
<ContainerType>HC</ContainerType>
<ContainerCode>45GP</ContainerCode>
<SealNumber>TEST0108321</SealNumber>
<OceanVessel>COSCO BEIJING</OceanVessel>
<Voyage>123TEST</Voyage>
<IMONumber>56756756</IMONumber>
<CustomerAlias>BLUEANCHOR</CustomerAlias>
<StatusCode>40</StatusCode>
<StatusLocationCode>DEHAM</StatusLocationCode>
<StatusLocationName>HAMBURG</StatusLocationName>
<RoutingDetails>
<ReceivingWarehouse>DEBRE</ReceivingWarehouse>
<CutoffReceivingWarehouse>2014-07-30</CutoffReceivingWarehouse>
<PlaceOfReceipt>DEBRE</PlaceOfReceipt>
<ETSPlaceOfReceipt>2014-08-04</ETSPlaceOfReceipt>
<PortOfLoading>DEHAM</PortOfLoading>
<ETSPortOfLoading>2014-08-04</ETSPortOfLoading>
<PortOfDischarge>BDCGP</PortOfDischarge>
<ETAPortOfDischarge>2014-09-05</ETAPortOfDischarge>
<PlaceOfDelivery>BDCGP</PlaceOfDelivery>
<ETAPlaceOfDelivery>2014-09-05</ETAPlaceOfDelivery>
</RoutingDetails>
<StatusDateTimeDetails>
<Date>2014-08-04</Date>
<Time>00:00:00</Time>
<TimeZone>CET</TimeZone>
</StatusDateTimeDetails>
<CargoDetails>
<Pieces>3</Pieces>
<WeightLBS>4087.370</WeightLBS>
<VolumeCBF>131.724</VolumeCBF>
<WeightKG>1854.000</WeightKG>
<VolumeCBM>3.730</VolumeCBM>
<HazardousFlag>N</HazardousFlag>
</CargoDetails>
<DocumentationDetails>
<Image></Image>
<ContentType></ContentType>
</DocumentationDetails>
</ShipmentStatusDetails>
</ShipmentStatus>
¶ Description of Shipment Status XML (version 1.0.0)
| 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, ‘WWA_Shipment_Status_XML’. | 50 | Required |
| Version | Message version | 8 | Required |
| EnvelopeID | Unique ID for message to have a follow up option. | 40 | Required |
| Message Body | |||
| ShipmentStatusDetails | Details for Shipment Status | ||
| ShipperReference | The Shipper Reference. | 20 | Optional for status codes 10,11,12,20,21,30,31 and Mandatory for rest of the status codes. |
| ForwarderReference | The forwarder reference. | 20 | Optional for status codes 10,11,12,20,21,30,31 and Mandatory for rest of the status codes. |
| ConsigneeReference | The consignee reference. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| CommunicationReference | The communication reference. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| WWAShipmentReference | The WWA reference. | 30 |
Required. For WWA online/EDI bookings - as provided by WWA system. For Manual Bookings (via email/calls created by members) - Manually generated WWA reference to be used as per following format "Booking number+Member office code" eg: 124577356ESBCN01, where '124577356' is the booking number and ESBCN01 is the Office Code for Transglory BCN (Barcelona) |
| PickupReference | The pickup references. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| BookingNumber | All booking numbers, tied into the shipment. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| LotNumber | All lot numbers, tied into the shipment. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| HouseBillOfLadingNumber | All House Bill numbers, tied into the shipment. | 30 | Optional, Required if StatusCode = 60, 70, 80 |
| CarrierBookingNumber | Carrier Booking Number. | 30 | Optional |
| CarrierBillofladingNumber | Carrier Bill of lading Number. | 30 | Optional |
| File Number | Unique reference identifier. | 30 | Optional |
| ArrivalNoticeNumber | All arrival notice numbers, tied into the shipment. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| Container Number | Container numbers, tied into the shipment. | 12 | Required |
| Container Size | The Size of the Container. | 15 | Optional |
| Container Type | The Type of the Container. | 4 | Optional |
| Container Code | The Code of the Container. | 5 | Optional |
| SealNumber | Seal Numbers, tied into the shipment. | 20 | Required |
| OceanVessel | The ocean vessel name. | 50 | Optional |
| Voyage | Reference number assigned by the carrier or his agent to the voyage of the vessel. | 10 | Optional |
| IMO Number | Lloyd’s register number. | 8 | Optional |
| CustomerAlias | The Customer Alias to be submitted. See description Customer_Alias |
2 | Required |
| StatusCode | The current status code. See description | 2 | Required |
| StatusLocationCode | Where the status took place, unlcode. | 5 | Required |
| StatusLocationName | Where the status took place, full name. | 35 | Required |
| RoutingDetails | Details for Routing | ||
| ReceivingWarehouse | Receiving Warehouse UN Location. | 5 | Required |
| CutoffReceivingWarehouse | The cut off date at Receiving Warehouse YYYY-MM-DD. | 10 | Required |
| PlaceOfReceipt | Place of Receipt UN Location. | 5 | Required |
| ETSPlaceOfReceipt | The ETS at Place of Receipt date YYYY-MM-DD. | 10 | Optional |
| PortOfLoading | Port of Loading UN location. | 5 | Required |
| ETSPortOfLoading | The ETS at the Port of Loading date YYYY-MM-DD. | 10 | Required |
| PortOfDischarge | Port of Discharge UN Location. | 5 | Required |
| ETAPortOfDischarge | ETA discharge date YYYY-MM-DD. | 10 | Required |
| PlaceOfDelivery | Place of Delivery UN Location. | 5 | Required |
| ETAPlaceOfDelivery | The ETA at PlaceOfDelivery date YYYY-MM-DD. | 10 | Optional |
| StatusDateTimeDetails | Details for the Status | ||
| Date | Date i.e YYYY-MM-DD. | 10 | Required |
| Time | Time i.e HH:MM:SS. | 10 | Required |
| TimeZone | Time Zone I.e GMT, CET, EST, etc. | 4 | Required |
| ExceptionTypeDetails | Details for the Exception | If StatusCode = 21, then field is required | |
| ExceptionID | Describe the exception in Weight, Volume, Pieces and or Destination. | 12 | Optional, If ExceptionID is Weight or Volume, UOM is mandatory |
| UOM | Unit of measure. 'E' for imperial or 'M' for metric. | 1 | Optional |
| ValueReceived | Value received in warehouse. | 15 | Optional, IF ExceptionID is Destination, then send UN Location code |
| ValueBooked | PValue booked. | 15 | Optional, IF ExceptionID is Destination, then send UN Location code |
| DocumentationDetails | Details for the Documentation. See Details | ||
| ImageLink | HTTP URL to the pdf, HTML, png, gif or jpeg documentation file. Procedure to test document Type/Link |
999 | IF <ImageLink> is specified, <Image> is Optional |
| Image | Base64binary encode pdf, html, png, gif, jpeg. Procedure to validate encoded PDF Contents |
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 |
¶ Description of Shipment Status XML (version 1.1.0)
| 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, ‘WWA_Shipment_Status_XML’. | 50 | Required |
| Version | Message version | 8 | Required |
| EnvelopeID | Unique ID for message to have a follow up option. | 40 | Required |
| Message Body | |||
| ShipmentStatusDetails | Details for Shipment Status | ||
| ApplicationType | This is to determine the booking request/bl instruction source type. 'WE'(WWA EDI), 'WO'(WWA Online), 'WS'(Web Service), 'MN' (Manual),'MO' (Member Website), 'ME' (Member EDI) | 2 | Required |
| ShipperReference | The Shipper Reference. | 30 |
Optional for status codes 10,11,12,20,21,30,31. Either of ShipperReference or ForwarderReference is required for status 40 to 80. Non UTF characters are not allowed |
| ForwarderReference | The forwarder reference. | 30 |
Optional for status codes 10,11,12,20,21,30,31. Either of ShipperReference or ForwarderReference is required for status 40 to 80. Non UTF characters are not allowed |
| ConsigneeReference | The consignee reference. | 30 | Optional, If existing, references will be sent. At least one would be required. |
| CommunicationReference | The communication reference. | 30 | Optional, If existing, references will be sent. At least one would be required. |
| PickupReference | The pickup references. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| BookingNumber | All booking numbers, tied into the shipment. | 20 | Mandatory for status codes 10 to 50 and Optional for rest of the status codes |
| WWAShipmentRefernce | WWA Shipment Reference | 30 |
Required. For WWA online/EDI bookings - as provided by WWA system. For Manual Bookings (via email/calls created by members) - Manually generated WWA reference to be used as per following format "Booking number+Member office code" eg: 124577356ESBCN01, where '124577356' is the booking number and ESBCN01 is the Office Code for Transglory BCN (Barcelona) |
| LotNumber | All lot numbers, tied into the shipment. | 20 | Mandatory for status codes 20,21,30,31,40,50 and Optional for rest of the status codes.. |
| HouseBillOfLadingNumber | All House Bill numbers, tied into the shipment. | 30 | Conditional, Either Booking number or HBL number should be present for StatusCode = 50,51,52,53. Either HBL number or Arival notice number is mandatory for StatusCode = 60,70,80,81 |
| CarrierBookingNumber | Carrier Booking Number. | 30 | Optional |
| File Number | Unique reference identifier. | 30 | Optional |
| Submitter Email | Email Address of the milestone sender | 50 | Optional |
| ReleaseType | E=Express release, O=Originals | 1 | Optional, required if status code=50. |
| ArrivalNoticeNumber | All arrival notice numbers, tied into the shipment. | 20 | Conditional, Either HBL number or Arival notice number is mandatory for StatusCodes 60,61,62,70,80,81 |
| Container Number | Container numbers, tied into the shipment. | 12 | Mandatory for status code 30,31 & 40 and Optional for rest of the status codes. |
| Container Size | The Size of the Container. | 15 | Optional |
| Container Type | The Type of the Container. | 4 | Optional |
| Container Code | The Code of the Container. | 5 | Optional |
| SealNumber | Seal Numbers, tied into the shipment. | 20 | Mandatory for status code 40 and Optional for rest of the status codes. |
| CarrierSCAC | Carrier SCAC | 10 | Optional |
| OceanVessel | The ocean vessel name. | 50 | Optional |
| Voyage | Reference number assigned by the carrier or his agent to the voyage of the vessel. | 10 | Optional |
| IMONumber | Lloyd’s register number. | 8 | Optional |
| CustomerAlias | The Customer Alias. See description Customer_Alias |
2 | Required |
| StatusCode | The current status code. See description | 2 | Required |
| StatusLocationCode | Where the status took place, unlcode. | 5 | Required |
| StatusLocationName | Where the status took place, full name. | 35 | Required |
| RoutingDetails | Details for Routing | ||
| ReceivingWarehouse | Receiving Warehouse UN Location. | 5 | Optional for status codes 60,70,80 and Mandatory for rest of the status codes. |
| CutoffReceivingWarehouse | The cut off date at Receiving Warehouse YYYY-MM-DD. | 10 | Optional for status codes 60,70,80 and Mandatory for rest of the status codes. |
| PlaceOfReceipt | Place of Receipt UN Location. | 5 | Conditional, A valid 5 character UN code for Place of Receipt or Port of Loading should be present. |
| ETSPlaceOfReceipt | The ETS at Place of Receipt date YYYY-MM-DD. | 10 | Conditional, A valid date for ETSPlaceOfReceipt or ETSPortOfLoading should be present. |
| PortOfLoading | Port of Loading UN location. | 5 | Conditional, A valid 5 character UN code for Place of Receipt or Port of Loading should be present. |
| ETSPortOfLoading | The ETS at the Port of Loading date YYYY-MM-DD. | 10 | Conditional, A valid date for ETSPlaceOfReceipt or ETSPortOfLoading should be present. |
| PortOfDischarge | Port of Discharge UN Location. | 5 | Required |
| ETAPortOfDischarge | ETA discharge date YYYY-MM-DD. | 10 | Required,"should be within 4 months (120 days) past/older date or should be within 6 months (180 days) future date else file will be rejected" |
| PlaceOfDelivery | Place of Delivery UN Location. | 5 | Required |
| ETAPlaceOfDelivery | The ETA at PlaceOfDelivery date YYYY-MM-DD. | 10 | Optional,"should be within 4 months (120 days) past/older date or should be within 6 months (180 days) future date else file will be rejected" |
| StatusDateTimeDetails | Details for the Status | ||
| Date | Date i.e YYYY-MM-DD. | 10 |
Required, "The file will be rejected If the Date is less than 3 months from Today's Date or If the Date is greater than 3 days from Today's Date or If the Date is blank or If the Date is other than "YYYYMMDD" or "YYYY-MM-DD" format" |
| Time | Time i.e HH:MM:SS. | 10 | Required |
| TimeZone | Time Zone I.e GMT, CET, EST, etc. | 4 | Required |
| CargoDetails | Summarized details for the Cargo. | ||
| Pieces | Number of pieces. | 3 | Required |
| WeightLBS | Weight in LBS | 12 | Required |
| VolumeCBF | Volume in CBF | 12 | Required |
| WeightKG | Weight in KG | 12 | Required |
| VolumeCBM | Volume in CBM | 12 | Required |
| HazardousDetails | Details for the Hazardous Component | ||
| Pieces | Number of pieces. | 3 | Required |
| HazWeightLBS | Weight in LBS | 12 | Optional |
| HazVolumeCBF | Volume in CBF | 12 | Optional |
| HazWeightKG | Weight in KG | 12 | Optional |
| HazVolumeCBM | Volume in CBM | 12 | Optional |
| ExceptionTypeDetails | Details for the Exception | If StatusCode = 21, then field is required | |
| ExceptionID | Describe the exception in Weight, Volume, Pieces and or Destination. | 12 | Optional, If ExceptionID is Weight or Volume, UOM is mandatory |
| UOM | Unit of measure. 'E' for imperial or 'M' for metric. | 1 | Optional |
| ValueReceived | Value received in warehouse. | 15 | Optional, IF ExceptionID is Destination, then send UN Location code |
| ValueBooked | PValue booked. | 15 | Optional, IF ExceptionID is Destination, then send UN Location code |
| DocumentationDetails | Details for the Documentation. See Details | Optional,If status code = 70 | |
| ImageLink | HTTP URL to the pdf, HTML, png, gif or jpeg documentation file. Procedure to test document Type/Link |
999 | IF <ImageLink> is specified, <Image> is Optional |
| Image | Base64binary encode pdf, html, png, gif, jpeg. Procedure to validate encoded PDF Contents |
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 |
¶ Description of Shipment Status XML (version 1.1.1)
| 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, ‘WWA_Shipment_Status_XML’. | 50 | Required |
| Version | Message version | 8 | Required |
| EnvelopeID | Unique ID for message to have a follow up option. | 40 | Required |
| Message Body | |||
| ShipmentStatusDetails | Details for Shipment Status | ||
| ApplicationType | This is to determine the booking request/bl instruction source type. 'WE'(WWA EDI), 'WO'(WWA Online), 'WS'(Web Service), 'MN' (Manual),'MO' (Member Website), 'ME' (Member EDI) | 2 | Required |
| TypeOfMove | L=LCL, F=FCL | 2 | Optional |
| ShipperReference | The Shipper Reference. | 30 |
Optional for status codes 10,11,12,20,21,30,31,40. Either of ShipperReference or ForwarderReference is required for status 50 to 80. Non UTF characters are not allowed |
| ForwarderReference | The forwarder reference. | 30 |
Optional for status codes 10,11,12,20,21,30,31,40. Either of ShipperReference or ForwarderReference is required for status 50 to 80. Non UTF characters are not allowed |
| ConsigneeReference | The consignee reference. | 30 | Optional, If existing, references will be sent. At least one would be required. Status codes |
| CommunicationReference | The communication reference. | 30 | Optional, If existing, references will be sent. At least one would be required. |
| PickupReference | The pickup references. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| BookingNumber | All booking numbers, tied into the shipment. | 20 | Mandatory for status codes 10 to 50 and Optional for rest of the status codes |
| WWAShipmentRefernce | WWA Shipment Reference | 30 |
Required. For WWA online/EDI bookings - as provided by WWA system. For Manual Bookings (via email/calls created by members) - Manually generated WWA reference to be used as per following format "Booking number+Member office code" eg: 124577356ESBCN01, where '124577356' is the booking number and ESBCN01 is the Office Code for Transglory BCN (Barcelona) |
| LotNumber | All lot numbers, tied into the shipment. | 20 | Mandatory for status codes 20,21,30,31,32,33,40,50 and Optional for rest of the status codes.. |
| HouseBillOfLadingNumber | All House Bill numbers, tied into the shipment. | 30 | Conditional, Either Booking number or HBL number should be present for StatusCode = 50,51,52,53. Either HBL number or Arival notice number is mandatory for StatusCode = 60,70,80,81 |
| CarrierBookingNumber | Carrier Booking Number. | 30 | Optional |
| CarrierBillofladingNumber | Carrier Bill of lading number. | 30 | Optional |
| FileNumber | Unique reference identifier. | 30 | Optional |
| ReleaseType | E=Express release, O=Originals | 1 | Optional, required if status code=50. |
| BLClauses | BLClauses | 2048 | Optional, required if status code is 49 and 50 |
| ArrivalNoticeNumber | All arrival notice numbers, tied into the shipment. | 20 | Conditional, Either HBL number or Arival notice number is mandatory for StatusCodes 60,61,62,70,80,81 |
| PreviousArrivalNoticeNumber | Previous Arrival notice number. | 20 | Optional |
| PalletExchange | Pallet Exchange | 3 | Optional, Applicable to receive data when status is import type |
| Container Number | Container numbers, tied into the shipment. | 12 | Mandatory for status code 30,31 & 40 and Optional for rest of the status codes. |
| Container Size | The Size of the Container. | 15 | Optional |
| Container Type | The Type of the Container. | 4 | Optional |
| Container Code | The Code of the Container. | 5 | Optional |
| SealNumber | Seal Numbers, tied into the shipment. | 20 | Mandatory for status code 40 and Optional for rest of the status codes. |
| CarrierSCAC | Carrier SCAC | 10 | Optional |
| OceanVessel | The ocean vessel name. | 50 | Optional, Should be present in status 30,31,32,33,40,50,70,80,81 |
| Voyage | Reference number assigned by the carrier or his agent to the voyage of the vessel. | 10 | Optional |
| IMONumber | Lloyd’s register number. | 8 | Optional |
| CustomerAlias | The Customer Alias. See description Customer_Alias |
2 | Required, Mandatory for all status |
| StatusCode | The current status code. See description | 2 | Required, Mandatory for all status |
| StatusLocationCode | Where the status took place, unlcode. | 5 | Required |
| StatusLocationName | Where the status took place, full name. | 35 | Optional |
| StatusDateTimeDetails | Details for the Status | ||
| Date | Date i.e YYYY-MM-DD. | 10 |
Required, "The file will be rejected If the Date is less than 3 months from Today's Date or If the Date is greater than 3 days from Today's Date or If the Date is blank or If the Date is other than "YYYYMMDD" or "YYYY-MM-DD" format" |
| Time | Time i.e HH:MM:SS. | 10 | Required |
| TimeZone | Time Zone I.e GMT, CET, EST, etc. | 4 | Required |
| RoutingDetails | Details for Routing | ||
| ReceivingWarehouse | Receiving Warehouse UN Location. | 5 | Optional for status codes 60,70,80 and Mandatory for rest of the status codes. |
| CutoffReceivingWarehouse | The cut off date at Receiving Warehouse YYYY-MM-DD. | 10 | Optional for status codes 60,70,80 and Mandatory for rest of the status codes. |
| PlaceOfReceipt | Place of Receipt UN Location. | 5 | Conditional, A valid 5 character UN code for Place of Receipt or Port of Loading should be present. |
| ETSPlaceOfReceipt | The ETS at Place of Receipt date YYYY-MM-DD. | 10 | Conditional, A valid date for ETSPlaceOfReceipt or ETSPortOfLoading should be present. |
| PortOfLoading | Port of Loading UN location. | 5 | Conditional, A valid 5 character UN code for Place of Receipt or Port of Loading should be present. |
| ETSPortOfLoading | The ETS at the Port of Loading date YYYY-MM-DD. | 10 | Conditional, A valid date for ETSPlaceOfReceipt or ETSPortOfLoading should be present. |
| PortOfDischarge | Port of Discharge UN Location. | 5 | Required |
| ETAPortOfDischarge | ETA discharge date YYYY-MM-DD. | 10 | Required,"should be within 4 months (120 days) past/older date or should be within 6 months (180 days) future date else file will be rejected" |
| PlaceOfDelivery | Place of Delivery UN Location. | 5 | Required |
| ETAPlaceOfDelivery | The ETA at PlaceOfDelivery date YYYY-MM-DD. | 10 | Required ,"should be within 4 months (120 days) past/older date or should be within 6 months (180 days) future date else file will be rejected" |
| TransshipmentSailingDetailsFlag | "Y"=Yes; "N"=No | 1 | Required |
| TSPortIdentifier | Transshipment Port Identifier | 3 | optional |
| TSMode | Transshipment mode: Vessel, RAIL, ROAD | 50 | optional |
| TSVesselName | Transshipment Vessel Name | 50 | optional |
| TSVesselIMO | Transshipment Vessel IMO | 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 | Transshipment Port Name | 80 | Optional, If UN code is not available, Name should be printed. |
| EtaTSPort | ETA of Transshipment Port. | optional | |
| EtdTSPort | ETD of Transshipment Port. | optional | |
| CargoDetails | Summarized details for the Cargo. | ||
| Pieces | Number of pieces. | 3 | Required |
| WeightLBS | Weight in LBS | 12 | Required |
| VolumeCBF | Volume in CBF | 12 | Required |
| WeightKG | Weight in KG | 12 | Required |
| VolumeCBM | Volume in CBM | 12 | Required |
| HazardousFlag | "Y"=Yes; "N"=No | 1 | Required |
| HazardousDetails | Details for the Hazardous Component | ||
| Pieces | Number of pieces. | 3 | Required |
| HazWeightLBS | Weight in LBS | 12 | Optional |
| HazVolumeCBF | Volume in CBF | 12 | Optional |
| HazWeightKG | Weight in KG | 12 | Optional |
| HazVolumeCBM | Volume in CBM | 12 | Optional |
| ExceptionTypeDetails | Details for the Exception | If StatusCode = 21, then field is required | |
| ExceptionID | Describe the exception in Weight, Volume, Pieces and or Destination. | 12 | Optional, If ExceptionID is Weight or Volume, UOM is mandatory |
| UOM | Unit of measure. 'E' for imperial or 'M' for metric. | 1 | Optional |
| ValueReceived | Value received in warehouse. | 15 | Optional, IF ExceptionID is Destination, then send UN Location code |
| ValueBooked | PValue booked. | 15 | Optional, IF ExceptionID is Destination, then send UN Location code |
| DocumentationDetails | Details for the Documentation. See Details | Optional,If status code = 70 | |
| ImageLink | HTTP URL to the pdf, HTML, png, gif or jpeg documentation file. Procedure to test document Type/Link |
999 | IF <ImageLink> is specified, <Image> is Optional |
| Image | Base64binary encode pdf, html, png, gif, jpeg. Procedure to validate encoded PDF Contents |
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 |
| DocumentRated | "Y"=Yes; "N"=No | 1 | Required |
| RatedDetails | Rated Details | Required, If StatusCode = 10, 20, 21, 50, 60, 70, then RatedDetails is Mandatory | |
| RatedImageLink | Rated Image URL | Optional | |
| RatedImage | Rated Image | Optional | |
| RatedContentType | Rated Content Type | Optional | |
¶ Description of Shipment Status XML - Newly added tags for Schema version 2.0.1
| Field | Content | Length | Input |
|---|---|---|---|
| PrimaryBookingNumber | Primary Booking Number | 20 | Optional |
| CustEmailAddress | Customer Eail Address | 200 | Optional |
| ParentArrivalNoticeNumber | Parent Arrival Notice Number | 20 | Optional |
| ExportAgentSCAC | Added to receive Export Agent scac code | 10 | Optional |
| ImportAgentSCAC | Added to receive Import Agent scac code | 10 | Optional |
| Dimensions | Based on request from Shipco/SACO "Dimensions" field introduced in Cargodeails for shipment dimensions | 0 | Optional |
| Pieces | Pieces | 0 | Optional |
| PackagingType | Packaging Type | 0 | Optional |
| Length | Length | 0 | Optional |
| Width | Width | 0 | Optional |
| Height | Height | 0 | Optional |
| MeasurementUnit | Measurement Unit | 0 | Optional |
| CargoDescription | Cargo Description | 2048 | Optional |
| Cargo Receipt Document | Cargo Receipt Document | 0 | Optional |
| Cargo Image | Cargo Image | 0 | Optional |
¶ Description of documentation needed
| Status Code | Status Name | Documentation |
|---|---|---|
| 10 | Booking Confirmed | Booking Confirmation |
| 20 | Received In Warehouse | Dock Receipt / Cargo Receipt Notification |
| 21 | Received In Warehouse With Discrepancy | Dock Receipt / Cargo Receipt Notification |
| 50 | Bill Of Lading Printed | House Bill of Lading |
| 60 | Arrival Notice Issued | Arrival Notice |
| 70 | Freight Available | Delivery Order (Conditional) |
¶ Description of DocumentationDetails
- DocumentationDetails is the parent tag that can only have 2 child tags:
<Image>+<ContentType> OR <ImageLink>+<ContentType>.
- The order of the nesting will appear in the following manner (with data):
<DocumentationDetails>
<Image>
<ContentType>
<DocumentationDetails>
OR
<DocumentationDetails>
<ImageLink>
<ContentType>
<DocumentationDetails>
- For file generation, the one of the following 10 nesting options can to be used. Please note for “Text in <ContentType>”, the data populated in <ContentType> must appear as written below:
(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 |
- Examples of data that could be included in a file.
