gm-backoffice-client

Client for mtrl.ai orders API


License
MIT
Install
pip install gm-backoffice-client==1.3.1

Documentation

Backoffice client

Build Status codecov PyPI version

This is a simple client for our v1 order API.

This client incapsulates all low-level logic, like makeing HTTP-queries or order schema validation.

Install

The project is available in pypi, so

# install from pip
$ pip install backoffice-client

Usage

from backoffice.client import BackofficeClient

client = BackofficeClient(
    url='https://app.gdml.ru/api/v1/',
    token='your-auth-token',
)

order = {
    'customer': {
        'name': 'Константин Львович Череззаборногузадерищенко',
        'phone': '+7 901 001-02-03',
        'email': 'putthelegoverthegrid@work.com',
    },
    'delivery': {
        'address': 'г. Магадан, ул. 3-я Спортивная, д. 15 кв. 22',
        'desired_date': '12.01.2023',
    },
}
items = [
    {
        'site_id': 2194,
        'name': 'Жердь для забора чугуниевая, 3.14 метра',
        'quantity': 15,
        'price': 200, # per single unit
    },
    {
        'name': 'Подборка для чугуниевой жерди, полтонны',  # the minimal item
    },
]

client.validator.validate_order(order)  # also called during send()
client.validator.validate_items(items)  # and this one either

client.send(order, items)