Packaging labels
General information
The service allows getting information on existing packaging labels as well as initiating the process of generating packaging labels. The service is available to authorized users only.
Packaging labels directory
Method request
Request structure
Method address: https://api.dellin.ru/v1/references/marking/packaging_marks.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000" }
Method address: 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>
Description of parameters
Request
Request | |||
---|---|---|---|
Parameter | Required | Type | Description |
appkey | Yes | string | Application key. To get the key, register |
sessionID | Yes | string | To get the session ID, use the User Authorization method |
Method response
Response structure
{ "metadata":{ "status":200, "generated_at":"2020-06-17 15:15:58" }, "data":[ { "name":"pallet", "format":"a4", "type":"image/jpeg", "base64":"hgrkhgkjtrhukthi..." } ] }
<response> <metadata> <status>200</status> <generated_at>2020-06-17 15:15:58</generated_at> </metadata> <data> <name>pallet</name> <format>a4</format> <type>image/jpeg</type> <base64>hgrkhgkjtrhukthi...</base64> </data> </response>
Description of parameters
Response
Response | ||
---|---|---|
Parameter | Type | Description |
metadata | object | System information |
metadata.status | integer | Emulated status http-code. If successful, code 200 (Success) is returned |
metadata.generated_at | string | Server response date and time. Format: YYYY-MM-DD HH:MM:SS |
data | array of Data | Information on packaging types |
data.name | string | Packaging type. Possible values see in the table below |
data.format | string | Labels size. Possible values: 80x50, a4 |
data.type | string | MIME-type file. Possible values: image/jpeg, application/pdf, image/png |
data.base64 | string | Base64-code of the file with the labels |
Packaging types
Value | Description | Label |
---|---|---|
pallet | Pallet | ПБ |
crate | Wooden crate | ЖУ |
crate_plus | Wooden box | ЖК |
box | Cardboard box | КК |
bag | Bag | Мешок |
bubble | Bubble wrap | ВПП |
tape | Additional packaging | ДОП |
pallet_with_bubble | Bubble wrap and pallet | СПЕЦ ПБ |
crate_with_bubble | Bubble wrap and wooden crate | СПЕЦ ЖУ |
protect_auto_part | Special packaging for auto parts | СПЕЦ БАМПЕР |
protect_auto_glass | Special packaging for auto glass | СПЕЦ АВТОСТЕКЛО |
Error handling
The common API errors are used with the method, for errors format description and errors list see Errors of API methods.
Getting the packaging labels
Method request
Request structure
Method address: 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 } ] }
Method address: 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>
Description of parameters
Request
Request | |||
---|---|---|---|
Parameter | Required | Type | Description |
appkey | Yes | string | Application key. To get the key, register |
sessionID | Yes | string | To get the session ID, use the User Authorization method |
type | No | string | Type of the file with the labels. Available values: jpg, pdf, png. Default value - pdf |
oneFile | No | boolean | Flag indicating whether to generate one multipage document (one label per page) or several individual files. Available values:
Default value - false |
per | No | integer | The number of links on files with the labels per page (1). Maximum value - 50. Default value - 30 |
page | No | integer | Page number (1). Default value - 1 |
packagingMarks | Yes | array of PackagingMarks | Parameters of labels array |
packagingMarks.name | Yes | string | Packaging type. Possible values see in the table above |
packagingMarks.format | No | string | Labels size. Available values: 80x50, a4. Default value - 80х50 |
packagingMarks.count | Yes | integer | Number of labels |
Notes:
|
Method response
Response structure
{ "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> <state>processed</state> <data> <name>pallet</number> <format>a4</format> <type>image/jpeg</type> <base64>JVBERi0xLjMKJf////8KMSAw...</base64> </data> </response>
Description of parameters
Response
Response | ||
---|---|---|
Parameter | Type | Description |
metadata | object | System information |
metadata.status | integer | Emulated status http-code. If successful, code 200 (Success) is returned |
metadata.current_page | integer | The current page number. The value is different from 1, only if generating individual files and requesting the specific page data (1) |
metadata.next_page | integer | The next page number. If generating individual files the value is different from 2 only if specific page data are requested (1). If generating multipage document (2) the value is "null" |
metadata.prev_page | integer | The previous page number. The value is different from "null" only if specific page data are requested (1) |
metadata.total_pages | integer | The total number of pages with the links. In case of multipage document (2) the value is always 1 |
metadata.generated_at | string | Server response date and time. Format: YYYY-MM-DD HH:MM:SS |
data | array of Data | Labels data |
data.name | string | Packaging type. Possible values see in the table above. If generating multipage document (2) the value is "result" |
data.format | string | Labels size. Possible values: 80x50, a4 If generating multipage document (2) the value is empty |
data.type | string | MIME-type file. Possible values: image/jpeg, application/pdf, image/png |
data.base64 | string | Base64-code of the file with the labels |
Notes:
|
Error handling
The common API errors are used with the method, for errors format description and errors list see Errors of API methods.