Skip to main content
All notable changes to the FuelBoss API. For the versioning policy and deprecation timelines, see Versioning.
​
October 8, 2026
Creates a webhook subscription now returns the subscription’s signing secret in the 201 response: the value you supplied, or the one FuelBoss generated when secret was omitted. Previously a generated secret was never returned, so deliveries to such subscriptions could not have their X-Webhook-Signature verified. The secret is returned only in this response and cannot be retrieved later; Retrieves all webhook subscriptions continues to omit it. The field is additive — existing integrations are unaffected. Subscriptions created without a secret before this release must be deleted and re-created to obtain one.
​
September 30, 2026
  • Made the receiver company optional for Singapore transfer nominations on Creates or updates a nomination as a supplier. When the transaction type is Transfer, both companyIdentifier and companyName in receiver may be omitted, in which case your own company is used as the receiver. For all other nominations the receiver company remains required and omitting it returns 422 Unprocessable Content. Existing integrations are unaffected.
  • Made supplierCompanyIdentifier optional for Singapore transfer nominations on Creates or updates a nomination as a receiver. When the transaction type is Transfer, it may be omitted, in which case your own company is used as the supplier. For all other nominations it remains required and omitting it returns 422 Unprocessable Content. Existing integrations are unaffected.
​
September 28, 2026
  • Added quantityReceived to the conventional BDN in Retrieves a specific operation and Lists operations sharing a client reference responses. It carries the quantity stated on the loading document (CQ, BL or BDN), so it can be reconciled against quantityDelivered, which reflects the metered quantity. It is only applicable to loading operations and Singapore transfer operations; it is omitted otherwise. The field is additive — existing integrations are unaffected.
​
September 25, 2026
  • Added optional assetOperatorCompanyIdentifier to the receiver details of the Creates or updates a nomination as a receiver request. It appoints a company as the receiver’s asset operator for the nomination, granting it the same view and edit access as the receiver company. Only the receiver can set their own asset operator. The field is additive — existing integrations are unaffected.
  • Added assetOperatorCompanyIdentifier to the receiver details of Get nomination, returned only when the caller is on the receiver’s side of the nomination. The field is additive — existing integrations are unaffected.
  • The supplier’s assetOperatorCompanyIdentifier in the Get nomination response is now returned only when the caller is on the supplier’s side of the nomination.
​
September 22, 2026
Added optional supplierOrderReference and supplierInternalInstructions to the Creates or updates a nomination as a receiver request. Both were previously only available when nominating as a supplier, so values sent on this endpoint were not stored. They are returned in the supplier details of Get nomination. The fields are additive — existing integrations are unaffected.
​
September 17, 2026
  • Added transactionType to Retrieves a specific operation and Lists operations sharing a client reference responses. It distinguishes a transfer from a cargo movement and is only applicable when the operation’s operationStandardCode is of type Transfer; it is omitted otherwise. The field is additive — existing integrations are unaffected.
  • Added loadingNumber to Retrieves a specific operation and Lists operations sharing a client reference responses. It carries the reference number of the loading document (CQ, BL or BDN) and is only applicable to loading operations; it is omitted otherwise. The field is additive — existing integrations are unaffected.
  • Behaviour change: on Creates or updates a draft nomination, fuelSpecifications[].fuelType, fuelSpecifications[].grade and fuelSpecifications[].brand are filled in from your company’s configured fuel brand mapping when you leave them unset. Supplying only a mapped brand fills the matching fuelType and grade; supplying fuelType and grade fills the configured brand. Values you send are never overwritten, and a value that disagrees with the mapping leaves the remaining fields unset rather than failing. Nothing is filled in when your company has fuel configuration switched off, when the brand matches no mapping, or when the mapped fuel type is not valid for the operation standard. No request or response fields change — drafts that already send these fields are unaffected.
