Portbase Port to Port API

The Port to Port API API from Portbase — 3 operation(s) for port to port api.

Operations 3

POST /port-to-port/v1/cancelCall To cancel the vessel call #
POST /port-to-port/v1/submitTimestamps For Port A to send timestamp data to Port B #
POST /port-to-port/v1/subscribe Subscribe to port to port events #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-booking-dossier-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-subscribe-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-subscription-id-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-track-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-api-organisation-bl-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-shipment-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-transfer-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-batch-track-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-terminal-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-equipment-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-equipment-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-container-list-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-get-road-voyage-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-get-hinterland-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-external-visit-api-visit-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-common-authentication-bezoekschip-organisation-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-commercialrelease-input-input-commercial-release-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-common-get-any-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-visit-get-visit-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-import-consignment-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/portbase:portbase-port-to-port-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

portbase-port-to-port-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Portbase Port to Port API
  version: '6.0'
  contact:
    name: Portbase portvisit team
    url: https://portvisit.pcs.portbase.com
    email: customerservice@portbase.com
  x-logo:
    url: Portbase_WB_RGB.png
    altText: Portbase logo
  description: 'Operations tagged Port to Port API across 2 of this provider''s published API definitions: portbase-portvisit-v6.json, portbase-vessel-visit-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.portbase.com/portvisit
  description: Production server
- url: https://api.kt.portbase.com/portvisit
  description: Acceptance server
- url: https://api.sc.portbase.com/portvisit
  description: Test server
tags:
- name: Port to Port API
paths:
  /port-to-port/v1/cancelCall:
    post:
      tags:
      - Port to Port API
      summary: To cancel the vessel call
      description: To cancel the vessel call.
      operationId: cancelCall
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.messaging.port2port.CancelCall'
      responses:
        '204':
          description: Successful operation
        '403':
          description: Forbidden
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /port-to-port/v1/submitTimestamps:
    post:
      tags:
      - Port to Port API
      summary: For Port A to send timestamp data to Port B
      description: For Port A to send timestamp data to Port B.
      operationId: submitTimestamps
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.messaging.port2port.SubmitTimestamps'
      responses:
        '204':
          description: No content
        '403':
          description: Forbidden
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /port-to-port/v1/subscribe:
    post:
      tags:
      - Port to Port API
      summary: Subscribe to port to port events
      description: API for a port to subscribe to be notified of a vessel’s timestamps when relevant. The caller will provide the callback API, which will be invoked when conditions are satisfied, i.e., event triggered.
      operationId: subscribe
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.port2port.SubscriptionRequest'
      responses:
        '204':
          description: No content
        '403':
          description: Forbidden
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
components:
  schemas:
    com.portbase.bezoekschip.common.api.port2port.SubscriptionRequest:
      title: SubscriptionRequest
      required:
      - callbackUrl
      - portUnloCode
      type: object
      properties:
        portUnloCode:
          type: string
          description: Identification of which port the information is from.
        callbackUrl:
          type: string
          description: URL of the endpoint that the port to port data should be sent to.
        authorization:
          type:
          - string
          - 'null'
          description: String that will be sent in the “Authorization” field in the message header.
        messageId:
          type:
          - string
          - 'null'
          description: String that will be sent in the “messageID” field in the message header.
    com.portbase.bezoekschip.common.api.messaging.port2port.CancelCall:
      title: CancelCall
      type: object
      properties:
        shipStayReferenceNumber:
          type:
          - string
          - 'null'
          description: Port call identifier of the vessel call at the previous port.
        portUnloCode:
          type:
          - string
          - 'null'
          description: For identification of which port the information is from.
    com.portbase.bezoekschip.common.api.messaging.port2port.SubmitTimestamps:
      title: SubmitTimestamps
      type: object
      properties:
        shipStayReferenceNumber:
          type:
          - string
          - 'null'
          description: Port call identifier of the vessel call at the previous vessel.
        etaPbp:
          type:
          - string
          - 'null'
          description: ETA of the vessel at the PBP
          format: date-time
        ptaPbp:
          type:
          - string
          - 'null'
          description: PTA of the vessel at the PBP
          format: date-time
        ataPbp:
          type:
          - string
          - 'null'
          description: ATA of the vessel at the PBP
          format: date-time
        etdLastBerth:
          type:
          - string
          - 'null'
          description: ETD of the vessel from the Berth
          format: date-time
        ptdLastBerth:
          type:
          - string
          - 'null'
          description: PTD of the vessel from the Berth
          format: date-time
        atdLastBerth:
          type:
          - string
          - 'null'
          description: ATD of the vessel from the Berth
          format: date-time
        vesselImoNumber:
          type:
          - string
          - 'null'
          description: IMO number of vessel
        portUnloCode:
          type:
          - string
          - 'null'
          description: For identification of which port the information is from.
x-refined-from:
- portbase-portvisit-v6.json
- portbase-vessel-visit-openapi.yml