purplship-python 2020.6.3

PurplShip Multi-carrier Shipping API Python client library

purplship

PurplShip is a Multi-carrier Shipping API that simplifies the integration of logistic carrier services

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 | [e-mail] | purplship.com