VRt.Packer [PC] (7.13.2613)

Veeroute Support Team: servicedesk@veeroute.com License: Proprietary

Veeroute Packer 的软件界面.

公司网站 Veeroute

描述

该服务旨在计算商品在给定包裹内的放置.

包的类型

托盘

单托盘

如果托盘完全装满了相同的产品，那么这样的托盘称为mono-pallet，这种托盘具有以下装载规则：

考虑了放置货物的托盘的最大允许高度. 1、考虑了装载托盘的最大允许重量. 1.货物包装只能平行于托盘壁堆放.
允许围绕垂直 Z 轴旋转包装，并且只能以直角旋转. 1.为了使位置之间的高度相等（在顶部放置另一个托盘），可以在堆叠中添加空白空间.

区域托盘

单托盘形成后，将同一物品的剩余部分货物放在下一个托盘上，以硬纸板隔板分隔成多个区域，每个区域只放置一件商品，而这些区域有以下限制：

区域是矩形的.
区域边之间的比例可以是任意的.
任何区域的一侧始终与托盘边缘接触.
托盘上允许的区域数量：从 2 到 6.
各区按单托盘装填规则进行装填. 1、所有货物的堆垛高度不超过50mm，这样一个托盘上可以再放一个托盘.
允许在不同位置（高度差大于50mm）形成不同堆垛高度的托盘，如果这些托盘是堆叠的顶部托盘.

混合箱

mixbox

如果上述步骤未能以这种方式放置物品，为了使托盘具有所需的高度或重量，使用混合箱：

Mixbox只能放在一层.
不同的货物可以放在一个mixbox中，这种情况下，它像托盘一样被隔板分开（唯一的区别是包装货物的高度不对齐）.
混合箱可以与同一个托盘上的物品混合.
一种产品可以包装在不同的混合箱中.

投币口

装载的托盘相互堆叠，插槽是放置托盘堆叠的位置. 插槽没有物理实体 - 因此插槽的“主体”尺寸为零.

坐标系

为了指示包裹和货物的位置，使用了局部坐标系，其中特定对象的坐标相对于父对象的左下角表示，而：

水平面 - 轴 X, Y
垂直 - Z 轴

商品与包裹的轴线比例：

宽度 - X
长度 - Y
高度 - Z

实体图

erd

Pack

计算产品在包装内的放置。

Packing (SYNC)

Planning the optimal package.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for calculation.

required	Array of objects (product) [ 1 .. 70001 ] items unique List of products.
required	Array of objects (package) [ 1 .. 11 ] items unique List of packages. It is obligatory to have at least one package of each type (SLOT, PALLET, MIXBOX).
	object (pack_settings) Packing settings.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (blueprint) [ 0 .. 70001 ] items Example: "[object Object]" A product layout plan as a list of packaging locations. The first level contains a list of pallet stacks.
required	object (pack_statistics) General statistics for packing scheme.
	Array of objects (entity_warning_list) [ 0 .. 70001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.
	object (unpacked_items) Unpacked items list.
calculation_progress required	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Request samples

Payload
Python

Content type

application/json

Example

1 Product

{"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
}
}
}

Response samples

Content type

application/json

Example

1 Product

{"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": "2025-03-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"
]
}
}

Packing (ASYNC)

The result can be obtained using the result method, removing - with delete.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for calculation.

required	Array of objects (product) [ 1 .. 70001 ] items unique List of products.
required	Array of objects (package) [ 1 .. 11 ] items unique List of packages. It is obligatory to have at least one package of each type (SLOT, PALLET, MIXBOX).
	object (pack_settings) Packing settings.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
process_code required	string <uuid> (process_code) Example: "11111111-2222-3333-4444-555555555555" Process code - calculation identifier.

Request samples

Payload

Content type

application/json

Example

1 Product

{"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
}
}
}

Response samples

Content type

application/json

{"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": "2025-03-21T09:30:00+03:00"
},
"process_code": "11111111-2222-3333-4444-555555555555"
}

Cancel calculation

Cancel calculation process by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

process_code

required

string <uuid> (process_code)

Example: 11111111-2222-3333-4444-555555555555

唯一的进程标识符。

Responses

Response samples

