How to use the Logistics API

Overview

important

The Logistics API section is reserved for partners who have a contract with Withings. You will not be able to access it without specific privileges. Please refer to the Usage authorisation section in order to request access.

The Logistics API provides a set of functions to facilitate the use cases described in the table below.

FeatureDetails
Dropship non-cellular devices to end users
  1. The createorder API can be used to ship non-cellular devices directly to programme members (see below for cellular devices option)
  2. The createorder API does not include device setup or account creation. When using createorder API, setup must be performed by the end user through the Withings SDK or Withings app
Get Started
Activate cellular devices before or after shipment
  1. Calling the Activate API is required for providers that choose to ship devices to their members using their own logistics
  2. The Activate API will activate cellular connectivity and return the necessary tokens to retrieve data from the devices.
This API is reserved for partners using the Withings Cellular Data Hub or Withings Cellular devices.
Get Started
Dropship and Activate cellular devices
  1. Withings also provides the option to dropship and activate cellular devices or cellular kits to your programme member in one API call (createuserorder).
  2. This API is necessary for providers using Withings logistics to ship setup-less cellular devices to their programme member
This API is reserved for partners using the Withings Cellular Data Hub or Withings Cellular devices.
Get Started

Implementation guidelines

How to implement the activation of pre-configured Cellular Pro devices

Using the Withings Public API, it is possible to activate Cellular devices directly for your end-users and fetch the data. In this use case, you are in charge of the logistics and the shipments of the kit to your end-users. Once the devices are assigned to a specific end-user, you need to activate the kit to pre-configure the devices so the unboxing is seamless for the end-user.

Here is the list of the endpoint you'll need:

The following flow provides a correct implementation of the endpoints for this use case
Toggle me!
device_settings
What if your are using the Withings HUB
You may use the Withings HUB to connect other Withings devices to the Internet. The API implementation works the same for this use case. The only difference is that the Withings devices will connect to the Withings HUB first (via Wi-Fi or Bluetooth) to get access to the Internet.

How to implement the dropshipment of pre-configured Cellular Pro devices dropshipment

Using the Withings Public API, it is possible to dropship Cellular devices directly to your end-users and fetch the data. In this use case, Withings is in charge of the logistics and the shipments of the kit to your end-users. The shipped devices will be automatically pre-configured so the unboxing is seamless for the end-user.

Here is the list of the endpoint you'll need:

The following flow provides a correct implementation of the endpoints for this use case
Toggle me!
device_settings
What if your are using the Withings HUB
You may use the Withings HUB to connect other Withings devices to the Internet. The API implementation works the same for this use case. The only difference is that the Withings devices will connect to the Withings HUB first (via Wi-Fi or Bluetooth) to get access to the Internet.
Help

Login required

Please login in order to file a request. If you did not create a developer account yet, you can create one by clicking the Signup button.

OK