Программный интерфейс для Veeroute Packer.
Моно-поддон
Если поддон полностью укомплектован одинаковым товаром, то такой поддон называется моно-поддон, такой поддон имеет следующие правила загрузки:
Разделенный на зоны поддон
После формирования моно-поддонов оставшаяся часть товаров того же артикула размещается на на следующем поддоне, который делится при помощи картонной перегородки на зоны таким образом, чтобы в каждой зоне был размещен товар только одного артикула, при этом зоны имеют следующие ограничения:
Если на описанных выше этапах не удается разместить номенклатуру таким образом, чтобы поддон был необходимой высоты или веса, используются миксбоксы:
Загруженные поддоны укладываются в стопки друг на друга, слот - это место установки стопки поддонов.
У слота нет физического тела - поэтому размеры body
слота нулевые.
Для указания местоположение упаковок и товаров используется локальная система координат, в которой координаты конкретного объекта указываются относительно ближнего левого нижнего угла родительского объекта, при этом:
Соотношение осей товаров и упаковок:
Планирование оптимального размещения.
Данные для расчета.
required | Array of objects (product) [ 1 .. 70001 ] items unique Список товаров, которые необходимо упаковать. |
required | Array of objects (package) [ 1 .. 11 ] items unique Список доступных упаковок. Обязательно наличие хотя бы одной упаковки каждого типа (SLOT, PALLET, MIXBOX). |
object (pack_settings) Настройки упаковки. | |
dataset_name | string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет. |
required | object (tracedata) Данные используемые для трассировки запросов. |
required | Array of objects (blueprint) [ 0 .. 70001 ] items Example: "[object Object]" План размещения товаров в виде списка расположений упаковок. На первом уровне находится список стопок поддонов. |
required | object (pack_statistics) Общая статистика по схеме упаковки. |
Array of objects (entity_warning_list) [ 0 .. 70001 ] items Список предупреждений. В зависимости от флага | |
object (unpacked_items) Список неупакованных товаров и не используемых упаковок. | |
calculation_progress required | integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов. |
required | object (calculation_info) Информация о расчете. |
{- "products": [
- {
- "key": "product_1",
- "count": 1,
- "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 60000
}
}
], - "packages": [
- {
- "key": "slot_default",
- "type": "SLOT",
- "body_dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "mass": 0
}, - "container_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 1800,
- "mass": 1000000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - {
- "key": "pallet_default",
- "type": "PALLET",
- "body_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 10000
}, - "container_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 1650,
- "mass": 650000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 150
}
}, - {
- "key": "mixbox_default",
- "type": "MIXBOX",
- "body_dimensions": {
- "length": 580,
- "width": 380,
- "height": 200,
- "mass": 0
}, - "container_dimensions": {
- "length": 580,
- "width": 380,
- "height": 200,
- "mass": 60000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}
], - "pack_settings": {
- "calculation_settings": {
- "max_calculation_time": "PT10M",
- "max_waiting_time": "PT10M",
- "result_ttl": "PT10M",
- "treat_warnings_as_errors": false
}
}
}
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "example_username",
- "company": "example_company",
- "env": "edge7",
- "pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
- "service": "PACKER",
- "operation": "run_pack_calculation",
- "time": "2024-11-21T16:55:35.370332Z"
}, - "blueprint": [
- {
- "package_key": "slot_default",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 300,
- "mass": 70000
}, - "product_group_layouts": [ ],
- "package_layouts": [
- {
- "package_key": "pallet_default",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 300,
- "mass": 70000
}, - "product_group_layouts": [
- {
- "product_key": "product_1",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 150
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 60000
}, - "product_layouts": [
- {
- "product_key": "product_1",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 60000
}
}
]
}
], - "package_layouts": [ ]
}
]
}
], - "statistics": {
- "products_count": 1,
- "packages_count": 2,
- "total_mass": 60,
- "total_volume": 0.144,
- "package_statistics": [
- {
- "package_key": "slot_default",
- "package_type": "SLOT",
- "count": 1,
- "max_container_mass": 60,
- "max_container_volume": 0.144,
- "utilization_by_mass": 0.06,
- "utilization_by_volume": 0.0833
}, - {
- "package_key": "pallet_default",
- "package_type": "PALLET",
- "count": 1,
- "max_container_mass": 60,
- "max_container_volume": 0.144,
- "utilization_by_mass": 0.0923,
- "utilization_by_volume": 0.0909
}
]
}, - "calculation_progress": 100,
- "calculation_info": {
- "status": "FINISHED_IN_TIME",
- "result_version": 1,
- "preparing_time": "PT1M10S",
- "business_validation_time": "PT1M10S",
- "math_validation_time": "PT1M10S",
- "waiting_time": "PT15S",
- "calculation_time": "PT1M10S"
}, - "warnings": [ ],
- "unpacked_items": {
- "product_keys": [ ],
- "package_keys": [
- "mixbox_default"
]
}
}
Данные для расчета.
required | Array of objects (product) [ 1 .. 70001 ] items unique Список товаров, которые необходимо упаковать. |
required | Array of objects (package) [ 1 .. 11 ] items unique Список доступных упаковок. Обязательно наличие хотя бы одной упаковки каждого типа (SLOT, PALLET, MIXBOX). |
object (pack_settings) Настройки упаковки. | |
dataset_name | string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет. |
required | object (tracedata) Данные используемые для трассировки запросов. |
process_code required | string <uuid> (process_code) Example: "11111111-2222-3333-4444-555555555555" Код процесса - идентификатор расчета. |
{- "products": [
- {
- "key": "product_1",
- "count": 1,
- "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 60000
}
}
], - "packages": [
- {
- "key": "slot_default",
- "type": "SLOT",
- "body_dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "mass": 0
}, - "container_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 1800,
- "mass": 1000000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - {
- "key": "pallet_default",
- "type": "PALLET",
- "body_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 10000
}, - "container_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 1650,
- "mass": 650000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 150
}
}, - {
- "key": "mixbox_default",
- "type": "MIXBOX",
- "body_dimensions": {
- "length": 580,
- "width": 380,
- "height": 200,
- "mass": 0
}, - "container_dimensions": {
- "length": 580,
- "width": 380,
- "height": 200,
- "mass": 60000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}
], - "pack_settings": {
- "calculation_settings": {
- "max_calculation_time": "PT10M",
- "max_waiting_time": "PT10M",
- "result_ttl": "PT10M",
- "treat_warnings_as_errors": false
}
}
}
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2024-11-21T09:30:00+03:00"
}, - "process_code": "11111111-2222-3333-4444-555555555555"
}
Отмена процесса планирования по идентификатору расчета.
process_code required | string <uuid> (process_code) Example: 11111111-2222-3333-4444-555555555555 Уникальный идентификатор процесса. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2024-11-21T09:30:00+03:00"
}, - "message": "bad task data",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
], - "logical_errors": [
- {
- "type": "UNIQUE_IDS_VIOLATION",
- "info": "entity error",
- "entities": [
- {
- "entity_key": "order_0001",
- "entity_type": "TASK",
- "child_entity": { }
}
]
}
], - "warnings": [
- {
- "type": "INVALID_PRODUCT_PACKAGE_FIT",
- "info": "entity warning",
- "entities": [
- {
- "entity_key": "order_0001",
- "entity_type": "TASK",
- "child_entity": { }
}
]
}
]
}
Получение состояния расчета по идентификатору расчета.
process_code required | string <uuid> (process_code) Example: 11111111-2222-3333-4444-555555555555 Уникальный идентификатор процесса. |
required | object (tracedata) Данные используемые для трассировки запросов. |
calculation_progress required | integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов. |
required | object (calculation_info) Информация о расчете. |
required | object (tracedata) Данные используемые для трассировки запросов. |
calculation_progress required | integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов. |
required | object (calculation_info) Информация о расчете. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2024-11-21T09:30:00+03:00"
}, - "calculation_progress": 52,
- "calculation_info": {
- "status": "FINISHED_IN_TIME",
- "result_version": 133,
- "preparing_time": "PT1H45M",
- "business_validation_time": "PT1H45M",
- "math_validation_time": "PT1H45M",
- "waiting_time": "PT1H45M",
- "calculation_time": "PT1H45M"
}
}
Получение результата расчета по идентификатору расчета.
process_code required | string <uuid> (process_code) Example: 11111111-2222-3333-4444-555555555555 Уникальный идентификатор процесса. |
required | object (tracedata) Данные используемые для трассировки запросов. |
required | Array of objects (blueprint) [ 0 .. 70001 ] items Example: "[object Object]" План размещения товаров в виде списка расположений упаковок. На первом уровне находится список стопок поддонов. |
required | object (pack_statistics) Общая статистика по схеме упаковки. |
Array of objects (entity_warning_list) [ 0 .. 70001 ] items Список предупреждений. В зависимости от флага | |
object (unpacked_items) Список неупакованных товаров и не используемых упаковок. | |
calculation_progress required | integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов. |
required | object (calculation_info) Информация о расчете. |
required | object (tracedata) Данные используемые для трассировки запросов. |
required | Array of objects (blueprint) [ 0 .. 70001 ] items Example: "[object Object]" План размещения товаров в виде списка расположений упаковок. На первом уровне находится список стопок поддонов. |
required | object (pack_statistics) Общая статистика по схеме упаковки. |
Array of objects (entity_warning_list) [ 0 .. 70001 ] items Список предупреждений. В зависимости от флага | |
object (unpacked_items) Список неупакованных товаров и не используемых упаковок. | |
calculation_progress required | integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов. |
required | object (calculation_info) Информация о расчете. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "example_username",
- "company": "example_company",
- "env": "edge7",
- "pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
- "service": "PACKER",
- "operation": "run_pack_calculation",
- "time": "2024-11-21T16:55:35.370332Z"
}, - "blueprint": [
- {
- "package_key": "slot_default",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 300,
- "mass": 70000
}, - "product_group_layouts": [ ],
- "package_layouts": [
- {
- "package_key": "pallet_default",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 300,
- "mass": 70000
}, - "product_group_layouts": [
- {
- "product_key": "product_1",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 150
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 60000
}, - "product_layouts": [
- {
- "product_key": "product_1",
- "coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}, - "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 60000
}
}
]
}
], - "package_layouts": [ ]
}
]
}
], - "statistics": {
- "products_count": 1,
- "packages_count": 2,
- "total_mass": 60,
- "total_volume": 0.144,
- "package_statistics": [
- {
- "package_key": "slot_default",
- "package_type": "SLOT",
- "count": 1,
- "max_container_mass": 60,
- "max_container_volume": 0.144,
- "utilization_by_mass": 0.06,
- "utilization_by_volume": 0.0833
}, - {
- "package_key": "pallet_default",
- "package_type": "PALLET",
- "count": 1,
- "max_container_mass": 60,
- "max_container_volume": 0.144,
- "utilization_by_mass": 0.0923,
- "utilization_by_volume": 0.0909
}
]
}, - "calculation_progress": 100,
- "calculation_info": {
- "status": "FINISHED_IN_TIME",
- "result_version": 1,
- "preparing_time": "PT1M10S",
- "business_validation_time": "PT1M10S",
- "math_validation_time": "PT1M10S",
- "waiting_time": "PT15S",
- "calculation_time": "PT1M10S"
}, - "warnings": [ ],
- "unpacked_items": {
- "product_keys": [ ],
- "package_keys": [
- "mixbox_default"
]
}
}
Удаление результата по идентификатору расчета.
process_code required | string <uuid> (process_code) Example: 11111111-2222-3333-4444-555555555555 Уникальный идентификатор процесса. |
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2024-11-21T09:30:00+03:00"
}, - "message": "bad task data",
- "schema_errors": [
- {
- "entity": "order_0001",
- "message": "bad input data"
}
], - "logical_errors": [
- {
- "type": "UNIQUE_IDS_VIOLATION",
- "info": "entity error",
- "entities": [
- {
- "entity_key": "order_0001",
- "entity_type": "TASK",
- "child_entity": { }
}
]
}
], - "warnings": [
- {
- "type": "INVALID_PRODUCT_PACKAGE_FIT",
- "info": "entity warning",
- "entities": [
- {
- "entity_key": "order_0001",
- "entity_type": "TASK",
- "child_entity": { }
}
]
}
]
}
Проверка данных перед отправкой на расчет.
Данные для расчета.
required | Array of objects (product) [ 1 .. 70001 ] items unique Список товаров, которые необходимо упаковать. |
required | Array of objects (package) [ 1 .. 11 ] items unique Список доступных упаковок. Обязательно наличие хотя бы одной упаковки каждого типа (SLOT, PALLET, MIXBOX). |
object (pack_settings) Настройки упаковки. | |
dataset_name | string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" Название набора данных. Техническое поле, не влияющее на расчет. |
required | object (tracedata) Данные используемые для трассировки запросов. |
required | Array of objects (entity_warning_list) [ 0 .. 70001 ] items Список предупреждений. В зависимости от флага |
{- "products": [
- {
- "key": "product_1",
- "count": 1,
- "dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 60000
}
}
], - "packages": [
- {
- "key": "slot_default",
- "type": "SLOT",
- "body_dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "mass": 0
}, - "container_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 1800,
- "mass": 1000000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}, - {
- "key": "pallet_default",
- "type": "PALLET",
- "body_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 150,
- "mass": 10000
}, - "container_dimensions": {
- "length": 1200,
- "width": 800,
- "height": 1650,
- "mass": 650000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 150
}
}, - {
- "key": "mixbox_default",
- "type": "MIXBOX",
- "body_dimensions": {
- "length": 580,
- "width": 380,
- "height": 200,
- "mass": 0
}, - "container_dimensions": {
- "length": 580,
- "width": 380,
- "height": 200,
- "mass": 60000
}, - "container_coordinates": {
- "x": 0,
- "y": 0,
- "z": 0
}
}
], - "pack_settings": {
- "calculation_settings": {
- "max_calculation_time": "PT10M",
- "max_waiting_time": "PT10M",
- "result_ttl": "PT10M",
- "treat_warnings_as_errors": false
}
}
}
{- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2024-11-21T09:30:00+03:00"
}, - "warnings": [
- {
- "type": "INVALID_PRODUCT_PACKAGE_FIT",
- "info": "entity warning",
- "entities": [
- {
- "entity_key": "order_0001",
- "entity_type": "TASK",
- "child_entity": { }
}
]
}
]
}
Проверка доступности сервиса.
health required | number <double> [ 0 .. 1 ] Example: "0.999" Текущий показатель здоровья сервиса.
|
{- "health": 0.999
}
Получение версии сервиса.
major required | integer <int32> [ 1 .. 100 ] Example: "7" Версия продукта.
В рамках одной версии гарантируется совместимость общих структур данных между сервисами. |
minor required | integer <int32> [ 0 .. 111 ] Example: "5" Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса. |
build required | string [ 1 .. 64 ] characters Example: "3754RC" Версия сборки. |
{- "major": 7,
- "minor": 5,
- "build": "3754RC"
}
Получение файла с документацией на этот сервис.
filename required | string [ 6 .. 128 ] characters Example: file_en.html Название файла. |
Файл с данными в формате HTML.
{- "resource_key": "resource_key",
- "detail": {
- "tracedata": {
- "process_code": "11111111-2222-3333-4444-555555555555",
- "request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
- "username": "username_for_login",
- "company": "smart_company",
- "service": "UNIVERSAL",
- "operation": "run_plan_calculation",
- "env": "edge7",
- "pod": "11111111-2222-3333-4444-555555555555",
- "time": "2024-11-21T09:30:00+03:00"
}
}
}