-
Notifications
You must be signed in to change notification settings - Fork 10
Tare Weight
Emmanuel Bernier edited this page Aug 1, 2018
·
8 revisions
These 2 services are passed a container number and return the container tare weight in kg (or lbs).
- production endpoint = https://app.bic-boxtech.org/api/v2.0/container/<container_number>/tare_kg
- production endpoint = https://app.bic-boxtech.org/api/v2.0/container/<container_number>/tare_lbs/
- sandbox endpoint = https://test-bic-container.herokuapp.com/api/v2.0/container/<container_number>/tare_kg
- sandbox endpoint = https://test-bic-container.herokuapp.com/api/v2.0/container/<container_number>/tare_lbs
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.
Authorization : Bearer <accessToken>
Note : there is a blank space between "Bearer" and the accessToken
Tare weight is retruned as a decimal value, in kg or lbs depending on endpoint called. The decimal separator is a '.'
<tare_weight>
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