├── .DS_Store ├── .gitbook.yaml ├── .gitbook └── assets │ ├── 01_New_Tab.png │ ├── 02_Auth_Headers.png │ ├── 03_Auth_Body.png │ ├── 04_Auth_Response.png │ ├── 05_Get_Headers.png │ ├── 06_get_Response.png │ ├── image (2).png │ ├── image-1-2 (1).png │ ├── image-1-2.png │ ├── image.png │ ├── results.png │ ├── screenshot-2021-07-27-at-11.56.47.png │ ├── screenshot-2021-07-27-at-11.57.40.png │ ├── screenshot-2021-07-27-at-12.02.23.png │ ├── screenshot-2021-07-27-at-12.11.07.png │ ├── search.png │ └── uploader.png ├── docs ├── .DS_Store ├── .gitbook │ ├── .DS_Store │ └── assets │ │ ├── .DS_Store │ │ ├── 01_New_Tab.png │ │ ├── 02_Auth_Headers.png │ │ ├── 03_Auth_Body.png │ │ ├── 04_Auth_Response.png │ │ ├── 05_Get_Headers.png │ │ ├── 06_get_Response.png │ │ ├── Screenshot 2023-03-22 at 13.11.40.png │ │ ├── Screenshot 2023-03-22 at 13.17.28.png │ │ ├── Screenshot 2023-03-22 at 13.27.43.png │ │ ├── Screenshot 2023-03-30 at 09.35.39.png │ │ ├── Screenshot 2023-03-30 at 09.39.58.png │ │ ├── Screenshot 2024-02-02 at 08.42.52.png │ │ ├── Screenshot 2024-05-31 at 10.39.58.png │ │ ├── Screenshot 2024-05-31 at 10.56.35.png │ │ ├── image (2).png │ │ ├── image-1-2 (1).png │ │ ├── image-1-2.png │ │ ├── image.png │ │ ├── results.png │ │ ├── screenshot-2021-07-27-at-11.56.47.png │ │ ├── screenshot-2021-07-27-at-11.57.40.png │ │ ├── screenshot-2021-07-27-at-12.02.23.png │ │ ├── screenshot-2021-07-27-at-12.11.07.png │ │ ├── search.png │ │ └── uploader.png ├── README.md ├── SUMMARY.md ├── api │ ├── api-documentation.md │ ├── examples.md │ └── limits-and-quotas.md ├── maintaining-your-fleet │ ├── automating-the-updates.md │ ├── boxtech-dataset.md │ └── getting-started.md └── user-guide │ ├── change-password.md │ ├── container-alerts.md │ ├── managing-your-fleet.md │ ├── search-boxtech.md │ ├── smart-containers.md │ └── upload-history.md └── templates ├── alert.csv ├── bic_tcd_smart_container_template.csv ├── fleet-in-full.csv ├── fleet-in-short.csv └── fleet-out.csv /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.DS_Store -------------------------------------------------------------------------------- /.gitbook.yaml: -------------------------------------------------------------------------------- 1 | root: ./docs/ 2 | -------------------------------------------------------------------------------- /.gitbook/assets/01_New_Tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/01_New_Tab.png -------------------------------------------------------------------------------- /.gitbook/assets/02_Auth_Headers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/02_Auth_Headers.png -------------------------------------------------------------------------------- /.gitbook/assets/03_Auth_Body.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/03_Auth_Body.png -------------------------------------------------------------------------------- /.gitbook/assets/04_Auth_Response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/04_Auth_Response.png -------------------------------------------------------------------------------- /.gitbook/assets/05_Get_Headers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/05_Get_Headers.png -------------------------------------------------------------------------------- /.gitbook/assets/06_get_Response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/06_get_Response.png -------------------------------------------------------------------------------- /.gitbook/assets/image (2).png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/image (2).png -------------------------------------------------------------------------------- /.gitbook/assets/image-1-2 (1).png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/image-1-2 (1).png -------------------------------------------------------------------------------- /.gitbook/assets/image-1-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/image-1-2.png -------------------------------------------------------------------------------- /.gitbook/assets/image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/image.png -------------------------------------------------------------------------------- /.gitbook/assets/results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/results.png -------------------------------------------------------------------------------- /.gitbook/assets/screenshot-2021-07-27-at-11.56.47.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/screenshot-2021-07-27-at-11.56.47.png -------------------------------------------------------------------------------- /.gitbook/assets/screenshot-2021-07-27-at-11.57.40.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/screenshot-2021-07-27-at-11.57.40.png -------------------------------------------------------------------------------- /.gitbook/assets/screenshot-2021-07-27-at-12.02.23.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/screenshot-2021-07-27-at-12.02.23.png -------------------------------------------------------------------------------- /.gitbook/assets/screenshot-2021-07-27-at-12.11.07.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/screenshot-2021-07-27-at-12.11.07.png -------------------------------------------------------------------------------- /.gitbook/assets/search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/search.png -------------------------------------------------------------------------------- /.gitbook/assets/uploader.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/.gitbook/assets/uploader.png -------------------------------------------------------------------------------- /docs/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.DS_Store -------------------------------------------------------------------------------- /docs/.gitbook/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/.DS_Store -------------------------------------------------------------------------------- /docs/.gitbook/assets/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/.DS_Store -------------------------------------------------------------------------------- /docs/.gitbook/assets/01_New_Tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/01_New_Tab.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/02_Auth_Headers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/02_Auth_Headers.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/03_Auth_Body.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/03_Auth_Body.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/04_Auth_Response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/04_Auth_Response.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/05_Get_Headers.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/05_Get_Headers.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/06_get_Response.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/06_get_Response.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2023-03-22 at 13.11.40.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2023-03-22 at 13.11.40.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2023-03-22 at 13.17.28.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2023-03-22 at 13.17.28.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2023-03-22 at 13.27.43.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2023-03-22 at 13.27.43.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2023-03-30 at 09.35.39.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2023-03-30 at 09.35.39.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2023-03-30 at 09.39.58.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2023-03-30 at 09.39.58.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2024-02-02 at 08.42.52.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2024-02-02 at 08.42.52.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2024-05-31 at 10.39.58.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2024-05-31 at 10.39.58.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/Screenshot 2024-05-31 at 10.56.35.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/Screenshot 2024-05-31 at 10.56.35.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/image (2).png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/image (2).png -------------------------------------------------------------------------------- /docs/.gitbook/assets/image-1-2 (1).png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/image-1-2 (1).png -------------------------------------------------------------------------------- /docs/.gitbook/assets/image-1-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/image-1-2.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/image.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/results.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/screenshot-2021-07-27-at-11.56.47.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/screenshot-2021-07-27-at-11.56.47.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/screenshot-2021-07-27-at-11.57.40.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/screenshot-2021-07-27-at-11.57.40.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/screenshot-2021-07-27-at-12.02.23.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/screenshot-2021-07-27-at-12.02.23.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/screenshot-2021-07-27-at-12.11.07.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/screenshot-2021-07-27-at-12.11.07.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/search.png -------------------------------------------------------------------------------- /docs/.gitbook/assets/uploader.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bic-org/Boxtech/e1c0a55623dbbec43623458d02061f287fe0a67e/docs/.gitbook/assets/uploader.png -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | Boxtech provides container technical detail for the global container fleet, you can see what data is available in our dataset, we would recommend that you use the API for integrating to your application as well as the user interface for less frequent lookups. 4 | 5 | The documentation is available at [https://docs.bic-boxtech.org](https://docs.bic-boxtech.org) 6 | 7 | Full details on Boxtech and the BIC can be found at [https://www.bic-boxtech.org](https://www.bic-boxtech.org) 8 | 9 | For feature requests, support or other requests please raise a github issue at [https://github.com/bic-org/Boxtech](https://github.com/bic-org/Boxtech) and we will reply accordingly. 10 | 11 | ## Register for Access 12 | 13 | Access to Boxtech is free, you just need to register to use the service and verify your email account. 14 | 15 | Registration can be found at [https://app.bic-boxtech.org/sign-up](https://app.bic-boxtech.org/sign-up) 16 | 17 | ## User Roles 18 | 19 | You can use Boxtech as either: 20 | 21 | * Consumer 22 | * Uploader 23 | 24 | #### Consumers 25 | 26 | As a consumer you get full access to Boxtech to query the containers in the database, you only need the container number you are looking for and you can [search using the web interface](user-guide/search-boxtech.md) for occasional use OR use the [API to integrate](api/api-documentation.md) or script queries to Boxtech from your own application. 27 | 28 | You will need to register to gain access, and can start using the application immediately. 29 | 30 | #### Uploaders 31 | 32 | To [add your containers to boxtech](user-guide/managing-your-fleet.md) and manage your fleet or [apply container alerts](user-guide/container-alerts.md) to containers you will need to have uploader rights. To qualify for this you will need to register as an uploader in Boxtech and provide the BIC prefix that applies to you. 33 | 34 | This information is verified by BIC and once approved you will have the ability to start managing your container fleet and alerts. 35 | 36 | You will gain immediate access to Boxtech as a `consumer` but only have `uploader` rights until verification has taken place by the BIC team. 37 | 38 | When registering for Boxtech provide one of your BIC codes and we will verify your account as part of your application to become an uploader. 39 | 40 | If you are already registered as a consumer then, once logged into Boxtech you can request access by clicking the button below and providing a BIC Code. 41 | 42 |
43 | 44 | Follow the [Getting Started](maintaining-your-fleet/getting-started.md) guide to uploading your fleet 45 | 46 | ## API Specifications 47 | 48 | All Our API's are published on SwaggerHub [https://app.swaggerhub.com/apis/BIC-ORG](https://app.swaggerhub.com/apis/BIC-ORG) 49 | 50 | Download the Postman Collection from [https://documenter.getpostman.com/view/Tzm9huBX](https://documenter.getpostman.com/view/Tzm9huBX) 51 | 52 | ## Issues, Support or Feature Requests 53 | 54 | We are always interested to hear your ideas for Boxtech, and to support your journey to integrating Boxtech into your systems. Please raise a **Github issue** for us to manage these requests and we will be happy to assist. and hear from you. 55 | 56 | [https://github.com/bic-org/Boxtech](https://github.com/bic-org/Boxtech) 57 | -------------------------------------------------------------------------------- /docs/SUMMARY.md: -------------------------------------------------------------------------------- 1 | # Table of contents 2 | 3 | * [Introduction](README.md) 4 | 5 | ## User Guide 6 | 7 | * [Search Boxtech](user-guide/search-boxtech.md) 8 | * [Managing your Fleet](user-guide/managing-your-fleet.md) 9 | * [Smart Containers](user-guide/smart-containers.md) 10 | * [Container Alerts](user-guide/container-alerts.md) 11 | * [Change Password](user-guide/change-password.md) 12 | * [Upload History](user-guide/upload-history.md) 13 | 14 | ## API 15 | 16 | * [API Documentation](api/api-documentation.md) 17 | * [API Use Case Examples](api/examples.md) 18 | * [Limits and Quotas](api/limits-and-quotas.md) 19 | 20 | ## Maintaining Your Fleet 21 | 22 | * [Getting Started](maintaining-your-fleet/getting-started.md) 23 | * [Automating the Updates](maintaining-your-fleet/automating-the-updates.md) 24 | * [Boxtech Dataset](maintaining-your-fleet/boxtech-dataset.md) 25 | -------------------------------------------------------------------------------- /docs/api/api-documentation.md: -------------------------------------------------------------------------------- 1 | # API Documentation 2 | 3 | The most beneficial way to use Boxtech is by integrating it into your workflow and systems to provide container data or a source of checking information. 4 | 5 | The Boxtech API is part of the BIC's digital services and you will need to follow the steps below to access this API 6 | 7 | ## Steps to Access Boxtech 8 | 9 | 1. Register for an Account by visiting one of the links below: 10 | 11 | * Live Environment: [https://app.bic-boxtech.org/sign-up](https://app.bic-boxtech.org/sign-up) 12 | * UAT Environment: [https://uat.bic-boxtech.org/sign-up](https://app.bic-boxtech.org/sign-up) 13 | 14 | 1. Download the Postman Collection or Start Coding to Integrate 15 | 16 | ## Authentication 17 | 18 | The value for Authorization header is: `Basic `, where credentials is the Base64 encoding of username and password joined by a single colon `:` eg. `username:password` 19 | 20 | Example: `Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==` 21 | 22 | {% swagger baseUrl="https://uat.bic-boxtech.org" path="/oauth/token" method="post" summary="Retrieve Token" %} 23 | {% swagger-description %} 24 | 25 | {% endswagger-description %} 26 | 27 | {% swagger-parameter name="Authorization" type="string" required="true" in="header" %} 28 | Base64 encoded username and password as described above. 29 | {% endswagger-parameter %} 30 | 31 | {% swagger-response status="200" description="" %} 32 | ``` 33 | { 34 | "accessToken": "eyJraWQLCJjdbWF6b25hd3MNWGwd8ixowDovA", 35 | "accessTokenExpiresAt": "2021-07-06T12:18:34.164521+00:00", 36 | "access_token": "eyJraWQiOiJPa2DovA" 37 | } 38 | ``` 39 | {% endswagger-response %} 40 | {% endswagger %} 41 | 42 | ## Open API Documentation and Postman Collection 43 | 44 | Open API documentation can be found at [https://app.swaggerhub.com/apis/BIC-ORG/Boxtech/](https://app.swaggerhub.com/apis/BIC-ORG/Boxtech/) 45 | 46 | You can download the Postman collection to get started with Boxtech at [https://documenter.getpostman.com/view/7925649/2s9YsNcV3E#5fc2ce38-b02a-4362-bc95-559b7592d53f](https://documenter.getpostman.com/view/7925649/2s9YsNcV3E#5fc2ce38-b02a-4362-bc95-559b7592d53f) 47 | -------------------------------------------------------------------------------- /docs/api/examples.md: -------------------------------------------------------------------------------- 1 | # API Use Case Examples 2 | 3 | ## SOLAS VGM 4 | 5 | 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. 6 | 7 | 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 8 | 9 | ## Terminal Process 10 | 11 | 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. 12 | 13 | BoxTech means a one-stop-shop to obtain container max weights for your automated safety checks within a terminal. 14 | 15 | 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. 16 | 17 | 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 18 | 19 | ## Query the API 20 | 21 | {% swagger baseUrl="https://app.bic-boxtech.org/api" path="/v2.0/container/:container" method="get" summary="GET Container Detail" %} 22 | {% swagger-description %} 23 | Find the technical Details for a given container number 24 | {% endswagger-description %} 25 | 26 | {% swagger-parameter name="container" type="string" required="true" in="path" %} 27 | Container Number i.e. GLDU5334260 28 | {% endswagger-parameter %} 29 | 30 | {% swagger-response status="200" description="" %} 31 | ``` 32 | [{ 33 | "uploaderaccountname": "TOUAX", 34 | "bic_code": "GLDU", 35 | "prefix": "GLD", 36 | "equipment_identifier": "U", 37 | "serial_number": "533426", 38 | "check_digit": "0", 39 | "group_st": "20DC", 40 | "detail_st": null, 41 | "tare_kg": 2230, 42 | "tare_lbs": 4920, 43 | "max_payload_kg": 30480, 44 | "max_payload_lbs": 67200, 45 | "max_gross_mass_kg": 28250, 46 | "max_gross_mass_lbs": 62280, 47 | "cubic_capacity_cbm": 33, 48 | "cubic_capacity_cuft": 1170, 49 | "stacking_kg": 216000, 50 | "stacking_lbs": 476190, 51 | "racking_kg": null, 52 | "racking_lbs": null, 53 | "racking_n": null, 54 | "one_door_off_stacking_kg": null, 55 | "one_door_off_stacking_lbs": null, 56 | "one_door_off_racking_kg": null, 57 | "one_door_off_racking_lbs": null, 58 | "one_door_off_racking_n": null, 59 | "one_door_off_end_wall_strength_kg": null, 60 | "one_door_off_end_wall_strength_lbs": null, 61 | "manufacture_number": null, 62 | "manufacture_date": "2008-03-27T00:00:00.000Z", 63 | "manufacturer": "CIMCDCMCDALIAN", 64 | "customs_approval": null, 65 | "customs_approval_type": null, 66 | "csc_approval": null, 67 | "timber_treatment_approval": null, 68 | "external_length_mm": null, 69 | "external_width_mm": null, 70 | "external_height_mm": null, 71 | "internal_length_mm": null, 72 | "internal_width_mm": null, 73 | "internal_height_mm": null, 74 | "door_opening_width_mm": null, 75 | "door_opening_height_mm": null, 76 | "codeholder": "TOUAX", 77 | "container_number": "GLDU5334260", 78 | "checkDigitwarning": false, 79 | "external_length_ft": null, 80 | "internal_length_ft": null, 81 | "external_width_ft": null, 82 | "internal_width_ft": null, 83 | "external_height_ft": null, 84 | "internal_height_ft": null, 85 | "door_opening_width_ft": null, 86 | "door_opening_height_ft": null 87 | }] 88 | ``` 89 | {% endswagger-response %} 90 | {% endswagger %} 91 | 92 | ### Retrieve the Tare Weight from Response 93 | 94 | Look for the \`tare\_kg\` in the json response, you can now use this value in your SOLAS VGM method 2 calculations. 95 | 96 | ``` 97 | [ 98 | { 99 | "uploaderaccountname": "CANADIAN ROYALTIES INC", 100 | "bic_code": "NNCU", 101 | "check_digit": "0", 102 | "checkDigitwarning": false, 103 | "codeholder": "CANADIAN ROYALTIES INC", 104 | "code_holder": "CANADIAN ROYALTIES INC", 105 | "container_number": "NNCU1000180", 106 | "csc_approval": "F/BV/7345/00", 107 | "cubic_capacity_cbm": 33.0, 108 | "cubic_capacity_cuft": 1172, 109 | "customs_approval": null, 110 | "current_operator": null, 111 | "customs_approval_type": "KB20-DC-73R1", 112 | "detail_st": "20G1", 113 | "door_opening_height_mm": null, 114 | "door_opening_height_ft": null, 115 | "door_opening_width_mm": 2340, 116 | "door_opening_width_ft": 7.6721, 117 | "equipment_identifier": "U", 118 | "external_height_mm": 2600, 119 | "external_height_ft": 7.9987, 120 | "external_length_mm": 6060, 121 | "external_length_ft": 19.8753, 122 | "external_width_mm": 2440, 123 | "external_width_ft": 7.9987, 124 | "group_st": "20GP", 125 | "internal_height_mm": 2390, 126 | "internal_height_ft": 7.8361, 127 | "internal_length_mm": 5900, 128 | "internal_length_ft": 19.3443, 129 | "internal_width_mm": 2350, 130 | "internal_width_ft": 7.7049, 131 | "manufacture_date": "2000-10-01", 132 | "manufacture_number": "CR00-28940", 133 | "manufacturer": "Cronos Containers", 134 | "max_gross_mass_kg": 30480, 135 | "max_gross_mass_lbs": 67197, 136 | "max_payload_kg": 28130, 137 | "max_payload_lbs": 62016, 138 | "one_door_off_end_wall_strength_kg": 15000, 139 | "one_door_off_end_wall_strength_lbs": 35000, 140 | "one_door_off_racking_kg": 10000, 141 | "one_door_off_racking_lbs": 25000, 142 | "one_door_off_racking_n": 60000, 143 | "one_door_off_stacking_kg": 70000, 144 | "one_door_off_stacking_lbs": 140000, 145 | "prefix": "NNC", 146 | "racking_kg": 15240, 147 | "racking_lbs": 33528, 148 | "racking_n": null, 149 | "serial_number": "100018", 150 | "stacking_kg": 213000, 151 | "stacking_lbs": 430000, 152 | "tare_kg": 2280, 153 | "tare_lbs": 5016, 154 | "timber_treatment_approval": "IM/BASILEUM SI-84/00", 155 | "capacity_litres": null, 156 | "imdg_code": null, 157 | "adr_rid_code": null, 158 | "baffles": null, 159 | "smart_container": null, 160 | "smart_container_certification": null, 161 | "smart_container_activated": null 162 | } 163 | ] 164 | ``` 165 | -------------------------------------------------------------------------------- /docs/api/limits-and-quotas.md: -------------------------------------------------------------------------------- 1 | # Limits and Quotas 2 | 3 | This section describes the limits and quotas of the BIC Boxtech API. 4 | 5 | Boxtech: Global Container Database provides supply chain safety and efficiency through data visibility: a non-profit platform for container technical details. 6 | 7 | To enable us to provide the service as a non profit and service the volume of requests we have put limits and quotas on API requests. The limits and quotas are subject to change. 8 | 9 | ### Quota Limits 10 | 11 | The following apply to 'consumers' of the API, for a container fleet 'uploader' these do not apply. Each API query to Boxtech is for a single container only, and counts as a 'query', it is not possible to query for multiple units at a time. 12 | 13 | * 5,000 queries per month 14 | * 300 for containers marked with the same [BIC Code](https://www.bic-code.org/bic-codes/) per day 15 | * 30 queries per second 16 | 17 | {% hint style="info" %} 18 | If your usage is exceeding the above limits then please contact BIC to explain your use case for Boxtech in which case it will be evaluated and you may be granted a higher tiered usage plan. Acceptable requests for higher usage are generally reserved for container depot operators, terminals, carriers, and feeder operators. BIC fully support the use of Boxtech for larger users so please [contact BIC](https://www.bic-boxtech.org/contact/) for a higher usage plan. 19 | {% endhint %} 20 | 21 | ### Exceeding Quota Limits 22 | 23 | If the quota is exceeded, the API will return an error code `429 (Exceeded Quota)` or `423 (Suspended Account)` and a message that the account has exceeded the quota or been suspended, see the [terms and conditions](https://www.bic-code.org/api-terms-of-use/) for more information. 24 | -------------------------------------------------------------------------------- /docs/maintaining-your-fleet/automating-the-updates.md: -------------------------------------------------------------------------------- 1 | # Automating the Updates 2 | 3 | Now you have uploaded your container fleet to Boxtech you will need to think about keeping it updated, there are a few ways to do this and the key part is to establish a process that fits well with your system and internal process, Boxtech has a number of options: 4 | 5 | 1. **Upload** on a regular basis through the website [https://bic-boxtech.org](https://bic-boxtech.org) 6 | 2. Send the file to Boxtech using **SFTP** on a schedule 7 | 3. Integrate the **API** into your system and container process 8 | 9 | We would recommend that you consider automating your updates to Boxtech, this ensures your fleet is regularly updated in Boxtech and makes the uploading process more efficient. 10 | 11 | If you output reports to update Boxtech then **option 2** maybe a good way to automate the updates, using SFTP is like having a shared folder between your organisation and Boxtech, your system securely connects to the shared folder on Boxtech and uploads the same format report that you would use if logging into the website. This approach can be for as little as 1 container or up to a fleet file of millions of containers. This approach is recommended if you want to provide periodic updates and can produce outputs in CSV format from your system, it's straightforward for your IT team to implement. 12 | 13 | If your system is event driven and you want to add hooks into those events to update Boxtech on a container by container basis then the API is a good option, usually you would perform a fleet upload, and then send messages as changes take place in your system for each container, in simple language terms 14 | 15 | > When new container added to the fleet send a NEW CONTAINER message with technical details to Boxtech 16 | > 17 | > For each container sold in my system send a SOLD alert to Boxtech 18 | 19 | This approach will mean implementing the Boxtech API into event messages from your system, enabling it to send messages to Boxtech when a system 'event' happens. A great way to be fully integrated with Boxtech, it requires a little more in terms of IT resource and planning, your IT department will want to look at the [API Specification](https://app.swaggerhub.com/apis/BIC-ORG/Boxtech/2.0.2) and it's useful to setup a call with the BIC team to familiarise you with the API and give you test platform access. 20 | 21 | ### Requesting SFTP or API Access 22 | 23 | To request access and setup for SFTP or API please contact the BIC team by email at [info@bic-boxtech.org](mailto:BIC%20BoxTech%20%3Cinfo%40bic-boxtech.org%3E) noting your BIC Code and that you would like to upload by API or SFTP. 24 | 25 | -------------------------------------------------------------------------------- /docs/maintaining-your-fleet/boxtech-dataset.md: -------------------------------------------------------------------------------- 1 | # Boxtech Dataset 2 | 3 | Boxtech stores a number of data elements about a container, the details of which can be found below. 4 | 5 | ## BIC Code Holder and Current Operator 6 | 7 | There are two parties that are often required to be known for a container, and these are the definitions and how they are determined: 8 | 9 | ### BIC Code Holder 10 | 11 | The owner of the BIC Prefix that is marked on the container, this company hold an account with BIC and are the registered code holder. This could be for example a lessor, carrier or shipper with own containers. 12 | 13 | ### Current Operator 14 | 15 | If the container is marked with a BIC prefix belonging to a lessor, they may not be the current operator of the container, as it will likely be 'on hire' to another company. When an `uploader` provides their fleet to Boxtech, if they are not the BIC Code Holder they will become the current operator, when they off hire OR another company on hires and uploads their fleet they will be removed and the new operator added. 16 | 17 | ## Physical Characteristics 18 | 19 | The Physical Characteristics are the details that are marked on the container as per ISO6346 20 | 21 | `Group ST` is the ISO Container Group Type Code as detailed in ISO6346, where this is not provided by the uploader it is determined from the `Detail ST` 22 | 23 | `Detail ST` is the ISO Container Detail Type Code as detailed in ISO6346 24 | 25 | `Tare Weight` is the Tare Weight of the container, detailed in kgs and lbs. 26 | 27 | `Max Payload` is the maximum weight of the goods that can be loaded in the container, detailed in kgs and lbs. 28 | 29 | `Max Gross` is the maximum weight that the container including its own weight and the weight of the goods can safely contain. This weight should not be exceeded. Detailed in kgs and lbs. 30 | 31 | `Stacking` is the weight that .. 32 | 33 | `Racking` is the weight that ... 34 | 35 | `Cubic Capacity` is the volume that the container has capacity for internal storage. Detailed in m3 and cuft. 36 | 37 | ## Dimensions 38 | 39 | Note that were the dimensions are not provided on upload for the external measurements they are provided under ISO6346 for the container type, where available. Internal measurements are only provided by the uploader. 40 | 41 | `External Length` - The length of the container measured from the outside. Detailed in mm and ft. 42 | 43 | `External Width` - The width of the container measured from the outside. Detailed in mm and ft. 44 | 45 | `External Height` - The height of the container measured from the outside. Detailed in mm and ft. 46 | 47 | `Internal Length` - The length of the container measured from the inside. Detailed in mm and ft. 48 | 49 | `Internal Width` - The width of the container measured from the inside. Detailed in mm and ft. 50 | 51 | `Internal Height` - The height of the container measured from the inside. Detailed in mm and ft. 52 | 53 | `Door Opening Width` - 54 | 55 | `Door Opening Height` - 56 | 57 | ## One Door Off Operations 58 | 59 | `Stacking` - 60 | 61 | `Racking` - 62 | 63 | `End Wall Strength` - 64 | 65 | ## Manufacturer Data and Data Plates 66 | 67 | `Manufacturer` - Name of the Manufacturer of the container 68 | 69 | `Manufacturer #` - identification code of the manufacturer 70 | 71 | `Manufacturing Date` - Date the container was manufactured 72 | 73 | `CSC Approval` - 74 | 75 | `Customs Approval` 76 | 77 | `Customs Approval Type` 78 | 79 | `Timber Treatment Plate` - 80 | 81 | ## Conversions 82 | 83 | ### Weights \(kgs/lbs\) 84 | 85 | Where the weight of a container is provided in only 1 of the unit types, it will be calculated for the other using the following calculation. 86 | 87 | `LBS / 2.20462 = KGS` 88 | 89 | `KGS * 2.20462 = LBS` 90 | 91 | ### Volume \(m3, cuft\) 92 | 93 | Where the volume of a container is provided in only 1 of the unit types, it will be calculated for the other using the following calculation. 94 | 95 | `CBM * 35.3146667 = CUFT` 96 | 97 | `CUFT / 35.3146667 = CBM` 98 | 99 | -------------------------------------------------------------------------------- /docs/maintaining-your-fleet/getting-started.md: -------------------------------------------------------------------------------- 1 | # Getting Started 2 | 3 | Uploading your first container fleet file to Boxtech is a simple process, this guide outlines how to make the first steps using minimum information to become familiar with the process and then moving towards more detailed information and automating the upload from your system if you so choose. 4 | 5 | This guide assumes that you have already [registered for Boxtech](https://app.bic-boxtech.org/sign-up), and have been approved as an uploader by BIC. You can watch the video to follow the steps or read below the guide. 6 | 7 | 8 | 9 | {% embed url="https://www.youtube.com/watch?v=coITdDxNq0A" %} 10 | Upload your fleet video guide 11 | {% endembed %} 12 | 13 | ### Prepare the Upload File 14 | 15 | Lets start by preparing our first upload file with some key information that you should have available for your fleet. 16 | 17 | 1. [Download the template for Fleet In](../../templates/fleet-in-full.csv) 18 | 2. Understand the Data Fields 19 | 3. Upload to Boxtech 20 | 21 | Lets look at a basic dataset for our first upload for point 2 22 | 23 | | Field | Description | Example | 24 | | -------------------- | -------------------------------------------- | ----------- | 25 | | container\_number | The container number marked as per ISO 6346 | AAAU9999990 | 26 | | detail\_st | ISO Size Type meeting ISO6346 standard | 42G1 | 27 | | tare\_kg | Tare Weight of the Container in Kgs | 2200 | 28 | | max\_payload\_kg | Maximum Payload of the Container in Kgs | 30480 | 29 | | max\_gross\_mass\_kg | Maximum Gross weight of the Container in Kgs | 32680 | 30 | 31 | We will use the above data to make our first upload, but please use a container and data relative you one of your own containers. Add this data to the fleet in template you downloaded in step 1, removing the example record provided. 32 | 33 | {% hint style="warning" %} 34 | Important, make sure you save your file as a CSV if you are working in Excel or other application, Boxtech only accepts the csv format, but not .xslx or .xls 35 | {% endhint %} 36 | 37 | Now were ready to upload for point 3. 38 | 39 | * [Login to Boxtech](https://app.bic-boxtech.org) 40 | * Under 'Fleet In' click '**Upload Fleet**' 41 | * Either drag your csv file onto the screen OR click '**Select File**' and locate your csv file to upload from your computer. 42 | * Click '**Upload Fleet In**' 43 | 44 | Following your upload you can expect to recieve an email to confirm your upload and its status, similar to the screen shot below, if there are any errors in the file then you can download the file to view the errors from the email 45 | 46 |
47 | 48 | **Congratulations!** you have made your first upload to Boxtech, an important first step. If you search for the container in Boxtech you will see the details you just uploaded as below 49 | 50 |
51 | 52 | If you receive any failed containers in the email we suggest watching the 'handling exceptions effectivly' video 53 | 54 | 55 | 56 | {% embed url="https://www.youtube.com/watch?v=RySwBo7Qh8M" %} 57 | 58 | Now you are familiar with the process you should take an action to upload your entire container fleet to Boxtech using the above process. 59 | 60 | You can also look to expand your dataset with information that you have available from your process 61 | 62 | Next you should think about [automating your updates](automating-the-updates.md) 63 | 64 | -------------------------------------------------------------------------------- /docs/user-guide/change-password.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: >- 3 | This page details the changing of your password during the migration of 4 | Boxtech to a new service. 5 | --- 6 | 7 | # Change Password 8 | 9 | When your account is migrated to Boxtech you will be requested by email to change your password to continue using the application, this step will apply for web users and API users during the migration only. 10 | 11 | ## Step 1 - Email Notification of Required Password Change 12 | 13 | ![](../.gitbook/assets/screenshot-2021-07-27-at-12.11.07.png) 14 | 15 | ## Step 2 - Login using temporary credentials 16 | 17 | ![](../.gitbook/assets/screenshot-2021-07-27-at-11.57.40.png) 18 | 19 | 20 | 21 | ## Step 3 - Set new password 22 | 23 | Set your new password, this will be subject to some restrictions for security 24 | 25 | ![](../.gitbook/assets/screenshot-2021-07-27-at-11.56.47.png) 26 | 27 | ## Complete Setup 28 | 29 | If you have an API integration you will need to update your application to use your new credentials. 30 | 31 | You will now be able to use Boxtech to search for containers, upload your fleet, on or off hire containers via the web and API 32 | 33 | -------------------------------------------------------------------------------- /docs/user-guide/container-alerts.md: -------------------------------------------------------------------------------- 1 | # Container Alerts 2 | 3 | ## Alert Types 4 | 5 | Boxtech contains a series of alerts grouped as: 6 | 7 | * Sold 8 | * Scrapped 9 | * Lost 10 | * Stolen 11 | 12 | If an alert is active for a container it will be shown on the search results and in the API response for that container. 13 | 14 | In all cases Boxtech will continue to show the container details for the container, but in all cases the alert type and text will be provided when active. 15 | 16 | ### Sold 17 | 18 | The container has been sold by the BIC Code Holder and is no longer part of their owned fleet, containers that have been sold should be remarked by the new owner if they are to continue circulation for International movements. 19 | 20 | Boxtech will continue to show the container details for the container, but in all cases the alert type and text will be provided. 21 | 22 | {% hint style="info" %} 23 | It is possible to make a declaration of sale for containers where you are not the BIC Code Holder for the container. The process is the same as Sold, the container will be shown with an alert to indicate you have made a '**public record of sale**', this date of this alert will also be timestamped by Boxtech and viewable by anyone searching for the container. 24 | {% endhint %} 25 | 26 | ### Scrapped 27 | 28 | The container has been scrapped by the BIC Code Holder and is no longer part of their owned fleet, containers that have been scrapped would not normally continue circulation for International movements, the intention is that the container has been or is being disposed of. 29 | 30 | Boxtech will continue to show the container details for the container, but in all cases the alert type and text will be provided. 31 | 32 | ### Lost 33 | 34 | The container is flagged as lost by the BIC Code Holder, meaning that whilst it is still in their fleet the whereabouts of the container are currently unknown and have been for a period of time, their internal criteria for identifying containers as lost is met, anyone finding this container should contact the BIC Code Holder. 35 | 36 | ### Stolen 37 | 38 | The container is flagged as stolen by the BIC Code Holder, meaning that whilst it is still in their fleet the whereabouts of the container are currently unknown, the theft of the container has been reported to authorities and a police report filed. Anyone finding this container should contact the BIC Code Holder. 39 | 40 | ## Activating or Deactivating Alerts in Boxtech 41 | 42 | To activate or deactivate alerts you must have `uploader` rights in Boxtech. 43 | 44 | Once logged in you have 2 options: 45 | 46 | * Sold/Scrapped 47 | * Lost/Stolen 48 | 49 | Select the category of alert, and follow the onscreen instructions if uploading your alert template in csv format. You will specify in the upload if you wish to activate or deactivate the alert. 50 | 51 | You can also integrate Boxtech into your application and activate or deactivate your alerts using the API endpoints documented in the [Open API Specification](../api/api-documentation.md) 52 | 53 | ![Uploader Screen](../.gitbook/assets/uploader.png) 54 | -------------------------------------------------------------------------------- /docs/user-guide/managing-your-fleet.md: -------------------------------------------------------------------------------- 1 | # Managing your Fleet 2 | 3 | ## Steps 4 | 5 | 1. Request `Uploader Access` for your BIC Code 6 | 2. Await Verification by BIC 7 | 3. Start Managing your Fleet 8 | 9 | ## Uploader Access Request 10 | 11 | You can request access as an uploader on the registration form when first registering for access to Boxtech, it is also possible to request access once logged in if it is required at a later time. 12 | 13 | You will just need to provide a BIC Code Prefix which will be used to verify your relationship to the BIC Code Holder's account in Boxtech, this is checked with the contact that registered the BIC Code from your organisation, they will receive an email from the BIC which they can confirm your request by clicking the button within the email. 14 | 15 | ## Action Types 16 | 17 | Boxtech contains a 2 types of action when it comes to managing your container fleet: 18 | 19 | * Fleet In / On Hire 20 | * Fleet Out / Off Hire 21 | 22 | You may have containers within your fleet that you own or lease, you can manage them through these actions. 23 | 24 | ### Fleet In / On Hire 25 | 26 | The containers being uploaded are currently in your active fleet of containers, meaning you either own the containers or they are 'on hire' to you from a lessor. 27 | 28 | If you own the BIC Code Prefix you will be noted as the **BIC Code Holder** for these containers, as well as the **Current Operator**. You will also be able to update the container details as the official owner. 29 | 30 | If you are leasing these containers and do not own the BIC prefix you will be identified as the **Current Operator** only, the **BIC Code Holder** will be automatically identified. In this case the technicala details of the container cannot be updated, only the BIC Code Holder has the rights to update their fleet detail. 31 | 32 | ### Fleet Out / Off Hire 33 | 34 | The containers being uploaded are to be removed from your active fleet of containers. You can perform this action when the container is either owned by you and you are identified as the **BIC Code Holder** OR you are the **Current Operator** of the container. 35 | 36 | If the container is on hire to you, performing this action will remove you from the Current Operator field, meaning the container is no longer operated within your fleet. 37 | 38 | If you also own the BIC Code Prefix you will be noted as the **BIC Code Holder** for these containers, in this case the off hire process is used to manage the **lease back container** use case in which the containers are owned by a leasing company but marked with your BIC Code Prefix. In this case you would be removed as the current operator of the container (as it is no longer in operation of your fleet) and an alert would be raised against the container showing that the container was a leaseback and is no longer under your fleet and thre container number is no longer valid. 39 | 40 | ## Use Cases 41 | 42 | Some typical examples of use cases and when to interact with the Fleet In / Out funcationality. 43 | 44 | ### New Containers added to Fleet 45 | 46 | In this case you would simply add the containers to the template and upload using the **fleet in** feature. This will add the containers to your fleet in Boxtech and identify you as the BIC Code Holder and/or the Current Operator. This file can include owned containers and leased containers in the same file. 47 | 48 | ### Update Container details 49 | 50 | In this case you would fill in all container details known to you (more complete the better) and upload using the **fleet in** feature. If the container exists and you are the BIC Code Holder the container details will be updated according to your request. 51 | 52 | If the containers are new to Boxtech they will be added using the details provided. 53 | 54 | ### 'On Hire' Containers to my fleet 55 | 56 | In this case you would simply add the containers to the template and upload using the **fleet in** feature. This will add the containers to your fleet in Boxtech and identify you as the Current Operator. 57 | 58 | ### 'Off Hire' Containers from my fleet 59 | 60 | In this case you would simply add the containers to the template and upload using the **off hire** feature. This will remove you from the Current Operator field in Boxtech. 61 | 62 | ### 'Off Hire' Leaseback containers 63 | 64 | In this case use the **off hire** feature, this covers when the container is marked with your BIC Code but is returned to the lessor as although marked against your BIC Code it was on lease. An alert will be raised to show this in Boxtech. 65 | 66 | ### Remove Containers from Fleet 67 | 68 | You should use the sold or scrapped feature for this purpose, as you would know why and where the containers are leaving the fleet. You can use the Fleet Out / Off Hire process if you are identifying containers in the same file that are being off hired or marked as sold or scrapped. 69 | 70 | If you do not know where the containers are you can mark them as[ lost or stolen](container-alerts.md#lost) using an alert. 71 | 72 | For leased containers use the off hire process 73 | -------------------------------------------------------------------------------- /docs/user-guide/search-boxtech.md: -------------------------------------------------------------------------------- 1 | # Search Boxtech 2 | 3 | Once you are logged into Boxtech as a `consumer` you willl have the facility to search for containers from the Boxtech database. 4 | 5 | You can only search for valid and complete container numbers in Boxtech, to do this enter your container number in the search box at the top of the Boxtech screen. 6 | 7 | ![Search Screen in Boxtech](../.gitbook/assets/search.png) 8 | 9 | ## Search Results 10 | 11 | Boxtech returns the data about a single container in its results, from here you can view the 12 | 13 | * Physical Characteristics 14 | * Owner and Operator Details 15 | * Dimensions of the Container 16 | * One Door Off Operations 17 | * Manufacturer Data and Data Plates 18 | 19 | Details of the data fields shown in Boxtech are defined in[ Boxtech Dataset](../maintaining-your-fleet/boxtech-dataset.md) 20 | 21 | ![Boxtech Search Results](../.gitbook/assets/results.png) 22 | -------------------------------------------------------------------------------- /docs/user-guide/smart-containers.md: -------------------------------------------------------------------------------- 1 | # Smart Containers 2 | 3 | Boxtech now supports the ability to upload Smart Container attributes to the container record, this can be done in 1 of 2 ways 4 | 5 | 1. [Upload using **fleet in** template file or API POST](smart-containers.md#upload-using-fleet-in-file) 6 | 2. [Upload only Smart Container Attributes to Boxtech](smart-containers.md#upload-smart-container-details-only) 7 | 8 | The purpose of the smart container details to is assist with the safety aspects of containers and planning at terminals. 9 | 10 | ### Smart Container Attributes 11 | 12 | Smart Containers have the following Attributes which can be added 13 | 14 | | Boxtech Field | Allowable Values | Description | 15 | | ------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 16 | | container\_number | BICU1234567 | Container number of which to apply the smart container data fields | 17 | | smart\_container | `YES` or `NO` | Indicate if the container is equiped with a smart device | 18 | | smart\_container\_certification | `UNKNOWN`, `A1`, `A2` | Which certification is applied to the smart container device, for meanings [see here ](https://github.com/bic-org/referencedata/blob/main/smartcontainercertifications.csv) | 19 | | smart\_container\_activated | `YES` or `NO` | Indicate if the device is active or deactivated | 20 | 21 | 22 | 23 | If you are uploading only the smart container attributes you can use the specific template [available here](https://raw.githubusercontent.com/bic-org/Boxtech/master/templates/bic\_tcd\_smart\_container\_template.csv) this can be used by either the BIC Code Holder or an IOT provider, the option of uplaod via an API POST is also available. 24 | 25 | ### Uploading via the Web Interface 26 | 27 | #### Upload using 'Fleet in' File 28 | 29 | Follow the normal process for uploading your containers via the 'Fleet In' tile 30 | 31 |

Boxtech Fleet In Tile

32 | 33 | Ensure you are using the latest [Fleet In Upload Template](https://raw.githubusercontent.com/bic-org/Boxtech/master/templates/fleet-in-full.csv) which includes the smart container attributes detailed above. 34 | 35 | #### Upload Smart Container Details Only 36 | 37 | Once logged in to Boxtech you will see a new tile showing 'Smart Containers\`as below 38 | 39 |

Smart Containers Upload Tile

40 | 41 | Selecting this option will allow you to upload smart container attributes to your containers without uploading all technical details for the container, useful if you output this data separately or want to maintain the smart container attributes independantly. 42 | 43 | Use the [smart container only template](https://raw.githubusercontent.com/bic-org/Boxtech/master/templates/bic\_tcd\_smart\_container\_template.csv) for the attributes and upload the file, you will receive an email on completion. 44 | 45 | #### Viewing the Smart Container Attributes 46 | 47 | Once you search for a container you will see for containers with smart container attributes the details as shown below 48 | 49 |

Example of Smart Container Attributes in Boxtech

50 | 51 | ### Uploading via the API 52 | 53 | For uploading using the API please see the Open API specification and documentation 54 | -------------------------------------------------------------------------------- /docs/user-guide/upload-history.md: -------------------------------------------------------------------------------- 1 | # Upload History 2 | 3 | ## Navigation 4 | 5 | You can navigate to this page by clicking the menu button in the top right hand corner of the page\ 6 | and clicking 'Upload History'. 7 | 8 |

How to navigate to the upload history page

9 | 10 | ## Uploads 11 | 12 | All uploads to BoxTech for your container fleet can be viewed on the upload history page. This is a shared upload page for all users belonging to the same company account. 13 | 14 |

View of the upload page

15 | 16 | ## Upload Outcomes 17 | 18 | The following results can occur from upload actions: 19 | 20 | * Success ( Green Tick ) 21 | * Pending ( Grey Clock ) 22 | * Failed ( Red Cross ) 23 | 24 | An action is considered a 'success' if at least one row in the CSV is successfully accepted. If you see row errors in the screen then some of the containers did not process as expected, you will have been notified by email of these also, and can view the failed file showing just those rows with errors to resolve. 25 | 26 | An action is 'pending' if the process is still running. 27 | 28 | An action is 'failed' if no rows could be accepted or if the formatting of the file was incorrect or corrupted. 29 | 30 | ## Downloads 31 | 32 | If there are any row errors you can use the grey '**failed**' button in the '**download'** column to download the failed file. 33 | 34 | This failed file will also be emailed to you however the email download link will expire, but this page will always give access to the file. 35 | 36 | You can also access the original file which was uploaded by clicking the green '**original**' button. 37 | -------------------------------------------------------------------------------- /templates/alert.csv: -------------------------------------------------------------------------------- 1 | container_number,text 2 | AAAU1234560,Enter additional information here (optional) 3 | -------------------------------------------------------------------------------- /templates/bic_tcd_smart_container_template.csv: -------------------------------------------------------------------------------- 1 | container_number,smart_container,smart_container_certification,smart_container_activated 2 | ABCDU1234567,YES,UNKNOWN,YES 3 | -------------------------------------------------------------------------------- /templates/fleet-in-full.csv: -------------------------------------------------------------------------------- 1 | container_number,tare_kg,tare_lbs,detail_st,max_payload_kg,max_payload_lbs,max_gross_mass_kg,max_gross_mass_lbs,cubic_capacity_cbm,cubic_capacity_cuft,stacking_kg,stacking_lbs,racking_kg,racking_lbs,racking_n,external_length_mm,external_width_mm,external_height_mm,internal_length_mm,internal_width_mm,internal_height_mm,door_opening_width_mm,door_opening_height_mm,manufacture_number,manufacture_date,manufacturer,customs_approval,customs_approval_type,csc_approval,timber_treatment_approval,one_door_off_stacking_kg,one_door_off_stacking_lbs,one_door_off_racking_kg,one_door_off_racking_lbs,one_door_off_racking_n,one_door_off_end_wall_strength_kg,one_door_off_end_wall_strength_lbs,smart_container,smart_container_certification,smart_container_activated,capacity_litres,imdg_code,adr_rid_code,baffles 2 | AAAU9999990,2200,4850,42G1,30480,74000,31200,69500,35,68,213000,430000,20000,40000,150,12129,2500,2591,12057,2444,2387,2400,2280,AB1234567,2016-12-31,ZZZZ01,YZ/X 1234 AB/2016,HC40:00A,A/BC0000/01,IM MEGANUM 10002000,70000,140000,10000,25000,60000,15000,35000,YES,UNKNOWN,YES,31000,T22,LGAV,YES 3 | AAAU9999990,2200,,42G1,30480,,31200,,35,,213000,,20000,,150,12129,2500,2591,12057,2444,2387,2400,2280,AB1234567,2016-12-31,ZZZZ01,YZ/X 1234 AB/2016,HC40:00A,A/BC0000/01,IM MEGANUM 10002000,70000,,10000,,60000,15000,,,,,,,, 4 | -------------------------------------------------------------------------------- /templates/fleet-in-short.csv: -------------------------------------------------------------------------------- 1 | container_number,detail_st,tare_kg,max_payload_kg,max_gross_mass_kg,cubic_capacity_cbm,stacking_kg,racking_kg,racking_n,internal_length_mm,internal_width_mm,internal_height_mm,door_opening_width_mm,door_opening_height_mm,smart_container,smart_container_certification,smart_container_activated,capacity_litres,imdg_code,adr_rid_code,baffles 2 | ABCU1234567,45G1,4880,31120,36000,35,213000,430000,150,12057,2444,2387,2400,2280,YES,UNKNOWN,YES,31000,T22,LGAV,YES 3 | -------------------------------------------------------------------------------- /templates/fleet-out.csv: -------------------------------------------------------------------------------- 1 | container_number 2 | AAAU9999990 3 | --------------------------------------------------------------------------------