Маркировка упаковки

Обновлено 20.01.2023

136 кб

Общие сведения

Сервис позволяет получить информацию о существующих этикетках с типами упаковки, а также сформировать файлы с этикетками для печати. Сервис доступен только авторизованным пользователям.

Справочник этикеток типов упаковки

Запрос метода

Структура запроса

JSON
XML

Адрес метода: https://api.dellin.ru/v1/references/marking/packaging_marks.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/references/marking/packaging_marks.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
</request>

Описание параметров

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Да	string	ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

Ответ метода

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "name":"pallet",
         "format":"a4",
         "type":"image/jpeg",
         "base64":"hgrkhgkjtrhukthi..."
      }
   ]
}

<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <name>pallet</name>
      <format>a4</format>
      <type>image/jpeg</type>
      <base64>hgrkhgkjtrhukthi...</base64>
   </data>
</response>

Описание параметров

Response

Response
Параметр	Тип	Описание
metadata	object	Системная информация
metadata.status	integer	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (Success)
metadata.generated_at	string	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
data	array of Data	Информация о типах упаковки
data.name	string	Тип упаковки. Возможные значения см. в таблице ниже
data.format	string	Размер этикетки. Возможные значение: 80x50, a4
data.type	string	MIME-тиф файла. Возможные значения: image/jpeg, application/pdf, image/png
data.base64	string	Base64-код файла, содержащего этикетку

Типы упаковок

Значение	Описание	Этикетка
pallet	Палетный борт	ПБ
crate	Деревянная обрешётка	ЖУ
crate_plus	Жёсткий короб	ЖК
box	Картонная коробка	КК
bag	Мешок	Мешок
bubble	Воздушно-пузырьковая плёнка	ВПП
tape	Дополнительная упаковка	ДОП
pallet_with_bubble	Палетный борт и амортизация	СПЕЦ ПБ
crate_with_bubble	Деревянная обрешетка и амортизация	СПЕЦ ЖУ
protect_auto_part	Специальная упаковка для автозапчастей	СПЕЦ БАМПЕР
protect_auto_glass	Специальная упаковка для автостекол	СПЕЦ АВТОСТЕКЛО

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

Получение этикеток типов упаковки

Запрос метода

Структура запроса

JSON
XML

Адрес метода: https://api.dellin.ru/v1/references/marking/packaging_marks/get.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "type":"jpg",
   "oneFile":false,
   "per":10,
   "page":1,
   "packagingMarks":[
      {
         "name":"pallet",
         "format":"a4",
         "count":2
      }
   ]
}

Адрес метода: https://api.dellin.ru/v1/references/marking/packaging_marks/get.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <type>jpg</type>
   <oneFile>false</oneFile>
   <per>10</per>
   <page>1</page>
   <packagingMarks>
      <name>pallet</name>
      <format>a4</format>
      <count>2</count>
   </packagingMarks>
</request>

Описание параметров

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Да	string	ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
type	Нет	string	Тип файла с этикетками. Доступные значения: jpg, pdf, png. Значение по умолчанию - pdf
oneFile	Нет	boolean	Флаг, позволяющий выбрать, сформировать один многостраничный документ (по одной этикетке на страницу) или сформировать отдельные файлы. Доступные значения: true - cформировать один многостраничный документ. Передача значения возможна, только если значение параметра "type" - "pdf"; false - сформировать отдельные файлы. Значение по умолчанию - false
per	Нет	integer	Количество ссылок на файлы с этикетками на странице (1). Максимальное значение - 50. Значение по умолчанию - 30
page	Нет	integer	Номер страницы со ссылками на файлы с этикетками (1). Значение по умолчанию - 1
packagingMarks	Да	array of PackagingMarks	Параметры массива этикеток
packagingMarks.name	Да	string	Тип упаковки. Доступные значения см. в таблице выше
packagingMarks.format	Нет	string	Размер этикетки. Доступные значения: 80x50, a4. Значение по умолчанию - 80х50
packagingMarks.count	Да	integer	Количество этикеток
Примечания: При формировании отдельных файлов (то есть если значение параметра "type" - "jpg" или "png") список ссылок для скачивания файлов размещается на нескольких страницах по 30 ссылок на страницу. При необходимости можно изменить количество ссылок на странице (см. описание параметра "per"), а также передать номер конкретной страницы, данные которой необходимо получить в ответе (см. описание параметра "page")

Ответ метода

Структура ответа

JSON
XML

{
   "metadata":{
      "status":200,
      "current_page":2,
      "next_page":3,
      "prev_page":1,
      "total_pages":6,
      "generated_at":"2022-03-16 16:29:47"
   },
   "data":[
      {
         "name":"pallet",
         "format":"a4",
         "type":"image/jpeg",
         "base64":"JVBERi0xLjMKJf////8KMSAw..."
      }
   ]
}

<response>
   <metadata>
      <status>200</status>
      <current_page>2</current_page>
      <next_page>3</next_page>
      <prev_page>1</prev_page>
      <total_pages>6</total_pages>
      <generated_at>2022-03-16 16:29:47</generated_at>
   </metadata>
   <data>
      <name>pallet</number>
      <format>a4</format>
      <type>image/jpeg</type>
      <base64>JVBERi0xLjMKJf////8KMSAw...</base64>
   </data>
</response>

Описание параметров

Response

Response
Параметр	Тип	Описание
metadata	object	Системная информация
metadata.status	integer	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.current_page	integer	Номер текущей страницы со ссылками. Значение номера будет отличаться от 1, только если было выбрано формирование отдельных файлов и были запрошены данные по конкретной странице (1)
metadata.next_page	integer	Номер следующей страницы. При формировании отдельных файлов значение будет отличаться от 2, только если были запрошены данные по конкретной странице (1). При формировании многостраничного документа (2) выводится значение "null"
metadata.prev_page	integer	Номер предыдущей страницы. Значение будет отличаться от "null", только если были запрошены данные по конкретной странице (1)
metadata.total_pages	integer	Общее количество страниц со ссылками. При формировании многостраничного документа (2) значение всегда равно 1
metadata.generated_at	string	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
data	array of Data	Данные по этикеткам
data.name	string	Тип упаковки. Доступные значения см. в таблице выше. При формировании многостраничного документа (2) выводится значение "result"
data.format	string	Размер этикеток. Возможные значение: 80x50, a4. При формировании многостраничного документа (2) выводится пустое значение
data.type	string	MIME-тиф файла. Возможные значения: image/jpeg, application/pdf, image/png
data.base64	string	Base64-код файла, содержащего этикетку
Примечания: Значение параметра запроса "type" - "jpg" или "png" и в запросе был передан параметр "page" со значением, отличным от 1. Значение параметра запроса "type" - "pdf", а параметра "oneFile" - "true"

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

Поиск по сайту

Маркировка упаковки

Общие сведения

Справочник этикеток типов упаковки

Запрос метода

Структура запроса

Описание параметров

Request

Ответ метода

Структура ответа

Описание параметров

Response

Типы упаковок

Обработка ошибок

Получение этикеток типов упаковки

Запрос метода

Структура запроса

Описание параметров

Request

Ответ метода

Структура ответа

Описание параметров

Response

Обработка ошибок