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

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

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

GET /orders/status/history?clientNumber

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

ПараметрОписаниеТип параметраТип данныхОбязательныйПример
clientNumberID заказа в системе клиентазапросстрокада36540

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

# GET параметры
# clientNumber = 36540

curl -X GET --header 'Accept: application/json' 
            --header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXX' 
            'https://api.apiship.ru/v1/orders/status/history?clientNumber=36540'

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

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

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

 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
{
  "orderInfo": {
    "orderId": "15203622",
    "providerNumber": "36540",
    "additionalProviderNumber": "",
    "barcode": "",
    "clientNumber": "36540",
    "returnProviderNumber": "",
    "checkUrl": ""
  },
  "statuses": [
    {
      "key": "uploadingError",
      "name": "Ошибка передачи информации в систему перевозчика",
      "description": "",
      "errorCode": "",
      "providerCode": "",
      "providerName": "",
      "providerDescription": "(-32602) Invalid configuration for path \"params.stock\": You do not have access to a stock",
      "createdProvider": "",
      "created": "2021-01-26T13:37:08+03:00"
    },
    {
      "key": "uploading",
      "name": "Загрузка информации в систему перевозчика",
      "description": "",
      "errorCode": "",
      "providerCode": "",
      "providerName": "",
      "providerDescription": "",
      "createdProvider": "",
      "created": "2021-01-26T13:37:07+03:00"
    }
  ]
}
 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
<response>
	<orderInfo>
		<orderId>15205812</orderId>
		<providerNumber>360102556</providerNumber>
		<additionalProviderNumber></additionalProviderNumber>
		<barcode>80084055031314</barcode>
		<clientNumber>202124695</clientNumber>
		<returnProviderNumber></returnProviderNumber>
		<checkUrl></checkUrl>
	</orderInfo>
	<statuses>
		<key>uploaded</key>
		<name>Информация успешно загружена в систему перевозчика</name>
		<description></description>
		<errorCode></errorCode>
		<providerCode></providerCode>
		<providerName></providerName>
		<providerDescription></providerDescription>
		<createdProvider></createdProvider>
		<created>2021-01-26T15:45:14+03:00</created>
	</statuses>
	<statuses>
		<key>uploading</key>
		<name>Загрузка информации в систему перевозчика</name>
		<description></description>
		<errorCode></errorCode>
		<providerCode></providerCode>
		<providerName></providerName>
		<providerDescription></providerDescription>
		<createdProvider></createdProvider>
		<created>2021-01-26T15:45:14+03:00</created>
	</statuses>
</response>