Swagger API Личный кабинет Центр поддержки
  • Languages Русский

Получение истории всех статусов с указанной даты #

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

GET /orders/statuses/history/date/{date}

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

ПараметрОписаниеТипОбязательныйПримерПримечания
dateДата, с которой необходимо получить историю статусовстроканет2021-01-25T21:00:07+03:00Формат даты RFC339.
offsetчислонет3Minimum - 0
limitчислонет40Minimum - 1, Maximum - 1000

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

# GET параметры
# date = 2021-01-25T21:00:07+03:00
# offset = 3
# limit = 40

curl -X GET --header 'Accept: application/json' 
            --header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXX' 
            'https://api.apiship.ru/v1/orders/statuses/history/date/2021-01-25T21%3A00%3A07%2B03%3A00?offset=3&limit=40'

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

РазделПараметрОписаниеТипОбязательныйПример
rows/orderInfo
orderIdID заказастроканет15045636
providerKeyКод службы доставкистроканетcdek
providerNumberНомер заказа в системе службы доставкистроканетAPXX116081893
returnProviderNumberНомер возврата заказа в системе службы доставкистроканетABXX3171340
additionalProviderNumberДополнительный номер заказа в системе службы доставкистроканет0000317134093
barcodeНомер заказа для печати штрихкодастроканет15045636
clientNumberНомер заказа в системе клиентастроканет240082077869
trackingUrlСсылка на отслеживание в системе СДстроканетhttps://dostavka.yandex.ru/route/f40cab58
rows/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
meta
totalчислонет20
offsetMinimum - 0, Maximum - 5000числонет40
limitMinimum - 1, Maximum - 100числонет3

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

 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

{
  "rows": [
    {
      "orderInfo": {
        "orderId": "15155762",
        "providerKey": "cdek",
        "providerNumber": "7501042255616",
        "additionalProviderNumber": "",
        "barcode": "",
        "clientNumber": "21-29863",
        "returnProviderNumber": "",
        "trackingUrl": ""
      },
      "statuses": [
        {
          "key": "delivered",
          "name": "Доставлен получателю",
          "description": "",
          "errorCode": "",
          "providerCode": "status_1",
          "providerName": "Доставлен",
          "providerDescription": "",
          "createdProvider": "2021-01-25T18:53:03+03:00",
          "created": "2021-01-25T21:02:07+03:00"
        }
      ]
    }
  ],
  "meta": {
    "total": 20,
    "offset": 40,
    "limit": 3
  }
}

 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


<response>
    <?xml version="1.0" encoding="UTF-8" ?>
    <rows>
        <orderInfo>
            <orderId>15155762</orderId>
            <providerKey>cdek</providerKey>
            <providerNumber>7501042255616</providerNumber>
            <additionalProviderNumber></additionalProviderNumber>
            <barcode></barcode>
            <clientNumber>21-29863</clientNumber>
            <returnProviderNumber></returnProviderNumber>
            <trackingUrl></trackingUrl>
        </orderInfo>
        <statuses>
            <key>delivered</key>
            <name>Доставлен получателю</name>
            <description></description>
            <errorCode></errorCode>
            <providerCode>status_1</providerCode>
            <providerName>Доставлен</providerName>
            <providerDescription></providerDescription>
            <createdProvider>2021-01-25T18:53:03+03:00</createdProvider>
            <created>2021-01-25T21:02:07+03:00</created>
        </statuses>
    </rows>
    <meta>
        <total>20</total>
        <offset>40</offset>
        <limit>3</limit>
    </meta>
</response>