purplship-python 2021.11

purplship Multi-carrier Shipping API Python client library

purplship-python

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.

Documentation

See the full Python API docs.

Requirements

Python >= 3.6

Installation & Usage

pip install

pip install purplship-python

Then import the package:

import purplship

Usage

Please follow the installation procedure and then run the following:

from __future__ import print_function
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'

try:
    api_response = purplship.carriers.list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling purplship.Carriers->list: %s\n" % e)

Documentation For Models

• Address
• AddressData
• AddressList
• AddressValidation
• CarrierList
• CarrierSettings
• Charge
• Commodity
• CommodityData
• Customs
• CustomsData
• CustomsList
• Duty
• ErrorResponse
• Message
• Metadata
• Operation
• OperationConfirmation
• OperationResponse
• Parcel
• ParcelData
• ParcelList
• Payment
• Pickup
• PickupCancelData
• PickupCancelRequest
• PickupData
• PickupList
• PickupRequest
• PickupResponse
• PickupUpdateData
• PickupUpdateRequest
• Rate
• RateRequest
• RateResponse
• References
• Shipment
• ShipmentCancelRequest
• ShipmentData
• ShipmentList
• ShipmentPurchaseData
• ShipmentRateData
• ShippingRequest
• TokenObtainPair
• TokenPair
• TokenRefresh
• TokenVerify
• TrackerList
• TrackingEvent
• TrackingResponse
• TrackingStatus
• Webhook
• WebhookData
• WebhookList
• WebhookTestRequest

Author

Purplship Team | [e-mail] | purplship.com