/BillOfLading

Short Description

Chapter Contents:

1 Supported Methods
2 Properties
3 Response Body Example

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

Property	Type	Length
`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"
        }
    ]
}

Top
Back