Metadata-Version: 2.4
Name: shipthisapi-python
Version: 1.3.0
Summary: ShipthisAPI utility package
Home-page: https://github.com/shipthisco/shipthisapi-python
Author: Mayur Rawte
Author-email: mayur@shipthis.co
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: summary

# ShipthisAPI Python 

[![PyPI version](https://badge.fury.io/py/shipthisapi-python.svg)](https://badge.fury.io/py/shipthisapi-python)

A Python wrapper package for ShipthisAPI for making api calls using python.


Features
--------

* Demo setup with ``demo.py``
* Simple Step API calls.

Quickstart
----------


Install the latest `shipthisapi-python`
if you haven't installed it yet.


    pip install shipthisapi-python


[Generate a API Key For your Organisation](https://shipthis.crisp.help/en/article/how-to-generate-an-api-key-1qnsq1d/?bust=1633352029281)


```python
from ShipthisAPI.shipthisapi import ShipthisAPI

x_api_key = '<your_api_key>'
organisation = 'demo'
region_id='<your_region_id>'
location_id='<your_location_id>'


shipthisapi = ShipthisAPI(organisation=organisation, x_api_key=x_api_key, region_id=region_id, location_id=location_id)


# Get Organisation/User Info 

print(shipthisapi.info())


# Get Invoice Collection List

print(shipthisapi.get_list(collection_name='invoice'))

# Get all Sea list

print(shipthisapi.get_list(collection_name="sea_shipment", params={"count": 2}))


```


Documentation
-----------

For more details related to available fields and operations check our [developer portal](https://developer.shipthis.co)


 Available Operations 

-  Get Organisation / User Information
-  Create New Collection Entry
-  Update Collection
-  Get Collection Items
-  Delete an existing collection item



Support
------------------

If you have any queries related to usage of the api please raise a issue [here](https://github.com/shipthisco/shipthisapi-python) 




