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

Karrio Shipments API

Create, manage, rate, purchase, and void shipments.

Karrio Shipments API is one of 2 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.

This API exposes 7 operations across 4 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.karrio.io, http://localhost:5002.

7 operations 4 paths 0 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.karrio.io
http://localhost:5002
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Karrio Shipments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Karrio API token sent as a Bearer credential in the Authorization header.

Paths & Operations 7

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

Shipments 7

Create, manage, rate, purchase, and void shipments.

GET
/v1/shipments
Retrieve all shipments
listShipments → 200
POST
/v1/shipments
Create a shipment
createShipment body → 201
GET
/v1/shipments/{id}
Retrieve a shipment
getShipment 1 param → 200
PATCH
/v1/shipments/{id}
Update a shipment
updateShipment 1 param body → 200
DELETE
/v1/shipments/{id}
Void a shipment
voidShipment 1 param → 200
POST
/v1/shipments/{id}/purchase
Purchase a shipping label
purchaseShipment 1 param body → 200
POST
/v1/shipments/{id}/rates
Refresh shipment rates
fetchShipmentRates 1 param → 200

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 Shipping API