/BunkerOrder

Short Description

This API Resource will be available from version 3.3 of the Dataloy API

Chapter Contents:

Long Description

Supported Methods

GET /BunkerOrder

Get a list of BunkerOrder objects. Filter to avoid huge amounts of data (see Filtering for search parameters).

GET /BunkerOrder/{key}

Get a single BunkerOrder object.

POST /BunkerOrder

Insert a new BunkerOrder:

Fields that must be unique: ExternalReferenceNo

PUT /BunkerOrder/{key}

Update an existing BunkerOrder. Unchanged properties need not be updated.

Properties

Property	Type	Length	Mandatory	Description	Comments
portCall	/PortCall		Y	PortCall	Includes data such as: Event Logs (ETA = eventeCode=ARR) Port Agent Reason For Call
BunkerOrderLines	Array of /BunkerOrderLine		Y	BunkerOrder Lines of the BunkerOrder	Includes data such as: BunkerType MinQuantity MaxQuantity ...
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

Example GET Return Body

Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)

Get return body can be customized by specifying what fields you want to extract using the API. This is done in the http header property "fields". Please see "Adjust Number of Fields to be Returned from a Request" for more information.

A http header property must be used to get the following structure as the API will by default not include all details of sub objects.

{
    "key": 3098739,
    "self": "http://localhost:8080/ws/rest/BunkerOrder/3098739",
    "BunkerOrderLines": [
        {
		    "key": 1116527,
    		"self": "http://localhost:8080/ws/rest/BunkerOrderLine/1116527",
    		"minQuantity": "30.50",
    		"maxQuantity": "34.50",
    		"bunkerType": {
        		"bunkerTypeCode": "DMA-2010-0.1"
     		},
			"unitPrice": 365.50,
    		"bunkeredQuantity": 295.16302,
    		"createdDate": "2012-10-03T10:33:11",
    		"modifiedDate": "2014-05-14T07:59:04",    
    		"remarks": []
        }
	],
	"vessel":{
      "key":1941760,
      "self":"http://localhost:8080/ws/rest/Vessel/1941760"
	  "vesselName":"Ocean Carrier", 
      "IMO":"8814275"
    },
    "createdDate": "2014-06-10T11:25:54",
    "modifiedDate": null,
    "externalReferenceNo": "XXX-XXX",
    "company": {
            "key": 1063570,
            "self": "http://localhost:8080/ws/rest/Company/1063570",
            "companyCode": "9000",
            "companyName": "Ocean Carries Inc",
            "companyCurrency": {
                "currencyCode": "USD",
                "currencyName": "US Dollars",
                "key": 400008,
                "self": "http://localhost:8080/ws/rest/Currency/400008"
            }
    },
    "exchangeRate": 0.91,
    "bunkerOrderDate": "2014-05-22T00:00:00",
    "bunkerSupplier": {
            "businessPartnerName": "Bunker Inc",
            "businessPartnerSort": "Bunk",
            "businessPartnerCode": "P200243",
            "bankAccount": null,
            "businessPartnerType": null,
            "self": "http://localhost:8080/ws/rest/BusinessPartner/1240222",
            "key": 1240222
    },
	"bunkerAccountOf": {
            "businessPartnerName": "Bunker 2 Inc ",
            "businessPartnerSort": "Bunk2",
            "businessPartnerCode": "P200240",
            "bankAccount": null,
            "businessPartnerType": null,
            "self": "http://localhost:8080/ws/rest/BusinessPartner/1240229",
            "key": 1240229
    },
	"bunkerBroker": {
            "businessPartnerName": "Ultimate Brokers",
            "businessPartnerSort": "Ultimate",
            "businessPartnerCode": "P200241",
            "bankAccount": null,
            "businessPartnerType": null,
            "self": "http://localhost:8080/ws/rest/BusinessPartner/1240225",
            "key": 1240225
    },
	"bunkerPaidBy": {
            "businessPartnerName": "Third Party Company",
            "businessPartnerSort": "Thrid",
            "businessPartnerCode": "P200240",
            "bankAccount": null,
            "businessPartnerType": null,
            "self": "http://localhost:8080/ws/rest/BusinessPartner/1240230",
            "key": 1240230
    },
    "bunkerOrderCurrency": {
            "currencyCode": "EUR",
            "currencyName": "Euro",
            "key": 400132,
            "self": "http://localhost:8080/ws/rest/Currency/400132"
    },
    "bunkerOrderStatus": {
            "key": 1000095,
            "self": "http://localhost:8080/ws/rest/StatusType/1000095",
            "statusTypeCode": "ATC",
            "statusTypeDesc": "ACTIVE"
    },
	"portCall": {
        "key": 1127910,
        "self": "http://localhost:8080/ws/rest/PortCall/1127910"
		"eventLog": [ 
			{ 
				"key": 1104817,
    			"self": "http://localhost:8080/ws/rest/EventLog/1104817",
    			"eventLogDate": "2012-07-30T04:08:00",
    			"event": {
        			"key": 1000050,
        			"self": "http://localhost:8080/ws/rest/Event/1000050",
        			"eventCode": "BRT",
        		"eventDesc": "Berthed"
    				},
    				"remarks": []
			},
			{ 
				"key": 1104816,
    			"self": "http://localhost:8080/ws/rest/EventLog/1104816",
    			"eventLogDate": "2012-07-30T04:08:00",
    			"event": {
        			"key": 1000050,
        			"self": "http://localhost:8080/ws/rest/Event/1000050",
        			"eventCode": "DEP",
        		"eventDesc": "Departed"
    				},
    				"remarks": []
			},
			{ 
				"key": 1104816,
    			"self": "http://localhost:8080/ws/rest/EventLog/1104816",
    			"eventLogDate": "2012-07-30T04:08:00",
    			"event": {
        			"key": 1000050,
        			"self": "http://localhost:8080/ws/rest/Event/1000050",
        			"eventCode": "ARR",
        		"eventDesc": "Arrived"
    				},
    				"remarks": []
			}
		],
        "port":{
			"portName":"Oslo",
    		"unLoCode":"NOOSL"
			"self": "http://localhost:8080/ws/rest/Port/101770",
			"key":101770
		},
		"portAgent": {
            "businessPartnerName": "Port Agent Agencies",
            "businessPartnerSort": "PAA",
            "businessPartnerCode": "A200299",
            "bankAccount": null,
            "businessPartnerType": null,
            "self": "http://localhost:8080/ws/rest/BusinessPartner/1240223",
            "key": 1240223
    	}
    },
    "remarks": []
}

