VRt.Packer [PC] (7.33.3222)

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

Software interface for Veeroute Packer.

Veeroute company website

Description

This service is designed to calculate the placement of goods within specified packages.

Package Types

Slot

slot

Loaded pallets are stacked on top of each other; a slot is the location where the pallet stack is placed.

A slot has no physical body, so the dimensions of its body are zero.

Pallet

pallet

If a pallet is completely filled with identical goods, it is called a mono-pallet. Such a pallet has the following loading rules:

The maximum permissible height of the pallet with the goods placed on it is taken into account.
The maximum permissible weight of the loaded pallet is taken into account. 1. Product packages may only be stacked parallel to the pallet walls.
Rotating packages around the vertical Z axis is permitted, but only at right angles.
To equalize the height between positions (to accommodate another pallet on top), empty spaces may be added to the stacking layer.

After forming a single-panel pallet, the remaining products of the same SKU are placed on the next pallet. Such a pallet is divided into zones using a cardboard divider so that each zone contains only one product SKU. The zones have the following restrictions:

The zones are rectangular.
The ratio between the sides of the zones may be any.
One side of any zone always touches the edge of the pallet.
The permitted number of zones on a pallet is from 2 to 6.
Each zone is filled according to the rules for filling a single-panel pallet.
The stacking height of all products must not exceed 50 mm, allowing for another pallet to be placed on top of the pallet.
Pallets with different stacking heights for different items (height differences greater than 50 mm) are permitted, provided they are the top pallets in the stack.

Mixbox

mixbox

If the steps described above do not allow the product to be stacked so that the pallet reaches the required height or weight, mixboxes are used:

Mixboxes can only be stacked in a single layer.
A single mixbox can contain different products; in this case, it is divided by dividers similar to a pallet (the only difference is that the height of the packed product is not aligned).
Mixboxes can be mixed with product items on the same pallet.
The same product can be packed in different mixboxes.

Coordinate System

coordinates

A local coordinate system is used to indicate the location of packages and products.

In this system, the coordinates of a specific object are specified relative to the lower-left corner of the parent object, as follows:

Horizontal plane - X, Y axes
Vertical plane - Z axis

Product and package axes ratio:

Width - X axis
Length - Y axis
Height - Z axis

Entity Diagram

erd

Pack

Calculation of the placement of products inside the packages.

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 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 (packer_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": "2026-04-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": "2026-04-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

Unique process identifier.

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": "2026-04-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

Unique process identifier.

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": "2026-04-21T09:30:00+03:00"
},
"calculation_progress": 52,
"calculation_info": {"status": "FINISHED_IN_TIME",
"message": "detail error message",
"result_version": 133,
"preparing_time": "PT1H45M",
"business_validation_time": "PT1H45M",
"math_validation_time": "PT1H45M",
"waiting_time": "PT1H45M",
"calculation_time": "PT1H45M",
"postprocessing_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

Unique process identifier.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (blueprint) [ 0 .. 70001 ] items 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 (packer_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 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 (packer_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": "2026-04-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

Unique process identifier.

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": "2026-04-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 (packer_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": "2026-04-21T16:55:35.370332Z"
},
"warnings": [ ]
}

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

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
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).
minor required	integer <int32> [ 0 .. 111 ] Example: "15" Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

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

Getting the documentation

Getting the file with this service documentation.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html) [ 0 .. 2000000000 ] characters

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key_one",
"detail": null
}

VRt.Packer [PC] (7.33.3222)

Description

Package Types

Slot

Pallet

Mixbox

Coordinate System

Entity Diagram

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

Checking the availability

Responses

Response Schema: application/json

Response samples

Getting the service version

Responses

Response Schema: application/json

Response samples

Getting the documentation

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