Setting and Updating Geotab Serials on Digital Matter devices via the Device Manager API
Table of Contents
Setting and Updating Geotab Serials via the Device Manager API
The SetGeotabSerial Device Manager API endpoint lets you assign or update the Geotab serial for a device programmatically. This article explains what the endpoint does, how to call it, and how to interpret its responses.
Before you begin
Make sure the following are in place:
- You have Device Manager API credentials. See Creating API Credentials (Device Manager).
- Your API user has the Geotab User permission enabled. Without it, calls to this endpoint are rejected.
- You have a valid Geotab serial to assign. For background on obtaining serials, see Using third-party telematics devices with MyGeotab.
- You know the device's Digital Matter Serial Number and its product identifier. See Device Product IDs
For the wider integration picture, see the DM to MyGeotab Integration Overview.
Endpoint
The endpoint uses a POST request:
POST /v1/trackingdevice/SetGeotabSerialBase URLs:
- Global:
https://api.oemserver.com - EU (GDPR):
https://api-eu.oemserver.com
Ensure that you are using the correct URL for your account. If you access the Device Manager UI using the devicemanager-eu.digitalmatter.com URL, use the EU API URL. If not, use the Global API URL.
Full endpoint reference is available in the Swagger documentation.
Query parameters
| Parameter | Type | Description |
|---|---|---|
product |
Integer | The Product ID for the device. For example, 114 is Manta-Fusion. |
id |
Integer | The Digital Matter device Serial Number. |
Request body
The body is a JSON object containing the Geotab serial to assign:
{
"GeotabSerial": "C12345678910"
}Worked example
The following request assigns the Geotab serial C12345678910 to a Manta-Fusion device (product 114) with Serial Number 1237496. This example uses the global instance; substitute the EU base URL if the device is hosted there:
POST https://api.oemserver.com/v1/trackingdevice/SetGeotabSerial?product=114&id=1237496
{
"GeotabSerial": "C12345678910"
}On the EU (GDPR) instance the same request is:
POST https://api-eu.oemserver.com/v1/trackingdevice/SetGeotabSerial?product=114&id=1237496
{
"GeotabSerial": "C12345678910"
}
Confirming the result
After a successful call, the Device Grid in Device Manager shows the populated Geotab fields. Here's a screenshot of the Device Grid featuring the Manta Fusion from the worked example:

Note: The following API calls can be used to confirm the Geotab Serial set on a device:
GET /v1/trackingdevice/GetGeotabSerialPOST /v1/trackingdevice/GetGeotabSerialPost Response Codes for the SET Geotab Serial Call
| Status | Meaning |
|---|---|
| 200 OK | The serial was assigned. The response body is "Successful". |
| 400 Bad Request | The request was malformed, for example a missing or invalid GeotabSerial. |
| 401 Unauthorized / 403 Forbidden | The credentials are invalid or the API user lacks the Geotab User permission. |
| 404 Not Found | The device could not be found for the supplied product and id. |
| 409 Conflict | The Geotab serial is already assigned to another device on the Digital Matter side. |
Example: 409 Conflict Response
Attempting to assign a serial that is already in use, returns a 409 Conflict. Resolve the conflict by confirming the correct target device, or by removing the serial from the device that currently holds it, before retrying.
