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

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

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

GET /orders/{orderId}/statusHistory

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

ПараметрОписаниеТипПримерПримечание
orderIdsМассив ID заказовМассив“orderIds”: [15203622]Предел 100 заказов
offsetMinimum - 0, Maximum - 5000числонет40
limitMinimum - 1, Maximum - 100числонет3

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

# GET параметры
# orderIds = 15203622
# offset = 40
# limit = 3

curl -X GET --header 'Accept: application/json' 
            --header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXX' 
            'https://api.apiship.ru/v1/orders/15203622/statusHistory?offset=40&limit=3'


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

РазделПараметрОписаниеТипОбязательныйПример
OrderInfo
orderIdID заказа в системе ApiShipстроканет15045636
providerNumberНомер заказа в системе службы доставкистроканетAPXX116081893
returnProviderNumberНомер возврата заказа в системе службы доставкистроканетABXX3171340
additionalProviderNumberДополнительный номер заказа в системе службы доставкистроканет0000317134093
barcodeНомер заказа для печати штрихкодастроканет15045636
clientNumberНомер заказа в системе клиентастроканет240082077869
OrderStatus
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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "orderInfo": {
    "orderId": "15203622",
    "providerNumber": "36540",
    "additionalProviderNumber": "",
    "barcode": "",
    "clientNumber": "36540",
    "returnProviderNumber": "",
    "checkUrl": ""
  },
  "rows": [],
  "meta": {
    "total": 2,
    "offset": 40,
    "limit": 3
  }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<response>
 	<orderInfo>
		<orderId>15203622</orderId>
		<providerNumber>36540</providerNumber>
		<additionalProviderNumber></additionalProviderNumber>
		<barcode></barcode>
		<clientNumber>36540</clientNumber>
		<returnProviderNumber></returnProviderNumber>
		<checkUrl></checkUrl>
	</orderInfo>
	<meta>
		<total>2</total>
		<offset>40</offset>
		<limit>3</limit>
	</meta>
</response>