...
Chapter Contents:
| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Long Description
Bill of
...
Lading (B/L)
...
Integration Process
Note: Recommended before proceeding - please read: Getting Started with Dataloy REST API.
Supported methodsMethods:
POST /BillOfLadingAnchor bl_post bl_post
...
Example of BillOfLading JSON messageMessage
Request Body:Anchor bl_example bl_example
...
| Property | Type | Length | Mandatory | Description | Comments |
|---|---|---|---|---|---|
weight | Double | 126 | Cargo Weight | ||
volume | Double | 126 | Cargo Volume | ||
notifyParty | String | 80 | The Person to be Notified upon Cargo Arrival. | ||
consignee | String | 80 | The Person to Whom the Cargo is to be Delivered. | ||
cargoQuantity | Double | 126 | Cargo Quantity | ||
billOfLadingNo | String | 20 | Yes | Bill of Lading (B/L) Number | |
billOfLadingDate | Date | Bill of Lading (B/L) Date | |||
| cargo | /Cargo | Yes | Identifies Cargo of the Bill of Lading (B/L). |
The
...
Bill of
...
Lading (B/L)
...
Stages
Inserting (or updating Updating) a bill Bill of lading Lading (B/L)
- To insert (or update) a Bill of Lading (B/L) into Dataloy VMS post a populated JSON message (see JSON example) to the Dataloy API.
- Fields required to be populated when posting a B/L to Dataloy VMS: cargo, billOfLadingNo.
Note: When updating an existing B/L, unchanged properties (except required fields) need not be updated.
ValidationsAnchor val1 val1
Prior to inserting/updating the B/L in Dataloy VMS, the following validations will be performed on the JSON message:- Are the required fields populated?
Yes: Continue Insertion.
No: Nothing is inserted and a HTTP status code is returned.
Verifying
...
Inserted (or
...
Updated)
...
Bill of
...
Ladings (B/Ls) in Dataloy VMS
To view inserted/updated bill of ladings View Inserted/Updated Bill of Ladings (B/Ls):
- Go to
Modules > Booking and Operations > cargo Browser. - The Cargo Browser window will open.
- Select the cargo the B/L belongs to.
Note: Locate cargo using the filter function of the Reference column. - Click on the first discharge port (bottom list of screen as the B/L is inserted on the first discharge port of a cargo).
- Click on the Bills of Lading tab to view the Bill of Ladings (B/L).
...