Go to file
Raimon Esteve 83011e7737 Merge task-028718 2016-11-18 15:23:38 +01:00
doc Initial release 2012-10-08 11:52:55 +02:00
envialia Increase version number 2016-11-18 15:13:45 +01:00
CHANGELOG Initial release 2012-10-08 11:52:55 +02:00
COPYRIGHT Initial release 2012-10-08 11:52:55 +02:00
INSTALL Initial release 2012-10-08 11:52:55 +02:00
LICENSE Initial release 2012-10-08 11:52:55 +02:00
MANIFEST.in Initial release 2012-10-08 11:52:55 +02:00
README README 2014-03-12 19:07:13 +01:00
setup.py Guideline pep8 2012-11-15 13:44:50 +01:00
test.py Add timeout configuration 2016-10-19 09:52:25 +02:00

README

Envialia
========

Python API Envialia carrier.

Features
--------

- Services
- Test connection
- List all shipments (by date)
- Create/Send shipments to Envialia
- Get shipment info (details)
- Get shipment state
- Delete shipment

Usage Examples
--------------

Example API in test.py file

Services
--------

.. code-block:: python

    from envialia.utils import services
    services()

Test connection
---------------

.. code-block:: python

    with API(agency, customer, password, debug) as envialia_api:
         envialia_api.test_connection()

List all shipments by date
--------------------------

.. code-block:: python

    with Picking(agency, customer, password, debug) as picking_api:
        date = None  # date YYYY/MM/DD
        print picking_api.list(date)

Create/Send shipments to Envialia
---------------------------------

.. code-block:: python

    with Picking(agency, customer, password, debug) as picking_api:
        data = {...}
        reference = picking_api.create(data)

Get shipment info (details)
---------------------------

.. code-block:: python

    with Picking(agency, customer, password, debug) as picking_api:
        reference = '123456'
        data = {}
        data['agency_origin'] = agency
        data['agency_cargo'] = agency
        picking_api.info(reference, data)

Get shipment state
------------------

.. code-block:: python

    with Picking(agency, customer, password, debug) as picking_api:
        reference = '123456'
        data = {}
        data['agency_origin'] = agency
        data['agency_cargo'] = agency
        picking_api.state(reference, data)

Delete shipment
---------------

.. code-block:: python

    with Picking(agency, customer, password, debug) as picking_api:
        reference = '123456'
        data = {}
        data['agency_origin'] = agency
        data['agency_cargo'] = agency
        picking_api.delete(reference, data)