Get Product Details

productDetails returns key configuration parameters of the Bolt device's associated product.
Useful for developers to fetch product metadata such as product name, data rate, and mapped pin variables.

Endpoint

GET https://cloud.boltiot.com/remote/{API_KEY}/productDetails?deviceID={DEVICE_ID}

Replace {API_KEY} with your Bolt Cloud API key and {DEVICE_ID} with the unique ID of your Bolt device.

IMPORTANT : BOLT prefix is compulsory to be added

Response Format

The response is a JSON object with the following fields:

Field	Type	Description
success	number	`1` on success, `0` on failure
value	object	Product configuration associated with the device

The value object contains:

Field	Type	Description
product_name	string	Name of the product configured for the device
data_rate	string	Data push interval (in seconds) configured for the device
pin_variables	object	Mapping of pins (0–A0, CSV0–CSV9) to variable names
device_id	string	Device ID queried

Example:

Request

https://cloud.boltiot.com/remote/857290ef-b762-43e2-bda2-e09ff4983653/productDetails?deviceID=BOLT16625007

Response

{
  "value": {
    "pin_variables": {
      "3": null,
      "4": null,
      "CSV1": "temp_fah",
      "CSV5": null,
      "CSV2": "thstatus",
      "0": null,
      "1": null,
      "CSV8": null,
      "CSV0": "temp_cel",
      "CSV3": "status",
      "CSV6": null,
      "CSV9": null,
      "A0": null,
      "CSV4": null,
      "CSV7": null,
      "2": null
    },
    "data_rate": "300",
    "product_name": "Blake_Temp_Only",
    "device_id": "BOLT16625007"
  },
  "success": 1
}

Notes for Developers and Agents

Use this API to understand how a customer’s product is configured.
Helpful for:
- Debugging incorrect readings
- Verifying CSV variable mapping during support conversations
- Customizing UI based on available product fields
- Showing product configuration in dashboards or admin tools
The pin_variables object includes all pins, even those not in use (represented by null).

Error Handling

If the API key is invalid or the request fails, success will be 0.

Example:

{
  "success": 0
}

It is recommended to check for success === 1 before accessing the value.