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

Karrio Shipments API

This is an object representing your Karrio shipment. A Shipment guides you through process of preparing and purchasing a label for an order. A Shipment transitions through multiple statuses throughout its lifetime as the package shipped makes its journey to it's destination.

Karrio Shipments API is one of 17 APIs that Karrio 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 8 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 2026.1.32.

Requests are made against the base URL https://{karrio-instance-host}/.

8 operations 6 paths 22 schemas 2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.1.32
Base URL
https://{karrio-instance-host}/
Authentication
API Key, OAuth 2.0, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 4

Karrio Shipments API declares 4 security schemes for authenticating requests. An API key is passed in the header as Authorization (JWT). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the header as Authorization (Token). It accepts HTTP basic authentication (TokenBasic).

  • JWT — Authorization: Bearer xxx.xxx.xxx
  • OAuth2 — Authorization: Bearer xxxxxxxx
  • Token — Authorization: Token keyxxxxxxxx
  • TokenBasic — -u keyxxxxxxxx:

Paths & Operations 8

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

Shipments 8

This is an object representing your Karrio shipment. A Shipment guides you through process of preparing and purchasing a label for an order. A Shipment transitions through multipl…

GET
/v1/shipments
List all shipments
$$$$$list 22 params → 200404500
POST
/v1/shipments
Create a shipment
$$$$$create body → 201400424500
GET
/v1/shipments/{id}
Retrieve a shipment
$$$$$retrieve 1 param → 200404500
PUT
/v1/shipments/{id}
Update a shipment
$$$$$update 1 param body → 200404400409424500
POST
/v1/shipments/{id}/cancel
Cancel a shipment
$$$$$cancel 1 param → 200304404400409424500
POST
/v1/shipments/{id}/documents/{doc}
Retrieve a shipment document
$$$$$document 2 params → 200404500
POST
/v1/shipments/{id}/purchase
Buy a shipment label
$$$$$purchase 1 param body → 200404400409424500
POST
/v1/shipments/{id}/rates
Fetch new shipment rates
$$$$$rates 1 param body → 200404400409424500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Shipment (38 properties), Address (19 properties), Commodity (19 properties), Parcel (18 properties). Each schema is shown below with its type and property counts.

ParcelData
object
16 properties 2 required
ShipmentPurchaseData
object
6 properties
Rate
object
12 properties 3 required
ShipmentData
object
16 properties 3 required
Charge
object
4 properties
Duty
object
4 properties
ShippingDocument
object
Serializer for shipping document download response.
5 properties 2 required
Shipment
object
38 properties 5 required
Commodity
object
19 properties 2 required
ErrorMessages
object
1 property
AddressValidation
object
2 properties 1 required
Parcel
object
18 properties 2 required
APIError
object
4 properties
CommodityData
object
17 properties 2 required
CustomsData
object
12 properties 1 required
ShipmentUpdateData
object
6 properties
AddressData
object
17 properties 1 required
Payment
object
3 properties
Message
object
6 properties
ShipmentRateData
object
5 properties
Address
object
19 properties 1 required
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

karrio-shipments-api-openapi.yml Raw ↑

Other APIs Karrio publishes across the network.

Karrio Addresses API
Karrio Auth API
Karrio Batches API
Karrio Carriers API
Karrio Connections API
Karrio Documents API
Karrio Manifests API
Karrio Orders API
Karrio Parcels API
Karrio Pickups API
Karrio Products API
Karrio Proxy API
Where this information came from

This is an independent, third-party profile of Karrio 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.