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

Получение истории изменения всех статусов по заданному интервалу #

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

GET /orders/statuses/interval

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

ПараметрОписаниеТипОбязательныйПримерПримечания
fromДата начала периодастрокада2021-01-25T13:14:37+03:00Формат даты RFC339.
toДата окончания периодастрокада2021-01-26T13:14:37+03:00Формат даты RFC339. Максимальный интервал 72 часа.
filterВозможна фильтрация по providerKeyстроканетproviderKey=cdek
offsetчислонет40Minimum - 0, Maximum - 5000
limitчислонет3Minimum - 1, Maximum - 100

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

# GET параметры
# from = 2021-01-25T13:14:37+03:00
# to = 2021-02-010T13:14:37+03:00
# filter = providerKey=cdek
# offset = 40
# limit = 3

curl -X GET --header 'Accept: application/json' 
            --header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXX' 'https://api.apiship.ru/v1/orders/statuses/interval?from=2021-01-25T13%3A14%3A37%2B03%3A00&to=2021-01-26T13%3A14%3A37%2B03%3A00&filter=providerKey%3Dcdek&offset=40&limit=3'

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

РазделПараметрОписаниеТипОбязательныйПример
rows/orderInfo
orderIdID заказастроканет15045636
providerKeyКод службы доставкистроканетcdek
providerNumberНомер заказа в системе службы доставкистроканетAPXX116081893
returnProviderNumberНомер возврата заказа в системе службы доставкистроканетABXX3171340
additionalProviderNumberДополнительный номер заказа в системе службы доставкистроканет0000317134093
barcodeНомер заказа для печати штрихкодастроканет15045636
clientNumberНомер заказа в системе клиентастроканет240082077869
rows/statuses
keyИдентификатор статуса заказастроканетuploaded
nameНазвание статусастроканетИнформация успешноо загружена в системму перевозчика
descriptionОписание статусастроканетЗаказ еще не обработан службой доставки
createdДата и время установки данного статусастроканет2021-01-19T13:01:09+03:00
providerCodeКод статуса в системе СДстроканет1
providerNameНазвание статуса в системе СДстроканетСоздан
providerDescriptionДата создания статуса в системе СДстроканет2021-01-19T13:01:09+03:00
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
  "rows": [
    {
      "orderInfo": {
        "orderId": "15138790",
        "providerKey": "cdek",
        "providerNumber": "1226642023",
        "additionalProviderNumber": "",
        "barcode": "",
        "clientNumber": "36495",
        "returnProviderNumber": "",
        "checkUrl": "http://3.16.136.241:5015/ofd/getcheck?cdek_order_number=1226642023&amount=2284.84"
      },
      "statuses": [
        {
          "key": "delivering",
          "name": "Передан на доставку в пункте назначения",
          "description": "",
          "errorCode": "",
          "providerCode": "11",
          "providerName": "Выдан на доставку",
          "providerDescription": "",
          "createdProvider": "2021-01-26T02:35:45+03:00",
          "created": "2021-01-26T03:00:55+03:00"
        }
      ]
    },
    {
      "orderInfo": {
        "orderId": "15149230",
        "providerKey": "cdek",
        "providerNumber": "1226755852",
        "additionalProviderNumber": "",
        "barcode": "",
        "clientNumber": "36515",
        "returnProviderNumber": "",
        "checkUrl": ""
      },
      "statuses": [
        {
          "key": "onWay",
          "name": "В пути",
          "description": "",
          "errorCode": "",
          "providerCode": "19",
          "providerName": "Выдан на отправку в г.-транзите",
          "providerDescription": "",
          "createdProvider": "2021-01-26T02:10:47+03:00",
          "created": "2021-01-26T02:21:18+03:00"
        },
        {
          "key": "onWay",
          "name": "В пути",
          "description": "",
          "errorCode": "",
          "providerCode": "13",
          "providerName": "Принят на склад транзита",
          "providerDescription": "",
          "createdProvider": "2021-01-26T01:06:46+03:00",
          "created": "2021-01-26T01:30:44+03:00"
        }
      ]
    }
  ],
  "meta": {
    "total": 79,
    "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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<responce>
	<rows>
		<orderInfo>
			<orderId>15138790</orderId>
			<providerKey>cdek</providerKey>
			<providerNumber>1226642023</providerNumber>
			<additionalProviderNumber></additionalProviderNumber>
			<barcode></barcode>
			<clientNumber>36495</clientNumber>
			<returnProviderNumber></returnProviderNumber>
			<checkUrl>http://3.16.136.241:5015/ofd/getcheck?cdek_order_number=1226642023&amp;amount=2284.84</checkUrl>
		</orderInfo>
		<statuses>
			<key>delivering</key>
			<name>Передан на доставку в пункте назначения</name>
			<description></description>
			<errorCode></errorCode>
			<providerCode>11</providerCode>
			<providerName>Выдан на доставку</providerName>
			<providerDescription></providerDescription>
			<createdProvider>2021-01-26T02:35:45+03:00</createdProvider>
			<created>2021-01-26T03:00:55+03:00</created>
		</statuses>
	</rows>
	<rows>
		<orderInfo>
			<orderId>15149230</orderId>
      <providerKey>cdek</providerKey>
			<providerNumber>1226755852</providerNumber>
			<additionalProviderNumber></additionalProviderNumber>
			<barcode></barcode>
			<clientNumber>36515</clientNumber>
			<returnProviderNumber></returnProviderNumber>
			<checkUrl></checkUrl>
		</orderInfo>
		<statuses>
			<key>onWay</key>
			<name>В пути</name>
			<description></description>
			<errorCode></errorCode>
			<providerCode>19</providerCode>
			<providerName>Выдан на отправку в г.-транзите</providerName>
			<providerDescription></providerDescription>
			<createdProvider>2021-01-26T02:10:47+03:00</createdProvider>
			<created>2021-01-26T02:21:18+03:00</created>
		</statuses>
		<statuses>
			<key>onWay</key>
			<name>В пути</name>
			<description></description>
			<errorCode></errorCode>
			<providerCode>13</providerCode>
			<providerName>Принят на склад транзита</providerName>
			<providerDescription></providerDescription>
			<createdProvider>2021-01-26T01:06:46+03:00</createdProvider>
			<created>2021-01-26T01:30:44+03:00</created>
		</statuses>
	</rows>
	<meta>
		<total>79</total>
		<offset>40</offset>
		<limit>3</limit>
	</meta>
</responce>