karrio
karrio copied to clipboard
Published
20 hours ago •
karrioapi
karrioapi
Programmable Shipping API (self-hosted)
Karrio - The Universal Shipping API
karrio makes shipping feature integration simple and accessible. Help us out… If you love open source and great software, give us a star! 🌟
Features
- Headless Shipping: Access a network of traditional and modern shipping carrier API-first
- Multi-carrier SDK: Integrate karrio once and connect to multiple shipping carrier APIs
- Extensible: Use the karrio SDK Framework to integrate with custom carrier APIs.
- Shipping: Connect carrier accounts, get live rates and purchase shipping labels.
- Tracking: Create package tracker, get real time tracking status and provide a branded tracking page.
- Address Validation: Validate shipping addresses using integrated 3rd party APIs.
- Cloud: Optimized for deployments using Docker.
- Dashboard: Use the karrio dashboard to orchestrate your logistics operations.
Try it now
There are several ways to use Karrio:
- Karrio Cloud let's you use the fullset of shipping features. you don't need to deploy anything. We will manage and scale your infrastructure.
- Karrio OSS is an open-source version of karrio that provides the core functionality of karrio (rating API, tracking API, shipping API), but lacks more advanced features (multi-tenant/orgs, shipping billing data, built-in address validation, etc.)
- Karrio SDK is the core of the karrio abstraction layer. It can be installed as a simple set of python libraries to do the low level carrier integration scripting yourself.
Source code for all editions is contained in this repository. See the License section for more details.
Status
- [x] Alpha: We are testing karrio with a closed set of customers
- [x] Private Beta: Stable enough for most non-enterprise use-cases
- [ ] Public: Production-ready
We are currently in Private Beta. Watch "releases" of this repo to get notified of major updates.
Self-hosted installation
Karrio OSS
check the latest version tags of the karrio/server image on Docker Hub
Using our Docker image
- Start a Postgres database
docker run -d \
--name db --rm \
-e POSTGRES_DB=db \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=postgres \
postgres
- Run your shipping API
docker run -d \
--name karrio --rm \
-e DEBUG_MODE=True \
-e [email protected] \
-e ADMIN_PASSWORD=demo \
--link=db:db -p 5002:5002 \
danh91.docker.scarf.sh/karrio/server:2022.6rc
Or using docker-compose
- Create a
docker-compose.ymlfile
version: '3'
services:
db:
image: postgres
restart: unless-stopped
environment:
POSTGRES_DB: "db"
POSTGRES_USER: "postgres"
POSTGRES_PASSWORD: "postgres"
networks:
- db_network
karrio:
image: danh91.docker.scarf.sh/karrio/server:2022.6rc
restart: unless-stopped
environment:
- DEBUG_MODE=True
- ALLOWED_HOSTS=*
- [email protected]
- ADMIN_PASSWORD=demo
- DATABASE_NAME=db
- DATABASE_HOST=db
- DATABASE_PORT=5432
- DATABASE_USERNAME=postgres
- DATABASE_PASSWORD=postgres
depends_on:
- db
networks:
- db_network
volumes:
karriodb:
driver: local
networks:
db_network:
driver: bridge
- Run the application
docker-compose up
Karrio should now be running at http://localhost:5002
Default Login
| Password | |
|---|---|
| [email protected] | demo |
Official Karrio Server Client Libraries
Karrio SDK
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-poland -
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
from karrio.core.models import Address, Parcel, RateRequest
from karrio.mappers.canadapost 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"),
# ],
# )
# ]
Resources
License
This repository contains both OSS-licensed and non-OSS-licensed files. We maintain one repository rather than two separate repositories mainly for development convenience.
All files in the /insiders fall under the Karrio LICENSE.
The remaining files fall under the Apache 2 license. Karrio OSS is built only from the Apache-licensed files in this repository.
Any other questions, mail us at [email protected] We’d love to meet you!
karrioapi