Short Description
...
| Property | Type | Length | Mandatory | Description | Comments |
|---|---|---|---|---|---|
portCall | /PortCall | Y | PortCall | Includes data such as:
| |
BunkerOrderLines | Array of /BunkerOrderLine | Y | BunkerOrder Lines of the BunkerOrder | Includes data such as:
| |
vessel | /Vessel | Y | Vessel | Vessels IMO number e.g. 8814275 | |
bunkerSupplier | /BusinessPartner | Bunker Supplier | |||
| bunkerPaidBy | /BusinessPartner | Payer of the bunkers (in case a thrid party) | |||
| bunkerBroker | /BusinessPartner | Bunker Broker | |||
| bunkerAccountOf | /BusinessPartner | ||||
externalReferenceNo | String | 64 | External Bunker Order Referecne Number | ||
| company | /Company | Orderer of bunkers | |||
exchangeRate | Double | Exchange Rate Between BunkerOrderAmount and companyCurrencyAmount | |||
currency | /Currency | BunkerOrder Currency | |||
bunkeredDate | Date | Actual bunker date ISO format | |||
bunkerOrderStatus | /StatusType | Y | BunkerOrder Status (see: BunkerOrder Status List) | ||
| extraCost | Double |
...
| Code Block |
|---|
{
"bunkerOrderStatus":"STM",
"bunkerOrderLines":[
{
"key":1116527,
"bunkeredQuantity":32.8888
}
]
} |
Webhook
The below webhook will give send a BunkerOrder to your endpoint when a BunkerOrder is created (replace eventType with U to be notified on update Bunker Order). It will give you the following information:
| Code Block | ||
|---|---|---|
| ||
{
"bunkerOrderStatus": { "statusTypeCode": "*", "statusTypeDesc": "*" },
"vessel": { "imoNumber": "*", "vesselName": "*" },
"portCall": {
"port": { "timezone": { "timezoneName": "*" }, "portName": "*" },
"voyage": { "vessel": { "imoNumber": "*", "vesselName": "*" } },
"agent": { "businessPartnerName": "*" },
"eventLogs": { "eventLogDate": "*", "event": { "eventCode": "*", "eventDesc": "*" } }
},
"remarks": "*",
"bunkerOrderLines": { "minQuantity": "*", "maxQuantity": "*", "bunkerType": { "bunkerTypeCode": "*" } }
}
|
| Code Block | ||
|---|---|---|
| ||
{
"eventType":"C",
"objectType":"BunkerOrder",
"url": "https://",
"user": 123456,
"json": "eyJidW5rZXJPcmRlclN0YXR1cyI6eyJzdGF0dXNUeXBlQ29kZSI6IioiLCJzdGF0dXNUeXBlRGVzYyI6IioifSwidmVzc2VsIjp7Imltb051bWJlciI6IioiLCJ2ZXNzZWxOYW1lIjoiKiJ9LCJwb3J0Q2FsbCI6eyJwb3J0Ijp7InRpbWV6b25lIjp7InRpbWV6b25lTmFtZSI6IioifSwicG9ydE5hbWUiOiIqIn0sInZveWFnZSI6eyJ2ZXNzZWwiOnsiaW1vTnVtYmVyIjoiKiIsInZlc3NlbE5hbWUiOiIqIn19LCJhZ2VudCI6eyJidXNpbmVzc1BhcnRuZXJOYW1lIjoiKiJ9LCJldmVudExvZ3MiOnsiZXZlbnRMb2dEYXRlIjoiKiIsImV2ZW50Ijp7ImV2ZW50Q29kZSI6IioiLCJldmVudERlc2MiOiIqIn19fSwicmVtYXJrcyI6IioiLCJidW5rZXJPcmRlckxpbmVzIjp7Im1pblF1YW50aXR5IjoiKiIsIm1heFF1YW50aXR5IjoiKiIsImJ1bmtlclR5cGUiOnsiYnVua2VyVHlwZUNvZGUiOiIqIn19fQ==",
"webhookUsername": "test",
"webhookPassword": "test"
} |
Additional Information
List of BunkerOrder Statuses in Dataloy VMS
...