This has been deprecated. Follow instead the standard REST endpoint: BillOfLading
Short Description
The objective of the bill of lading integration is to automate the creation and flow of transactions between the Dataloy VMS and a cargo documentation system. The advantage is, for example, reduced risk of errors as several transactions handled by the Dataloy VMS system generates transactions to be entered in a client cargo documentation system.
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.
...
Note |
---|
Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior versions has date format: yyyy-dd-MM hh:mi:ss) |
{ "cargo":206591205, "billOfLadingDate":"2015-09-21T00:00:00", "billOfLadingNo":"123456", "cargoQuantity":0, "consignee":null, "notifyParty":null , "volume":0, "weight":0 } |
Properties
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) a Bill of 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 (B/Ls):
...
Example:
Figure1 shows where the B/L in the JSON example is inserted in Dataloy VMS.
Fig. 1
Related Content
Expand | ||
---|---|---|
| ||
|