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

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

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

GET /orders/{orderId}/status

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

ПараметрОписаниеТип параметраТип данныхОбязательныйПример
orderIDID заказапутьчислода15203622

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

# GET параметры
# orderID = 15203622

curl -X GET --header 'Accept: application/json' 
            --header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXX' 
            'https://api.apiship.ru/v1/orders/15203622/status'

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

РазделПараметрОписаниеТипОбязательныйПример
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
{
  "orderInfo": {
    "orderId": "15203622",
    "providerNumber": "36540",
    "additionalProviderNumber": "",
    "barcode": "",
    "clientNumber": "36540",
    "returnProviderNumber": "",
    "checkUrl": ""
  },
  "status": {
    "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"
  }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
<response>
	<orderInfo>
		<orderId>15203622</orderId>
		<providerNumber>36540</providerNumber>
		<additionalProviderNumber></additionalProviderNumber>
		<barcode></barcode>
		<clientNumber>36540</clientNumber>
		<returnProviderNumber></returnProviderNumber>
		<checkUrl></checkUrl>
	</orderInfo>
	<status>
		<key>uploadingError</key>
		<name>Ошибка передачи информации в систему перевозчика</name>
		<description></description>
		<errorCode></errorCode>
		<providerCode></providerCode>
		<providerName></providerName>
		<providerDescription>(-32602) Invalid configuration for path &quot;params.stock&quot;: You do not have access to a stock</providerDescription>
		<createdProvider></createdProvider>
		<created>2021-01-26T13:37:08+03:00</created>
	</status>
</response>