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

Описание раздела: Данный раздел GTD.API Beta предназначен для работы с заказами.

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

Поля запроса:
ПараметрОписаниеТипОбязательныйПример
date_startДата начала диапозонаДатаДа2018-04-01
date_endДата завершение диапозонаДатаДа2018-06-30
limitКоличество записейintegerНет, по умолчанию 10 (мин 1 - макс 30)10
offsetсмещениеintegerНет, по умолчанию 0 (мин 0)10
profile_idid профиля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Код регионаinteger72
codeКод городастрока720000200000
nameНаселенный пунктстрокаТобольск
typeТип населенного пунктастрокаГород

 

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

ПараметрОписаниеТипПример
dateДата статусадата2018-04-09
timeВремя статусавремя09:56:57
codeКод статусаinteger01
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"
    }
]