Skip to content
APIv1
llms.txt
Menu

Overview

A read-only REST API for Cubic customers to query their own shipments.

View as markdown

Endpoints

Base URL: https://api.gocubic.io/v1

MethodPathPurpose
GET/v1/meVerify the key. Call this first.
GET/v1/shipmentsList shipments, most recently updated first.
GET/v1/shipments/{reference}One shipment by its Cubic reference, for example QB10293.
GET/v1/openapi.jsonThe OpenAPI 3.1 document. No authentication.

Both shipment endpoints return the same Shipment object.

Conventions

  • Auth: Authorization: Bearer <key>, with the key in CUBIC_API_KEY. One key belongs to one customer account. See Authentication.
  • Format: JSON. camelCase keys. Enum values are case-sensitive (OceanFCL, EXW).
  • Nulls: null or an empty list means "not known yet" or "does not apply"; never an error.
  • Dates: milestone dates are local yyyy-MM-dd with an optional local HH:mm, no time zone. createdAt, updatedAt and cancelledAt are ISO 8601 UTC.
  • Units: as recorded, not normalised. Read the unit next to every value.
  • Pagination: follow nextCursor until it is null. See Pagination.
  • Errors: RFC 9457 application/problem+json with a code and a hint. See Errors.
  • Rate limit: 60 requests per minute per key. See Rate limits.

Machine-readable docs

ResourceURL
Index of these docshttps://developers.gocubic.io/llms.txt
All of these docs as one markdown filehttps://developers.gocubic.io/llms-full.txt
OpenAPI 3.1 documenthttps://developers.gocubic.io/openapi.json
Any page as markdownAppend .md to its URL: https://developers.gocubic.io/quickstart.md. This page is https://developers.gocubic.io/index.md.

AI agents: read For AI agents next. Everyone else: Quickstart.