Create Request

POST 
/pack

Processes the request and returns the result.

Parameters

request : RequestModel User-inputted request.

upsert : bool Whether to overwrite previous scenario (document that shares the same "scenario_id"). Defaults to true.

Return

ResponseModel Generated response.

Request

Query Parameters

callback_url uri

Possible values: non-empty

upsert Upsert

Default value: true

application/json

Body

required

_id object-id

Autogenerated unique identifier

owner_id object-id
response_id object-id
scenario_id Scenario Id
description Description
orders object[]required
Possible values: >= 1
Array [
uuid uuid4
order_id Order Idrequired
items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
extras object
Default value: [object Object]
]
bins object[]
Array [
uuid uuid4
bin_id Bin Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
tar_weight object
anyOf
number
max_weight object
anyOf
number
adjust_width_min object
anyOf
number
adjust_height_min object
anyOf
number
adjust_depth_min object
anyOf
number
packaging_cost object
anyOf
number
transport_cost object
anyOf
number
min_fill_rate object
anyOf
number
max_fill_rate object
anyOf
number
bin_type BinType
Possible values: [BOX, PALLET, TRUCK, ENVELOPE]
Default value: BOX
max_height Max Height
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
parameters object

The parameters to be used when packing the orders, optional.

Parameters

group object

anyOf

boolean

messages object[]
Array [
message Messagerequired
category MessageCategory
Possible values: [preprocessing, packing, other]
Default value: other
severity MessageSeverity
Possible values: [info, warning, error]
Default value: info
]
bin_type BinType

Possible values: [BOX, PALLET, TRUCK, ENVELOPE]

Default value: BOX

units object

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

bins object

The units for the bins.

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

items object

The units for the items.

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

config object

Default value: [object Object]

Responses

202

Successful Response

application/json

Schema

Schema

_id object-id

Autogenerated unique identifier

owner_id object-id
request_id object

anyOf

string

request object

An API request to pack items.

Parameters

id : string The identifier of this request.

description : string A description of the request.

orders : list of models.Order The orders to be packed.

bins : list of models.Bin The bins available to pack the orders.

parameters : models.Parameters The parameters to be used when packing the orders, optional.

response_id : string The identifier of the response to this request.

time : datetime The time this request was made.

config: dict The packer configuration for this request. This is a dictionary that overrides the user configuration (which overrides the default configuration). If a key is not present in the dictionary, the user-level value is used (and if this one is not found, the default is used).

_id object-id

Autogenerated unique identifier

owner_id object-id

response_id object-id

scenario_id Scenario Id

description Description

orders object[]required

Possible values: >= 1

Array [

uuid uuid4

order_id Order Idrequired

items object[]required

Array [

uuid uuid4

item_id Item Idrequired

width Widthrequired

Possible values: >= 0.001

height Heightrequired

Possible values: >= 0.001

depth Depthrequired

Possible values: >= 0.001

weight Weight

quantity Quantity

Default value: 1

max_weight_on_top Max Weight On Top

Default value: 1.7976931348623157e+308

min_floor_space_coverage Min Floor Space Coverage

Possible values: <= 1

allow_WD_floor Allow Wd Floor

Default value: true

allow_DH_floor Allow Dh Floor

Default value: true

allow_WH_floor Allow Wh Floor

Default value: true

allow_WHD_rotation Allow Whd Rotation

Default value: true

allow_WDH_rotation Allow Wdh Rotation

Default value: true

allow_DWH_rotation Allow Dwh Rotation

Default value: true

allow_DHW_rotation Allow Dhw Rotation

Default value: true

allow_HWD_rotation Allow Hwd Rotation

Default value: true

allow_HDW_rotation Allow Hdw Rotation

Default value: true

stack_width_increase object

anyOf

number

stack_height_increase object

anyOf

number

stack_depth_increase object

anyOf

number

inner_width object

anyOf

number

inner_height object

anyOf

number

inner_depth object

anyOf

number

sequence object

Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.

anyOf

integer

group Group

tags object

anyOf

MOD2

Array [

string

]

string

extras object

Default value: [object Object]

]

extras object

Default value: [object Object]

]

bins object[]

Array [

uuid uuid4

bin_id Bin Idrequired

width Widthrequired

Possible values: >= 0.001

height Heightrequired

Possible values: >= 0.001

depth Depthrequired

Possible values: >= 0.001

tar_weight object

anyOf

number

max_weight object

anyOf

number

adjust_width_min object

anyOf

number

adjust_height_min object

anyOf

number

adjust_depth_min object

anyOf

number

packaging_cost object

anyOf

number

transport_cost object

anyOf

number

min_fill_rate object

anyOf

number

max_fill_rate object

anyOf

number

bin_type BinType

Possible values: [BOX, PALLET, TRUCK, ENVELOPE]

Default value: BOX

max_height Max Height

tags object

anyOf

MOD2

Array [

string

]

string

extras object

Default value: [object Object]

]

parameters object

The parameters to be used when packing the orders, optional.

Parameters

group object

anyOf

boolean

messages object[]

Array [

message Messagerequired

category MessageCategory

Possible values: [preprocessing, packing, other]

Default value: other

severity MessageSeverity

Possible values: [info, warning, error]

Default value: info

]

bin_type BinType

Possible values: [BOX, PALLET, TRUCK, ENVELOPE]

Default value: BOX

units object

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

bins object

The units for the bins.

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

items object

The units for the items.

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

config object

Default value: [object Object]

scenario_id Scenario Id
status ResponseStatus

Possible values: [created, awaiting_bins, busy, finished, error, deleted]

Default value: created

description Description
orders object[]
Array [
order objectrequired
Groups together a collection of items that are destined for the same client. Entire Order objects are fit as good as possible into Bins.
Parameters
id : string The identifier of this order. items : list of models.Item The items that are to be packed.
Attributes
weight : float The total weight of the items in this order. volume : float The total volume of the items in this order. items : list of models.Item The items that are to be packed. id : string The identifier of this order.
uuid uuid4
order_id Order Idrequired
items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
extras object
Default value: [object Object]
original_order_uuid uuid4
uuid uuid4
order_id Order Idrequired
bins object[]
List containing all succesfully packed bins.
Array [
bin objectrequired
A bin in which items can be packed.
Parameters
id : string The identifier of this bin.
depth : float The depth of the bin (in meters).
width : float The width of the bin (in meters).
height : float The height of the bin (in meters).
max_weight : float The total weight that items within this bin can have (in grams).
transport_cost : float The cost incurred when transporting this type of bin.
packaging_cost : float The cost incurred when using this type of bin to pack items in.
min_fill_rate : float The minimum fill rate of the bin.
Attributes
id : string The identifier of this bin.
depth : float The depth of the bin (in meters).
width : float The width of the bin (in meters).
height : float The height of the bin (in meters).
max_weight : float The total weight that items within this bin can have (in grams).
transport_cost : float The cost incurred when transporting this type of bin.
packaging_cost : float The cost incurred when using this type of bin to pack items in.
min_fill_rate : float The minimum fill rate of the bin.
volume : float The volume of the bin.
max_dim : float The maximum dimension of the bin.
second_max_dim : float The second maximum dimension of the bin.
min_dim : float The minimum dimension of the bin.
cost : float The total cost of the bin.
tags : Tags Tags associated with this bin. Tags can be used to filter bins when packing items.
uuid uuid4
bin_id Bin Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
tar_weight object
anyOf
number
max_weight object
anyOf
number
adjust_width_min object
anyOf
number
adjust_height_min object
anyOf
number
adjust_depth_min object
anyOf
number
packaging_cost object
anyOf
number
transport_cost object
anyOf
number
min_fill_rate object
anyOf
number
max_fill_rate object
anyOf
number
bin_type BinType
Possible values: [BOX, PALLET, TRUCK, ENVELOPE]
Default value: BOX
max_height Max Height
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
original_bin_uuid object
anyOf
string
uuid uuid4
bin_id Bin Idrequired
width Widthrequired
Possible values: > 0
height Heightrequired
Possible values: > 0
depth Depthrequired
Possible values: > 0
tar_weight Tar Weight
max_weight Max Weight
transport_cost Transport Cost
packaging_cost Packaging Cost
bin_type BinType
Possible values: [BOX, PALLET, TRUCK, ENVELOPE]
tags string[]
Default value: ``
extras object
Default value: [object Object]
fitted_items object[]
Array [
oneOf
PackedItem
item object required
anyOf
Item
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
SuperItem
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
smaller_items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
item_type Item Type
Default value: Super
penalty Penalty
packed_bin required
mult1 Mult1required
mult2 Mult2required
mult3 Mult3required
rotation Rotation
Possible values: [0, 1, 2, 3, 4, 5]
original_item_uuid object
anyOf
string
type Type
Possible values: [base]
Default value: base
uuid uuid4
x Xrequired
Item position on X axis.
y Yrequired
Item position on Y axis.
z Zrequired
Item position on Z axis.
sequence Sequence
max_weight_on_top Max Weight On Top
weight_on_top Weight On Top
tags string[]
Default value: ``
extras object
Default value: [object Object]
id Idrequired
rotated Rotatedrequired
width Widthrequired
Width of the item.
height Heightrequired
Height of the item.
depth Depthrequired
Depth of the item.
volume Volumerequired
Volume of the item.
weight Weightrequired
Weight of the item.
item_id Item Idrequired
PackedItemRotation
item object required
anyOf
Item
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
SuperItem
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
smaller_items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
item_type Item Type
Default value: Super
penalty Penalty
packed_bin required
mult1 Mult1required
mult2 Mult2required
mult3 Mult3required
rotation Rotation
Possible values: [0, 1, 2, 3, 4, 5]
original_item_uuid object
anyOf
string
type Type
Possible values: [rotation]
Default value: rotation
uuid uuid4
x Xrequired
Item position on X axis.
y Yrequired
Item position on Y axis.
z Zrequired
Item position on Z axis.
sequence Sequence
max_weight_on_top Max Weight On Top
weight_on_top Weight On Top
tags string[]
Default value: ``
extras object
Default value: [object Object]
contained_items object[]
Array [
item object required
anyOf
Item
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
SuperItem
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
smaller_items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
item_type Item Type
Default value: Super
penalty Penalty
packed_bin required
mult1 Mult1required
mult2 Mult2required
mult3 Mult3required
rotation Rotation
Possible values: [0, 1, 2, 3, 4, 5]
original_item_uuid object
anyOf
string
type Type
Possible values: [base]
Default value: base
uuid uuid4
x Xrequired
Item position on X axis.
y Yrequired
Item position on Y axis.
z Zrequired
Item position on Z axis.
sequence Sequence
max_weight_on_top Max Weight On Top
weight_on_top Weight On Top
tags string[]
Default value: ``
extras object
Default value: [object Object]
id Idrequired
rotated Rotatedrequired
width Widthrequired
Width of the item.
height Heightrequired
Height of the item.
depth Depthrequired
Depth of the item.
volume Volumerequired
Volume of the item.
weight Weightrequired
Weight of the item.
item_id Item Idrequired
]
original objectrequired
An object that represents a certain item from an Order.
Parameters
id : string The identifier of this item.
depth : float The depth of the item (in centimeter).
width : float The width of the item (in centimeter).
height : float The height of the item (in centimeter).
weight : float The weight of the item (in kilograms).
min_floor_space_coverage : float (default : 0.75) A value between 0 and 1 specifying how much (in percentage) the ground floor of an item needs to be covered by items beneath it.
rotated : bool (default : False) A boolean that specifies whether this item has been rotated with a certain angle to fit in a box. The dimensions will be adjusted by drawing a bounding box around the rotated item.
allow_wd_floor : bool (default : True) Whether this item is allowed to be rotated such that the width x depth face touches the floor.
allow_wh_floor : bool (default : True) Whether this item is allowed to be rotated such that the width x height face touches the floor.
allow_dh_floor : bool (default : True) Whether this item is allowed to be rotated such that the depth x height face touches the floor.
sequence : int The sequence number of this item in the order.
group : string (default: "") The group to which this item belongs. Items of different groups will not be packed together.
Attributes
id : string The identifier of this item.
depth : float The depth of the item (in centimeter).
width : float The width of the item (in centimeter).
height : float The height of the item (in centimeter).
weight : float The weight of the item (in kilograms).
min_floor_space_coverage : float (default : 0.75) A value between 0 and 1 specifying how much (in percentage) the ground floor of an item needs to be covered by items beneath it.
rotated : bool (default : False) A boolean that specifies whether this item has been rotated with a certain angle to fit in a box. The dimensions will be adjusted by drawing a bounding box around the rotated item.
allow_wd_floor : bool (default : True) Whether this item is allowed to be rotated such that the width x depth face touches the floor.
allow_wh_floor : bool (default : True) Whether this item is allowed to be rotated such that the width x height face touches the floor.
allow_dh_floor : bool (default : True) Whether this item is allowed to be rotated such that the depth x height face touches the floor.
sequence : int The sequence number of this item in the order.
volume : float The volume of the item.
biggest_surface : float The biggest surface of the item.
density : float The density of the item.
max_dim : float The biggest dimension of the item.
second_biggest_dim : float The second biggest dimension of the item.
min_dim : float The smallest dimension of the item.
tags : Tags Tags associated with this item. Tags can be used to dictate the destination bin of an item.
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
rotated_dim Rotated Dimrequired
rotation_angle Rotation Anglerequired
id Idrequired
rotated Rotatedrequired
width Widthrequired
Width of the item.
height Heightrequired
Height of the item.
depth Depthrequired
Depth of the item.
volume Volumerequired
weight Weightrequired
Weight of the item.
item_id Item Idrequired
vertices array[]required
PackedItemStacking
item object required
anyOf
Item
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
SuperItem
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
smaller_items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
item_type Item Type
Default value: Super
penalty Penalty
packed_bin required
mult1 Mult1required
mult2 Mult2required
mult3 Mult3required
rotation Rotation
Possible values: [0, 1, 2, 3, 4, 5]
original_item_uuid object
anyOf
string
type Type
Possible values: [stacking]
Default value: stacking
uuid uuid4
x Xrequired
Item position on X axis.
y Yrequired
Item position on Y axis.
z Zrequired
Item position on Z axis.
sequence Sequence
max_weight_on_top Max Weight On Top
weight_on_top Weight On Top
tags string[]
Default value: ``
extras object
Default value: [object Object]
contained_items object[]
Array [
item object required
anyOf
Item
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
SuperItem
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
smaller_items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
item_type Item Type
Default value: Super
penalty Penalty
packed_bin required
mult1 Mult1required
mult2 Mult2required
mult3 Mult3required
rotation Rotation
Possible values: [0, 1, 2, 3, 4, 5]
original_item_uuid object
anyOf
string
type Type
Possible values: [base]
Default value: base
uuid uuid4
x Xrequired
Item position on X axis.
y Yrequired
Item position on Y axis.
z Zrequired
Item position on Z axis.
sequence Sequence
max_weight_on_top Max Weight On Top
weight_on_top Weight On Top
tags string[]
Default value: ``
extras object
Default value: [object Object]
id Idrequired
rotated Rotatedrequired
width Widthrequired
Width of the item.
height Heightrequired
Height of the item.
depth Depthrequired
Depth of the item.
volume Volumerequired
Volume of the item.
weight Weightrequired
Weight of the item.
item_id Item Idrequired
]
id Idrequired
rotated Rotatedrequired
width Widthrequired
Width of the item.
height Heightrequired
Height of the item.
depth Depthrequired
Depth of the item.
volume Volumerequired
Volume of the item.
weight Weightrequired
Weight of the item.
item_id Item Idrequired
PackedItemNesting
item object required
anyOf
Item
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
SuperItem
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
smaller_items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
item_type Item Type
Default value: Super
penalty Penalty
packed_bin required
mult1 Mult1required
mult2 Mult2required
mult3 Mult3required
rotation Rotation
Possible values: [0, 1, 2, 3, 4, 5]
original_item_uuid object
anyOf
string
type Type
Possible values: [nesting]
Default value: nesting
uuid uuid4
x Xrequired
Item position on X axis.
y Yrequired
Item position on Y axis.
z Zrequired
Item position on Z axis.
sequence Sequence
max_weight_on_top Max Weight On Top
weight_on_top Weight On Top
tags string[]
Default value: ``
extras object
Default value: [object Object]
contained_items object[]
Array [
item object required
anyOf
Item
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
SuperItem
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
smaller_items object[]required
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
item_type Item Type
Default value: Super
penalty Penalty
packed_bin required
mult1 Mult1required
mult2 Mult2required
mult3 Mult3required
rotation Rotation
Possible values: [0, 1, 2, 3, 4, 5]
original_item_uuid object
anyOf
string
type Type
Possible values: [base]
Default value: base
uuid uuid4
x Xrequired
Item position on X axis.
y Yrequired
Item position on Y axis.
z Zrequired
Item position on Z axis.
sequence Sequence
max_weight_on_top Max Weight On Top
weight_on_top Weight On Top
tags string[]
Default value: ``
extras object
Default value: [object Object]
id Idrequired
rotated Rotatedrequired
width Widthrequired
Width of the item.
height Heightrequired
Height of the item.
depth Depthrequired
Depth of the item.
volume Volumerequired
Volume of the item.
weight Weightrequired
Weight of the item.
item_id Item Idrequired
]
id Idrequired
rotated Rotatedrequired
width Widthrequired
Width of the item.
height Heightrequired
Height of the item.
depth Depthrequired
Depth of the item.
volume Volumerequired
Volume of the item.
weight Weightrequired
Weight of the item.
item_id Item Idrequired
inner_cuboid arrayrequired
Possible values: >= 6, <= 6
]
interactive_viz_url Interactive Viz Url
static_viz_url Static Viz Url
min_fill_rate object required
anyOf
number
max_fill_rate object required
anyOf
number
max_height Max Heightrequired
max_width Max Widthrequired
max_depth Max Depthrequired
volume Volumerequired
Volume of the bin.
item_volume Item Volumerequired
Item volume of the bin.
fill_rate Fill Raterequired
Fraction of bin that is filled by items.
item_weight Item Weightrequired
Weight of the items in the bin.
weight Weightrequired
Weight of the bin with items inside.
weight_fill_rate Weight Fill Raterequired
Fraction of max weight of the bin that is filled by item weight.
cost Costrequired
num_items Num Itemsrequired
]
unfitted_items object[]
Items that were not able to fit in any of the bins.
Array [
uuid uuid4
item_id Item Idrequired
width Widthrequired
Possible values: >= 0.001
height Heightrequired
Possible values: >= 0.001
depth Depthrequired
Possible values: >= 0.001
weight Weight
quantity Quantity
Default value: 1
max_weight_on_top Max Weight On Top
Default value: 1.7976931348623157e+308
min_floor_space_coverage Min Floor Space Coverage
Possible values: <= 1
allow_WD_floor Allow Wd Floor
Default value: true
allow_DH_floor Allow Dh Floor
Default value: true
allow_WH_floor Allow Wh Floor
Default value: true
allow_WHD_rotation Allow Whd Rotation
Default value: true
allow_WDH_rotation Allow Wdh Rotation
Default value: true
allow_DWH_rotation Allow Dwh Rotation
Default value: true
allow_DHW_rotation Allow Dhw Rotation
Default value: true
allow_HWD_rotation Allow Hwd Rotation
Default value: true
allow_HDW_rotation Allow Hdw Rotation
Default value: true
stack_width_increase object
anyOf
number
stack_height_increase object
anyOf
number
stack_depth_increase object
anyOf
number
inner_width object
anyOf
number
inner_height object
anyOf
number
inner_depth object
anyOf
number
sequence object
Determines the order within packing. Items are packed according to an ascending order of sequence numbers. Sequence numbers will be ignored if not provided for every item in the order.
anyOf
integer
group Group
tags object
anyOf
MOD2
Array [
string
]
string
extras object
Default value: [object Object]
]
extras object
Default value: [object Object]
unfitted_item_ids string[]required
bin_volume Bin Volumerequired
item_volume Item Volumerequired
fill_rate Fill Raterequired
max_weight Max Weightrequired
item_weight Item Weightrequired
weight Weightrequired
weight_fill_rate Weight Fill Raterequired
packaging_cost Packaging Costrequired
transport_cost Transport Costrequired
cost Costrequired
num_bins Num Binsrequired
num_items Num Itemsrequired
]
errors string[]

Default value: ``

messages object[]
Array [
message Messagerequired
category MessageCategory
Possible values: [preprocessing, packing, other]
Default value: other
severity MessageSeverity
Possible values: [info, warning, error]
Default value: info
]
execution_time Execution Time
bin_type BinType

Possible values: [BOX, PALLET, TRUCK, ENVELOPE]

Default value: BOX

units object

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

bins object

The units for the bins.

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

items object

The units for the items.

length object

A length unit.

anyOf

LengthShort

string

LengthLong

string

mass object

A mass unit.

anyOf

MassShort

string

MassLong

string

created_at date-time
bin_volume Bin Volumerequired
item_volume Item Volumerequired
fill_rate Fill Raterequired
max_weight Max Weightrequired
item_weight Item Weightrequired
weight Weightrequired
weight_fill_rate Weight Fill Raterequired
packaging_cost Packaging Costrequired
transport_cost Transport Costrequired
cost Costrequired
num_items Num Itemsrequired
num_bins Num Binsrequired
num_orders Num Ordersrequired

Example (from schema)

{
  "_id": "string",
  "owner_id": "string",
  "request": {
    "_id": "string",
    "owner_id": "string",
    "response_id": "string",
    "scenario_id": "string",
    "description": "string",
    "orders": [
      {
        "id": "order_1",
        "items": [
          {
            "depth": 1,
            "height": 1,
            "id": "item_1",
            "width": 1
          }
        ]
      }
    ],
    "bins": [
      {
        "depth": 1,
        "height": 1,
        "id": "bin_1",
        "width": 1
      }
    ],
    "parameters": {
      "group": true
    },
    "messages": [
      {
        "message": "string",
        "category": "other",
        "severity": "info"
      }
    ],
    "bin_type": "BOX",
    "units": {
      "length": "mm",
      "mass": "mg",
      "bins": {
        "length": "mm",
        "mass": "mg"
      },
      "items": {
        "length": "mm",
        "mass": "mg"
      }
    },
    "config": {}
  },
  "scenario_id": "string",
  "status": "created",
  "description": "string",
  "orders": [
    {
      "order": {
        "id": "order_1",
        "items": [
          {
            "depth": 1,
            "height": 1,
            "id": "item_1",
            "width": 1
          }
        ]
      },
      "original_order_uuid": "string",
      "uuid": "string",
      "order_id": "string",
      "bins": [
        {
          "bin": {
            "depth": 1,
            "height": 1,
            "id": "bin_1",
            "width": 1
          },
          "original_bin_uuid": "string",
          "uuid": "string",
          "bin_id": "string",
          "width": 0,
          "height": 0,
          "depth": 0,
          "tar_weight": 0,
          "max_weight": 0,
          "transport_cost": 0,
          "packaging_cost": 0,
          "bin_type": "BOX",
          "tags": [
            "string"
          ],
          "extras": {},
          "fitted_items": [
            {},
            {},
            {},
            {}
          ],
          "interactive_viz_url": "string",
          "static_viz_url": "string",
          "min_fill_rate": 0,
          "max_fill_rate": 0,
          "max_height": 0,
          "max_width": 0,
          "max_depth": 0,
          "volume": 0,
          "item_volume": 0,
          "fill_rate": 0,
          "item_weight": 0,
          "weight": 0,
          "weight_fill_rate": 0,
          "cost": 0,
          "num_items": 0
        }
      ],
      "unfitted_items": [
        {
          "depth": 1,
          "height": 1,
          "id": "item_1",
          "width": 1
        }
      ],
      "extras": {},
      "unfitted_item_ids": [
        "string"
      ],
      "bin_volume": 0,
      "item_volume": 0,
      "fill_rate": 0,
      "max_weight": 0,
      "item_weight": 0,
      "weight": 0,
      "weight_fill_rate": 0,
      "packaging_cost": 0,
      "transport_cost": 0,
      "cost": 0,
      "num_bins": 0,
      "num_items": 0
    }
  ],
  "errors": [
    "string"
  ],
  "messages": [
    {
      "message": "string",
      "category": "other",
      "severity": "info"
    }
  ],
  "execution_time": 0,
  "bin_type": "BOX",
  "units": {
    "length": "mm",
    "mass": "mg",
    "bins": {
      "length": "mm",
      "mass": "mg"
    },
    "items": {
      "length": "mm",
      "mass": "mg"
    }
  },
  "created_at": "2025-02-24T15:38:37.397Z",
  "bin_volume": 0,
  "item_volume": 0,
  "fill_rate": 0,
  "max_weight": 0,
  "item_weight": 0,
  "weight": 0,
  "weight_fill_rate": 0,
  "packaging_cost": 0,
  "transport_cost": 0,
  "cost": 0,
  "num_items": 0,
  "num_bins": 0,
  "num_orders": 0
}

404

Request not found

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD2
string
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

message Messagerequired

Example (from schema)

{
  "message": "string"
}

Loading...