Skip to main content
PUT
Creates or updates a contract

Authorizations

Authorization
string
header
required

Access token obtained from the /oauth/token endpoint using your client credentials.

Body

application/json

Request body for creating or updating a contract. The contract is identified by its reference.

name
string

Contract name.

reference
string

Unique reference for the contract, used as contractReference on nominations.

externalReference
null | string

External reference for the contract in your own systems.

type
null | enum<string>

Contract type.

Possible values:

  • term — Term contract.
  • spot — Spot contract.
Available options:
term,
spot
supplierEntities
string[]

Company entity references of the supplier entities covered by the contract (from Get Company Entities).

ports
string[]

UN/LOCODEs of the ports covered by the contract.

counterpartCompanies
string[]

Identifiers of the counterpart companies covered by the contract (from Get Companies).

counterpartEntities
string[]

References of the counterpart entities covered by the contract (from Get Counterpart Entities).

priceType
null | enum<string>

Price type.

Possible values:

  • floating — Floating price.
  • fixed — Fixed price.
Available options:
floating,
fixed
startDateUtc
null | string<date-time>

Start of the contract validity period (UTC).

endDateUtc
null | string<date-time>

End of the contract validity period (UTC).

Response

OK

Response returned after creating or updating a contract.

contractReference
string

Unique reference of the created or updated contract.

lastChangedAtUtc
string<date-time>

Timestamp (UTC) of the last change to the contract.