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

In some scenarios, all we need is to send request to a carrier using the Karrio unified API. The Proxy API comes handy for that as it turn Karrio into a simple middleware thatconverts and validate your request and simply forward it to the shipping carrier server. **Note:** When using the proxy API, no objects are created in the Karrio system. excpet API logs and tracing records for debugging purposes.

Karrio Proxy API is one of 17 APIs that Karrio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 9 operations across 9 paths, and defines 40 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}/.

9 operations 9 paths 40 schemas 1 GET8 POST

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 Proxy 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 9

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

Proxy 9

In some scenarios, all we need is to send request to a carrier using the Karrio unified API. The Proxy API comes handy for that as it turn Karrio into a simple middleware that con…

POST
/v1/proxy/manifest
Create a manifest
@@@$generate_manifest body → 200400424500
POST
/v1/proxy/pickups/{carrier_name}
Schedule a pickup
@schedule_pickup 1 param body → 201400424500
POST
/v1/proxy/pickups/{carrier_name}/cancel
Cancel a pickup
@cancel_pickup 1 param body → 200400424500
POST
/v1/proxy/pickups/{carrier_name}/update
Update a pickup
@update_pickup 1 param body → 200400424500
POST
/v1/proxy/rates
Fetch shipment rates
@@fetch_rates body → 200400424500
POST
/v1/proxy/shipping
Buy a shipment label
@@@buy_label body → 200400424500
POST
/v1/proxy/shipping/{carrier_name}/cancel
Void a shipment label
@@@void_label 1 param body → 202400424
POST
/v1/proxy/tracking
Get tracking details
@@@@get_tracking 1 param body → 200400424500
GET
/v1/proxy/tracking/{carrier_name}/{tracking_number}deprecated
Track a shipment
@@@@track_shipment 3 params → 200400424500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are ShippingResponse (36 properties), Pickup (24 properties), Address (19 properties), TrackingInfo (19 properties). Each schema is shown below with its type and property counts.

TrackingEvent
object
10 properties
ParcelData
object
16 properties 2 required
ShipmentCancelRequest
object
4 properties 1 required
RateResponse
object
2 properties 1 required
PickupCancelRequest
object
4 properties 1 required
RateRequest
object
12 properties 3 required
Rate
object
12 properties 3 required
TrackingInfo
object
19 properties
ManifestRequest
object
5 properties 3 required
ShippingRequest
object
14 properties 5 required
Charge
object
4 properties
PickupUpdateRequest
object
11 properties 6 required
Duty
object
4 properties
ShippingDocument
object
Serializer for shipping document download response.
5 properties 2 required
TrackerDetails
object
17 properties 4 required
ErrorMessages
object
1 property
PickupRequest
object
12 properties 3 required
Commodity
object
19 properties 2 required
ManifestResponse
object
2 properties
AddressValidation
object
2 properties 1 required
Parcel
object
18 properties 2 required
OperationResponse
object
2 properties
APIError
object
4 properties
OperationConfirmation
object
4 properties 3 required
TrackingData
object
6 properties 2 required
CommodityData
object
17 properties 2 required
Documents
object
3 properties
CustomsData
object
12 properties 1 required
ManifestDocument
object
1 property
ManifestDetails
object
7 properties 3 required
TrackingResponse
object
2 properties
AddressData
object
17 properties 1 required
PickupResponse
object
2 properties
ShippingResponse
object
36 properties 5 required
Payment
object
3 properties
Message
object
6 properties
Pickup
object
24 properties 6 required
Images
object
2 properties
Address
object
19 properties 1 required
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

karrio-proxy-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 Shipments API
Where this information came from

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