Маркировка грузовых мест
Общие сведения
Сервис позволяет передать артикулы грузовых мест по заказу (и тем самым инициировать процесс генерации этикеток для груза / сопроводительных документов), а также скачать сгенерированные этикетки. Кроме того, предусмотрена возможность уточнить статус приёма грузовых мест по заказу. Сервис доступен только авторизованным пользователям.
- В обработке,
- Забор груза от адреса,
- Ожидает сдачи на терминал
Передача артикулов грузовых мест
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/request/cargo/shipment_labels.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"111111", "cargoPlaces":[ { "cargoPlace":"123123", "amount":1 }, { "cargoPlace":"22222", "amount":1 } ] }
Адрес метода: https://api.dellin.ru/v2/request/cargo/shipment_labels.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>111111</orderID> <cargoPlaces> <cargoPlace>123123</cargoPlace> <amount>1</amount> </cargoPlaces> <cargoPlaces> <cargoPlace>22222</cargoPlace> <amount>1</amount> </cargoPlaces> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
Да | string | ID заказа, по которому необходимо сгенерировать этикетки на груз и сопроводительные документы Для оформления заказа следует использовать метод "Перевозка сборных грузов" | |
cargoPlaces | Да | array of CargoPlaces | Данные по грузовым местам |
cargoPlaces.cargoPlace | Да | string | Артикул грузового места (грузовые места маркируются заказчиком), значение может быть неуникальным. Если нет информации / возможности передать информацию по грузовому месту, но необходимо сгенерировать этикетки, можно передать null в качестве значения параметра |
cargoPlaces.amount | Нет | integer | Количество грузовых мест с одинаковым артикулом. Если значение не передано, то параметр принимает значение 1 |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2020-06-17 15:15:58" }, "data":{ "state":"enqueued" } }
<response> <metadata> <status>200</status> <generated_at>2020-06-17 15:15:58</generated_at> </metadata> <data> <state>enqueued</state> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (Success) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | object | Информация о выполнении операции |
data.state | string | Статус. |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".
Получение этикеток на груз
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/request/cargo/shipment_labels/get.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"2000395000025", "type":"jpg", "format":"a4", "oneFile":false, "per":10, "page":1 }
Адрес метода: https://api.dellin.ru/v2/request/cargo/shipment_labels/get.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>2000395000025</orderID> <type>jpg</type> <format>a4</format> <oneFile>false</oneFile> <per>10</per> <page>1</page> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
orderID | Да | string | Номер заказа, по которому необходимо сгенерировать этикетки |
type | Нет | string | Тип файла с этикетками. Доступные значения: jpg, pdf, png. Значение по умолчанию - pdf |
format | Нет | string | Размер этикеток. Доступные значения: 80x50, a4. Значение по умолчанию - 80х50 |
oneFile | Нет | boolean | Флаг, позволяющий выбрать, сформировать один многостраничный документ (по одной этикетке на страницу) или сформировать отдельные файлы. Доступные значения:
Значение по умолчанию - false |
per | Нет | integer | Количество ссылок на файлы с этикетками на странице (1). Максимальное значение - 50. Значение по умолчанию - 30 |
page | Нет | integer | Номер страницы со ссылками на файлы с этикетками (1). Значение по умолчанию - 1 |
Примечания:
|
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "current_page":2, "next_page":3, "prev_page":1, "total_pages":6, "generated_at":"2022-03-16 16:29:47" }, "state":"processed", "data":[ { "cargoPlace":"123123", "number":"11", "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> <state>processed</state> <data> <cargoPlace>123123</cargoPlace> <number>11</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 | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
state | string | Статус процесса формирования этикеток. Возможные значения:
|
data | array of Data | Данные по этикеткам для самомаркировки |
data.cargoPlace | string | Артикул грузового места. При формировании многостраничного документа (2) выводится пустое значение |
data.number | string | Порядковый номер грузового места. При формировании многостраничного документа (2) параметр принимает значение "result" |
data.format | string | Размер этикеток. Возможные значение: 80x50, a4 |
data.type | string | MIME-тиф файла. Возможные значения: image/jpeg, application/pdf, image/png |
data.base64 | string | Base64-код файла, содержащего этикетку |
Примечания:
|
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".
Получение этикеток на сопроводительные документы
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/request/cargo/docs_shipment_labels/get.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"2000395000025", "format":"a4", "type":"pdf" }
Адрес метода: https://api.dellin.ru/v2/request/cargo/docs_shipment_labels/get.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>2000395000025</orderID> <format>a4</format> <type>pdf</type> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
orderID | Да | string | Номер заказа, по которому необходимо сгенерировать этикетки |
format | Нет | string | Размер этикеток. Доступные значения: 80x50, a4. Значение по умолчанию - 80х50 |
type | Нет | string | Тип файла с этикетками. Доступные значения: jpg, pdf, png. Значение по умолчанию - pdf |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2022-03-16 16:29:47" }, "state":"processed", "data":[ { "format":"a4", "type":"application/pdf", "base64":"JVBERi0xLjMKJf////8KMSAw..." } ] }
<response> <metadata> <status>200</status> <generated_at>2022-03-16 16:29:47</generated_at> </metadata> <state>processed</state> <data> <format>a4</format> <type>application/pdf</type> <base64>JVBERi0xLjMKJf////8KMSAw...</base64> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
state | string | Статус процесса формирования этикеток. Возможные значения:
|
data | array of Data | Данные по этикеткам для самомаркировки |
data.format | string | Размер этикеток. Возможные значение: 80x50, a4 |
data.type | string | MIME-тиф файла. Возможные значения: image/jpeg, application/pdf, image/png |
data.base64 | string | Base64-код файла, содержащего этикетку |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".
Информация о статусе грузового места
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v3/orders/cargo/statuses.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "orderID":"2000395000025", "per":10, "page":1, }
Адрес метода: https://api.dellin.ru/v3/orders/cargo/statuses.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <orderID>2000395000025</orderID> <per>10</per> <page>1</page> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
orderID | Да | string | Номер заказа, по которому необходимо получить информацию о статусах грузовых мест |
per | Нет | integer | Количество статусов грузовых мест на странице (1). Максимальное значение - 50. Значение по умолчанию - 30 |
page | Нет | integer | Номер страницы (1). Значение по умолчанию - 1 |
Примечания:
|
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "current_page":2, "next_page":3, "prev_page":1, "total_pages":6, "generated_at":"2022-03-16 16:29:47" }, "data":[ { "cargoPlace":"123123", "number":"11", "state":"new" } ] }
<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> <cargoPlace>123123</cargoPlace> <number>11</number> <state>new</state> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK) |
metadata.current_page | integer | Номер текущей страницы со ссылками. Значение номера будет отличаться от 1, только если были запрошены данные по конкретной странице (1) |
metadata.next_page | integer | Номер следующей страницы. Значение номера будет отличаться от 2, только если были запрошены данные по конкретной странице (1) |
metadata.prev_page | integer | Номер предыдущей страницы. Значение будет отличаться от "null", только если были запрошены данные по конкретной странице (1) |
metadata.total_pages | integer | Общее количество страниц со ссылками |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | array of Data | Данные по статусам приёма грузовых мест |
data.cargoPlace | string | Артикул грузового места |
data.number | string | Порядковый номер грузового места |
data.state | string | Статус грузового места. Возможные значения:
|
Примечания:
|
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".