¶ Shipment Status Module Overview
- In this module, WWA customers can receive shipment status files
¶ Shipment Status, XML formatted. (Customer)
Shipment Status XML Schema Definition:
wwa_shipment_status_version_1.0.0.xsd
¶ Sample Shipment Status XML (version 1.0.0) for WWA milestones (10-80)
<?xml version="1.0" encoding="UTF-8"?>
<!-- Auto-generated XML Document WWA-EI -->
<ShipmentStatus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.wwalliance.com/doc/wwa-ei/Shipment_Status/1.0.0/Schema/WWA_Shipment_Status_version_1.0.0.xsd">
<Envelope>
<SenderID>wwalliance</SenderID>
<ReceiverID>edi_customer_prod</ReceiverID>
<Password>test</Password>
<Type>Shipment_Status_XML_1.0.0</Type>
<Version>1.0.0</Version>
<EnvelopeID>1477928701872</EnvelopeID>
</Envelope>
<ShipmentStatusDetails>
<ShipperReference>BSL0276813</ShipperReference>
<ForwarderReference>BSL0276813</ForwarderReference>
<ConsigneeReference></ConsigneeReference>
<CommunicationReference>B3S 05166 Q8</CommunicationReference>
<PickupReference></PickupReference>
<BookingNumber>2652097</BookingNumber>
<LotNumber>2652097</LotNumber>
<HouseBillOfLadingNumber>SHA2652097</HouseBillOfLadingNumber>
<CarrierSCAC></CarrierSCAC>
<ArrivalNoticeNumber>130550518705</ArrivalNoticeNumber>
<ContainerNumber>KKFU7676628</ContainerNumber>
<SealNumber>10247</SealNumber>
<OceanVessel>COSCO ASIA</OceanVessel>
<CustomerAlias>CUSTOMER</CustomerAlias>
<StatusCode>60</StatusCode>
<StatusLocationCode>CNSHA</StatusLocationCode>
<StatusLocationName>Shanghai</StatusLocationName>
<RoutingDetails>
<PlaceOfReceipt>INMAA</PlaceOfReceipt>
<ETSPlaceOfReceipt>2016-11-07</ETSPlaceOfReceipt>
<PortOfLoading>INMAA</PortOfLoading>
<ETSPortOfLoading>2016-11-07</ETSPortOfLoading>
<PortOfDischarge>NLRTM</PortOfDischarge>
<ETAPortOfDischarge>2016-12-03</ETAPortOfDischarge>
<PlaceOfDelivery>NLRTM</PlaceOfDelivery>
<ETAPlaceOfDelivery>2016-12-03</ETAPlaceOfDelivery>
</RoutingDetails>
<StatusDateTimeDetails>
<Date>2016-11-07</Date>
<Time>13:00:00</Time>
<TimeZone>GMT</TimeZone>
</StatusDateTimeDetails>
<DocumentationDetails>
<Image></Image>
<ContentType></ContentType>
</DocumentationDetails>
</ShipmentStatusDetails>
</ShipmentStatus>
¶ Description of Shipment Status XML (version 1.0.0) for WWA milestones (10-80)
| 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, If existing, references will be sent. At least one would be required. |
| ForwarderReference | The forwarder reference. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| 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. |
| 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 |
| CarrierSCAC | SCAC code of actual carrier. | 4 | Optional |
| ReleaseType | E=Express release, O=Originals | 1 | Optional, required if status code=50. |
| 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 | Mandatory for status code 30,31 & 40 and Optional for rest of the status codes. |
| SealNumber | Seal Numbers, tied into the shipment. | 20 | Mandatory for status code 40 and Optional for rest of the status codes. |
| OceanVessel | The ocean vessel name. | 50 | Optional |
| CustomerAlias | The Customer Alias. | 25 | 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 | Optional |
| 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 | 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 Description | ||
| 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 |
¶ Sample Shipment Status XML (version 1.0.0) for carrier milestones (8xx series) Example:823, 829
<!-- Auto-generated XML Document STi-EI Version 1.0.9 -->
<ShipmentStatus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.wwalliance.com/doc/wwa-ei/Shipment_Status/1.0.0/Schema/WWA_Shipment_Status_version_1.0.0.xsd">
<Envelope>
<SenderID>wwalliance</SenderID>
<ReceiverID>edi_customer_prod</ReceiverID>
<Password>test</Password>
<Type>Shipment_Status_XML_1.0.0</Type>
<Version>1.0.0</Version>
<EnvelopeID>1368684539811</EnvelopeID>
</Envelope>
<ShipmentStatusDetails>
<ShipperReference>CHN0398762</ShipperReference>
<ForwarderReference>CHN0398762</ForwarderReference>
<ConsigneeReference></ConsigneeReference>
<CommunicationReference></CommunicationReference>
<PickupReference></PickupReference>
<BookingNumber>500336008682</BookingNumber>
<LotNumber>500336008682</LotNumber>
<HouseBillOfLadingNumber>500336008682</HouseBillOfLadingNumber>
<CarrierBookingNumber>47066326</CarrierBookingNumber>
<CarrierBillofladingNumber>TEST3161102718</CarrierBillofladingNumber>
<FileNumber></FileNumber>
<OfficeCode></OfficeCode>
<CarrierSCAC>HLCU</CarrierSCAC>
<ArrivalNoticeNumber></ArrivalNoticeNumber>
<ContainerNumber>AMFU3231959</ContainerNumber>
<SealNumber>1674726</SealNumber>
<OceanVessel>RIO BLACKWATER</OceanVessel>
<CustomerAlias>CUSTOMER</CustomerAlias>
<StatusCode>823</StatusCode>
<StatusLocationCode>INMAA</StatusLocationCode>
<StatusLocationName>Chennai</StatusLocationName>
<RoutingDetails>
<PlaceOfReceipt>INMAA</PlaceOfReceipt>
<ETSPlaceOfReceipt>2016-11-07</ETSPlaceOfReceipt>
<PortOfLoading>INMAA</PortOfLoading>
<ETSPortOfLoading>2016-11-07</ETSPortOfLoading>
<PortOfDischarge>NLRTM</PortOfDischarge>
<ETAPortOfDischarge>2016-12-03</ETAPortOfDischarge>
<PlaceOfDelivery>NLRTM</PlaceOfDelivery>
<ETAPlaceOfDelivery>2016-12-03</ETAPlaceOfDelivery>
</RoutingDetails>
<StatusDateTimeDetails>
<Date>2016-11-07</Date>
<Time>13:00:00</Time>
<TimeZone>GMT</TimeZone>
</StatusDateTimeDetails>
<DocumentationDetails>
<Image></Image>
<ContentType></ContentType>
</DocumentationDetails>
</ShipmentStatusDetails>
</ShipmentStatus>
¶ Description of Shipment Status XML (version 1.0.0) for carrier milestones (8xx Series) Example: 823, 829
| 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, If existing, references will be sent. At least one would be required. |
| ForwarderReference | The forwarder reference. | 20 | Optional, If existing, references will be sent. At least one would be required. |
| 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. |
| 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. | 25 | Optional |
| FileNumber | File Number. | 25 | Optional |
| Office Code | Office Code. | 10 | Optional |
| CarrierSCAC | SCAC code of actual carrier. | 4 | Optional, data will be sent only for carrier milestones (8xx series, example : Milestone 829) |
| ReleaseType | E=Express release, O=Originals | 1 | Optional, required if status code=50. |
| 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 | Mandatory for status code 30,31 & 40 and Optional for rest of the status codes. |
| SealNumber | Seal Numbers, tied into the shipment. | 20 | Mandatory for status code 40 and Optional for rest of the status codes. |
| OceanVessel | The ocean vessel name. | 50 | Optional |
| CustomerAlias | The Customer Alias. | 25 | 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 | Optional |
| 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 | 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 Description | ||
| 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 Status Codes
| tatus Code | Status Name |
|---|---|
| 10 | Booking Confirmed |
| 11 | Booking Cancelled |
| 12 | Booking Updated |
| 13 | Booking Rejected |
| 20 | Received In Warehouse |
| 21 | Received In Warehouse With Discrepancy |
| 30 | Container Loaded And Sealed |
| 31 | Customers Own Container Loaded and Sealed |
| 40 | Confirmed On Board |
| 50 | Bill Of Lading Printed |
| 51 | Arrived at Transshipment port |
| 52 | Container Loaded and Sealed Transshipment port |
| 53 | Confirmed on Board Transshipment port |
| 60 | Arrival Notice Issued |
| 61 | Arrived at Deconsolidation CFS |
| 62 | Container Devanned at Deconsolidation CFS |
| 70 | Freight Available |
| 80 | Freight Picked up/Delivered |
¶ 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> )
| ption | 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.
