API

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

Назначение: Информация по заказу

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

Параметр	Описание	Тип	Обязательный	Пример
sale_number	номер груза	string	да	1105871333
profile_id	id профиля	integer	да	1

Поля ответа:

Параметр	Описание	Тип	Пример
customer	Заказчик	partner
sender	Отправитель	partner
recipient	Получатель	partner
from	Откуда	city
to	Куда	city
contact_from	Контактное лицо отправителя	contact
contact_to	Контактное лицо получателя	contact
about_cargo	О грузе	orderCargo
total	Итого	orderTotal
service	Услуги	orderService
status	Статус	status
payment	Статус оплаты	payment
pickup_address	Адрес забора груза (с услугой забора адрес клиента, без адрес склада на котором был принят груз)	строка	ул. 8 Марта, дом № 269
delivery_address	Адрес доставки груза (с услугой доставки адрес клиента, без адрес склада на которой груз прибудет)	строка	ул. Северный луч, дом № 1”А”

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

Параметр	Описание	Тип	Пример
code	Код населенного пункта	integer (12)	660000300000
name	Имя населенного пункта	строка	Березовский
type	Тип населенного пункта	строка	Город

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

Параметр	Описание	Тип	Пример
debitor	Номер делового партнера в учетной системе	integer (10)	0001011311
name	Название организации или ФИО	строка	ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ ТРАНСПОРТНАЯ КОМПАНИЯ "GTD"
short_name	Краткое Название или Имя	строка	ООО ТК "GTD"
inn	ИНН	integer	123456789012
kpp	КПП	integer	1234567890
type	Тип клиента: 2 - физик 3 - ИП 1 - юрик	integer	1
phone	Номер телефона	строка	+73478370109

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

Параметр	Описание	Тип	Пример
locality	Название населенного пункта	строка	г.Екатеринбург
name	Краткое Название или Имя	partner	ООО ТК "GTD"
phone	Номер телефона	строка	+73478370109
time_work	Время забора груза	строка	с 12:00 до 18:00

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

Параметр	Описание	Тип	Пример
places	Количество мест	integer	3
weight	Вес груза	decimal(10.2)	1.0
weight_unit	Единица измерения веса	строка	кг
volume	Объем груза	decimal(10.3)	1.0
volume_unit	Единица измерения объема	строка	куб.м.

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

Параметр	Описание	Тип	Пример
nds	Сумма НДС	decimal(10.2)	100.00
price	Общая цена	decimal(10.2)	736.00
route	Направление	строка	Екатеринбург-Челябинск
comment	Комментарий заказа	строка	Домофон не работает
cargo_number	Номер заказа	строка	ЕКБЧЛБ0015786003

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

Параметр	Описание	Тип	Пример
nds	Сумма НДС	decimal(10.2)	100.00
price	Цена	decimal(10.2)	736.00
quantity	кол-во	integer	1
comment	Комментарий заказа	строка	Домофон не работает
currency_code	Код валюты	строка	RUB
payer_debitor	Номер дебитора плательщика	integer	0001011311
payer_short_name	Короткое название организации или фио плательщика	строка	ООО ТК "GTD"

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

Параметр	Описание	Тип	Пример
code	Код статуса 1 - олачено, 2 - не оплачено, 3 - отсрочка	integer	2
name	Название статуса	строка	Не оплачено

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

Параметр	Описание	Тип	Пример
date	Дата	дата	2018-01-09
time	Время	время	16:39:06
name	Название статуса	строка	Груз принят
code	Код статуса	строка	01

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

{
    "sale_number": "1105871333",
    "profile_id": "1"
}

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

{
    "to": {
        "code": "660000100000",
        "name": "Екатеринбург",
        "type": "Город"
    },
    "from": {
        "code": "720000200000",
        "name": "Тобольск",
        "type": "Город"
    },
    "total": {
        "nds": "0.0",
        "price": "150.0",
        "route": "Тобольск-Екатеринбург",
        "comment": "",
        "cargo_number": "ТБЛЕКБ0051237634"
    },
    "sender": {
        "inn": "6671271218",
        "kpp": "667101001",
        "name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ ТРАНСПОРТНАЯ КОМПАНИЯ \"GTD\"",
        "phone": "+773478370109",
        "status": "1",
        "debitor": "0001011311",
        "short_name": "ООО ТК \"GTD\"",
        "legal_address": "-",
        "actual_address": "-"
    },
    "status": [
        {
            "code": "00",
            "date": "2018-01-09",
            "name": "Новый заказ",
            "time": "16:02:33"
        },
        {
            "code": "01",
            "date": "2018-01-09",
            "name": "Груз принят",
            "time": "16:39:06"
        },
        {
            "code": "02",
            "date": "2018-01-10",
            "name": "Отправлен",
            "time": "14:29:11"
        },
        {
            "code": "03",
            "date": "2018-01-11",
            "name": "Прибыл",
            "time": "11:14:06"
        }
    ],
    "payment": {
        "code": "2",
        "name": "Не оплачено"
    },
    "service": [
        {
            "nds": "0.00",
            "name": "Перевозка груза: Тобольск-Екатеринбург",
            "price": "150.0",
            "quantity": "1.0",
            "currency_code": "RUB",
            "payer_debitor": "0001011311",
            "payer_short_name": "ООО ТК \"GTD\""
        }
    ],
    "customer": {
        "inn": "6671271218",
        "kpp": "667101001",
        "name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ ТРАНСПОРТНАЯ КОМПАНИЯ \"GTD\"",
        "phone": "+77347777777",
        "status": "1",
        "debitor": "0001011311",
        "short_name": "ООО ТК \"GTD\"",
        "legal_address": "-",
        "actual_address": "-"
    },
    "recipient": {
        "inn": "6671271218",
        "kpp": "667101001",
        "name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ ТРАНСПОРТНАЯ КОМПАНИЯ \"GTD\"",
        "phone": "+773478370109",
        "status": "1",
        "debitor": "0001011311",
        "short_name": "ООО ТК \"GTD\"",
        "legal_address": "-",
        "actual_address": "-"
    },
    "contact_to": {
        "name": "Гульнара",
        "phone": "73478370109",
        "locality": "г.Екатеринбург",
        "time_work": ""
    },
    "about_cargo": {
        "places": "1.0",
        "volume": "0.001",
        "weight": "1.0",
        "volume_unit": "куб.м.",
        "weight_unit": "кг"
    },
    "contact_from": {
        "name": "Гульнара",
        "phone": "73478370109",
        "locality": "г.Тобольск",
        "time_work": ""
    },
    "pickup_address": "Промкомзона №3",
    "delivery_address": "ул 8 Марта, дом № 269"
}

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