Creates or updates a nomination as a receiver
curl --request PUT \
--url https://api.demo.fuelboss.net/v1/nominations/receiver \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientReference": "<string>",
"delivery": {
"operationStandardCode": "<string>",
"bunkeringLocationCode": "<string>",
"bunkeringLocationName": "<string>",
"portBunkeringLocationCode": "<string>",
"bunkeringLocationDetails": "<string>",
"deliveryMethod": "vessel",
"berthTime": "2023-11-07T05:31:56Z",
"pilotTime": "2023-11-07T05:31:56Z",
"estimatedTimeOfBunkering": "2023-11-07T05:31:56Z",
"estimatedAlongsideTime": "2023-11-07T05:31:56Z",
"laycanStart": "2023-11-07T05:31:56Z",
"laycanEnd": "2023-11-07T05:31:56Z",
"estimatedTimeOfCompletion": "2023-11-07T05:31:56Z",
"estimatedBunkeringDurationInMinutes": 123,
"supplierAssetBufferTimeInMinutes": 123,
"contractReference": "<string>",
"gasUpRequired": true,
"coolDownRequired": true,
"transactionType": "transfer",
"transactionDirection": "in",
"isBestEndeavourBasis": true
},
"supplierCompanyIdentifier": "<string>",
"supplierOrderReference": "<string>",
"supplierInternalReference": "<string>",
"supplierInternalInstructions": "<string>",
"supplierCompanyEntityReference": "<string>",
"supplierCounterpartEntityReference": "<string>",
"supplierAssetIdentifier": {
"vessel": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"terminalName": "<string>"
},
"receiver": {
"orderReference": "<string>",
"vesselIdentifier": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"estimatedTimeOfArrival": "2023-11-07T05:31:56Z",
"estimatedTimeOfDeparture": "2023-11-07T05:31:56Z",
"lastPortCode": "<string>",
"nextPortCode": "<string>",
"nextDestination": "international",
"companyEntityReference": "<string>",
"contactName": "<string>",
"assetOperatorCompanyIdentifier": "<string>"
},
"fuelSpecifications": [
{
"fuelType": "<string>",
"quantityRange": {
"minQuantity": 123,
"maxQuantity": 123,
"unit": "metric_tonnes"
},
"grade": "rma",
"brand": "<string>",
"certificateOfQuality": {
"identifier": "<string>",
"flashPoint": {
"value": "<string>",
"unit": "celsius"
},
"pourPoint": {
"value": 123,
"unit": "celsius"
},
"viscosity": {
"value": 123,
"unit": "celsius"
},
"sulphurContent": {
"value": "<string>",
"unit": "celsius"
},
"density": {
"value": 123,
"unit": "celsius"
},
"waterContent": {
"value": "<string>",
"unit": "celsius"
}
},
"biofuelProperties": {
"typeOfFeedstock": "<string>",
"blendRatio": 123,
"generationCode": "gen1",
"isccCertified": true,
"isccValue": 123,
"certificateScheme": "<string>"
}
}
],
"stakeholders": [
{
"type": "surveyor",
"companyIdentifier": "<string>",
"userEmail": "<string>"
}
]
}
'import requests
url = "https://api.demo.fuelboss.net/v1/nominations/receiver"
payload = {
"clientReference": "<string>",
"delivery": {
"operationStandardCode": "<string>",
"bunkeringLocationCode": "<string>",
"bunkeringLocationName": "<string>",
"portBunkeringLocationCode": "<string>",
"bunkeringLocationDetails": "<string>",
"deliveryMethod": "vessel",
"berthTime": "2023-11-07T05:31:56Z",
"pilotTime": "2023-11-07T05:31:56Z",
"estimatedTimeOfBunkering": "2023-11-07T05:31:56Z",
"estimatedAlongsideTime": "2023-11-07T05:31:56Z",
"laycanStart": "2023-11-07T05:31:56Z",
"laycanEnd": "2023-11-07T05:31:56Z",
"estimatedTimeOfCompletion": "2023-11-07T05:31:56Z",
"estimatedBunkeringDurationInMinutes": 123,
"supplierAssetBufferTimeInMinutes": 123,
"contractReference": "<string>",
"gasUpRequired": True,
"coolDownRequired": True,
"transactionType": "transfer",
"transactionDirection": "in",
"isBestEndeavourBasis": True
},
"supplierCompanyIdentifier": "<string>",
"supplierOrderReference": "<string>",
"supplierInternalReference": "<string>",
"supplierInternalInstructions": "<string>",
"supplierCompanyEntityReference": "<string>",
"supplierCounterpartEntityReference": "<string>",
"supplierAssetIdentifier": {
"vessel": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"terminalName": "<string>"
},
"receiver": {
"orderReference": "<string>",
"vesselIdentifier": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"estimatedTimeOfArrival": "2023-11-07T05:31:56Z",
"estimatedTimeOfDeparture": "2023-11-07T05:31:56Z",
"lastPortCode": "<string>",
"nextPortCode": "<string>",
"nextDestination": "international",
"companyEntityReference": "<string>",
"contactName": "<string>",
"assetOperatorCompanyIdentifier": "<string>"
},
"fuelSpecifications": [
{
"fuelType": "<string>",
"quantityRange": {
"minQuantity": 123,
"maxQuantity": 123,
"unit": "metric_tonnes"
},
"grade": "rma",
"brand": "<string>",
"certificateOfQuality": {
"identifier": "<string>",
"flashPoint": {
"value": "<string>",
"unit": "celsius"
},
"pourPoint": {
"value": 123,
"unit": "celsius"
},
"viscosity": {
"value": 123,
"unit": "celsius"
},
"sulphurContent": {
"value": "<string>",
"unit": "celsius"
},
"density": {
"value": 123,
"unit": "celsius"
},
"waterContent": {
"value": "<string>",
"unit": "celsius"
}
},
"biofuelProperties": {
"typeOfFeedstock": "<string>",
"blendRatio": 123,
"generationCode": "gen1",
"isccCertified": True,
"isccValue": 123,
"certificateScheme": "<string>"
}
}
],
"stakeholders": [
{
"type": "surveyor",
"companyIdentifier": "<string>",
"userEmail": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientReference: '<string>',
delivery: {
operationStandardCode: '<string>',
bunkeringLocationCode: '<string>',
bunkeringLocationName: '<string>',
portBunkeringLocationCode: '<string>',
bunkeringLocationDetails: '<string>',
deliveryMethod: 'vessel',
berthTime: '2023-11-07T05:31:56Z',
pilotTime: '2023-11-07T05:31:56Z',
estimatedTimeOfBunkering: '2023-11-07T05:31:56Z',
estimatedAlongsideTime: '2023-11-07T05:31:56Z',
laycanStart: '2023-11-07T05:31:56Z',
laycanEnd: '2023-11-07T05:31:56Z',
estimatedTimeOfCompletion: '2023-11-07T05:31:56Z',
estimatedBunkeringDurationInMinutes: 123,
supplierAssetBufferTimeInMinutes: 123,
contractReference: '<string>',
gasUpRequired: true,
coolDownRequired: true,
transactionType: 'transfer',
transactionDirection: 'in',
isBestEndeavourBasis: true
},
supplierCompanyIdentifier: '<string>',
supplierOrderReference: '<string>',
supplierInternalReference: '<string>',
supplierInternalInstructions: '<string>',
supplierCompanyEntityReference: '<string>',
supplierCounterpartEntityReference: '<string>',
supplierAssetIdentifier: {
vessel: {imo: 123, mmsi: 123, externalId: '<string>'},
terminalName: '<string>'
},
receiver: {
orderReference: '<string>',
vesselIdentifier: {imo: 123, mmsi: 123, externalId: '<string>'},
estimatedTimeOfArrival: '2023-11-07T05:31:56Z',
estimatedTimeOfDeparture: '2023-11-07T05:31:56Z',
lastPortCode: '<string>',
nextPortCode: '<string>',
nextDestination: 'international',
companyEntityReference: '<string>',
contactName: '<string>',
assetOperatorCompanyIdentifier: '<string>'
},
fuelSpecifications: [
{
fuelType: '<string>',
quantityRange: {minQuantity: 123, maxQuantity: 123, unit: 'metric_tonnes'},
grade: 'rma',
brand: '<string>',
certificateOfQuality: {
identifier: '<string>',
flashPoint: {value: '<string>', unit: 'celsius'},
pourPoint: {value: 123, unit: 'celsius'},
viscosity: {value: 123, unit: 'celsius'},
sulphurContent: {value: '<string>', unit: 'celsius'},
density: {value: 123, unit: 'celsius'},
waterContent: {value: '<string>', unit: 'celsius'}
},
biofuelProperties: {
typeOfFeedstock: '<string>',
blendRatio: 123,
generationCode: 'gen1',
isccCertified: true,
isccValue: 123,
certificateScheme: '<string>'
}
}
],
stakeholders: [{type: 'surveyor', companyIdentifier: '<string>', userEmail: '<string>'}]
})
};
fetch('https://api.demo.fuelboss.net/v1/nominations/receiver', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.demo.fuelboss.net/v1/nominations/receiver",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'clientReference' => '<string>',
'delivery' => [
'operationStandardCode' => '<string>',
'bunkeringLocationCode' => '<string>',
'bunkeringLocationName' => '<string>',
'portBunkeringLocationCode' => '<string>',
'bunkeringLocationDetails' => '<string>',
'deliveryMethod' => 'vessel',
'berthTime' => '2023-11-07T05:31:56Z',
'pilotTime' => '2023-11-07T05:31:56Z',
'estimatedTimeOfBunkering' => '2023-11-07T05:31:56Z',
'estimatedAlongsideTime' => '2023-11-07T05:31:56Z',
'laycanStart' => '2023-11-07T05:31:56Z',
'laycanEnd' => '2023-11-07T05:31:56Z',
'estimatedTimeOfCompletion' => '2023-11-07T05:31:56Z',
'estimatedBunkeringDurationInMinutes' => 123,
'supplierAssetBufferTimeInMinutes' => 123,
'contractReference' => '<string>',
'gasUpRequired' => true,
'coolDownRequired' => true,
'transactionType' => 'transfer',
'transactionDirection' => 'in',
'isBestEndeavourBasis' => true
],
'supplierCompanyIdentifier' => '<string>',
'supplierOrderReference' => '<string>',
'supplierInternalReference' => '<string>',
'supplierInternalInstructions' => '<string>',
'supplierCompanyEntityReference' => '<string>',
'supplierCounterpartEntityReference' => '<string>',
'supplierAssetIdentifier' => [
'vessel' => [
'imo' => 123,
'mmsi' => 123,
'externalId' => '<string>'
],
'terminalName' => '<string>'
],
'receiver' => [
'orderReference' => '<string>',
'vesselIdentifier' => [
'imo' => 123,
'mmsi' => 123,
'externalId' => '<string>'
],
'estimatedTimeOfArrival' => '2023-11-07T05:31:56Z',
'estimatedTimeOfDeparture' => '2023-11-07T05:31:56Z',
'lastPortCode' => '<string>',
'nextPortCode' => '<string>',
'nextDestination' => 'international',
'companyEntityReference' => '<string>',
'contactName' => '<string>',
'assetOperatorCompanyIdentifier' => '<string>'
],
'fuelSpecifications' => [
[
'fuelType' => '<string>',
'quantityRange' => [
'minQuantity' => 123,
'maxQuantity' => 123,
'unit' => 'metric_tonnes'
],
'grade' => 'rma',
'brand' => '<string>',
'certificateOfQuality' => [
'identifier' => '<string>',
'flashPoint' => [
'value' => '<string>',
'unit' => 'celsius'
],
'pourPoint' => [
'value' => 123,
'unit' => 'celsius'
],
'viscosity' => [
'value' => 123,
'unit' => 'celsius'
],
'sulphurContent' => [
'value' => '<string>',
'unit' => 'celsius'
],
'density' => [
'value' => 123,
'unit' => 'celsius'
],
'waterContent' => [
'value' => '<string>',
'unit' => 'celsius'
]
],
'biofuelProperties' => [
'typeOfFeedstock' => '<string>',
'blendRatio' => 123,
'generationCode' => 'gen1',
'isccCertified' => true,
'isccValue' => 123,
'certificateScheme' => '<string>'
]
]
],
'stakeholders' => [
[
'type' => 'surveyor',
'companyIdentifier' => '<string>',
'userEmail' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.demo.fuelboss.net/v1/nominations/receiver"
payload := strings.NewReader("{\n \"clientReference\": \"<string>\",\n \"delivery\": {\n \"operationStandardCode\": \"<string>\",\n \"bunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationName\": \"<string>\",\n \"portBunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationDetails\": \"<string>\",\n \"deliveryMethod\": \"vessel\",\n \"berthTime\": \"2023-11-07T05:31:56Z\",\n \"pilotTime\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfBunkering\": \"2023-11-07T05:31:56Z\",\n \"estimatedAlongsideTime\": \"2023-11-07T05:31:56Z\",\n \"laycanStart\": \"2023-11-07T05:31:56Z\",\n \"laycanEnd\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfCompletion\": \"2023-11-07T05:31:56Z\",\n \"estimatedBunkeringDurationInMinutes\": 123,\n \"supplierAssetBufferTimeInMinutes\": 123,\n \"contractReference\": \"<string>\",\n \"gasUpRequired\": true,\n \"coolDownRequired\": true,\n \"transactionType\": \"transfer\",\n \"transactionDirection\": \"in\",\n \"isBestEndeavourBasis\": true\n },\n \"supplierCompanyIdentifier\": \"<string>\",\n \"supplierOrderReference\": \"<string>\",\n \"supplierInternalReference\": \"<string>\",\n \"supplierInternalInstructions\": \"<string>\",\n \"supplierCompanyEntityReference\": \"<string>\",\n \"supplierCounterpartEntityReference\": \"<string>\",\n \"supplierAssetIdentifier\": {\n \"vessel\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"terminalName\": \"<string>\"\n },\n \"receiver\": {\n \"orderReference\": \"<string>\",\n \"vesselIdentifier\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"estimatedTimeOfArrival\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfDeparture\": \"2023-11-07T05:31:56Z\",\n \"lastPortCode\": \"<string>\",\n \"nextPortCode\": \"<string>\",\n \"nextDestination\": \"international\",\n \"companyEntityReference\": \"<string>\",\n \"contactName\": \"<string>\",\n \"assetOperatorCompanyIdentifier\": \"<string>\"\n },\n \"fuelSpecifications\": [\n {\n \"fuelType\": \"<string>\",\n \"quantityRange\": {\n \"minQuantity\": 123,\n \"maxQuantity\": 123,\n \"unit\": \"metric_tonnes\"\n },\n \"grade\": \"rma\",\n \"brand\": \"<string>\",\n \"certificateOfQuality\": {\n \"identifier\": \"<string>\",\n \"flashPoint\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"pourPoint\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"viscosity\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"sulphurContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"density\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"waterContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n }\n },\n \"biofuelProperties\": {\n \"typeOfFeedstock\": \"<string>\",\n \"blendRatio\": 123,\n \"generationCode\": \"gen1\",\n \"isccCertified\": true,\n \"isccValue\": 123,\n \"certificateScheme\": \"<string>\"\n }\n }\n ],\n \"stakeholders\": [\n {\n \"type\": \"surveyor\",\n \"companyIdentifier\": \"<string>\",\n \"userEmail\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.demo.fuelboss.net/v1/nominations/receiver")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientReference\": \"<string>\",\n \"delivery\": {\n \"operationStandardCode\": \"<string>\",\n \"bunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationName\": \"<string>\",\n \"portBunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationDetails\": \"<string>\",\n \"deliveryMethod\": \"vessel\",\n \"berthTime\": \"2023-11-07T05:31:56Z\",\n \"pilotTime\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfBunkering\": \"2023-11-07T05:31:56Z\",\n \"estimatedAlongsideTime\": \"2023-11-07T05:31:56Z\",\n \"laycanStart\": \"2023-11-07T05:31:56Z\",\n \"laycanEnd\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfCompletion\": \"2023-11-07T05:31:56Z\",\n \"estimatedBunkeringDurationInMinutes\": 123,\n \"supplierAssetBufferTimeInMinutes\": 123,\n \"contractReference\": \"<string>\",\n \"gasUpRequired\": true,\n \"coolDownRequired\": true,\n \"transactionType\": \"transfer\",\n \"transactionDirection\": \"in\",\n \"isBestEndeavourBasis\": true\n },\n \"supplierCompanyIdentifier\": \"<string>\",\n \"supplierOrderReference\": \"<string>\",\n \"supplierInternalReference\": \"<string>\",\n \"supplierInternalInstructions\": \"<string>\",\n \"supplierCompanyEntityReference\": \"<string>\",\n \"supplierCounterpartEntityReference\": \"<string>\",\n \"supplierAssetIdentifier\": {\n \"vessel\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"terminalName\": \"<string>\"\n },\n \"receiver\": {\n \"orderReference\": \"<string>\",\n \"vesselIdentifier\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"estimatedTimeOfArrival\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfDeparture\": \"2023-11-07T05:31:56Z\",\n \"lastPortCode\": \"<string>\",\n \"nextPortCode\": \"<string>\",\n \"nextDestination\": \"international\",\n \"companyEntityReference\": \"<string>\",\n \"contactName\": \"<string>\",\n \"assetOperatorCompanyIdentifier\": \"<string>\"\n },\n \"fuelSpecifications\": [\n {\n \"fuelType\": \"<string>\",\n \"quantityRange\": {\n \"minQuantity\": 123,\n \"maxQuantity\": 123,\n \"unit\": \"metric_tonnes\"\n },\n \"grade\": \"rma\",\n \"brand\": \"<string>\",\n \"certificateOfQuality\": {\n \"identifier\": \"<string>\",\n \"flashPoint\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"pourPoint\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"viscosity\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"sulphurContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"density\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"waterContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n }\n },\n \"biofuelProperties\": {\n \"typeOfFeedstock\": \"<string>\",\n \"blendRatio\": 123,\n \"generationCode\": \"gen1\",\n \"isccCertified\": true,\n \"isccValue\": 123,\n \"certificateScheme\": \"<string>\"\n }\n }\n ],\n \"stakeholders\": [\n {\n \"type\": \"surveyor\",\n \"companyIdentifier\": \"<string>\",\n \"userEmail\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.demo.fuelboss.net/v1/nominations/receiver")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientReference\": \"<string>\",\n \"delivery\": {\n \"operationStandardCode\": \"<string>\",\n \"bunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationName\": \"<string>\",\n \"portBunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationDetails\": \"<string>\",\n \"deliveryMethod\": \"vessel\",\n \"berthTime\": \"2023-11-07T05:31:56Z\",\n \"pilotTime\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfBunkering\": \"2023-11-07T05:31:56Z\",\n \"estimatedAlongsideTime\": \"2023-11-07T05:31:56Z\",\n \"laycanStart\": \"2023-11-07T05:31:56Z\",\n \"laycanEnd\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfCompletion\": \"2023-11-07T05:31:56Z\",\n \"estimatedBunkeringDurationInMinutes\": 123,\n \"supplierAssetBufferTimeInMinutes\": 123,\n \"contractReference\": \"<string>\",\n \"gasUpRequired\": true,\n \"coolDownRequired\": true,\n \"transactionType\": \"transfer\",\n \"transactionDirection\": \"in\",\n \"isBestEndeavourBasis\": true\n },\n \"supplierCompanyIdentifier\": \"<string>\",\n \"supplierOrderReference\": \"<string>\",\n \"supplierInternalReference\": \"<string>\",\n \"supplierInternalInstructions\": \"<string>\",\n \"supplierCompanyEntityReference\": \"<string>\",\n \"supplierCounterpartEntityReference\": \"<string>\",\n \"supplierAssetIdentifier\": {\n \"vessel\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"terminalName\": \"<string>\"\n },\n \"receiver\": {\n \"orderReference\": \"<string>\",\n \"vesselIdentifier\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"estimatedTimeOfArrival\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfDeparture\": \"2023-11-07T05:31:56Z\",\n \"lastPortCode\": \"<string>\",\n \"nextPortCode\": \"<string>\",\n \"nextDestination\": \"international\",\n \"companyEntityReference\": \"<string>\",\n \"contactName\": \"<string>\",\n \"assetOperatorCompanyIdentifier\": \"<string>\"\n },\n \"fuelSpecifications\": [\n {\n \"fuelType\": \"<string>\",\n \"quantityRange\": {\n \"minQuantity\": 123,\n \"maxQuantity\": 123,\n \"unit\": \"metric_tonnes\"\n },\n \"grade\": \"rma\",\n \"brand\": \"<string>\",\n \"certificateOfQuality\": {\n \"identifier\": \"<string>\",\n \"flashPoint\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"pourPoint\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"viscosity\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"sulphurContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"density\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"waterContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n }\n },\n \"biofuelProperties\": {\n \"typeOfFeedstock\": \"<string>\",\n \"blendRatio\": 123,\n \"generationCode\": \"gen1\",\n \"isccCertified\": true,\n \"isccValue\": 123,\n \"certificateScheme\": \"<string>\"\n }\n }\n ],\n \"stakeholders\": [\n {\n \"type\": \"surveyor\",\n \"companyIdentifier\": \"<string>\",\n \"userEmail\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"clientReference": "<string>",
"status": "supplier_requested",
"lastChangedAtUtc": "2023-11-07T05:31:56Z"
}{
"clientReference": "<string>",
"status": "supplier_requested",
"lastChangedAtUtc": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}Nominations
Creates or updates a nomination as a receiver
Creates a new nomination or updates an existing one based on the client reference. Uses idempotency to prevent duplicate submissions
PUT
/
v1
/
nominations
/
receiver
Creates or updates a nomination as a receiver
curl --request PUT \
--url https://api.demo.fuelboss.net/v1/nominations/receiver \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientReference": "<string>",
"delivery": {
"operationStandardCode": "<string>",
"bunkeringLocationCode": "<string>",
"bunkeringLocationName": "<string>",
"portBunkeringLocationCode": "<string>",
"bunkeringLocationDetails": "<string>",
"deliveryMethod": "vessel",
"berthTime": "2023-11-07T05:31:56Z",
"pilotTime": "2023-11-07T05:31:56Z",
"estimatedTimeOfBunkering": "2023-11-07T05:31:56Z",
"estimatedAlongsideTime": "2023-11-07T05:31:56Z",
"laycanStart": "2023-11-07T05:31:56Z",
"laycanEnd": "2023-11-07T05:31:56Z",
"estimatedTimeOfCompletion": "2023-11-07T05:31:56Z",
"estimatedBunkeringDurationInMinutes": 123,
"supplierAssetBufferTimeInMinutes": 123,
"contractReference": "<string>",
"gasUpRequired": true,
"coolDownRequired": true,
"transactionType": "transfer",
"transactionDirection": "in",
"isBestEndeavourBasis": true
},
"supplierCompanyIdentifier": "<string>",
"supplierOrderReference": "<string>",
"supplierInternalReference": "<string>",
"supplierInternalInstructions": "<string>",
"supplierCompanyEntityReference": "<string>",
"supplierCounterpartEntityReference": "<string>",
"supplierAssetIdentifier": {
"vessel": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"terminalName": "<string>"
},
"receiver": {
"orderReference": "<string>",
"vesselIdentifier": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"estimatedTimeOfArrival": "2023-11-07T05:31:56Z",
"estimatedTimeOfDeparture": "2023-11-07T05:31:56Z",
"lastPortCode": "<string>",
"nextPortCode": "<string>",
"nextDestination": "international",
"companyEntityReference": "<string>",
"contactName": "<string>",
"assetOperatorCompanyIdentifier": "<string>"
},
"fuelSpecifications": [
{
"fuelType": "<string>",
"quantityRange": {
"minQuantity": 123,
"maxQuantity": 123,
"unit": "metric_tonnes"
},
"grade": "rma",
"brand": "<string>",
"certificateOfQuality": {
"identifier": "<string>",
"flashPoint": {
"value": "<string>",
"unit": "celsius"
},
"pourPoint": {
"value": 123,
"unit": "celsius"
},
"viscosity": {
"value": 123,
"unit": "celsius"
},
"sulphurContent": {
"value": "<string>",
"unit": "celsius"
},
"density": {
"value": 123,
"unit": "celsius"
},
"waterContent": {
"value": "<string>",
"unit": "celsius"
}
},
"biofuelProperties": {
"typeOfFeedstock": "<string>",
"blendRatio": 123,
"generationCode": "gen1",
"isccCertified": true,
"isccValue": 123,
"certificateScheme": "<string>"
}
}
],
"stakeholders": [
{
"type": "surveyor",
"companyIdentifier": "<string>",
"userEmail": "<string>"
}
]
}
'import requests
url = "https://api.demo.fuelboss.net/v1/nominations/receiver"
payload = {
"clientReference": "<string>",
"delivery": {
"operationStandardCode": "<string>",
"bunkeringLocationCode": "<string>",
"bunkeringLocationName": "<string>",
"portBunkeringLocationCode": "<string>",
"bunkeringLocationDetails": "<string>",
"deliveryMethod": "vessel",
"berthTime": "2023-11-07T05:31:56Z",
"pilotTime": "2023-11-07T05:31:56Z",
"estimatedTimeOfBunkering": "2023-11-07T05:31:56Z",
"estimatedAlongsideTime": "2023-11-07T05:31:56Z",
"laycanStart": "2023-11-07T05:31:56Z",
"laycanEnd": "2023-11-07T05:31:56Z",
"estimatedTimeOfCompletion": "2023-11-07T05:31:56Z",
"estimatedBunkeringDurationInMinutes": 123,
"supplierAssetBufferTimeInMinutes": 123,
"contractReference": "<string>",
"gasUpRequired": True,
"coolDownRequired": True,
"transactionType": "transfer",
"transactionDirection": "in",
"isBestEndeavourBasis": True
},
"supplierCompanyIdentifier": "<string>",
"supplierOrderReference": "<string>",
"supplierInternalReference": "<string>",
"supplierInternalInstructions": "<string>",
"supplierCompanyEntityReference": "<string>",
"supplierCounterpartEntityReference": "<string>",
"supplierAssetIdentifier": {
"vessel": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"terminalName": "<string>"
},
"receiver": {
"orderReference": "<string>",
"vesselIdentifier": {
"imo": 123,
"mmsi": 123,
"externalId": "<string>"
},
"estimatedTimeOfArrival": "2023-11-07T05:31:56Z",
"estimatedTimeOfDeparture": "2023-11-07T05:31:56Z",
"lastPortCode": "<string>",
"nextPortCode": "<string>",
"nextDestination": "international",
"companyEntityReference": "<string>",
"contactName": "<string>",
"assetOperatorCompanyIdentifier": "<string>"
},
"fuelSpecifications": [
{
"fuelType": "<string>",
"quantityRange": {
"minQuantity": 123,
"maxQuantity": 123,
"unit": "metric_tonnes"
},
"grade": "rma",
"brand": "<string>",
"certificateOfQuality": {
"identifier": "<string>",
"flashPoint": {
"value": "<string>",
"unit": "celsius"
},
"pourPoint": {
"value": 123,
"unit": "celsius"
},
"viscosity": {
"value": 123,
"unit": "celsius"
},
"sulphurContent": {
"value": "<string>",
"unit": "celsius"
},
"density": {
"value": 123,
"unit": "celsius"
},
"waterContent": {
"value": "<string>",
"unit": "celsius"
}
},
"biofuelProperties": {
"typeOfFeedstock": "<string>",
"blendRatio": 123,
"generationCode": "gen1",
"isccCertified": True,
"isccValue": 123,
"certificateScheme": "<string>"
}
}
],
"stakeholders": [
{
"type": "surveyor",
"companyIdentifier": "<string>",
"userEmail": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientReference: '<string>',
delivery: {
operationStandardCode: '<string>',
bunkeringLocationCode: '<string>',
bunkeringLocationName: '<string>',
portBunkeringLocationCode: '<string>',
bunkeringLocationDetails: '<string>',
deliveryMethod: 'vessel',
berthTime: '2023-11-07T05:31:56Z',
pilotTime: '2023-11-07T05:31:56Z',
estimatedTimeOfBunkering: '2023-11-07T05:31:56Z',
estimatedAlongsideTime: '2023-11-07T05:31:56Z',
laycanStart: '2023-11-07T05:31:56Z',
laycanEnd: '2023-11-07T05:31:56Z',
estimatedTimeOfCompletion: '2023-11-07T05:31:56Z',
estimatedBunkeringDurationInMinutes: 123,
supplierAssetBufferTimeInMinutes: 123,
contractReference: '<string>',
gasUpRequired: true,
coolDownRequired: true,
transactionType: 'transfer',
transactionDirection: 'in',
isBestEndeavourBasis: true
},
supplierCompanyIdentifier: '<string>',
supplierOrderReference: '<string>',
supplierInternalReference: '<string>',
supplierInternalInstructions: '<string>',
supplierCompanyEntityReference: '<string>',
supplierCounterpartEntityReference: '<string>',
supplierAssetIdentifier: {
vessel: {imo: 123, mmsi: 123, externalId: '<string>'},
terminalName: '<string>'
},
receiver: {
orderReference: '<string>',
vesselIdentifier: {imo: 123, mmsi: 123, externalId: '<string>'},
estimatedTimeOfArrival: '2023-11-07T05:31:56Z',
estimatedTimeOfDeparture: '2023-11-07T05:31:56Z',
lastPortCode: '<string>',
nextPortCode: '<string>',
nextDestination: 'international',
companyEntityReference: '<string>',
contactName: '<string>',
assetOperatorCompanyIdentifier: '<string>'
},
fuelSpecifications: [
{
fuelType: '<string>',
quantityRange: {minQuantity: 123, maxQuantity: 123, unit: 'metric_tonnes'},
grade: 'rma',
brand: '<string>',
certificateOfQuality: {
identifier: '<string>',
flashPoint: {value: '<string>', unit: 'celsius'},
pourPoint: {value: 123, unit: 'celsius'},
viscosity: {value: 123, unit: 'celsius'},
sulphurContent: {value: '<string>', unit: 'celsius'},
density: {value: 123, unit: 'celsius'},
waterContent: {value: '<string>', unit: 'celsius'}
},
biofuelProperties: {
typeOfFeedstock: '<string>',
blendRatio: 123,
generationCode: 'gen1',
isccCertified: true,
isccValue: 123,
certificateScheme: '<string>'
}
}
],
stakeholders: [{type: 'surveyor', companyIdentifier: '<string>', userEmail: '<string>'}]
})
};
fetch('https://api.demo.fuelboss.net/v1/nominations/receiver', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.demo.fuelboss.net/v1/nominations/receiver",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'clientReference' => '<string>',
'delivery' => [
'operationStandardCode' => '<string>',
'bunkeringLocationCode' => '<string>',
'bunkeringLocationName' => '<string>',
'portBunkeringLocationCode' => '<string>',
'bunkeringLocationDetails' => '<string>',
'deliveryMethod' => 'vessel',
'berthTime' => '2023-11-07T05:31:56Z',
'pilotTime' => '2023-11-07T05:31:56Z',
'estimatedTimeOfBunkering' => '2023-11-07T05:31:56Z',
'estimatedAlongsideTime' => '2023-11-07T05:31:56Z',
'laycanStart' => '2023-11-07T05:31:56Z',
'laycanEnd' => '2023-11-07T05:31:56Z',
'estimatedTimeOfCompletion' => '2023-11-07T05:31:56Z',
'estimatedBunkeringDurationInMinutes' => 123,
'supplierAssetBufferTimeInMinutes' => 123,
'contractReference' => '<string>',
'gasUpRequired' => true,
'coolDownRequired' => true,
'transactionType' => 'transfer',
'transactionDirection' => 'in',
'isBestEndeavourBasis' => true
],
'supplierCompanyIdentifier' => '<string>',
'supplierOrderReference' => '<string>',
'supplierInternalReference' => '<string>',
'supplierInternalInstructions' => '<string>',
'supplierCompanyEntityReference' => '<string>',
'supplierCounterpartEntityReference' => '<string>',
'supplierAssetIdentifier' => [
'vessel' => [
'imo' => 123,
'mmsi' => 123,
'externalId' => '<string>'
],
'terminalName' => '<string>'
],
'receiver' => [
'orderReference' => '<string>',
'vesselIdentifier' => [
'imo' => 123,
'mmsi' => 123,
'externalId' => '<string>'
],
'estimatedTimeOfArrival' => '2023-11-07T05:31:56Z',
'estimatedTimeOfDeparture' => '2023-11-07T05:31:56Z',
'lastPortCode' => '<string>',
'nextPortCode' => '<string>',
'nextDestination' => 'international',
'companyEntityReference' => '<string>',
'contactName' => '<string>',
'assetOperatorCompanyIdentifier' => '<string>'
],
'fuelSpecifications' => [
[
'fuelType' => '<string>',
'quantityRange' => [
'minQuantity' => 123,
'maxQuantity' => 123,
'unit' => 'metric_tonnes'
],
'grade' => 'rma',
'brand' => '<string>',
'certificateOfQuality' => [
'identifier' => '<string>',
'flashPoint' => [
'value' => '<string>',
'unit' => 'celsius'
],
'pourPoint' => [
'value' => 123,
'unit' => 'celsius'
],
'viscosity' => [
'value' => 123,
'unit' => 'celsius'
],
'sulphurContent' => [
'value' => '<string>',
'unit' => 'celsius'
],
'density' => [
'value' => 123,
'unit' => 'celsius'
],
'waterContent' => [
'value' => '<string>',
'unit' => 'celsius'
]
],
'biofuelProperties' => [
'typeOfFeedstock' => '<string>',
'blendRatio' => 123,
'generationCode' => 'gen1',
'isccCertified' => true,
'isccValue' => 123,
'certificateScheme' => '<string>'
]
]
],
'stakeholders' => [
[
'type' => 'surveyor',
'companyIdentifier' => '<string>',
'userEmail' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.demo.fuelboss.net/v1/nominations/receiver"
payload := strings.NewReader("{\n \"clientReference\": \"<string>\",\n \"delivery\": {\n \"operationStandardCode\": \"<string>\",\n \"bunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationName\": \"<string>\",\n \"portBunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationDetails\": \"<string>\",\n \"deliveryMethod\": \"vessel\",\n \"berthTime\": \"2023-11-07T05:31:56Z\",\n \"pilotTime\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfBunkering\": \"2023-11-07T05:31:56Z\",\n \"estimatedAlongsideTime\": \"2023-11-07T05:31:56Z\",\n \"laycanStart\": \"2023-11-07T05:31:56Z\",\n \"laycanEnd\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfCompletion\": \"2023-11-07T05:31:56Z\",\n \"estimatedBunkeringDurationInMinutes\": 123,\n \"supplierAssetBufferTimeInMinutes\": 123,\n \"contractReference\": \"<string>\",\n \"gasUpRequired\": true,\n \"coolDownRequired\": true,\n \"transactionType\": \"transfer\",\n \"transactionDirection\": \"in\",\n \"isBestEndeavourBasis\": true\n },\n \"supplierCompanyIdentifier\": \"<string>\",\n \"supplierOrderReference\": \"<string>\",\n \"supplierInternalReference\": \"<string>\",\n \"supplierInternalInstructions\": \"<string>\",\n \"supplierCompanyEntityReference\": \"<string>\",\n \"supplierCounterpartEntityReference\": \"<string>\",\n \"supplierAssetIdentifier\": {\n \"vessel\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"terminalName\": \"<string>\"\n },\n \"receiver\": {\n \"orderReference\": \"<string>\",\n \"vesselIdentifier\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"estimatedTimeOfArrival\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfDeparture\": \"2023-11-07T05:31:56Z\",\n \"lastPortCode\": \"<string>\",\n \"nextPortCode\": \"<string>\",\n \"nextDestination\": \"international\",\n \"companyEntityReference\": \"<string>\",\n \"contactName\": \"<string>\",\n \"assetOperatorCompanyIdentifier\": \"<string>\"\n },\n \"fuelSpecifications\": [\n {\n \"fuelType\": \"<string>\",\n \"quantityRange\": {\n \"minQuantity\": 123,\n \"maxQuantity\": 123,\n \"unit\": \"metric_tonnes\"\n },\n \"grade\": \"rma\",\n \"brand\": \"<string>\",\n \"certificateOfQuality\": {\n \"identifier\": \"<string>\",\n \"flashPoint\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"pourPoint\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"viscosity\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"sulphurContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"density\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"waterContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n }\n },\n \"biofuelProperties\": {\n \"typeOfFeedstock\": \"<string>\",\n \"blendRatio\": 123,\n \"generationCode\": \"gen1\",\n \"isccCertified\": true,\n \"isccValue\": 123,\n \"certificateScheme\": \"<string>\"\n }\n }\n ],\n \"stakeholders\": [\n {\n \"type\": \"surveyor\",\n \"companyIdentifier\": \"<string>\",\n \"userEmail\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.demo.fuelboss.net/v1/nominations/receiver")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientReference\": \"<string>\",\n \"delivery\": {\n \"operationStandardCode\": \"<string>\",\n \"bunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationName\": \"<string>\",\n \"portBunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationDetails\": \"<string>\",\n \"deliveryMethod\": \"vessel\",\n \"berthTime\": \"2023-11-07T05:31:56Z\",\n \"pilotTime\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfBunkering\": \"2023-11-07T05:31:56Z\",\n \"estimatedAlongsideTime\": \"2023-11-07T05:31:56Z\",\n \"laycanStart\": \"2023-11-07T05:31:56Z\",\n \"laycanEnd\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfCompletion\": \"2023-11-07T05:31:56Z\",\n \"estimatedBunkeringDurationInMinutes\": 123,\n \"supplierAssetBufferTimeInMinutes\": 123,\n \"contractReference\": \"<string>\",\n \"gasUpRequired\": true,\n \"coolDownRequired\": true,\n \"transactionType\": \"transfer\",\n \"transactionDirection\": \"in\",\n \"isBestEndeavourBasis\": true\n },\n \"supplierCompanyIdentifier\": \"<string>\",\n \"supplierOrderReference\": \"<string>\",\n \"supplierInternalReference\": \"<string>\",\n \"supplierInternalInstructions\": \"<string>\",\n \"supplierCompanyEntityReference\": \"<string>\",\n \"supplierCounterpartEntityReference\": \"<string>\",\n \"supplierAssetIdentifier\": {\n \"vessel\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"terminalName\": \"<string>\"\n },\n \"receiver\": {\n \"orderReference\": \"<string>\",\n \"vesselIdentifier\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"estimatedTimeOfArrival\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfDeparture\": \"2023-11-07T05:31:56Z\",\n \"lastPortCode\": \"<string>\",\n \"nextPortCode\": \"<string>\",\n \"nextDestination\": \"international\",\n \"companyEntityReference\": \"<string>\",\n \"contactName\": \"<string>\",\n \"assetOperatorCompanyIdentifier\": \"<string>\"\n },\n \"fuelSpecifications\": [\n {\n \"fuelType\": \"<string>\",\n \"quantityRange\": {\n \"minQuantity\": 123,\n \"maxQuantity\": 123,\n \"unit\": \"metric_tonnes\"\n },\n \"grade\": \"rma\",\n \"brand\": \"<string>\",\n \"certificateOfQuality\": {\n \"identifier\": \"<string>\",\n \"flashPoint\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"pourPoint\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"viscosity\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"sulphurContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"density\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"waterContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n }\n },\n \"biofuelProperties\": {\n \"typeOfFeedstock\": \"<string>\",\n \"blendRatio\": 123,\n \"generationCode\": \"gen1\",\n \"isccCertified\": true,\n \"isccValue\": 123,\n \"certificateScheme\": \"<string>\"\n }\n }\n ],\n \"stakeholders\": [\n {\n \"type\": \"surveyor\",\n \"companyIdentifier\": \"<string>\",\n \"userEmail\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.demo.fuelboss.net/v1/nominations/receiver")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientReference\": \"<string>\",\n \"delivery\": {\n \"operationStandardCode\": \"<string>\",\n \"bunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationName\": \"<string>\",\n \"portBunkeringLocationCode\": \"<string>\",\n \"bunkeringLocationDetails\": \"<string>\",\n \"deliveryMethod\": \"vessel\",\n \"berthTime\": \"2023-11-07T05:31:56Z\",\n \"pilotTime\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfBunkering\": \"2023-11-07T05:31:56Z\",\n \"estimatedAlongsideTime\": \"2023-11-07T05:31:56Z\",\n \"laycanStart\": \"2023-11-07T05:31:56Z\",\n \"laycanEnd\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfCompletion\": \"2023-11-07T05:31:56Z\",\n \"estimatedBunkeringDurationInMinutes\": 123,\n \"supplierAssetBufferTimeInMinutes\": 123,\n \"contractReference\": \"<string>\",\n \"gasUpRequired\": true,\n \"coolDownRequired\": true,\n \"transactionType\": \"transfer\",\n \"transactionDirection\": \"in\",\n \"isBestEndeavourBasis\": true\n },\n \"supplierCompanyIdentifier\": \"<string>\",\n \"supplierOrderReference\": \"<string>\",\n \"supplierInternalReference\": \"<string>\",\n \"supplierInternalInstructions\": \"<string>\",\n \"supplierCompanyEntityReference\": \"<string>\",\n \"supplierCounterpartEntityReference\": \"<string>\",\n \"supplierAssetIdentifier\": {\n \"vessel\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"terminalName\": \"<string>\"\n },\n \"receiver\": {\n \"orderReference\": \"<string>\",\n \"vesselIdentifier\": {\n \"imo\": 123,\n \"mmsi\": 123,\n \"externalId\": \"<string>\"\n },\n \"estimatedTimeOfArrival\": \"2023-11-07T05:31:56Z\",\n \"estimatedTimeOfDeparture\": \"2023-11-07T05:31:56Z\",\n \"lastPortCode\": \"<string>\",\n \"nextPortCode\": \"<string>\",\n \"nextDestination\": \"international\",\n \"companyEntityReference\": \"<string>\",\n \"contactName\": \"<string>\",\n \"assetOperatorCompanyIdentifier\": \"<string>\"\n },\n \"fuelSpecifications\": [\n {\n \"fuelType\": \"<string>\",\n \"quantityRange\": {\n \"minQuantity\": 123,\n \"maxQuantity\": 123,\n \"unit\": \"metric_tonnes\"\n },\n \"grade\": \"rma\",\n \"brand\": \"<string>\",\n \"certificateOfQuality\": {\n \"identifier\": \"<string>\",\n \"flashPoint\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"pourPoint\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"viscosity\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"sulphurContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n },\n \"density\": {\n \"value\": 123,\n \"unit\": \"celsius\"\n },\n \"waterContent\": {\n \"value\": \"<string>\",\n \"unit\": \"celsius\"\n }\n },\n \"biofuelProperties\": {\n \"typeOfFeedstock\": \"<string>\",\n \"blendRatio\": 123,\n \"generationCode\": \"gen1\",\n \"isccCertified\": true,\n \"isccValue\": 123,\n \"certificateScheme\": \"<string>\"\n }\n }\n ],\n \"stakeholders\": [\n {\n \"type\": \"surveyor\",\n \"companyIdentifier\": \"<string>\",\n \"userEmail\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"clientReference": "<string>",
"status": "supplier_requested",
"lastChangedAtUtc": "2023-11-07T05:31:56Z"
}{
"clientReference": "<string>",
"status": "supplier_requested",
"lastChangedAtUtc": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"trace_id": "<string>"
}Authorizations
Access token obtained from the /oauth/token endpoint using your client credentials.
Body
application/json
Request body for creating or updating a nomination as a receiver company.
Your unique identifier for the nomination within your company, used to reference the nomination in all subsequent calls.
Delivery information.
Show child attributes
Show child attributes
Supplier company identifier (from Get Companies). May be omitted only for Singapore transfer nominations, in which case your own company is used as the supplier.
Order reference for the supplier.
Internal reference for the supplier.
Internal instructions for the supplier.
Supplier company entity reference (from Get Company Entities). Only applied for loading or transfer operations where the receiver and supplier are the same company; ignored otherwise.
Supplier counterpart entity reference (from Get Counterpart Entities). Only applied for loading or transfer operations where the supplier and receiver are different companies; ignored otherwise.
Supplier asset performing the delivery, identified consistently with the delivery method (Vessel uses vessel; Terminal/Truck uses terminalName).
Applied for loading and transfer operations. For loading operations the asset must be a terminal (provide terminalName).
Show child attributes
Show child attributes
Receiver information.
Show child attributes
Show child attributes
Fuel specifications for the nomination.
Show child attributes
Show child attributes
Stakeholders involved in the nomination.
Show child attributes
Show child attributes
Response
OK
Response returned after creating or updating a nomination as a receiver company.
Your unique identifier for the nomination within your company.
Status of the nomination after the operation.
Possible values:
supplier_requested— Supplier has been requested for this nomination.supplier_unassigned— Nomination has no supplier assigned.supplier_assigned— Supplier has been assigned to the nomination.operation_started— Bunkering operation has started.cancelled— Nomination has been cancelled.accepted— Nomination has been accepted by the supplier.amended— Nomination has been amended. Not currently returned as a nomination's current status; accept it for forward compatibility.
Available options:
supplier_requested, supplier_unassigned, supplier_assigned, operation_started, cancelled, accepted, amended Example:
"supplier_requested"
UTC timestamp of the last change to the nomination.