Swagger API Личный кабинет Центр поддержки

Получение статусов по нескольким заказам #

Адрес метода #

POST /orders/statuses

Параметры запроса #

Для данного запроса токен авторизации передавать не нужно

ПараметрОписаниеТипПримерПримечание
orderIdsМассив ID заказовМассив“orderIds”: [1012]Предел 100 заказов

Пример данных запроса #

1
2
3
4
5
6
7
{
  "orderIds": [
    1012,
    15190048,
    15190068
  ]
}
1
2
3
4
5
6
7
8

<request>
    <orderIds>
        <element>1012</element>
        <element>15190048</element>
        <element>15190068</element>
    </orderIds>
</request>

Параметры ответа #

РазделПараметрОписаниеТипОбязательныйПример
succeedOrders/orderInfo
orderIdID заказастроканет15045636
providerKeyКод службы доставкистроканетcdek
providerNumberНомер заказа в системе службы доставкистроканетAPXX116081893
returnProviderNumberНомер возврата заказа в системе службы доставкистроканетABXX3171340
additionalProviderNumberДополнительный номер заказа в системе службы доставкистроканет0000317134093
barcodeНомер заказа для печати штрихкодастроканет15045636
clientNumberНомер заказа в системе клиентастроканет240082077869
trackingUrlСсылка на отслеживание в системе СДстроканетhttps://dostavka.yandex.ru/route/f40cab58
succeedOrders/statuses
keyИдентификатор статуса заказастроканетuploaded
nameНазвание статусастроканетИнформация успешно загружена в систему перевозчика
descriptionОписание статусастроканетЗаказ ещё не обработан службой доставки
createdДата и время установки данного статусастроканет2021-01-19T13:01:09+03:00
providerCodeКод статуса в системе СДстроканет1
providerNameНазвание статуса в системе СДстроканетСоздан
providerDescriptionОписание статуса в системе службы доставкистрокаЗаказ передан курьеру для доставки
createdProviderДата создания статуса в системе СДстрока2021-01-17T10:15:25+04:00
errorCodeКоды ошибокстроканет200
failedOrders
orderIdID заказачислонет1112
messageОписание причины неудачного получения статуса по заказустроканетЗаказ принадлежит другому клиенту

Пример данных ответа #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  "succeedOrders": [
    {
      "orderInfo": {
        "orderId": "15190048",
        "providerKey": "cdek",
        "providerNumber": "1227319268",
        "additionalProviderNumber": "",
        "barcode": "",
        "clientNumber": "30650",
        "returnProviderNumber": "",
        "trackingUrl": ""
      },
      "status": {
        "key": "onWay",
        "name": "В пути",
        "description": "",
        "errorCode": "",
        "providerCode": "19",
        "providerName": "Выдан на отправку в г.-транзите",
        "providerDescription": "",
        "createdProvider": "2021-01-26T09:05:05+03:00",
        "created": "2021-01-26T09:05:48+03:00"
      }
    },
    {
      "orderInfo": {
        "orderId": "15190068",
        "providerNumber": "AYT116972891",
        "additionalProviderNumber": "0000317607578",
        "barcode": "",
        "clientNumber": "21-30090",
        "returnProviderNumber": "",
        "trackingUrl": ""
      },
      "status": {
        "key": "onWay",
        "name": "В пути",
        "description": "",
        "errorCode": "",
        "providerCode": "Заказ передан на доставку",
        "providerName": "Заказ передан на доставку",
        "providerDescription": "",
        "createdProvider": "2021-01-25T17:41:00+03:00",
        "created": "2021-01-25T18:04:57+03:00"
      }
    }
  ],
  "failedOrders": [
    {
      "orderId": 1112,
      "message": "Заказ принадлежит другому клиенту"
    }
  ]
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

<responce>
    <succeedOrders>
        <orderInfo>
            <orderId>15190048</orderId>
            <providerKey>cdek</providerKey>
            <providerNumber>1227319268</providerNumber>
            <additionalProviderNumber></additionalProviderNumber>
            <barcode></barcode>
            <clientNumber>30650</clientNumber>
            <returnProviderNumber></returnProviderNumber>
            <trackingUrl></trackingUrl>
        </orderInfo>
        <status>
            <key>onWay</key>
            <name>В пути</name>
            <description></description>
            <errorCode></errorCode>
            <providerCode>19</providerCode>
            <providerName>Выдан на отправку в г.-транзите</providerName>
            <providerDescription></providerDescription>
            <createdProvider>2021-01-26T09:05:05+03:00</createdProvider>
            <created>2021-01-26T09:05:48+03:00</created>
        </status>
    </succeedOrders>
    <succeedOrders>
        <orderInfo>
            <orderId>15190068</orderId>
            <providerKey>cdek</providerKey>
            <providerNumber>AYT116972891</providerNumber>
            <additionalProviderNumber>0000317607578</additionalProviderNumber>
            <barcode></barcode>
            <clientNumber>21-30090</clientNumber>
            <returnProviderNumber></returnProviderNumber>
            <trackingUrl></trackingUrl>
        </orderInfo>
        <status>
            <key>onWay</key>
            <name>В пути</name>
            <description></description>
            <errorCode></errorCode>
            <providerCode>Заказ передан на доставку</providerCode>
            <providerName>Заказ передан на доставку</providerName>
            <providerDescription></providerDescription>
            <createdProvider>2021-01-25T17:41:00+03:00</createdProvider>
            <created>2021-01-25T18:04:57+03:00</created>
        </status>
    </succeedOrders>
    <failedOrders>
        <orderId>1112</orderId>
        <message>Заказ принадлежит другому клиенту</message>
    </failedOrders>
</responce>