API

Функция /1.0/order/get-list

Назначение: Получение списка заказов

Поля запроса:

Параметр	Описание	Тип	Обязательный	Пример
date_start	Дата начала диапозона	Дата	Да	2018-04-01
date_end	Дата завершение диапозона	Дата	Да	2018-06-30
limit	Количество записей	integer	Нет, по умолчанию 10 (мин 1 - макс 30)	10
offset	смещение	integer	Нет, по умолчанию 0 (мин 0)	10
profile_id	id профиля	integer	Нет	1

Поля ответа:

Параметр	Описание	Тип	Пример
sale_number	Номер заказа	integer(10)	1111319202
cargo_number	Номер груза	string	ТБЛЕКБ0051621250
date	Дата создания заказа	дата	2018-04-09
time	Время создания заказа	время	00:00:00
price	Стоимость заказа	decimal(10.2)	150.0
currency_code	Код валюты	строка	RUB
customer	Заказчик	partner
sender	Отправитель	partner
receiver	Получатель	partner
payment	Счет	payment
from	Пункт отправления	city
to	Пункт получения	city
status	Статусы груза	status

Описание типа partner

Параметр	Описание	Тип	Пример
debitor	Номер дебитора	integer(10)	0001011311
short_name	Краткое наименование дебитора	строка	"ООО ТК "КИТ""

Описание типа payment

Параметр	Описание	Тип	Пример
code	Код статуса счета	integer(1)	2
name	Статус счета	строка	Выставлен

Описание типа city

Параметр	Описание	Тип	Пример
country_code	Код страны	строка	RU
region_code	Код региона	integer	72
code	Код города	строка	720000200000
name	Населенный пункт	строка	Тобольск
type	Тип населенного пункта	строка	Город

Описание типа status

Параметр	Описание	Тип	Пример
date	Дата статуса	дата	2018-04-09
time	Время статуса	время	09:56:57
code	Код статуса	integer	01
name	Статус	строка	Новый заказ

Пример запроса:

{
    "date_start": "2018-04-01",
    "date_end": "2018-06-30",
    "profile_id": "1"
}

Пример ответа:

[
    {
        "to": {
            "code": "660000100000",
            "name": "Екатеринбург",
            "type": "Город",
            "region_code": "66",
            "country_code": "RU"
        },
        "date": "2018-04-09",
        "from": {
            "code": "720000200000",
            "name": "Тобольск",
            "type": "Город",
            "region_code": "72",
            "country_code": "RU"
        },
        "time": "00:00:00",
        "price": "150.0",
        "sender": {
            "debitor": "0001011311",
            "short_name": "ООО ТК \"КИТ\""
        },
        "status": [
            {
                "code": "00",
                "date": "2018-04-09",
                "name": "Новый заказ",
                "time": "09:56:57"
            },
            {
                "code": "01",
                "date": "2018-04-09",
                "name": "Груз принят",
                "time": "12:04:49"
            },
            {
                "code": "02",
                "date": "2018-04-09",
                "name": "Отправлен",
                "time": "12:46:45"
            },
            {
                "code": "03",
                "date": "2018-04-10",
                "name": "Прибыл",
                "time": "09:39:37"
            }
        ],
        "payment": {
            "code": "2",
            "name": "Выставлен"
        },
        "customer": {
            "debitor": "0001011311",
            "short_name": "ООО ТК \"КИТ\""
        },
        "recipient": {
            "debitor": "0001011311",
            "short_name": "ООО ТК \"КИТ\""
        },
        "sale_number": 6171781901,
        "cargo_number": "XXXXXX0062074336",
        "currency_code": "RUB"
    }
]

API-интеграция