# Portbase Reference Data API

**Canonical:** https://apis.io/apis/portbase/portbase-reference-data-api-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 Reference Data 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 Reference Data API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 20 JSON Schemas.

Portbase uses reference data within the API calls for instance barges, shipping companies, container sizetypes etc. With this Reference Data API you can retrieve the data to be used in the API calls for voyages, visits and handlings. This way you make sure you do not send unknown or invalid information.

## Operations (43)

| Method | Path | Summary |
|---|---|---|
| POST | `/refdata/findShippingCompanies` | Find shipping companies |
| POST | `/refdata/getShippingCompany` | Get shipping company |
| POST | `/refdata/getShippingCompanies` | Get shipping companies |
| POST | `/refdata/findBarges` | Find barges |
| POST | `/refdata/getBarge` | Get barge |
| POST | `/refdata/findLocations` | Find locations |
| POST | `/refdata/getLocation` | Get location |
| POST | `/refdata/findSizeTypes` | Find size types |
| POST | `/refdata/getSizeType` | Get size type |
| POST | `/refdata/getSizeTypes` | Get all size types |
| POST | `/refdata/getBargeAccessPoints` | Get barge access points |
| POST | `/refdata/getTerminals` | Get terminals |
| POST | `/refdata/getTerminal` | Get terminal |
| POST | `/refdata/getTerminalByCode` | Get terminal by BICS or SMDG code |
| POST | `/refdata/getForwarder` | Get forwarder |
| POST | `/refdata/getTractionSupplier` | Get traction supplier |
| GET | `/refdata/getTractionSuppliers` | Get traction suppliers |
| POST | `/refdata/getRailInterTerminals` | Get rail inter-terminals |
| POST | `/refdata/getRailInterTerminal` | Get rail inter-terminal |
| POST | `/refdata/getFixedWindowsForDeclarant` | Get Fixed Windows for Declarant |
| POST | `/refdata/getFixedWindowsForTerminal` | Get Fixed Windows for Terminal |
| POST | `/refdata/getFixedWindowsForIntegralPlanning` | Get Fixed Windows for Integral Planning |
| POST | `/refdata/getOrganisation` | Get Organisation |
| POST | `/refdata/findOrganisations` | Find Organisations |
| POST | `/refdata/findInlandOperators` | Find Inland Operators |
| POST | `/refdata/getTimeTablesForDeclarant` | Get Timetable Entries for Declarant |
| POST | `/refdata/getBarges` | Get barges |
| POST | `/refdata/findVessels` | Find vessels |
| POST | `/refdata/getEntryPoints` | Get entry points |
| POST | `/refdata/getPilotStations` | Get pilot boarding places |
| POST | `/refdata/getBoatmen` | Get boatmen |
| POST | `/refdata/getPilots` | Get pilots |
| POST | `/refdata/getTugboats` | Get tugboats |
| POST | `/refdata/findCarriers` | Find carriers |
| POST | `/refdata/findBerths` | Find berths or buoys |
| POST | `/refdata/findPilotExemptions` | Find pilot exemption holders |
| POST | `/refdata/findPorts` | Find ports |
| POST | `/refdata/findPortsOrWayPoints` | Find ports or way points |
| POST | `/refdata/getCustomsOffices` | Get customs offices |
| POST | `/refdata/getWasteCollectors` | Get waste collectors |
| POST | `/refdata/findLinerServices` | Find liner services |
| POST | `/refdata/findVesselServices` | Find liner services |
| POST | `/refdata/findWasteMaterials` | Find waste types |

## Machine-readable artifacts (29)

- **OpenAPI** — https://artifacts.apis.io/portbase/openapi/portbase-reference-data-api-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

Reference Data API

---

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