400
402
404
429
500

Content type

application/json

{"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_plan_calculation",
"time": "2025-03-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "essence_1",
"entity_type": "PACKAGE"
}
]
}
],
"warnings": [ ]
}

Calculation state

Read calculation state by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

process_code

required

string <uuid> (process_code)

Example: 11111111-2222-3333-4444-555555555555

唯一的进程标识符。

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
calculation_progress required	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response Schema: application/json

required	object (tracedata) Data for request tracing.
calculation_progress required	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

{"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": "2025-03-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"
}
}

Getting the result

Getting the result based on the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

process_code

required

string <uuid> (process_code)

Example: 11111111-2222-3333-4444-555555555555

唯一的进程标识符。

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (blueprint) [ 0 .. 70001 ] items Example: "[object Object]" A product layout plan as a list of packaging locations. The first level contains a list of pallet stacks.
required	object (pack_statistics) General statistics for packing scheme.
	Array of objects (entity_warning_list) [ 0 .. 70001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.
	object (unpacked_items) Unpacked items list.
calculation_progress required	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (blueprint) [ 0 .. 70001 ] items Example: "[object Object]" A product layout plan as a list of packaging locations. The first level contains a list of pallet stacks.
required	object (pack_statistics) General statistics for packing scheme.
	Array of objects (entity_warning_list) [ 0 .. 70001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.
	object (unpacked_items) Unpacked items list.
calculation_progress required	integer <int32> (calculation_progress) [ 0 .. 100 ] Example: "52" Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

Example

1 Product

{"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": "2025-03-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"
]
}
}

Result removal

Removal of the planning result by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

process_code

required

string <uuid> (process_code)

Example: 11111111-2222-3333-4444-555555555555

唯一的进程标识符。

Responses

Response samples

400
402
404
429
500

Content type

application/json

{"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_plan_calculation",
"time": "2025-03-28T17:13:27.945583194Z"
},
"message": "logical",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"entities": [{"entity_key": "essence_1",
"entity_type": "PACKAGE"
}
]
}
],
"warnings": [ ]
}

Data validation

Checking data before planning.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for calculation.

required	Array of objects (product) [ 1 .. 70001 ] items unique List of products.
required	Array of objects (package) [ 1 .. 11 ] items unique List of packages. It is obligatory to have at least one package of each type (SLOT, PALLET, MIXBOX).
	object (pack_settings) Packing settings.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (entity_warning_list) [ 0 .. 70001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.

Request samples

Payload

Content type

application/json

Example

1 Product

{"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
}
}
}

Response samples

Content type

application/json

{"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_validation",
"time": "2025-03-21T16:55:35.370332Z"
},
"warnings": [ ]
}

System

系统功能。所有服务共有的辅助功能。

检查服务可用性

检查服务可用性。

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

The current health indicator of the service.

0.0 means the service is not ready to perform tasks.
1.0 means the service is fully ready to perform tasks.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

获取服务版本

获取服务版本。

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" 产品版本。在单个版本中，保证了服务之间通用数据结构的兼容性。版本更改表示与以前版本的产品（和所有服务）不兼容的更改。
minor required	integer <int32> [ 0 .. 111 ] Example: "15" 服务的小版本。版本更改表示新功能。该更新向后兼容服务的主要版本。
build required	string [ 1 .. 64 ] characters Example: "3754RC" 构建版本。包含向后兼容的错误修复和文档更新。

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 15,
"build": "3754RC"
}

检查服务可用性

检查服务可用性。

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"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": "2025-03-21T09:30:00+03:00"
}
}
}

VRt.Packer [PC] (7.13.2613)

描述

包的类型

托盘

混合箱

投币口

坐标系

实体图

Pack

Packing (SYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Packing (ASYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Cancel calculation

Authorizations:

path Parameters

Responses

Response samples

Calculation state

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response samples

Getting the result

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response samples

Result removal

Authorizations:

path Parameters

Responses

Response samples

Data validation

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

System

检查服务可用性

Responses

Response Schema: application/json

Response samples

获取服务版本

Responses

Response Schema: application/json

Response samples

检查服务可用性

path Parameters

Responses

Response Schema: text/htmltext/plaintext/html

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Response Schema:
text/html