How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shipwell Shipments API

Multimodal freight shipments - the central platform resource. (confirmed)

Shipwell Shipments API is one of 5 APIs that Shipwell 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 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against 3 base URLs: https://api.shipwell.com/v2, https://sandbox-api.shipwell.com/v2, https://api.shipwell.com.

7 operations 4 paths 8 schemas 3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.shipwell.com/v2
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

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

  • authToken — Company-scoped API key passed in the Authorization header (the docs refer to this as the AuthToken scheme). Production and sandbox use separate keys. Keys can…

Paths & Operations 7

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

Shipments 7

Multimodal freight shipments - the central platform resource. (confirmed)

GET
/shipments/
List shipments
listShipments 2 params → 200401
POST
/shipments/
Create a shipment
createShipment body → 201401422
GET
/shipments/{shipmentId}/
Retrieve a shipment
getShipment 1 param → 200401404
PUT
/shipments/{shipmentId}/
Update a shipment
updateShipment 1 param body → 200401404422
GET
/shipments/{shipmentId}/notes/
List notes for a shipment or shipment quote
listShipmentNotes 1 param → 200401
POST
/shipments/{shipmentId}/notes/
Create a shipment note
createShipmentNote 1 param body → 201401
PUT
/shipments/tenders/{tenderId}/
Update a tendered shipment
updateTender 1 param body → 200401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Stop (7 properties), ShipmentInput (6 properties), Address (5 properties), LineItem (4 properties). Each schema is shown below with its type and property counts.

LineItem
object
4 properties
ShipmentInput
object
6 properties 2 required
Address
object
5 properties
Error
object
2 properties
ShipmentNote
object
3 properties
ShipmentList
object
3 properties
Stop
object
7 properties
Shipment

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shipwell-shipments-api-openapi.yml Raw ↑

Other APIs Shipwell publishes across the network.

Shipwell Carriers API
Shipwell Events and Webhooks API
Shipwell Orders API
Shipwell Quoting API
Where this information came from

This is an independent, third-party profile of Shipwell Shipments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.