Introduction

The OnePort BPAAS (Booking Platform as a Service) Middleware API is a RESTful integration layer that gives partner platforms programmatic access to OnePort 365's freight and logistics services.

OnePort 365 is a digital freight forwarding platform that connects shippers, exporters, and importers to carriers, freight agents, and logistics providers across Africa and global trade lanes. The BPAAS Middleware API is the bridge that lets your platform — whether a marketplace, ERP system, trade finance tool, or customs portal — embed OnePort's freight capabilities directly into your own product without building the logistics infrastructure from scratch.

Through this API, your platform can:

• Onboard users with a secure, OTP-verified registration and login flow.
• Search live freight rates across multiple carriers and lanes in real time.
• Create and confirm bookings for ocean freight shipments with full container specification.
• Manage shipments end-to-end, from creation to document uploads.
• Access reference data such as commodity types and HS codes to validate and enrich payloads.

Who This API Is For

This documentation is intended for developers integrating OnePort 365's freight services into a third-party platform. You should be comfortable working with REST APIs, JSON payloads, and HTTP Bearer Token authentication.

Base URL

All API endpoints are relative to the base URL for your target environment. Prefix every endpoint path in this documentation with the appropriate base URL.

Authentication

The API uses Bearer Token authentication. Every request — except Register and Login — must include a valid token in the Authorization header.

Authorization: Bearer <your_token>

Tokens are obtained by completing the registration and login flow. Follow these steps before making any other API calls:

1. Register — Create an account with your email, password, name, and phone. An OTP is sent to your email.
2. Verify OTP — Confirm your email using the OTP. Your account is inactive until this step is completed.
3. Login — Authenticate with your credentials. The response contains your bearer token.
4. Store and use the token — Include it in the Authorization header on every subsequent request.

If your token expires, call Login again for a fresh one. For forgotten passwords, use the Forgot Password → Reset Password flow.

Request & Response Format

All request bodies must be sent as JSON (Content-Type: application/json), except for document uploads which use multipart/form-data. All responses are returned as JSON. A successful request returns a 2xx status code. Errors return a corresponding 4xx or 5xx status with a message body.

Resource Groups

The API is organized into five groups, each covering a distinct domain of the freight workflow:

Typical Integration Flow

Most integrations follow this end-to-end sequence. Each step depends on data returned by the previous one.

1.  Register
        ↓
2.  Verify OTP         (activates the account)
        ↓
3.  Login              →  receive bearer token
        ↓
4.  Get Live Rates     (pass search_id to next steps)
        ↓
5.  Confirm Live Rates (validate pricing in your chosen currency)
        ↓
6.  Select Rate        (locks the rate for a booking)
        ↓
7.  Create Booking     (origin, destination, container spec, cargo-ready date)
        ↓
8.  Confirm Booking    (links shipment_id and finalizes container details)
        ↓
9.  Create Shipment    (lane, multi-container, goods details)
        ↓
10. Upload Documents   (bill of lading, NXP, packing list, etc.)

Use the DaaS — Commodity Types endpoint at any point in the flow to look up valid HS codes, commodity categories, or descriptions to populate booking and shipment payloads correctly.

Key Concepts

search_id

A search_id ties together the three Live Rates calls — Get, Confirm, and Select. It represents a single rate-search session and must be passed as a path variable in all three endpoints.

booking_id vs shipment_id

A booking is a freight reservation — the intent to ship. A shipment is the operational record that tracks the cargo from origin to destination. They are linked: when you confirm a booking, you provide a shipment_id to tie them together.

Port Codes

Origin and destination ports are identified using UN/LOCODE — the United Nations Code for Trade and Transport Locations. For example, NGAPP is Apapa (Lagos, Nigeria) and DEHAM is Hamburg, Germany.

Container Sizes & Types

Container sizes follow the standard format: 20FT, 40FT, 40HC. Container types include dry (standard), reefer (refrigerated), and others depending on carrier availability.