PurplShip Multi-carrier Shipping API Python client library
Project description
purplship
PurplShip is a Multi-carrier Shipping API that simplifies the integration of logistic carrier services.
Visit purplship.com to deploy your private cloud multi-carrier shipping API instance.
Requirements.
Python 3.4+
Installation & Usage
pip install
pip install purplship-python
Then import the package:
import purplship
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import purplship
from purplship.rest import ApiException
from pprint import pprint
# Configure API key authorization: Token
purplship.api_key = 'YOUR_API_KEY'
purplship.host = 'https://instance.purplship.api/v1'
try:
api_response = purplship.Carriers.list()
pprint(api_response)
except ApiException as e:
print("Exception when calling Carriers->list: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://instance.purplship.api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
Carriers | list | GET /carriers | List all Carriers |
Carriers | retrieve | GET /carriers/{carrier_id_or_pk} | Retrieve a Carrier |
Rate | fetch | POST /proxy/rates | Fetch Shipment Rates |
Shipment | create | POST /proxy/shipments | Create a Shipment |
Tracking | fetch | GET /proxy/tracking/{carrier_name}/{tracking_number} | Track a Shipment |
Utils | references | GET /references | Get all References |
Utils | print_label | POST /labels | Print a Label |
Documentation For Models
- Address
- Card
- CarrierSettings
- Charge
- Commodity
- Customs
- Doc
- ErrorResponse
- Invoice
- LabelPrintingRequest
- Message
- Options
- Parcel
- Payment
- Rate
- RateRequest
- RateResponse
- References
- Shipment
- ShipmentRequest
- ShipmentResponse
- TrackingDetails
- TrackingEvent
- TrackingResponse
Documentation For Authorization
Token
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
OAuth2 password
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes:
- read: Read everything.
- write: Write everything,
Author
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
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for purplship_python-2020.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0198357332d4e76230e1d72ecc37b26bc8ed607b63930eebbc5c9e6570ddaf35 |
|
MD5 | 28cb4626d42f274cbe4201dde6fdc8c7 |
|
BLAKE2b-256 | 0d05650a34b9a142c46d198ae144440deb45f38725bd706415f4b27a18cb6bb3 |