API Data Provider - Online Help

Connecting to DeTrack

DeTrack uses API Key authentication. Your DeTrack API key is used to authenticate all requests via the X-API-Key header. You can obtain your API key from your DeTrack account settings at app.detrack.com under Settings > API & Webhooks.

Using APIKey Authentication

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your DeTrack API key.

Example connection string:

Profile=C:\profiles\DeTrack.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Available Tables

The DeTrack API Profile provides access to delivery and logistics data across 4 tables:

  • Jobs - Query delivery and collection jobs tracked in DeTrack. Filter by DoNumber to retrieve a single job, or use date, type, status, and assign_to filters for the list.
  • Depots - Retrieve depot locations configured in DeTrack. Filter by Name to retrieve a specific depot.
  • Routes - Query optimized delivery routes. The Date filter is required for all route queries.
  • ExportJobs - Retrieve the status and download URL for an asynchronous job data export. The Id filter is required.

Usage Examples

Depots:

SELECT * FROM Depots

ExportJobs:

SELECT * FROM ExportJobs WHERE Id = 'export-id-123'

Jobs:

SELECT * FROM Jobs

Routes:

SELECT * FROM Routes WHERE Date = '2026-05-20'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey The API key used to authenticate requests to the DeTrack API.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0