API Use Case Examples

Boxtech Public Documentation
Search…
Boxtech Public Documentation
Introduction
Web
API
API Use Case Examples
SOLAS VGM
BoxTech allows shippers, carriers, terminals, depots, and other supply chain participants to instantly obtain technical information about containers, such as tare weight, size/type and maximum gross mass. BoxTech means a one-stop-shop to obtain container tare weights for use in Method 2 SOLAS VGM calculations.
To obtain the tare weight for a given containers you would use the GET method below to retrieve the container detail and would look for the tare_kg in the response, you can now use this in your SOLAS VGM method 2 calculations
Terminal Process
BoxTech allows shippers, carriers, terminals, depots, and other supply chain participants to instantly obtain technical information about containers, such as tare weight, size/type and maximum gross mass.
BoxTech means a one-stop-shop to obtain container max weights for your automated safety checks within a terminal.
For safety you may want to obtain the max weight for a given container to cross check the weight of a container on arrival at the port or terminal.
To obtain the tare weight for a given containers you would use the GET method below to retrieve the container detail and would look for the max_payload_kg or for the loading process the max_gross_mass_kg in the response
Query the API
get
https://app.bic-boxtech.org/api
/v2.0/container/:container
GET Container Detail
Retrieve the Tare Weight from Response
Look for the `tare_kg` in the json response, you can now use this value in your SOLAS VGM method 2 calculations.
1
[{
2
       "uploaderaccountname": "TOUAX",
3
       "bic_code": "GLDU",
4
       "prefix": "GLD",
5
       "equipment_identifier": "U",
6
       "serial_number": "533426",
7
       "check_digit": "0",
8
       "group_st": "20DC",
9
       "detail_st": null,
10
       "tare_kg": 2230,
11
       "tare_lbs": 4920,
12
       "max_payload_kg": 30480,
13
       "max_payload_lbs": 67200,
14
       "max_gross_mass_kg": 28250,
15
       "max_gross_mass_lbs": 62280,
16
       "cubic_capacity_cbm": 33,
17
       "cubic_capacity_cuft": 1170,
18
       "stacking_kg": 216000,
19
       "stacking_lbs": 476190,
20
       "racking_kg": null,
21
       "racking_lbs": null,
22
       "racking_n": null,
23
       "one_door_off_stacking_kg": null,
24
       "one_door_off_stacking_lbs": null,
25
       "one_door_off_racking_kg": null,
26
       "one_door_off_racking_lbs": null,
27
       "one_door_off_racking_n": null,
28
       "one_door_off_end_wall_strength_kg": null,
29
       "one_door_off_end_wall_strength_lbs": null,
30
       "manufacture_number": null,
31
       "manufacture_date": "2008-03-27T00:00:00.000Z",
32
       "manufacturer": "CIMCDCMCDALIAN",
33
       "customs_approval": null,
34
       "customs_approval_type": null,
35
       "csc_approval": null,
36
       "timber_treatment_approval": null,
37
       "external_length_mm": null,
38
       "external_width_mm": null,
39
       "external_height_mm": null,
40
       "internal_length_mm": null,
41
       "internal_width_mm": null,
42
       "internal_height_mm": null,
43
       "door_opening_width_mm": null,
44
       "door_opening_height_mm": null,
45
       "codeholder": "TOUAX",
46
       "container_number": "GLDU5334260",
47
       "checkDigitwarning": false,
48
       "external_length_ft": null,
49
       "internal_length_ft": null,
50
       "external_width_ft": null,
51
       "internal_width_ft": null,
52
       "external_height_ft": null,
53
       "internal_height_ft": null,
54
       "door_opening_width_ft": null,
55
       "door_opening_height_ft": null,
56
       "capacity_litres": "31200",
57
       "imdg_code": "T1",
58
       "adr_rid_code": "L10CH",
59
       "baffles": false
60
   }]
Copied!
API - Previous
API Documentation
Last modified 1mo ago
Copy link
Contents
Retrieve the Tare Weight from Response