Important terms and their definitions in the Closelink ecosystem.
Similar terms : Request for Quote (RFQ)
An enquiry is a request for one or multiple suppliers to quote available quantity, prices etc. for a set of products. It contains the details of the products and quantities requested. As well as the vessel, port and delivery date.
Full Enquiry API Model id string
Example: "5fc4f3b053e79838873f72e9"
dateCreated string
The date the enquiry was created
Example: "2023-10-01T12:00:00Z"
dateUpdated string
The date the enquiry was last updated
Example: "2023-10-02T12:00:00Z"
version integer (int64)
The version of the enquiry
Example: 1
customerId string
The customer ID associated with the enquiry
Example: "572206b5e4b0d7441f638363"
vesselId string
The vessel ID associated with the enquiry
Example: "572206b5e4b0d7441f638364"
portId string
The port ID associated with the enquiry
Example: "572206b5e4b0d7441f638365"
state string
Example: "OPEN"
dateDelivery string
Lubes only: The delivery date of the enquiry
Example: "2023-10-10T12:00:00Z"
dateCanceled string
The cancellation date of the enquiry
Example: "2023-10-05T12:00:00Z"
dateStarted string
The start date of the enquiry
Example: "2023-10-01T12:00:00Z"
dateOrdered string
The order date of the enquiry
Example: "2023-10-01T12:00:00Z"
buyerReference string
The buyer reference for the enquiry
Example: "123-XYZ"
enquiryNumber string
Example: "CL-123"
cancelReason string
The reason for cancellation
Example: "Chose a different supplier"
items Array of objects (OrderItemMessage)
The list of items in the enquiry
+ Show 13 array properties
samplekits Array of objects (SamplekitMessage)
The list of sample kits in the enquiry
+ Show 6 array properties
createdBy string
The ID of the user who created the enquiry
Example: "572206b5e4b0d7441f638366"
updatedBy string
The ID of the user who last updated the enquiry
Example: "572206b5e4b0d7441f638367"
comment string
The comment on the enquiry
Example: "Urgent delivery required"
chosenOrderId string
The chosen order ID for the enquiry
Example: "572206b5e4b0d7441f638367"
spot boolean
Whether the enquiry is a spot enquiry
Example: true
receiverSupplierIds Array of strings
The list of receiver supplier IDs
assignedSupplierIds Array of strings
The list of assigned supplier IDs
excludeSupplierGroupIds Array of strings
The list of excluded supplier group IDs
attributes object
The attributes of the enquiry
+ Show property
creationComment string
The creation comment for the enquiry
Example: "Initial creation"
agentId string
The agent ID associated with the enquiry
Example: "572206b5e4b0d7441f638368"
source string
The source of the enquiry
Example: "ERP_SYSTEM"
type string
Example: "LUBES"
contractId string
Fuel only: The contract ID associated with the enquiry
Example: "572206b5e4b0d7441f638369"
eta string
Fuel only: The estimated time of arrival
Example: "2023-10-10T12:00:00Z"
etd string
Fuel only: The estimated time of departure
Example: "2023-10-11T12:00:00Z"
validityTime integer (int64)
Fuel only: The validity time of the enquiry in milliseconds
Example: 3600000
validUntil string
Fuel only: The date until the enquiry is valid
Example: "2023-10-10T12:00:00Z"
fileIds Array of strings
The list of file IDs associated with the enquiry
approvalRequestState string
The approval request state of the enquiry
Example: "PENDING"
Related API Routes
Related Webhook Events
A draft enquiry is an enquiry that has not been sent to any suppliers yet. It is a temporary state that allows users to prepare an enquiry before sending it out.
Related API Routes
Related Webhook Events
Similar terms : Quote
An offer is a response to an enquiry. It contains the same details as the enquiry with the addition of prices and possibly additional information and changes from the supplier.
Full Offer API Model id string
Example: "5abb6605e4b05f80261fdf37"
dateCreated string
Date when the offer was created
Example: "2025-01-01T00:00:00Z"
dateUpdated string
Date when the offer was last updated
Example: "2025-01-02T00:00:00Z"
enquiryId string
Example: "5abb6605e4b05f80261fdf37"
customerId string
Example: "5abb6605e4b05f80261fdf37"
supplierId string
Example: "5abb6605e4b05f80261fdf37"
enquiryType string
Enum "SPOT" "ASSIGNED" "FORWARDED" "ANONYMOUS"
Example: "ASSIGNED"
state string
Enum "DRAFT" "ENQUIRY" "QUOTED" "ORDER" "CUSTOMER_ADJUSTED" "SUPPLIER_ADJUSTED" "CONFIRMED" "ACKNOWLEDGED" "CANCELED" "DELIVERED" +6 more
Example: "CONFIRMED"
dateDelivered string
Date when the offer was delivered
Example: "2025-01-03T00:00:00Z"
dateConfirmation string
Date when the offer was confirmed
Example: "2025-01-04T00:00:00Z"
dateOrdered string
Date when the offer was ordered
Example: "2025-01-05T00:00:00Z"
dateEnquired string
Date when the enquiry was made
Example: "2025-01-06T00:00:00Z"
dateQuoted string
Date when the offer was quoted
Example: "2025-01-07T00:00:00Z"
dateCanceled string
Date when the offer was canceled
Example: "2025-01-08T00:00:00Z"
dateAcknowledged string
Date when the offer was acknowledged
Example: "2025-01-09T00:00:00Z"
dateInvoiced string
Date when the offer was invoiced
Example: "2025-01-10T00:00:00Z"
vendorReference string
Example: "VR-12345"
offerNumber string
Example: "CL-1AB2CD-XY"
cancelReason string
Example: "Delivery not needed anymore"
volume number
Example: 1000
ppl object (MoneyMessage)
+ Show 2 properties
total object (MoneyMessage)
+ Show 2 properties
createdBy string
ID of the user who created the offer
Example: "5abb6605e4b05f80261fdf37"
updatedBy string
ID of the user who updated the offer
Example: "5abb6605e4b05f80261fdf37"
orderedBy string
ID of the user who ordered the offer
Example: "5abb6605e4b05f80261fdf37"
paymentTermReference string
Enum "DAYS_AFTER_DELIVERY" "DAYS_AFTER_NOMINATION" "DAYS_AFTER_INVOICE_DATE" "PREPAYMENT"
Example: "DAYS_AFTER_DELIVERY"
paymentTermReferenceDays integer (int64)
Payment term reference days
Example: 30
supplyMode string
Enum "BARGE" "TRUCK" "BARGEANDTRUCK" "EX_WHARF" "EX_PIPE"
Example: "BARGE"
supplyModeIncludesDeliveryCosts boolean
Indicates if the supply mode includes delivery costs
Example: true
noticeDays integer (int64)
Example: 7
priceComplete boolean
Indicates if the price is complete
Example: true
fileIds Array of strings
Example: ["67c586ef358cb50eab2a63c7","5abb6605e4b05f80261fdf37"]
changes object (OfferChangesMessage)
+ Show 12 properties
portId string
Example: "5abb6605e4b05f80261fdf37"
dateDelivery string
Example: "2025-01-11T00:00:00Z"
buyerReference string
Example: "BUYER-REF123"
vesselId string
Example: "5abb6605e4b05f80261fdf37"
items Array of objects (OfferItemResponseMessage)
+ Show 14 array properties
surcharges Array of objects (SurchargeMessage)
+ Show 7 array properties
samplekits Array of objects (SamplekitMessage)
+ Show 6 array properties
agentId string
Example: "5abb6605e4b05f80261fdf37"
type string
Enum "LUBES" "FUEL"
Example: "LUBES"
surveyor object (SurveyorMessage)
+ Show 2 properties
contractId string
Fuel only: ID of the contract
Example: "5abb6605e4b05f80261fdf37"
eta string
Fuel only: Estimated time of arrival
Example: "2025-01-12T00:00:00Z"
etd string
Fuel only: Estimated time of departure
Example: "2025-01-13T00:00:00Z"
quoteValidityTime integer (int64)
Fuel only: Quote validity time in minutes
Example: 1622505600000
validityTime integer (int64)
Fuel only: Validity time in minutes
Example: 120
validUntil string
Fuel only: Valid until date
Example: "2025-01-14T00:00:00Z"
quoteValidUntil string
Fuel only: Quote valid until date
Example: "2025-01-15T00:00:00Z"
Related API Routes
Related Webhook Events
Similar terms : Purchase Order (PO)
Once an offer has been accepted by the customer, it is converted into an order. The order contains the same details as the offer with some additional information.
A vessel is a ship that is managed in closelink. It contains information about the vessel itself, as well as the tanks and their capacity.
Full Vessel API Model dateCreated string (date-time)
The date the vessel was created
Example: "2023-07-04T19:53:42.172Z"
dateUpdated string (date-time)
The date the vessel was last updated
Example: "2023-07-04T19:53:42.172Z"
dateActiveUpdated string (date-time)
The date the active status of the vessel was last updated
Example: "2023-07-04T19:53:42.172Z"
id string
Example: "5fc4f3b053e79838873f72e9"
version integer (int64)
Example: 2
customerId string
ID of the customer this vessel belongs to
Example: "61c9c86346e0fb0001fe4df6"
name string required
Example: "Rio Bravo"
imo string required
The IMO ship identification number
Example: 923012
email string
Example: "vessel@company.com"
invoiceVAT string
Example: "DE123456789"
invoiceAddress object (AddressMessage)
Model for address details
+ Show 5 properties
directOrderAllowed boolean required
Are direct orders allowed for this vessel
Example: true
paying boolean required
Example: true
active boolean required
Example: true
defaultSupplierId string
Example: "61e694d1c9e77c00013dd46e"
transactionEmailAddresses Array of strings required
Transaction email addresses
Example: ["vessel@company.com"]
lubricationChart object (LubricationChartMessage)
+ Show 2 properties
services Array of strings
Example: ["HFO","LNG"]
types Array of strings
Example: ["Container","Panamax"]
mailNotificationSettings object (MailNotificationSettingsMessage) required
Email notification settings
+ Show 4 properties
Related API Routes
A port call is stop of a vessel at a port as part of its scheduled voyage. It contains information about the expected arrival and departure times.
Full Port Call API Model id string read-only
Example: "5cb6cfc92a8bc367aeec923b"
dateCreated string (date-time) read-only
The date-time the object was created
Example: "2024-04-17T07:03:37.947Z"
dateUpdated string (date-time) read-only
The date-time the object was last updated
Example: "2024-04-17T07:03:37.947Z"
customerGroupId string read-only
Example: "5cb6cfc92a8bc367aeec923b"
imo string required
Example: 9776171
eta string (date-time) required
The estimated time of arrival
Example: "2024-03-01T00:00:00.000Z"
etd string (date-time) required
The estimated time of departure
Example: "2024-03-05T00:00:00.000Z"
locode string required
Example: "DEHAM"
agentIds Array of strings
A list of internal IDs of agents for a stop
Example: ["5cb6cfc92a8bc367aeec923b"]
Related API Routes
Closelink representation of a real world port.
Full Port API Model id string read-only
Example: "5cb6cfc92a8bc367aeec923b"
dateCreated string read-only
The date-time the object was created
Example: "2024-04-17T07:03:37.947Z"
dateUpdated string read-only
The date-time the object was last updated
Example: "2024-04-17T07:03:37.947Z"
name string required
Example: "Hamburg"
country object (CountryMessage) required
+ Show 5 properties
latitude number (double)
Example: 53.5511
longitude number (double)
The longitude of the port
Example: 9.9937
locode string required
Example: "DEHAM"
aliases Array of strings
A list of aliases for the port
Example: ["Hamburg Süd","Hamburg Port"]
locodeAliases Array of strings
A list of locode aliases for the port
Example: ["DEHAM1","DEHAM2"]
timeZoneId string required
Example: "Europe/Berlin"
Related API Routes
A company is a legal entity that is managed in closelink. It can either be a customer or a supplier.
A customer group is a group of companies that are managed together in closelink.
Full Customer Group API Model id string read-only
Example: "5cb6cfc92a8bc367aeec923b"
dateCreated string (date-time) read-only
The timestamp the object was created
Example: "2023-07-04T19:53:42.172Z"
dateUpdated string (date-time) read-only
The timestamp the object was last updated
Example: "2023-07-04T19:53:42.172Z"
name string required
Example: "Closelink GmbH"
address object (AddressMessage)
Model for address details
+ Show 5 properties
phone string
Phone number of the company
Example: "+49 40 1234567-0"
fax string
Fax number of the company
Example: "+49 40 1234567-98"
email string required
Email address of the company
Example: "hello@closelink.com"
invoiceMail string
Email address for invoicing
Example: "financial-department@closelink.com"
additionalReceiver Array of strings
A list of additional email addresses to receive emails
Example: "[cc@closelink.com,bcc@closelink.com]"
testCompany boolean required
Flag that indicates if the customer group is a test group
Example: false
gtcAccepted boolean required
Flag that indicates if the customer group has accepted the terms and conditions of Closelink
Example: true
invoiceVAT string
Example: 9776171
trial boolean required
Flag that indicates if a company is on trial
Example: true
mailSettings object (MailSettingsMessage)
+ Show 2 properties
headquarter string
Headquarter of the company
Example: "Copenhagen, Denmark"
closelinkLite boolean required
Flag that indicates if a customer group is a Closelink Lite customer
Example: false
gtcUrl string
URL of the terms and conditions of a customer
Example: "https://www.closelink.com/terms-conditions"
Related API Routes
A customer is a company managed in Closelink that is using Closelink to purchase products.
A supplier is a company managed in Closelink that is using Closelink to sell products.
Full Supplier API Model id string read-only
Example: "5cb6cfc92a8bc367aeec923b"
dateCreated string (date-time) read-only
The ISO date when the object was created
Example: "2025-05-01T20:00:00Z"
dateUpdated string (date-time) read-only
The ISO date when the object was last updated
Example: "2025-05-01T20:00:00Z"
name string required
Example: "Closelink GmbH"
address object (AddressMessage)
Model for address details
+ Show 5 properties
phone string
Phone number of the company
Example: "+49 40 1234567-0"
fax string
Fax number of the company
Example: "+49 40 1234567-98"
email string required
Email address of the company
Example: "hello@closelink.com"
invoiceMail string
Email address for invoicing
Example: "financial-department@closelink.com"
additionalReceiver Array of strings
A list of additional email addresses to receive emails
Example: "[cc@closelink.com,bcc@closelink.com]"
testCompany boolean required
Flag that indicates if a company is a test company
Example: false
gtcAccepted boolean required
Flag that indicates if the company has accepted the terms and conditions of Closelink
Example: true
invoiceVAT string
Example: 9776171
trial boolean required
Flag that indicates if a company is on trial time
Example: true
mailSettings object (MailSettingsMessage) required
+ Show 2 properties
invoiceAddress object (AddressMessage) required
Model for address details
+ Show 5 properties
supplierGroupId string required
The supplier group ID of the company
Example: "5cb6cfc92a8bc367aeec923b"
showGtc boolean required
Flag to show the general terms and conditions
type string required
Enum "LUBES" "FUEL"
Example: "LUBES"
Related API Routes
An approval request can be issued by a customer for an offer if the value of the offer exceeds a configured threshold.
Full Approval Request API Model id string
Unique identifier of the approval request.
Example: "5abb6605e4b05f80261fdf37"
dateCreated string
Date when the approval request was created.
Example: "2025-01-01T00:00:00Z"
dateUpdated string
Date when the approval request was last updated.
Example: "2025-01-02T00:00:00Z"
createdBy string
User who created the approval request.
Example: "5abb6605e4b05f80261fdf37"
updatedBy string
User who last updated the approval request.
Example: "5abb6605e4b05f80261fdf37"
customerId string
Customer ID associated with the approval request.
Example: "5abb6605e4b05f80261fdf37"
state string
Current state of the approval request.
Enum "PENDING" "APPROVED" "DECLINED" "WITHDRAWN" "EXPIRED"
Example: "PENDING"
offerId string
Offer ID associated with the approval request.
Example: "5abb6605e4b05f80261fdf37"
approvers Array of objects (ApproverMessage)
List of approvers for the approval request.
+ Show array property
controllerEmailAddress string
Email address of the approver who responded to the approval with approval or rejection.
Example: "controller@example.com"
responseMessage string
Response message for the approval request.
Example: "Approved successfully."
requestMessage string
Request message for the approval request.
Example: "Please approve this offer."
dateApproved string
Date when the approval request was approved.
Example: "2025-01-03T00:00:00Z"
dateDeclined string
Date when the approval request was declined.
Example: "2025-01-03T00:00:00Z"
dateExpired string
Date when the approval request expired.
Example: "2025-02-01T00:00:00Z"
dateWithdrawn string
Date when the approval request was withdrawn.
Example: "2025-01-04T00:00:00Z"
total object (MoneyMessage)
+ Show 2 properties
Related API Routes
Related Webhook Events
Items that are offered and ordered as part of an enquiry are called products in Closelink (usually marine lubricants).
Full Product API Model id string read-only
The internal ID of a product
Example: "5cb6cfc92a8bc367aeec923b"
dateCreated string read-only
The timestamp a product was created
Example: "2023-07-04T19:53:42.172Z"
dateUpdated string read-only
The timestamp a product was last updated
Example: "2023-07-04T19:53:42.172Z"
supplierProductGroup string read-only
The supplier group associated with a product
Example: "SHELL"
publicId string read-only
The public ID of a product
Example: "L-3VFMZL"
name string read-only
Example: "Aeroshell Grease 33"
packTypeDefault string read-only
The default pack type of a product
Enum "BULK" "DRUMS" "IBCS" "PAIL" "BULK_EX_IBC" "BULK_EX_DRUMS" "BOTTLE" "PACK" "CARTON"
Example: "BULK"
aliases Array of strings read-only
Aliases of a product, used as additional names
unitDefault string read-only
The unit default of a product
Enum "L" "KG" "MT" "BARREL" "MWH" "MMBTU" "PIECE"
Example: "L"
group string read-only
Enum "CYLINDER_OIL" "SYSMTEM_OIL_2_STROKE" "ENGINE_OIL_4_STROKE" "ANCILLARY_OIL" "GREASE" "HFO" "MDO" "MGO" "LNG" "TEST_KIT" +3 more
Example: "GREASE"
latestSuccessorProductId string read-only
The internal ID of the latest successor product of a given product
Example: "5cb6cfc92a8bc367aeec923b"
dateDeprecated string read-only
The timestamp a product was deprecated and should not be used anymore
Example: "2023-07-04T19:53:42.172Z"
type string read-only
Enum "LUBES" "FUEL"
Example: "LUBES"
viscosity integer (int32) read-only
The viscosity of a product
sulphurContent string read-only
The sulphur content of a product
Enum "HS" "VLS" "ULS"
Example: "HS"
archived boolean read-only
Indicates whether a product is archived
Related API Routes
Similar terms : Stock
The amount of product remaining on board a vessel in a specific tank.
Full Remaining On Board API Model imo string required
The IMO of the vessel reporting the remaining on board information
Example: 9776171
dateMeasured string required
The date when the remaining on board information were measured
Example: "2024-03-01T00:00:00.000Z"
quantity integer (int32) required
Example: 15000
vesselTankId string required
Example: "5fc4f3b053e12538873f72e9"
Related API Routes