Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Terminal49 Shipments API

The Shipments API from Terminal49 — 4 operation(s) for shipments.

Terminal49 Shipments API is one of 7 APIs that Terminal49 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://api.terminal49.com/v2.

5 operations 4 paths 5 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://api.terminal49.com/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Terminal49 Shipments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — Token-based authentication. Send the header Authorization: Token YOURAPIKEY.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Shipments 5
GET
/shipments
List shipments
listShipments 2 params → 200
GET
/shipments/{id}
Retrieve a shipment
getShipment 1 param → 200
PATCH
/shipments/{id}
Edit a shipment
updateShipment 1 param body → 200
POST
/shipments/{id}/stop_tracking
Stop tracking a shipment
stopTrackingShipment 1 param → 200
POST
/shipments/{id}/resume_tracking
Resume tracking a shipment
resumeTrackingShipment 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ShipmentAttributes (22 properties), JsonApiLinks (5 properties), ShipmentResource (4 properties), ShipmentList (2 properties). Each schema is shown below with its type and property counts.

ShipmentAttributes
object
22 properties
JsonApiLinks
object
5 properties
ShipmentResource
object
4 properties
ShipmentSingle
object
1 property
ShipmentList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terminal49-shipments-api-openapi.yml Raw ↑

Other APIs Terminal49 publishes across the network.

Terminal49 Containers API
Terminal49 Shipping Lines API
Terminal49 Terminals API
Terminal49 Tracking Requests API
Terminal49 Transport Events API
Terminal49 Webhooks API