Introduction

Load Calculator API

version 1

Load Calculator is an application intended to compute and to place some goods into container and make their position to place some goods into a transport unit and make their position optimal. The software visualizes calculation and allows you to export results.

Download OpenAPI Spec

General information

Load Calculator API is organized around REST.
Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

API endpoint#

1https://packer.searates.com

All endpoints are only accessible via HTTPS and are located at packer.searates.com

Get packing result

post/services/api/json

Get packing result

Headers

Content-Typeapplication/json

Body Parameters

api_keyREQUIREDstring
API key
packer_data_cargoREQUIREDarray[object]
Sets cargo physical details.
box_type
Optional
string
Specify the type of cargo.
Allowed values:boxbig-bagbarrelsack
Default:box
box_name
REQUIRED
string
Cargo name.
box_length
REQUIRED
integer
Cargo length in millimeters (mm).
box_width
REQUIRED
integer
Cargo width in millimeters (mm).
box_weight
REQUIRED
integer
Cargo weight in kilograms (kg).
box_height
REQUIRED
integer
Cargo height in millimeters (mm).
box_number
Optional
integer
Cargo quantity.
Default:1
box_color
REQUIRED
string
Cargo color (six-digit HEX number).
Example:0050E3
packer_rules_height
Optional
boolean
Set if accessible to load cargo by height position.
Default:true
packer_rules_length
Optional
boolean
Set if accessible to load cargo by length position.
Default:true
packer_rules_width
Optional
boolean
Set if accessible to load cargo by width position.
Default:true
packer_data_containerOptionalarray[object]
If this parameter doesn't exist, container type will be set automatically (20’ST/40’ST/40’HQ/45’HQ). Otherwise container type must be set manually.
container_name
Optional
string
Container or Truck name.
container_length
Optional
integer
Container length in millimeters (mm).
container_width
Optional
integer
Container width in millimeters (mm).
container_height
Optional
integer
Container width in millimeters (mm).
container_tonnage
Optional
integer
Max container weight in kilograms (kg).
box_orderOptionalarray[string]
Order of cargo loading. The priority of loading defines what cargo will be stuffed first. If you determine priority of cargo loading it could adversely affect effective stuffing.
image_allOptionalboolean
Shows additional details by images, allowing to see step-by-step container load process.
Default:false
pallet_enableOptionalboolean
Enable loading on pallets.
Default:false
pallet_lengthOptionalinteger
Pallet length in millimeters (mm).
Default:1000
pallet_widthOptionalinteger
Pallet width in millimeters (mm).
Default:1200
pallet_heightOptionalinteger
Pallet height in millimeters (mm).
Default:150
pallet_tonnageOptionalinteger
Pallet payload in kilograms (kg).
Default:750
pallet_max_heightOptionalinteger
Pallet Max loading height level in millimeters (mm).
Default:2000
pallet_level_separate_heightOptionalinteger
Thickness of separating plate of pallet in millimeters (mm).
Default:50

Request sample

Example 1

{
  "api_key": "{API_KEY}",
  "packer_data_cargo": [
    {
      "box_type": "box",
      "box_name": "Cargo 1",
      "box_length": 300,
      "box_width": 700,
      "box_height": 300,
      "box_weight": 30,
      "box_number": 100,
      "box_color": "F48B04"
    },
    {
      "box_type": "barrel",
      "box_name": "Cargo 2",
      "box_length": 400,
      "box_width": 400,
      "box_height": 400,
      "box_weight": 30,
      "box_number": 30,
      "box_color": "CF0F0F"
    }
  ]
}

Example 2

Response example

1{
2  "image64_pallet": "data:image/png;base64...",
3  "image64_pallet_groups": [
4    "data:image/png;base64..."
5  ],
6  "image64_pallet_steps": [
7    "data:image/png;base64..."
8  ],
9  "unit": {
10    "40' hq": 2
11  },
12  "packages_total": 700,
13  "packages_packed": 700,
14  "group": [
15    {
16      "image64": "data:image/png;base64",
17      "image64_groups": [
18        "data:image/png;base64...",
19        "data:image/png;base64"
20      ],
21      "image64_steps": [
22        "data:image/png;base64..."
23      ],
24      "name": "40' hq",
25      "number": 1,
26      "cargo": [
27        {
28          "name": "Cargo 1",
29          "box_number": 130,
30          "box_percent": 65,
31          "color": "F48B04"
32        },
33        {
34          "name": "Cargo 2",
35          "box_number": 182,
36          "box_percent": 91,
37          "color": "FF1B00"
38        },
39        {
40          "name": "Cargo 3",
41          "box_number": 286,
42          "box_percent": 95,
43          "color": "CF0F0F"
44        }
45      ],
46      "packed": 598,
47      "packed_percent": 85,
48      "volume": 37.96,
49      "volume_percent": 50,
50      "weight": 17940,
51      "weight_percent": 63,
52      "limits": "Cargo quantity is limited by volume"
53    },
54    {
55      "image64": "data:image/png;base64...",
56      "image64_groups": [
57        "data:image/png;base64..."
58      ],
59      "image64_steps": [
60        "data:image/png;base64..."
61      ],
62      "name": "40' hq",
63      "number": 1,
64      "cargo": [
65        {
66          "name": "Cargo 1",
67          "box_number": 70,
68          "box_percent": 35,
69          "color": "F48B04"
70        },
71        {
72          "name": "Cargo 2",
73          "box_number": 18,
74          "box_percent": 9,
75          "color": "FF1B00"
76        },
77        {
78          "name": "Cargo 3",
79          "box_number": 14,
80          "box_percent": 4,
81          "color": "CF0F0F"
82        }
83      ],
84      "packed": 102,
85      "packed_percent": 14,
86      "volume": 6.44,
87      "volume_percent": 8,
88      "weight": 3060,
89      "weight_percent": 11
90    }
91  ]
92}