/BillOfLading
Short Description
Chapter Contents:
Long Description
Supported Methods
GET /BillOfLading
Get a list of BillOfLading objects. Filter to avoid huge amounts of data (see Filtering for search parameters).
GET /BillOfLading/{key}
Get a single BillOfLading object.
POST /BillOfLading
Insert a new BillOfLading object
Note: Required field: cargo, billOfLadingNo.Â
Â
PUT /BillOfLading/{key}
Update an existing BillOfLading. Unchanged properties need not be updated.Â
Properties
Property | Type | Length | Mandatory | Description | Comments |
---|---|---|---|---|---|
variousCost | Float | Â | Â | Â | Â |
variousRevenue | Float | Â | Â | Â | Â |
freight | Float | Â | Â | Â | Â |
receiver | /BusinessPartner | Â | Â | Â | Â |
cargoQuantity | Float | Â | Â | Â | Â |
volume | Float | Â | Â | Â | Â |
weight | Float | Â | Â | Â | Â |
subCommodity | /SubCommodity | Â | Â | Â | Â |
businessPartner | /BusinessPartner | Â | Â | Â | Â |
cargoPort | /CargoPort | Â | Â | Â | Â |
billOfLadingTerm | /BillOfLadingTerm | Â | Â | Â | Â |
billOfLadingDate | Date | Â | Â | Â | Â |
billOfLadingNo | String | 20 | Â | Â | Â |
consignee | String | 80 | Â | Â | Â |
notifyParty | String | 80 | Â | Â | Â |
releasedDate | Date | Â | Â | Â | Â |
 |  |  |  |  |  |
Response Body Example
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)
{ "key": 1250048, "self": "http://localhost:8080/ws/rest/BillOfLading/1250048", "createdDate": "2013-01-02T09:39:28", "modifiedDate": "2013-01-02T09:39:28", "variousCost": 0, "variousRevenue": 0, "freight": 0, "receiver": null, "cargoQuantity": 0, "volume": 0, "weight": 0, "subCommodity": null, "businessPartner": null, "cargoPort": { "self": "http://localhost:8080/ws/rest/CargoPort/1220437", "key": 1220437 }, "billOfLadingTerm": null, "billOfLadingDate": null, "billOfLadingNo": null, "consignee": null, "notifyParty": null, "releasedDate": null, "remarks": [ { "remarkTitle": "BL mate's receipt", "key": 1250051, "self": "http://localhost:8080/ws/rest/Remark/1250051" } ] }