Karrio Carriers API
This is an object representing your Karrio carrier extension. You can retrieve all supported carrier extensions available.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/karrio:karrio-carriers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: 'Karrio is a multi-carrier shipping API that simplifies the integration of logistics carrier services.
The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded
request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The Karrio API differs for every account as we release new versions.
These docs are customized to your version of the API.
## Versioning
When backwards-incompatible changes are made to the API, a new, dated version is released.
The current version is `2024.12.6`.
Read our API changelog to learn more about backwards compatibility.
As a precaution, use API versioning to check a new API version before committing to an upgrade.
## Environments
The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`.
In development, it is therefore possible to add carrier connections, get live rates,
buy labels, create trackers and schedule pickups in `test_mode`.
## Pagination
All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list addresses,
list shipments, and list trackers. These list API methods share a common structure, taking at least these
two parameters: limit, and offset.
Karrio utilizes offset-based pagination via the offset and limit parameters.
Both parameters take a number as value (see below) and return objects in reverse chronological order.
The offset parameter returns objects listed after an index.
The limit parameter take a limit on the number of objects to be returned from 1 to 100.
```json
{
"count": 100,
"next": "/v1/shipments?limit=25&offset=50",
"previous": "/v1/shipments?limit=25&offset=25",
"results": [
{ ... },
]
}
```
## Metadata
Updateable Karrio objects—including Shipment and Order have a metadata parameter.
You can use this parameter to attach key-value data to these Karrio objects.
Metadata is useful for storing additional, structured information on an object.
As an example, you could store your user''s full name and corresponding unique identifier
from your system on a Karrio Order object.
Do not store any sensitive information as metadata.
## Authentication
API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret
API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via HTTP Basic Auth. Provide your API token as
the basic auth username value. You do not need to provide a password.
```shell
$ curl https://instance.api.com/v1/shipments \
-u key_xxxxxx:
# The colon prevents curl from asking for a password.
```
If you need to authenticate via bearer auth (e.g., for a cross-origin request),
use `-H "Authorization: Token key_xxxxxx"` instead of `-u key_xxxxxx`.
All API requests must be made over HTTPS.
API requests without authentication will also fail.'
title: Karrio Carriers API
version: 2024.12.6
tags:
- name: Carriers
description: 'This is an object representing your Karrio carrier extension.
You can retrieve all supported carrier extensions available.'
paths:
/v1/carriers:
get:
operationId: listCarriers
description: Returns the list of configured carriers
summary: List all carriers
tags:
- Carriers
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CarrierDetails'
examples:
CarrierList:
value:
- carrier_name: dhl_express
display_name: DHL Express
connection_fields:
site_id:
name: site_id
required: true
type: string
password:
name: password
required: true
type: string
account_number:
name: account_number
required: false
type: string
capabilities:
- paperless
- shipping
- tracking
- rating
- pickup
config_fields:
label_type:
code: label_type
name: label_type
required: false
type: string
skip_service_filter:
code: skip_service_filter
name: skip_service_filter
required: false
type: string
shipping_options:
code: shipping_options
name: shipping_options
required: false
type: list
shipping_services:
code: shipping_services
name: shipping_services
required: false
type: list
summary: Carrier List
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: listCarriers
/v1/carriers/{carrier_name}/services:
get:
operationId: getServices
description: Retrieve a carrier's services
summary: Get carrier services
parameters:
- in: path
name: carrier_name
schema:
type: string
description: 'The unique carrier slug. <br/>Values: `allied_express`, `allied_express_local`, `amazon_shipping`, `aramex`, `asendia_us`, `australiapost`, `boxknight`, `bpost`, `canadapost`, `canpar`, `chronopost`, `colissimo`, `dhl_express`, `dhl_parcel_de`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `easyship`, `eshipper`, `fedex`, `fedex_ws`, `freightcom`, `generic`, `geodis`, `hay_post`, `laposte`, `locate2u`, `nationex`, `purolator`, `roadie`, `royalmail`, `sapient`, `seko`, `sendle`, `tge`, `tnt`, `ups`, `usps`, `usps_international`, `usps_wt`, `usps_wt_international`, `zoom2u`'
required: true
tags:
- Carriers
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties: {}
examples:
CarrierList:
value:
canadapost_regular_parcel: DOM.RP
canadapost_expedited_parcel: DOM.EP
canadapost_xpresspost: DOM.XP
canadapost_xpresspost_certified: DOM.XP.CERT
canadapost_priority: DOM.PC
canadapost_library_books: DOM.LIB
canadapost_expedited_parcel_usa: USA.EP
canadapost_priority_worldwide_envelope_usa: USA.PW.ENV
canadapost_priority_worldwide_pak_usa: USA.PW.PAK
canadapost_priority_worldwide_parcel_usa: USA.PW.PARCEL
canadapost_small_packet_usa_air: USA.SP.AIR
canadapost_tracked_packet_usa: USA.TP
canadapost_tracked_packet_usa_lvm: USA.TP.LVM
canadapost_xpresspost_usa: USA.XP
canadapost_xpresspost_international: INT.XP
canadapost_international_parcel_air: INT.IP.AIR
canadapost_international_parcel_surface: INT.IP.SURF
canadapost_priority_worldwide_envelope_intl: INT.PW.ENV
canadapost_priority_worldwide_pak_intl: INT.PW.PAK
canadapost_priority_worldwide_parcel_intl: INT.PW.PARCEL
canadapost_small_packet_international_air: INT.SP.AIR
canadapost_small_packet_international_surface: INT.SP.SURF
canadapost_tracked_packet_international: INT.TP
summary: Carrier List
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: ''
x-operationId: getServices
components:
schemas:
CarrierDetails:
type: object
properties:
carrier_name:
enum:
- allied_express
- allied_express_local
- amazon_shipping
- aramex
- asendia_us
- australiapost
- boxknight
- bpost
- canadapost
- canpar
- chronopost
- colissimo
- dhl_express
- dhl_parcel_de
- dhl_poland
- dhl_universal
- dicom
- dpd
- dpdhl
- easypost
- easyship
- eshipper
- fedex
- fedex_ws
- freightcom
- generic
- geodis
- hay_post
- laposte
- locate2u
- nationex
- purolator
- roadie
- royalmail
- sapient
- seko
- sendle
- tge
- tnt
- ups
- usps
- usps_international
- usps_wt
- usps_wt_international
- zoom2u
type: string
x-spec-enum-id: 3812983dc743ed62
description: Indicates a carrier (type)
display_name:
type: string
description: The carrier verbose name.
capabilities:
type: array
items:
type: string
default: []
description: The carrier supported and enabled capabilities.
connection_fields:
type: object
additionalProperties: {}
default: {}
description: The carrier connection fields.
config_fields:
type: object
additionalProperties: {}
default: {}
description: The carrier connection config.
required:
- carrier_name
- display_name
ErrorResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/APIError'
description: The list of API errors
APIError:
type: object
properties:
message:
type: string
description: The error or warning message
code:
type: string
description: The message code
details:
type: object
additionalProperties: {}
description: any additional details
securitySchemes:
JWT:
in: header
type: apiKey
scheme: bearer
bearerFormat: JWT
name: Authorization
description: 'Authorization: Bearer xxx.xxx.xxx'
OAuth2:
type: oauth2
in: header
name: Authorization
flows:
authorizationCode:
authorizationUrl: /oauth/authorize/
tokenUrl: /oauth/token/
scopes:
read: Reading scope
write: Writing scope
openid: OpenID connect
description: 'Authorization: Bearer xxxxxxxx'
Token:
type: apiKey
in: header
name: Authorization
description: 'Authorization: Token key_xxxxxxxx'
TokenBasic:
type: http
scheme: basic
name: Authorization
description: '-u key_xxxxxxxx:'
x-provenance:
method: harvested
publisher: Karrio
source: https://www.karrio.io/openapi.yml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)