Home

Introduction

Load Calculator API

version 2

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.

OpenAPI Specification

Start designing your API in minutes. The OpenAPI specification file enables you to learn and interact with API elements, including all available endpoints, input and output representations.

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://www.searates.com

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

Get packing result

post/stuffing/api
Headers

Content-Typeapplication/json

Query Parameters
  • keyOptionalstring

    Your API key (Must be filled if "Authorization" header is missing)

Body Parameters
  • optionsREQUIREDobject
  • groupsREQUIREDarray[object]

    Groups are an array of JSON objects arranged in a strict order, which is taken into account when stuffing containers. The closer to the beginning of the array the group, the earlier it will be stuffed. A group can contain a pallet setting for a group.

  • containersOptionalarray[object]

    fixed quantity of containers that fill up earlier than auto containers

  • autoContainersREQUIREDarray[object]

    The algorithm determines which type will be used for loading automatically.

  • imagesOptionalobject
Request sample
{
  "options": {
    "lengthUnits": "mm",
    "weightUnits": "kg",
    "lengthAccuracy": 5,
    "remainsNear": true
  },
  "groups": [
    {
      "name": "Group #1",
      "uid": "111",
      "color": "#000",
      "pallets": {
        "uid": "1dca98",
        "color": "#000",
        "size": {
          "length": 1200,
          "width": 800,
          "height": 2000
        },
        "stacking": {
          "maxHeight": null,
          "layers": 3,
          "fill": 0.85
        },
        "weight": 10,
        "maxWeight": 1500,
        "depth": 100,
        "name": "euro",
        "type": "euro"
      },
      "items": [
        {
          "color": "#23b753",
          "index": 1,
          "name": "Boxes 1",
          "qty": 400,
          "type": "box",
          "uid": "2222",
          "weight": 10,
          "size": {
            "length": 500,
            "width": 400,
            "height": 300,
            "radius": null
          },
          "stacking": {
            "tiltX": true,
            "tiltY": false,
            "layers": 0,
            "topWeight": 0,
            "height": null,
            "fill": null,
            "rollPlacement": null
          }
        }
      ]
    }
  ],
  "containers": [],
  "autoContainers": [
    {
      "attr": {
        "type": "20st"
      },
      "spaces": [
        {
          "length": 5890,
          "width": 2350,
          "height": 2390,
          "maxWeight": 28230
        }
      ]
    },
    {
      "attr": {
        "type": "40st"
      },
      "spaces": [
        {
          "length": 12020,
          "width": 2350,
          "height": 2390,
          "maxWeight": 26700
        }
      ]
    },
    {
      "attr": {
        "type": "40hq"
      },
      "spaces": [
        {
          "length": 12020,
          "width": 2350,
          "height": 2690,
          "maxWeight": 26460
        }
      ]
    }
  ],
  "auth": {
    "demo": false,
    "user": false
  },
  "errorProducts": [],
  "palletCheckLoader": false
}
Response example
Successful operation
1{
2  "result": [
3    {
4      "uid": "string",
5      "size": {
6        "x": 0,
7        "y": 0,
8        "z": 0
9      },
10      "qty": 0,
11      "attr": {},
12      "general": {
13        "itemQty": 0,
14        "cargoVolume": 0,
15        "cargoWeight": 0,
16        "volumeRatio": 0,
17        "weightRatio": 0,
18        "items": {
19          "property1": 0,
20          "property2": 0
21        }
22      },
23      "spaces": [
24        {
25          "uid": "string",
26          "color": "string",
27          "name": "string",
28          "form": "box",
29          "general": {
30            "itemQty": 0,
31            "cargoVolume": 0,
32            "cargoWeight": 0,
33            "items": {
34              "property1": 0,
35              "property2": 0
36            }
37          },
38          "size": {
39            "x": 0,
40            "y": 0,
41            "z": 0
42          },
43          "complex": {
44            "x": 0,
45            "y": 0,
46            "z": 0
47          },
48          "location": {
49            "x": 0,
50            "y": 0,
51            "z": 0
52          },
53          "children": [
54            {
55              "uid": "string",
56              "color": "string",
57              "name": "string",
58              "form": "box",
59              "general": {
60                "itemQty": 0,
61                "cargoVolume": 0,
62                "cargoWeight": 0,
63                "items": {
64                  "property1": 0,
65                  "property2": 0
66                }
67              },
68              "size": {
69                "x": 0,
70                "y": 0,
71                "z": 0
72              },
73              "complex": {
74                "x": 0,
75                "y": 0,
76                "z": 0
77              },
78              "location": {
79                "x": 0,
80                "y": 0,
81                "z": 0
82              }
83            }
84          ]
85        }
86      ]
87    }
88  ],
89  "cargoAttributes": {
90    "property1": {
91      "name": "string",
92      "color": "string",
93      "volume": 0,
94      "weight": 0,
95      "type": "box"
96    },
97    "property2": {
98      "name": "string",
99      "color": "string",
100      "volume": 0,
101      "weight": 0,
102      "type": "box"
103    }
104  },
105  "images": [
106    "string"
107  ],
108  "version": "string"
109}