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

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

GET /orders/{orderId}/statusHistory

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

Параметр	Описание	Тип	Пример	Примечание
orderIds	Массив ID заказов	Массив	“orderIds”: [15203622]	Предел 100 заказов
offset	Minimum - 0, Maximum - 5000	число	нет	40
limit	Minimum - 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
	orderId	ID заказа в системе ApiShip	строка	нет	15045636
	providerKey	Код службы доставки	строка	нет	cdek
	providerNumber	Номер заказа в системе службы доставки	строка	нет	APXX116081893
	returnProviderNumber	Номер возврата заказа в системе службы доставки	строка	нет	ABXX3171340
	additionalProviderNumber	Дополнительный номер заказа в системе службы доставки	строка	нет	0000317134093
	barcode	Номер заказа для печати штрихкода	строка	нет	15045636
	clientNumber	Номер заказа в системе клиента	строка	нет	240082077869
	trackingUrl	Ссылка на отслеживание в системе СД	строка	нет	https://dostavka.yandex.ru/route/f40cab58
OrderStatus
	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

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

json

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

xml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

<response>
    <orderInfo>
        <orderId>15203622</orderId>
        <providerKey>cdek</providerKey>
        <providerNumber>36540</providerNumber>
        <additionalProviderNumber></additionalProviderNumber>
        <barcode></barcode>
        <clientNumber>36540</clientNumber>
        <returnProviderNumber></returnProviderNumber>
        <trackingUrl></trackingUrl>
    </orderInfo>
    <meta>
        <total>2</total>
        <offset>40</offset>
        <limit>3</limit>
    </meta>
</response>