Retrieve a job

GET

jobs

show

Retrieve a job

curl --request GET \
  --url https://app.detrack.com/api/v2/dn/jobs/show \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://app.detrack.com/api/v2/dn/jobs/show', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.detrack.com/api/v2/dn/jobs/show",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.detrack.com/api/v2/dn/jobs/show"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.detrack.com/api/v2/dn/jobs/show")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "5b22055510c92b1a046ece04",
    "type": "Delivery",
    "do_number": "DO-10001",
    "date": "2026-09-15",
    "status": "dispatched",
    "primary_job_status": "dispatched",
    "tracking_status": "Info received",
    "attempt": 1,
    "detrack_number": "DET2000001",
    "tracking_number": "T0",
    "order_number": "ORN12345678",
    "address": "Singapore 470140",
    "postal_code": "470140",
    "deliver_to_collect_from": "James Li",
    "phone_number": "65432178",
    "notify_email": "test@example.com",
    "items_count": 2,
    "created_at": "2026-09-15T06:04:06.017Z",
    "items": [
      {
        "id": "5b22055510c92b1a046ece05",
        "sku": "12345678",
        "description": "iPad",
        "quantity": 10,
        "checked": false
      }
    ],
    "milestones": [
      {
        "status": "info_recv",
        "assign_to": null,
        "reason": null,
        "pod_at": "2026-09-15T06:04:06.017Z",
        "created_at": "2026-09-15T06:04:06.017Z",
        "user_name": "Simon"
      }
    ]
  }
}

{
  "code": "invalid_key",
  "message": "Invalid key"
}

{
  "code": "forbidden"
}

{
  "code": "not_found",
  "message": "Could not find job with this DO number"
}

{
  "code": "invalid_date",
  "message": "Invalid date"
}

Use the Retrieve Job endpoint to fetch a single job and its full details, including the items and milestones arrays. You must provide the job do_number. You can optionally narrow the result with date and type. For what status, primary_job_status, and tracking_status mean, see Status fields.

Authorizations

X-API-KEY

string

header

required

Your Detrack API key, from Integrations > API Key in the dashboard.

Query Parameters

do_number

string

required

DO number of the job.

Example:

"DO-10001"

date

string<date>

Job date (YYYY-MM-DD). If several jobs share the DO number and you leave this out, the one with the latest date is used.

Example:

"2026-09-15"

type

enum<string>

Job type.

Available options:

Delivery,

Collection

Response

The job.

data

object

A delivery or collection job. Only the most-used fields are listed; the API returns more.

Show child attributes

Retrieve a job

curl --request GET \
  --url https://app.detrack.com/api/v2/dn/jobs/show \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://app.detrack.com/api/v2/dn/jobs/show', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.detrack.com/api/v2/dn/jobs/show",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.detrack.com/api/v2/dn/jobs/show"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.detrack.com/api/v2/dn/jobs/show")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "5b22055510c92b1a046ece04",
    "type": "Delivery",
    "do_number": "DO-10001",
    "date": "2026-09-15",
    "status": "dispatched",
    "primary_job_status": "dispatched",
    "tracking_status": "Info received",
    "attempt": 1,
    "detrack_number": "DET2000001",
    "tracking_number": "T0",
    "order_number": "ORN12345678",
    "address": "Singapore 470140",
    "postal_code": "470140",
    "deliver_to_collect_from": "James Li",
    "phone_number": "65432178",
    "notify_email": "test@example.com",
    "items_count": 2,
    "created_at": "2026-09-15T06:04:06.017Z",
    "items": [
      {
        "id": "5b22055510c92b1a046ece05",
        "sku": "12345678",
        "description": "iPad",
        "quantity": 10,
        "checked": false
      }
    ],
    "milestones": [
      {
        "status": "info_recv",
        "assign_to": null,
        "reason": null,
        "pod_at": "2026-09-15T06:04:06.017Z",
        "created_at": "2026-09-15T06:04:06.017Z",
        "user_name": "Simon"
      }
    ]
  }
}

{
  "code": "invalid_key",
  "message": "Invalid key"
}

{
  "code": "forbidden"
}

{
  "code": "not_found",
  "message": "Could not find job with this DO number"
}

{
  "code": "invalid_date",
  "message": "Invalid date"
}

Jobs

Depots

Routes

Authorizations

Query Parameters

Response