Skip to content

Max Gross Mass

Emmanuel Bernier edited this page Nov 6, 2017 · 2 revisions

MAX_GROSS_MASS_KG, MAX_GROSS_MASS_LBS

These 2 services are passed a container number and return the container max gross mass in kg (or lbs).

OPERATION = GET

ENDPOINT

<Container_number>

For Sandbox, you may test you tare request with the following container number : GLDU5334260 Generally speaking, the container number format is AAAU9999999 :

  • BIC Code of 4 characters
  • Container number with 6 digits plus 1 check digit.

HEADERS =

Authorization : Bearer <accessToken>

Note : there is a blank space between "Bearer" and the accessToken

RESPONSE =

Tare weight is returned as a decimal value, in kg or lbs depending on endpoint called. The decimal separator is a '.'

<max_gross_mass>

For example :

1234.56

If there is no container with this container number in the TCD, the returned value is an error string for example :

 {
    "error": "Sorry, there is no record for this container in BoxTech."
}

If there is an alert preventing you from accessing the container details, the returned value is an error string s well as a status 417. for example :

An alert or warning prevents you from querying this container