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

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

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

POST /orders/waybill

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

ПараметрОписаниеТипОбязательныйПример
orderIdsмассив ID заказов в системе ApiShipмассив чиселда15530368

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

1
2
3
4
5
6
{
  "orderIds": [
    15530368,
    15530367
  ]
}
1
2
3
4
5
6
<request>
   <orderIds>
      <element>15530368</element>
      <element>15530367</element>
   </orderIds>
</request>

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

РазделПараметрОписаниеТипОбязательныйПример
waybillItems
providerKeyкод СДстроканетcdek
fileпуть к накладнойстроканетhttps://storage.apiship.ru/file/get?file=XXXXXXX.pdf
orderIdsмассив чиселнет15530368
failedOrders
orderIdID заказа, по которому не удалось сформировать актычислонет15530367
messageописание причины неудачного получения актов по заказустроканет“Заказ принадлежит другому клиенту”

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
 "waybillItems": [
   {
     "providerKey": "cdek",
     "file": "https://storage.apiship.ru/file/get?file=XXXXXXX.pdf",
     "orderIds": [
       15530368
     ]
   }
 ],
 "failedOrders": [
   {
     "orderId": 15530367,
     "message": "Заказ принадлежит другому клиенту"
   }
 ]
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
<responce>
   <failedOrders>
      <element>
         <message>Заказ принадлежит другому клиенту</message>
         <orderId>15530367</orderId>
      </element>
   </failedOrders>
   <waybillItems>
      <element>
         <file>https://storage.apiship.ru/file/get?file=XXXXXXX.pdf</file>
         <orderIds>
            <element>15530368</element>
         </orderIds>
         <providerKey>cdek</providerKey>
      </element>
   </waybillItems>
</responce>