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

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

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

GET /orders/status

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

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

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

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

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

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

РазделПараметрОписаниеТипОбязательныйПример
OrderInfo
orderIdID заказастроканет15045636
providerKeyКод службы доставкистроканетcdek
providerNumberНомер заказа в системе службы доставкистроканетAPXX116081893
returnProviderNumberНомер возврата заказа в системе службы доставкистроканетABXX3171340
additionalProviderNumberДополнительный номер заказа в системе службы доставкистроканет0000317134093
barcodeНомер заказа для печати штрихкодастроканет15045636
clientNumberНомер заказа в системе клиентастроканет240082077869
status
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
36
{
  "orderInfo": {
    "orderId": "15109766",
    "providerKey": "cdek",
    "providerNumber": "1226114750",
    "additionalProviderNumber": "",
    "barcode": "",
    "clientNumber": "10154365",
    "returnProviderNumber": "",
    "checkUrl": ""
  },
  "statuses": [
    {
      "key": "uploaded",
      "name": "Информация успешно загружена в систему перевозчика",
      "description": "",
      "errorCode": "",
      "providerCode": "1",
      "providerName": "Создан",
      "providerDescription": "",
      "createdProvider": "",
      "created": "2021-01-19T12:57:05+03:00"
    },
    {
      "key": "uploading",
      "name": "Загрузка информации в систему перевозчика",
      "description": "",
      "errorCode": "",
      "providerCode": "",
      "providerName": "",
      "providerDescription": "",
      "createdProvider": "",
      "created": "2021-01-19T12:57:04+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
34
35
36
37
<?xml version="1.0" encoding="UTF-8"?>
<responce>
   <orderInfo>
      <additionalProviderNumber />
      <barcode />
      <checkUrl />
      <clientNumber>10154365</clientNumber>
      <orderId>15109766</orderId>
      <providerNumber>1226114750</providerNumber>
      <providerKey>cdek</providerKey>
      <returnProviderNumber />
   </orderInfo>
   <statuses>
      <element>
         <created>2021-01-19T12:57:05+03:00</created>
         <createdProvider />
         <description />
         <errorCode />
         <key>uploaded</key>
         <name>Информация успешно загружена в систему перевозчика</name>
         <providerCode>1</providerCode>
         <providerDescription />
         <providerName>Создан</providerName>
      </element>
      <element>
         <created>2021-01-19T12:57:04+03:00</created>
         <createdProvider />
         <description />
         <errorCode />
         <key>uploading</key>
         <name>Загрузка информации в систему перевозчика</name>
         <providerCode />
         <providerDescription />
         <providerName />
      </element>
   </statuses>
</responce>