karrio-python 2022.3
karrio universal Shipping API Python client library
Requires Python: >=3.6
Keywords: Karrio,Multi-carrier API,Shipping API

# karrio-python

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

Visit [karrio.io](https://karrio.io) to deploy your private cloud multi-carrier shipping API instance.

## Documentation

See the full [Python API docs](https://docs.karrio.io/reference).

## Requirements

Python >= 3.6

## Installation & Usage

### pip install

```sh
pip install karrio-python
```

Then import the package:

```python
import karrio
```

### Usage

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
from __future__ import print_function
import karrio
from karrio.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
karrio.api_key = 'YOUR_API_KEY'
karrio.host = 'https://api.karrio.io'

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

```

## Documentation For Models

- [Address](docs/Address.md)
- [AddressData](docs/AddressData.md)
- [AddressList](docs/AddressList.md)
- [AddressValidation](docs/AddressValidation.md)
- [CarrierList](docs/CarrierList.md)
- [CarrierSettings](docs/CarrierSettings.md)
- [Charge](docs/Charge.md)
- [Commodity](docs/Commodity.md)
- [CommodityData](docs/CommodityData.md)
- [Customs](docs/Customs.md)
- [CustomsData](docs/CustomsData.md)
- [CustomsList](docs/CustomsList.md)
- [Documents](docs/Documents.md)
- [Duty](docs/Duty.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [Message](docs/Message.md)
- [Metadata](docs/Metadata.md)
- [Operation](docs/Operation.md)
- [OperationConfirmation](docs/OperationConfirmation.md)
- [OperationResponse](docs/OperationResponse.md)
- [Order](docs/Order.md)
- [OrderData](docs/OrderData.md)
- [OrderList](docs/OrderList.md)
- [OrderUpdateData](docs/OrderUpdateData.md)
- [Parcel](docs/Parcel.md)
- [ParcelData](docs/ParcelData.md)
- [ParcelList](docs/ParcelList.md)
- [Payment](docs/Payment.md)
- [Pickup](docs/Pickup.md)
- [PickupCancelData](docs/PickupCancelData.md)
- [PickupCancelRequest](docs/PickupCancelRequest.md)
- [PickupData](docs/PickupData.md)
- [PickupList](docs/PickupList.md)
- [PickupRequest](docs/PickupRequest.md)
- [PickupResponse](docs/PickupResponse.md)
- [PickupUpdateData](docs/PickupUpdateData.md)
- [PickupUpdateRequest](docs/PickupUpdateRequest.md)
- [Rate](docs/Rate.md)
- [RateRequest](docs/RateRequest.md)
- [RateResponse](docs/RateResponse.md)
- [References](docs/References.md)
- [Shipment](docs/Shipment.md)
- [ShipmentCancelRequest](docs/ShipmentCancelRequest.md)
- [ShipmentData](docs/ShipmentData.md)
- [ShipmentList](docs/ShipmentList.md)
- [ShipmentPurchaseData](docs/ShipmentPurchaseData.md)
- [ShipmentRateData](docs/ShipmentRateData.md)
- [ShipmentUpdateData](docs/ShipmentUpdateData.md)
- [ShippingRequest](docs/ShippingRequest.md)
- [ShippingResponse](docs/ShippingResponse.md)
- [TokenObtainPair](docs/TokenObtainPair.md)
- [TokenPair](docs/TokenPair.md)
- [TokenRefresh](docs/TokenRefresh.md)
- [TokenVerify](docs/TokenVerify.md)
- [TrackerList](docs/TrackerList.md)
- [TrackingEvent](docs/TrackingEvent.md)
- [TrackingResponse](docs/TrackingResponse.md)
- [TrackingStatus](docs/TrackingStatus.md)
- [Webhook](docs/Webhook.md)
- [WebhookData](docs/WebhookData.md)
- [WebhookList](docs/WebhookList.md)
- [WebhookTestRequest](docs/WebhookTestRequest.md)

## Author

Team Karrio | hello@karrio.io | [karrio.io](https://karrio.io)