Contract Performance

Retrieve contract booking history

Takes the contract ID and booking ID as parameters and returns the booking history of the listed contract, if successful. If the request is not successful, it returns an error.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

bookingId
required
string <uuid>
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Booking history found

post/v1/contract-performance/contracts/{contractId}/bookings/{bookingId}/history
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "events": [
    ]
}

Retrieve booking details

Lists the full booking details of the contract.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

bookingId
required
string <uuid>
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Booking details returned

post/v1/contract-performance/contracts/{contractId}/bookings/{bookingId}/details
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "bookingNumber": "string",
  • "nvoBookingReferences": [
    ],
  • "contractNumber": "string",
  • "carrierId": "81a9910c-2657-4f54-9feb-7f6d85d613bc",
  • "placeOfReceipt": "string",
  • "portOfLoad": "string",
  • "portOfDischarge": "string",
  • "placeOfDelivery": "string",
  • "size": "string",
  • "teu": { },
  • "equipmentTeu": { },
  • "equipmentTeuGatedOut": { },
  • "equipmentTeuGatedIn": { },
  • "teuRequested": { },
  • "confirmedAt": { },
  • "gateOut": { },
  • "gateIn": { },
  • "initialShippedOnBoard": { },
  • "shippedOnBoard": { },
  • "initialVessel": "string",
  • "vessel": "string",
  • "initialVoyage": "string",
  • "voyage": "string",
  • "service": "string",
  • "serviceCode": "string",
  • "weight": 0,
  • "portCut": { },
  • "proformaDeparture": { },
  • "namedAccount": "string",
  • "adhocData": "string",
  • "equipment": [
    ],
  • "status": "string",
  • "customerReference": "string"
}

List bookings by contract ID

Returns a list of all bookings connected to the contract ID.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
object (ExternalBusinessRequestDto)
object (ExternalContractBookingsQueryParams)
Responses
200

Users full list of bookings by contract returned

post/v1/contract-performance/contracts/{contractId}/bookings
Request samples
application/json
{
  • "businessRequest": {
    },
  • "queryParams": {
    }
}
Response samples
application/json
{
  • "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
  • "bookings": [
    ],
  • "currentPage": 0,
  • "pageSize": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Retrieve locked in lanes page details

Retrieves the details for why a contract is locked-in lanes.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Locked in lanes details returned

post/v1/contract-performance/contracts/{contractId}/locked-in-lanes
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
  • "lockedInLanes": [
    ]
}

Performance summary details

Returns a summary about the contracts carrier, booking, shipping, and delivery information.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Performance summary details returned

post/v1/contract-performance/contracts/{contractId}/performance
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
  • "name": "string",
  • "contractNumber": "string",
  • "carrierId": "81a9910c-2657-4f54-9feb-7f6d85d613bc",
  • "performance": [
    ]
}