​
September 15, 2026
Added optional estimatedAlongsideTime to the delivery details of Creates or updates a nomination as a supplier, Creates or updates a nomination as a receiver and Creates or updates a draft nomination requests, returned in the delivery details of Get nomination, Get nominations by client reference and Get draft nominations responses. It records the estimated time the supplying asset is alongside, in port local time. The field is only accepted when your company has the Estimated Alongside Time field enabled; sending a value while it is disabled returns a 422 Unprocessable Content response. Omitting the field or sending null leaves it unset. The field is additive — existing integrations are unaffected.
​
September 14, 2026
Added optional contactName to the receiver section of Creates or updates a nomination as a supplier, Creates or updates a nomination as a receiver and Creates or updates a draft nomination requests. It records the trader or customer contact for the receiver company, and is returned in the receiver section of Get nomination, Get nominations by client reference and Get draft nominations responses. Omitting the field, or sending null or an empty string, leaves it unset. The field is additive — existing integrations are unaffected.
​
September 11, 2026
  • Added optional supplierAssetIdentifier to Creates or updates a nomination as a receiver requests, letting the receiver set the supplier’s delivery asset. It identifies the asset consistently with the delivery method — a vessel for vessel deliveries or a terminalName for terminal or truck deliveries — and is applied on loading and transfer operations; on loading operations the asset must be a terminal. The field is additive — existing integrations are unaffected.
  • On Creates or updates a nomination as a receiver, the supplierCompanyEntityReference, supplierCounterpartEntityReference and receiver companyEntityReference fields now also apply to transfer operations. Previously they applied only to loading operations and were ignored on transfers; on transfer nominations they now take effect and must reference active entities.
​
September 10, 2026
  • Added Get operations by client reference (GET /v1/operations/{clientReference}/all). It returns every operation with the given client reference that your company can access, most recently changed first, in the same shape as Get operation. Use it to disambiguate when a single read returns 422.
  • Get operation, Get operation document and Get merged operation documents now return operations where your company is the receiver as well as those where it is the supplier. Previously the receiver received a 404. A company that is neither supplier nor receiver still receives a 404.
  • Behaviour change: the same three endpoints now return 422 when more than one accessible operation shares the client reference, instead of returning an arbitrary match. The problem details point to GET /v1/operations/{clientReference}/all. Clients that only handle 200 and 404 on these endpoints should handle 422.
​
September 4, 2026
  • Added optional supplierCounterpartEntityReference to Creates or updates a nomination as a receiver requests, applied on loading operations where the supplier and receiver are different companies. The resolved entity is returned read-only as counterpartEntityReference in the supplier details on Get nomination and Get nominations by client reference responses. The field is additive — existing integrations are unaffected.
  • On Creates or updates a nomination as a receiver, the receiver companyEntityReference is now applied to all loading operations. Previously it was applied only when the supplier and receiver were the same company; it is now applied on cross-company loading operations and must reference an active entity.
  • Creates a webhook subscription now rejects URLs that target or resolve to internal, loopback, or link-local addresses with a 400. The same restriction is enforced at delivery time — deliveries to endpoints that resolve to such addresses are refused, and HTTP redirects from the endpoint are no longer followed.