Update Bunker Order

When updating a bunker order it is possible to do that in one PUT operation (including sub objects such as Bunker Order Line)

See example below where we update the BunkerOrderStatus to "STM" (Stemmed) and the bunkeredQuantity on the bunker order line (sub object) to 32. 8888.

URL:

PUT request to: http://localhost/ws/rest/BunkerOrder/[ID OF BUNKER_ORDER]

{
	"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:

Fields used in below Bunker Order Webhook

{
    "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": "*" } }
}

Webhook for create bunker order

{
    "eventType":"C",
    "objectType":"BunkerOrder",
    "url": "https://",
    "user": 123456,
    "json": "eyJidW5rZXJPcmRlclN0YXR1cyI6eyJzdGF0dXNUeXBlQ29kZSI6IioiLCJzdGF0dXNUeXBlRGVzYyI6IioifSwidmVzc2VsIjp7Imltb051bWJlciI6IioiLCJ2ZXNzZWxOYW1lIjoiKiJ9LCJwb3J0Q2FsbCI6eyJwb3J0Ijp7InRpbWV6b25lIjp7InRpbWV6b25lTmFtZSI6IioifSwicG9ydE5hbWUiOiIqIn0sInZveWFnZSI6eyJ2ZXNzZWwiOnsiaW1vTnVtYmVyIjoiKiIsInZlc3NlbE5hbWUiOiIqIn19LCJhZ2VudCI6eyJidXNpbmVzc1BhcnRuZXJOYW1lIjoiKiJ9LCJldmVudExvZ3MiOnsiZXZlbnRMb2dEYXRlIjoiKiIsImV2ZW50Ijp7ImV2ZW50Q29kZSI6IioiLCJldmVudERlc2MiOiIqIn19fSwicmVtYXJrcyI6IioiLCJidW5rZXJPcmRlckxpbmVzIjp7Im1pblF1YW50aXR5IjoiKiIsIm1heFF1YW50aXR5IjoiKiIsImJ1bmtlclR5cGUiOnsiYnVua2VyVHlwZUNvZGUiOiIqIn19fQ==",
    "webhookUsername": "test",
    "webhookPassword": "test"
}

Additional Information

List of BunkerOrder Statuses in Dataloy VMS

BunkerOrder Status Code	BunkerOrder Status Description	Description
REQBO	Requirement	Default Status on new bunker orders
STMBO	Stemmed	Stemmed
DLVBO	Delivered	Bunkers delivered
CANBO	Canceled	Canceled

Top

Back