Samples and downloads

load calculation API

URL https://e3.cubemaster.net:1591/api/LoadBuilder
HTTP Method POST
Input Parameters
Parameter name Required Type Description
Login   yes array Sets the login credential.
UserID yes string The email of the login.
Password yes string The passowrd of the login.
Company yes string The compnay of the login.
Shipment   yes array Sets the shipment information.
Title yes string The title of the shipment.
Description no string The description of the shipment.
Cargoes   yes array Sets cargo physical details.
GroupName no string Sets the group name of the cargo.
Name yes string Cargo name.
Length yes number Cargo length in millimeter, centimeter or inch.
Width yes number Cargo width in millimeter, centimeter or inch.
Height yes number Cargo height in millimeter, centimeter or inch.
Weight yes number Cargo weight in kilograms or pound.
Qty no number Sets the quantity of the cargo. This is taken in consideration when the CalculationType of the Rules is MixLoad and MultipleSetLoadByQuantity.
Default value: 0
SetRatio no number Sets the set ratio of the cargo. This is taken in consideration only if the CalculationType of the Rules is SetLoad or MultipleSetLoadByQuantity. 
Default value: 0
PieceInside no number Sets or the number of pack inside the cargo.
Default value: 0
ColorKnownName no string Cargo color as a known name such as 'white','red' and 'blue'.
Default value: white
ColorHexaCode no string Cargo color (#six-digit HEX number).
Default value: #FFFFFF
OrientationsAllowed yes string Cargo directionss allowed in a load. The available values for this parameter are: 
OrientationsDefault|Orientation1|Orientation2|Orientation3|Orientation4|Orientation5|Orientation6|OrientatioBasic|OrientationAll|OrientationBasic.
Default value: OrientationBasic
TurnAllowedOnFloor no bool Set if the turning directions (when OrientationsAllowed is either Orientation3|Orientation4|Orientation5|Orientation6) are allowed on the floor of the vehicle or pallet.
Default value: true
Sequence no number Sets the priority of the cargo. Less value makes the cargo placed earlier. This is taken in consideration when the IsGroupUsed of the class Rules is true. Default value: 0
FloorStackType no string Sets the floor stacking type of this cargo. The available values for this parameter are: BottomOnly|NoBottom|Bestfit.
Bestfit: The cargoes are placed where it's most efficient in relation to other items in the load.
BottomOnly: Any solutions are disregarded in which the cargo is not placed on the floor.
NoBottom: Any solutions are disregarded in which the cargo is placed on the floor.
  Default value: Bestfit 
FloorStackSupportsOthers no bool Sets or if the cargo can support others.
Default value: true
UnitloadBottomPattern no string Sets the pattern of the bottom layers for a unit load when it is filled with this cargo. The available values for this parameter are: Pattern1Block|Pattern2Blocks|Pattern3Blocks|Pattern4Blocks|Bestfit.
Default value: Bestfit 
UnitloadTopPattern no string Sets the pattern of the top layers for a unit load when it is filled with this cargo. The top layers may not compose if there is no more space in the top of the bottom layers. The available values for this parameter are: Pattern1Block|Pattern2Blocks|Pattern3Blocks|Pattern4Blocks|Bestfit.
Default value: Bestfit 
Containers   yes array Sets container physical details such as sea container, truck, pallet, carton or ULD.
ContainerType yes string Sets or the type of the container. The available values for this parameter are: Carton|Pallet|SeaVan|Truck|AirPallet.
  Default value: Truck 
Name yes string Container name.
Length yes number The length of the container in millimeter, centimeter or inch.
Width yes number The width of the container in millimeter, centimeter or inch.
Height yes number The height of the container in millimeter, centimeter or inch. The thickness comes to the PalletThickness member.
VehicleMaxWidth no number The width of the truck or trailer allowed over the width. This is taken in consideraton if the truck or trailer is Flatbed.
VehicleMaxHeight no number The height of the truck or trailer allowed over the height. This is taken in consideraton if the truck or trailer is Flatbed or Opentop.
PalletThickness yes number The thickness of the pallet in millimeter, centimeter or inch.
MaxHeight no number The height allowed on the load on a pallet. It includes the thickness of the pallet.
EmptyWeight no number The weight of the empty conainer in kilograms or pound.
MaxWeight no number Max container weight in kilograms (kg). It contains the empty weight of the container.
MaxVolPercent no number Max volume allowed on the container in percent. Default value: 0
Qty no number Sets the quantity of the container. This is taken in consideration when the BestFitContainersSelectionType of the class Rules is BestfitDisabled. Default value: 0
Priority no number Sets the priority of the container. Less value makes the container filled earlier. This is taken in consideration when the BestFitContainersSelectionType of the class Rules is BestfitDisabled. Default value: 0
Color no number Container color as a RGB value. Set 0 to assign a random color. Default value: 0