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

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

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

Параметр	Описание	Тип	Обязательный	Пример
orderIds	Массив ID заказов в системе ApiShip	массив чисел	да	15530368
format	Формат получаемого файла. pdf либо xlsx. По умолчанию pdf.	строка	нет	xlsx

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

json

1
2
3
4
5
6
7
{
  "orderIds": [
    15530368,
    15530367
  ],
  "format": "pdf"
}

xml

1
2
3
4
5
6
7
<request>
  	<orderIds>
      <element>15530368</element>
      <element>15530367</element>
    </orderIds>
	<format>xlsx</format>
</request>

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

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

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

json

 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": "Заказ принадлежит другому клиенту"
   }
 ]
}

xml

 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>