# Portbase Terminal API - visits API

**Canonical:** https://apis.io/apis/portbase/portbase-terminal-api-visits-api/  
**Provider:** Portbase — https://apis.io/providers/portbase/  
**Base URL:** https://api.cargo-controller-export.pcs.portbase.com/api  
**Documentation:** https://api.cargo-controller-export.pcs.portbase.com/api/public/index.html

Portbase Terminal API - visits API is one of 32 APIs that [Portbase](https://apis.io/providers/portbase/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 20 JSON Schema definitions. Tagged areas include Terminal API - visits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 20 JSON Schemas.

Api defining the operations a terminal can do to respond on visit requests from the declarant. The terminal supplies feedback if a visit is accepted and can be planned, rejected or completed.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| POST | `/visits:accept` | Accept visit |
| PATCH | `/visits:accept` | Accept visit |
| POST | `/visits:reject` | Reject visit |
| POST | `/visits:acknowledge` | Acknowledge visit |
| POST | `/visits:updateStatus` | Update visit status |
| PATCH | `/visits:updateStatus` | Update visit status |
| POST | `/visits:complete` | Complete visit |
| POST | `/visits:acceptCancellation` | Accept visit cancellation |
| POST | `/visits:reopen` | Reopen load-discharge list |
| POST | `/roadVisits:byTar` | Get road visit by TAR code |
| POST | `/roadVisits:updateEta` | Update road eta for the charter |
| POST | `/visits:updateNotifications` | Set the notifications for a visit |

## Machine-readable artifacts (29)

- **OpenAPI** — https://artifacts.apis.io/portbase/openapi/portbase-terminal-api-visits-api-openapi.yml
- **Documentation** — https://api.cargo-controller-export.pcs.portbase.com/api/public/index.html
- **GettingStarted** — https://support.portbase.com/hc/en-gb/articles/34948493768466-Creating-a-system-interface-API-with-Cargo-Controller-Export
- **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
- **Documentation** — https://cargo-controller.pcs.portbase.com/api/public/index.html
- **GettingStarted** — https://support.portbase.com/hc/en-gb/articles/29522670809746-Create-a-system-interface-API-with-Cargo-Controller-Import
- **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
- **Documentation** — https://hcn.pcs.portbase.com/api-documentation/index.html
- **GettingStarted** — https://support.portbase.com/hc/en-gb/articles/29950155564562-Create-a-system-interface-API-with-Hinterland-Container-Notification-Barge-Rail-or-Road
- **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
- **Documentation** — https://portvisit.pcs.portbase.com/api-documentation/index.html
- **GettingStarted** — https://support.portbase.com/hc/en-gb/articles/29950455304594-Create-system-interface-with-Vessel-Notification
- **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

## Other Portbase APIs (12)

- [Portbase Bookings API](https://apis.io/apis/portbase/portbase-bookings-api/)
- [Portbase Cargo Controller Import API](https://apis.io/apis/portbase/portbase-cargo-controller-import-api-api/)
- [Portbase Commercial Release API](https://apis.io/apis/portbase/portbase-commercial-release-api-api/)
- [Portbase Consignments API](https://apis.io/apis/portbase/portbase-consignments-api-api/)
- [Portbase Event API](https://apis.io/apis/portbase/portbase-event-api-api/)
- [Portbase Forwarder API](https://apis.io/apis/portbase/portbase-forwarder-api-api/)
- [Portbase Harbour Dues API](https://apis.io/apis/portbase/portbase-harbour-dues-api-api/)
- [Portbase Integral Planning API](https://apis.io/apis/portbase/portbase-integral-planning-api-api/)
- [Portbase Operator API - handlings API](https://apis.io/apis/portbase/portbase-operator-api-handlings-api/)
- [Portbase Operator API - rail-only API](https://apis.io/apis/portbase/portbase-operator-api-rail-only-api/)
- [Portbase Operator API - road-only API](https://apis.io/apis/portbase/portbase-operator-api-road-only-api/)
- [Portbase Operator API - visits API](https://apis.io/apis/portbase/portbase-operator-api-visits-api/)

## Tags

Terminal API - visits

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/portbase/portbase-terminal-api-visits-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/portbase/.