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

Получение ярлыков для заказов #

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

POST /orders/labels

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

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

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

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

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

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

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

1
2
3
4
{
 "url": "https://storage.apiship.ru/file/get?file=1234567_3.pdf",
 "failedOrders": null
}
1
2
3
4
<responce>
    <failedOrders null="true" />
   <url>https://storage.apiship.ru/file/get?file=1234567_3.pdf</url>  
</responce>