​
August 31, 2026
  • Added optional version to Creates a webhook subscription requests, and to that endpoint’s response and Retrieves all webhook subscriptions responses, reflecting the payload schema version a subscription is pinned to. Omitted on create, it defaults to 1, the only version currently supported; an unsupported value returns a 400 listing the supported versions. The field is additive — existing subscriptions default to 1 and are unaffected.
  • Added dataschema to every webhook delivery envelope, identifying the event type and payload version of that delivery (for example https://docs.ofiniti.com/api-reference/webhooks/v1/nomination_created). The field is additive — existing integrations are unaffected.
​
August 24, 2026
Added read-only isBestEndeavourBasis to delivery details on Get nomination, Get nominations by client reference, and Get draft nominations responses. It indicates whether the nomination or draft is agreed on a best endeavour basis. The value is maintained in the FuelBoss web app and is ignored if supplied on create or update requests. The field is additive — existing integrations are unaffected.
​
August 20, 2026
Consolidated nomination transaction types.
  • TransactionType now has two values — transfer and cargo — replacing the previous directional values (cargo_in, cargo_out, transfer_in, transfer_out). The direction is now conveyed separately by the new read-only transactionDirection field (in, out, or in_and_out), derived from your company’s role on the nomination.
  • transactionType is now also accepted on nomination upserts (PUT /v1/nominations/supplier, PUT /v1/nominations/receiver) and returned on Get nomination responses together with transactionDirection; previously the field was only available on draft nominations.
  • Breaking change: requests that send a legacy transaction type value are rejected with 422 Unprocessable Entity, and responses return the consolidated values — nominations stored with a legacy value are returned with its consolidated equivalent.
  • Bug fix: deliveryMethod and transactionType on Get draft nominations responses now return the documented lowercase values (e.g. vessel); they previously returned PascalCase.
​
August 19, 2026
Added asset-operator support to nominations.
  • New endpoint Get asset operator companies (GET /v1/asset-operators/companies) returns the companies your company operates assets for (companiesIAmOperatorFor) and the companies you have appointed as your asset operators (myAssetOperators), each with the allowed company entity references.
  • Added optional assetOperatorCompanyIdentifier to the supplier section of nomination upserts (PUT /v1/nominations/supplier) and draft nomination upserts (PUT /v1/nominations/drafts); it is also returned in the supplier section of Get draft nominations responses.
  • Two directions are supported: appoint one of your asset operators on a nomination to grant it view/edit access, or act as the asset operator for a company you operate assets for by setting supplier.companyIdentifier to that company together with an allowed companyEntityReference. See Nominations with an asset operator.
The field is additive and optional — existing integrations are unaffected.
​
August 17, 2026
  • Added optional biofuelQuantityDelivered to conventional bunker delivery notes on the Get operation response. The field is only populated for operations under the RED III operation standard: FuelBoss calculates the biofuel quantity in metric tons from the total delivered quantity, the nomination’s biofuel blend ratio, and the biofuel offset configured by the supplier’s company admin. The field is additive and optional — existing integrations are unaffected.
  • On Create or update draft nomination (PUT /v1/nominations/drafts), the receiver company is now derived from the provided counterpartEntityReference when the receiver companyIdentifier is omitted.
  • Documented the value limits for fuel specification quantities. minQuantity and maxQuantity in nomination and draft nomination quantity ranges must stay within the supported decimal range — at most 28 significant digits, with a maximum magnitude of approximately 7.9 × 10^28 — and values outside that range are rejected with 400 Bad Request.
  • Related platform fix: excessively large quantity values could previously be stored and caused bunkering activities to render incorrectly in the FuelBoss web app schedule; such values are now rejected when a nomination is created or updated.
  • Documentation fix: corrected the conventional bunker delivery note example — measurement units are returned as the stored human-readable strings (e.g. metric tons), not the abbreviated mt previously shown.
​
August 12, 2026
  • Added the Get nominations by client reference endpoint (GET /v1/nominations/{clientReference}/all), which returns every nomination your company can access that shares a given client reference.
  • To support this, Get nomination (GET /v1/nominations/{clientReference}) now returns 422 Unprocessable Entity when more than one accessible nomination shares the requested client reference, instead of arbitrarily returning one of them; the problem detail points to the new endpoint. Single-reference lookups are unaffected.
  • Bug fix: receivers can now read, update, and cancel nominations they created themselves — Get nomination, Create or update nomination (receiver), and Cancel nomination now work for receiver-created nominations.
​
August 4, 2026
Added optional email and phoneNumber fields to the counterpart entity. Both are accepted on the Create or update counterpart entity request (PUT /v1/counterpart-entities) and returned on the Get counterpart entities response. email must be a valid email address (max 320 characters); phoneNumber may contain only digits, spaces, and the characters + - ( ). Both fields are additive and optional — existing integrations are unaffected.
​
August 4, 2026
Added optional companyEntityReference to the receiver section of nomination upserts (PUT /v1/nominations/supplier, PUT /v1/nominations/receiver) and draft nomination upserts (PUT /v1/nominations/drafts), and added optional supplierCompanyEntityReference to the receiver upsert request (PUT /v1/nominations/receiver). These let a company that both supplies and receives the fuel assign its company entities when a receiver creates the nomination. Both are only applied for loading operations where the receiver and supplier are the same company; they are ignored otherwise. The receiver companyEntityReference is also returned on Get nomination and Get draft nominations responses.
​
July 28, 2026
  • Added five new webhook event types: nomination_bunkering_start_time_changed (fires when a nomination’s estimated bunkering start time changes), nomination_bunkering_end_time_changed (fires when the estimated time of completion changes), nomination_contract_changed (fires when the contract assigned to a nomination changes), nomination_company_entity_changed (fires when the supplier company entity changes), and nomination_counterpart_entity_changed (fires when the counterpart entity changes). See the webhook event reference pages for the payload structures.
  • Documentation fix: corrected the documented CloudEvent type for nomination_draft_upserted deliveries to net.fuelboss.nomination.draft.upserted (previously documented as net.fuelboss.nomination_draft.upserted).
​
July 17, 2026
  • All timestamps sent to the API must now include an explicit UTC offset (e.g. +02:00, -04:00, or Z); timestamps without an offset are rejected with 400 Bad Request (see Date and time formats). Applies to all endpoints accepting timestamps: PUT /v1/nominations/supplier, PUT /v1/nominations/receiver, PUT /v1/nominations/drafts, PATCH /v1/nominations/{clientReference}/schedule, and PUT /v1/contracts.
  • Bug fix: the supplied offset is now always honored as an absolute instant — previously, timestamps sent with a zero offset (Z or +00:00) were misinterpreted as local time in the bunkering port and stored shifted.
  • Breaking change: timestamps on Get draft nominations responses are now returned in the local time zone of the bunkering port (with the port’s UTC offset) instead of UTC, matching Get nomination responses, and the fields were renamed to drop the AtUtc suffix: berthTime, pilotTime, estimatedTimeOfBunkering, estimatedTimeOfArrival, estimatedTimeOfDeparture, laycanStart, laycanEnd.
  • Malformed request bodies now return RFC 9457 problem details consistently in all environments.
​
June 23, 2026
Bug fix: the status field on nomination responses (Get nomination, Cancel nomination) now correctly returns supplier_unassigned for nominations that have no supplier assigned. Previously this status was not mapped, which could cause the API to fail when reading such a nomination. Added the supplier_unassigned and amended values to the documented NominationStatus enumeration to match the API contract. Clients performing strict enum validation on status should accept these values.
​
June 15, 2026
  • Made estimatedTimeOfBunkering always required in nomination delivery details (PUT /v1/nominations/supplier and PUT /v1/nominations/receiver). Previously, estimatedTimeOfBunkering could be omitted when laycanStart and laycanEnd were provided. The laycan fields remain fully optional and may be provided together alongside estimatedTimeOfBunkering.
  • Made minQuantity optional within draft nomination quantity ranges — a draft fuel specification can now include a unit without specifying a quantity.
​
June 1, 2026
Added optional gasUpRequired and coolDownRequired boolean fields to delivery details. They indicate whether a gas-up or cool-down operation is required before bunkering (applicable to LNG). The fields are accepted on nomination upserts (supplier and receiver — PUT /v1/nominations/supplier and PUT /v1/nominations/receiver) and draft nomination upserts (PUT /v1/nominations/drafts), and are returned in the corresponding read responses (Get nomination and Get draft nominations).
​
May 25, 2026
  • Added optional priceType field to SupplierDetails on nomination upserts (PUT /v1/nominations/supplier) and to supplier details on draft nomination upserts (PUT /v1/nominations/drafts). The field also appears in nomination and draft nomination read responses. Accepted values are floating and fixed.
  • Added read-only bunkeringLocationName (human-readable name of the bunkering location) to delivery details on Get nomination, Get draft nominations, and Get operation responses.
  • Added read-only estimatedTimeOfCompletion to delivery details on Get nomination responses.
  • Expanded LNG fuel properties (LngFuelProperties) on bunker delivery notes: added methaneNumberMethod, grossHeatingValueMassBtu, netHeatingValueMassBtu, grossHeatingValueVolumeBtuScf, netHeatingValueVolumeBtuScf, grossWobbeIndexBtuScf, and netWobbeIndexBtuScf. The existing MMBtu-suffixed heating-value and Wobbe-index fields are now deprecated in favour of the new Btu/BtuScf variants and retained only for v1 contract compatibility. Formal deprecation effective August 23, 2026 (announced with 3 months’ notice under the versioning policy in force at the time; see the current versioning policy); fields remain in v1 responses, with eventual removal reserved for a future v2 contract.
  • Tightened laycan validation introduced in 1.6.0: laycanStart and laycanEnd must now be supplied together or both omitted — supplying only one is rejected.
​
May 14 and June 11, 2026
  • Added optional laycanStart and laycanEnd fields to DeliveryDetails on nomination upserts (supplier and receiver). estimatedTimeOfBunkering is no longer always required — you may now either supply estimatedTimeOfBunkering alone (the laycan window is derived automatically as [estimatedTimeOfBunkering, estimatedTimeOfBunkering + estimatedBunkeringDurationInMinutes]) or supply laycanStart + laycanEnd directly.
  • Added optional companyName to the receiver section of the supplier upsert request (PUT /v1/nominations/supplier): suppliers can now nominate a receiver by name when the receiving company is not yet known to FuelBoss. If a company with that name already exists, it is reused; otherwise the API automatically registers a company suggestion and uses it as the receiver. companyIdentifier and companyName are mutually exclusive — exactly one must be provided.
  • June 11: deprecated the Reschedule nomination endpoint (PATCH /v1/nominations/{clientReference}/schedule). Use the Create or update nomination endpoints (PUT /v1/nominations/supplier, PUT /v1/nominations/receiver) to reschedule a nomination or change its supplier asset. The endpoint remains functional for backward compatibility but will be removed in a future version.
​
May 12, 2026
  • Added Create or update draft nomination endpoint (PUT /v1/nominations/drafts) and nomination_draft_upserted webhook event.
  • Added operationStandardCode to the Get operation response.
  • Added companyEntityReference to the supplier section of the Get operation response (matches the value used when creating the corresponding nomination).
  • Added transactionType (with the TransactionType enumeration) to draft delivery details — only applicable when the operation standard is of type Transfer.
  • Draft responses now include clientReference, supplier companyEntityReference, and receiver counterpartEntityReference/companyName/vesselName.
  • Breaking change (previously coordinated with consumers): the API now identifies a company entity by its reference — the value you set in the FuelBoss Entity Management module and can mirror to your ERP — rather than an internal identifier that was not surfaced in the FuelBoss web app. As a result, the field on GET /v1/company-entities responses changed from identifier to reference, and the supplier section of both firm nominations (GET /v1/nominations/{clientReference}) and drafts changed from companyEntityIdentifier to companyEntityReference.
  • Bug fix: the GET /v1/operations/{clientReference} response now returns status in lowercase (e.g. "ended") matching the documented OperationStatus enum values and Swagger schema; it previously returned PascalCase.
  • Added validation that the receiver counterpartEntityReference must belong to the receiver company.
​
April 12, 2026
  • Added multiple new endpoints for getting draft nominations, creating or updating contracts, getting contracts, getting company entities, getting counterpart entities, and creating or updating counterpart entities.
  • Added companyEntityIdentifier to SupplierDetails and counterpartEntityReference to ReceiverDetails.
  • Bug fixes: added mmbtu and mwh fuel measurement units, added productName to LNG bunker delivery notes, and fixed delivery method casing.
​
March 10, 2026
  • Added Accept nomination endpoint (PUT /v1/nominations/{clientReference}/accept).
  • Improved error response handling with RFC 9457 compliant Problem Details — error responses no longer expose internal implementation details.
​
February 18, 2026
  • Added optional custom headers support for webhook subscriptions. Custom headers are sent with every webhook delivery, enabling integration with API gateways like Azure API Management.
  • Added headerKeys field to webhook subscription responses.
  • Added webhook delivery source IP addresses for firewall allowlisting.
​
February 10, 2026
  • Added Create or update nomination (receiver) endpoint. The receiver endpoint uses dedicated ReceiverDetails without companyIdentifier.
  • Added Cancel nomination endpoint (PUT) with mandatory reason.
  • Added accepted nomination status.
  • Added status field to the Get nomination response.
​
January 2, 2026
Added nomination_created webhook event. Added biofuel properties to fuel specification with the BiofuelGenerationCode enumeration.
​
December 22, 2025
Production release. Changed the reschedule nomination endpoint to use clientReference as path parameter.
​
December 1, 2025
Production release candidate #2 with various changes to contracts, including vessel/asset identifier, bunker delivery note, and how measurement units are represented.
​
October 31, 2025
Production release candidate #1 with nominations, operations, webhooks, and common resources.