VRt.Packer [PC] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary

Veeroute Packer API.

Main site

Description

The service is designed to calculate the placement of goods inside given packages.

Types of packages

Pallet

pallet

Mono-pallet

If the pallet is fully equipped with the same product, then such a pallet is called mono-pallet, such a pallet has the following loading rules:

The maximum allowable height of the pallet with the goods laid on it is taken into account.
The maximum allowable weight of the loaded pallet is taken into account.
Goods packages can only be stacked parallel to the walls of the pallet.
It is allowed to rotate packages around the vertical Z-axis and only at a right angle.
In order to equalize the height between the positions (to place another pallet on top), empty spaces can be added to the stacking by layers.

Zone tray

After the formation of mono-pallets, the remaining part of the goods of the same article is placed on the next pallet, which is divided into zones by means of a cardboard partition in such a way that only one item of goods is placed in each zone, while the zones have the following restrictions:

The zones are rectangular.
The ratio between the sides of the zones can be any.
One of the sides of any zone is always in contact with the edge of the pallet.
Permissible number of zones on a pallet: from 2 to 6.
Each zone is filled according to the rules for filling a mono-pallet.
The stacking height of all goods does not exceed 50 mm, so that another pallet can be placed on top of such a pallet.
It is allowed to form pallets with different stacking heights for different positions (height difference is more than 50 mm), if these are the top pallets in the stack.

Mixbox

mixbox

If the above steps fail to place the item in this way, so that the pallet is of the required height or weight, mixboxes are used:

Mixbox can only be placed in one layer.
Different goods can be placed in one mixbox, in this case it is divided by partitions similarly to a pallet (the only difference is that the height of the packed goods is not aligned).
Mixboxes can be mixed with items on the same pallet.
One product can be packed in different mixboxes.

Slot

slot

The loaded pallets are stacked on top of each other, the slot is where the stack of pallets is placed. The slot has no physical body - so the dimensions of the body of the slot are zero.

Coordinate system

coordinates

To indicate the location of packages and goods, a local coordinate system is used, in which the coordinates of a particular object are indicated relative to the near left lower corner of the parent object, while:

Horizontal plane - axes X, Y
Vertical - Z axis

The ratio of the axes of goods and packages:

Width - X
Length - Y
Height - Z

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.

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 (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.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] 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": {"code": "69c507e4-7c2a-46fd-a862-a503cf27b1a3",
"client": "veeroute_|_example",
"server": "Packer:leo",
"service": "PACKER",
"operation": "runPackCalculation",
"time": "2024-02-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
}
]
},
"progress": 100,
"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.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
id required	string<uuid> (calculation_id) 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": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"id": "11111111-2222-3333-4444-555555555555"
}

Calculation state

Read calculation state by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] 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": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
}
}

Cancel calculation

Cancel calculation process by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"message": "bad task data",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "TASK",
"child_entity": { }
}
]
}
],
"warnings": [ ]
}

Getting the result

Getting the result based on the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation 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 (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.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] 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 (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.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] 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": {"code": "69c507e4-7c2a-46fd-a862-a503cf27b1a3",
"client": "veeroute_|_example",
"server": "Packer:leo",
"service": "PACKER",
"operation": "runPackCalculation",
"time": "2024-02-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
}
]
},
"progress": 100,
"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

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Calculation identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"message": "bad task data",
"schema_errors": [ ],
"logical_errors": [{"type": "UNIQUE_IDS_VIOLATION",
"info": "entity error",
"entities": [{"entity_key": "order_0001",
"entity_type": "TASK",
"child_entity": { }
}
]
}
],
"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.

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": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"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 ]

Current health.

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 ] 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 ] 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 Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

{"major": 4,
"minor": 4,
"build": "1754RC"
}

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)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_id": "resource_id",
"detail": {"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
}
}

VRt.Packer [PC] (6.20.2289)

Description

Types of packages

Pallet

Mixbox

Slot

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

Calculation state

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Cancel calculation

Authorizations:

path Parameters

Responses

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