Upcoming version

You're browsing the documentation for an upcoming version. Its documentation and features are subject to change.

Replace a vessel's manifest

put

/vessels/{imo}/manifest

replaceManifest

The whole manifest at once — a PUT, because half a manifest is not a smaller manifest, it is a wrong one.

Authorisation

Any one of these
- apiKeyapiKey · X-Api-Key · Header
  A key from the account page.
Any one of these
- bearerhttp · bearer
  A token obtained from the authorisation server.

Parameters

Path

imo*Requiredstringpattern ^IMO[0-9]{7}$
The vessel's IMO number.

Header

If-Matchstring
The manifest revision you are replacing.

Request body Required

application/json

object

entries*Requiredarray<object>
Each item
objectManifestEntry
- line*Requiredintegermin 1
- contents*Requiredany
  At least one of
  object
  consignmentIdstring
  object
  descriptionstring
  weightKgnumbermin 0

json

{
  "entries": [
    {
      "line": 1,
      "contents": {
        "consignmentId": "00000000-0000-4000-8000-000000000000"
      }
    }
  ]
}

Responses

200

The manifest as it now stands.

application/json

array<object>

Each item

objectManifestEntry

line*Requiredintegermin 1
contents*Requiredany
At least one of
- object
  consignmentIdstring
- object
  descriptionstring
  weightKgnumbermin 0

json

[
  {
    "line": 1,
    "contents": {
      "consignmentId": "00000000-0000-4000-8000-000000000000"
    }
  }
]

412

Something went wrong, described the same way every time.

application/problem+json

objectProblem

title*RequiredstringA short, human-readable summary.
status*Requiredintegermin 400max 599
detailstring | null

json

{
  "title": "string",
  "status": 400,
  "detail": "string"
}

Send a request

curl 'https://api.example.org/v3/consignments?limit=20&cursor=string&status=%5B%0A++%22booked%22%0A%5D&session=string' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000'

Edit this page