Inventory assets can be uploaded to Sopht through a JSON API described in the following Swagger documentation : https://backbone.sopht.com/swagger-ui/index.html#/inventory-asset-controller/uploadInventoryAssets
<aside> 💡
Both the JSON API and the CSV expect your full inventory at each import. If an asset is not present in a subsequent import, we will consider it retired. If your inventory is too large for one call, you can use pagination.
</aside>
The API is available at the following URL :
https://backbone.sopht.com/assets/upload/list
The assets you want to upload should be given in the body as a JSON. The fields of the JSON are described in the table below.
To estimate the carbon impact of an asset, Sopht needs to know its inventory status change. There are two ways
If you want to use the sub statuses, please refer to this page:
CSV for inventory substatus configuration
The parameters are described in the Swagger documentation.
⚠️ Please note that, unlike the Sopht backbone API key for instance, those are query parameters and not HTTP headers, they should appear in the URL, for instance : https://backbone.sopht.com/assets/upload/list?dry_run=true
To test the API and validate your assets without uploading the assets in our system, you can use the “Dry Run” mode, by setting the dry_run parameter to true.
If your inventory is too large for one call, you can provide it in multiple pages. To do so, call the API with each page as body, incrementing the parameter page_number at each call, starting with 0. When uploading the last page, set the is_last_page parameter to true .
As long as the last page has not been sent, sending the same page (a page with the same page number) multiple times will cause the page to be overridden : only the last upload of this page will be kept.