Skip to main content

Multi-carrier shipping API integration with python

Project description

Karrio

puprlship-tests License Codacy Badge

karrio is a multi-carrier shipping SDK.

The key features are:

  • Unified API: A standardized set of models representing the common shipping data (Address, Parcel, Shipment...)
  • Intuitive API: A library that abstracts and unifies the typical shipping API services (Rating, Shipping, Tracking...)
  • Multi-carrier: Integrate karrio once and connect to multiple shipping carrier APIs
  • Custom carrier: A framework to integrate a shipping carrier services within hours instead of months

Requirements

Python 3.11+

Installation

# install karrio core
pip install karrio

# eg: install the karrio canadapost extention
pip install karrio.canadapost
Additional carrier extensions
  • karrio.aramex
  • karrio.australiapost
  • karrio.canadapost
  • karrio.canpar
  • karrio.dhl-express
  • karrio.dhl-universal
  • karrio.dicom
  • karrio.fedex
  • karrio.purolator
  • karrio.royalmail
  • karrio.sendle
  • karrio.sf-express
  • karrio.tnt
  • karrio.ups
  • karrio.usps
  • karrio.usps-international
  • karrio.yanwen
  • karrio.yunexpress

Usage

Rates Fetching
  • Fetch shipping rates
import karrio.sdk as karrio
from karrio.core.models import Address, Parcel, RateRequest
from karrio.mappers.canadapost.settings import Settings


# Initialize a carrier gateway
canadapost = karrio.gateway["canadapost"].create(
    Settings(
        username="6e93d53968881714",
        password="0bfa9fcb9853d1f51ee57a",
        customer_number="2004381",
        contract_id="42708517",
        test=True
    )
)

# Fetching shipment rates

# Provide the shipper's address
shipper = Address(
    postal_code="V6M2V9",
    city="Vancouver",
    country_code="CA",
    state_code="BC",
    address_line1="5840 Oak St"
)

# Provide the recipient's address
recipient = Address(
    postal_code="E1C4Z8",
    city="Moncton",
    country_code="CA",
    state_code="NB",
    residential=False,
    address_line1="125 Church St"
)

# Specify your package dimensions and weight
parcel = Parcel(
    height=3.0,
    length=6.0,
    width=3.0,
    weight=0.5,
    weight_unit='KG',
    dimension_unit='CM'
)

# Prepare a rate request
rate_request = RateRequest(
    shipper=shipper,
    recipient=recipient,
    parcels=[parcel],
    services=["canadapost_xpresspost"],
)

# Send a rate request using a carrier gateway
response = karrio.Rating.fetch(rate_request).from_(canadapost)

# Parse the returned response
rates, messages = response.parse()

print(rates)
# [
#     RateDetails(
#         carrier_name="canadapost",
#         carrier_id="canadapost",
#         currency="CAD",
#         transit_days=2,
#         service="canadapost_xpresspost",
#         discount=1.38,
#         base_charge=12.26,
#         total_charge=13.64,
#         duties_and_taxes=0.0,
#         extra_charges=[
#             ChargeDetails(name="Automation discount", amount=-0.37, currency="CAD"),
#             ChargeDetails(name="Fuel surcharge", amount=1.75, currency="CAD"),
#         ],
#         meta=None,
#         id=None,
#     )
# ]

Resources

Join us on Discord

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

karrio-2026.1.28-py3-none-any.whl (215.3 kB view details)

Uploaded Python 3

File details

Details for the file karrio-2026.1.28-py3-none-any.whl.

File metadata

  • Download URL: karrio-2026.1.28-py3-none-any.whl
  • Upload date:
  • Size: 215.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for karrio-2026.1.28-py3-none-any.whl
Algorithm Hash digest
SHA256 845b5151dbd405214117d92d3414cbf70d73cd2580f86608414d3eb8a8185822
MD5 c75b1ff11ab51b663a03ac4d4681bacd
BLAKE2b-256 44f8b179e4e555207ccaaf6d47f643c42b62692f24f1995a124753e317495366

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page