Multi-carrier shipping API integration with python
Project description
Purplship - The Open Source multi-carrier shipping SDK
Puprlship is a modern development kit that simplifies the integration of shipping carriers services into an app.
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
,Pickup
,Tracking
...) - Multi-carrier: Integrate Purplship once and connect to multiple shipping carrier APIs
- Custom carrier: A framework to integrate a shipping carrier services within hours instead of months
For a complete shipping management REST API with a dashboard checkout purplship-server.
Requirements
Python 3.6+
Installation
# install purplship core
pip install purplship
# install the purplship canadapost extention
pip install purplship.canadapost
Additional extensions:
Available carriers
purplship.aramex
purplship.australiapost
purplship.canadapost
purplship.canpar
purplship.dhl-express
purplship.dhl-universal
purplship.dicom
purplship.fedex-express
purplship.purolator-courier
purplship.royalmail
purplship.sendle
purplship.sf-express
purplship.ups-package
purplship.usps
purplship.yanwen
purplship.yunexpress
Usage
- Fetch shipping rates
import purplship
from purplship.core.models import Address, Parcel, RateRequest
from purplship.mappers.canadapost.settings import Settings
# Initialize a carrier gateway
canadapost = purplship.gateway["canadapost"].create(
Settings(
username="username",
password="password",
customer_number="123456789",
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],
)
# Send a rate request using a carrier gateway
response = purplship.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
Contributing
We encourage you to contribute to Purplship! Please check out the Contributing to Purplship guide for guidelines about how to proceed. Join us!
Do you want to extend Purplship and integrate a custom carrier, check out Extending Purplship
License
This project is licensed under the terms of the LGPL v3
license.
Please see LICENSE.md for licensing details.
Authors
- Daniel K. | @DanHK91 | danielk.xyz
- Purplship Team | hello@purplship.com | purplship.com
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
Built Distribution
Hashes for purplship-2021.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c04326f69376811d1440553afa9d5d2f3bab0ee250e156f7c45feaa69a96e80 |
|
MD5 | b7245c9b44299bea917f2bdf341e9116 |
|
BLAKE2b-256 | c0c528dac90d275c3feca177477410b6b63ab5a355adc01cae92bcd48e0037fb |