> ## Documentation Index
> Fetch the complete documentation index at: https://detrack.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a job

> GET /dn/jobs/show/?do_number={} retrieves a single job by its DO number, with optional date and type filters.

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](/concepts/jobs#status-fields).


## OpenAPI

````yaml GET /dn/jobs/show
openapi: 3.0.3
info:
  title: Detrack REST API v2
  version: '2.0'
  description: >-
    Detrack REST API v2. Checked against detrack-webapp origin/main (production)
    on 2026-09-29: dn_jobs.rb @ d246ad006, dn_depots.rb @ 2a5f387, dn_routes.rb
    @ 50a73a9, app_helper.rb @ d745ad2, dn_jobs_helper.rb @ d296e30,
    job_decorator.rb @ 3041da7, run_location_decorator.rb @ 0f0274d,
    vehicle_route_plan_decorator.rb and tsp_route_decorator.rb @ 7d1f3ef,
    data_export.rb @ ed4e135.
servers:
  - url: https://app.detrack.com/api/v2
security:
  - apiKey: []
tags:
  - name: Jobs
    description: Deliveries and collections.
  - name: Depots
    description: Saved warehouse and pickup locations.
  - name: Routes
    description: Optimized multi-stop plans across vehicles.
paths:
  /dn/jobs/show:
    get:
      tags:
        - Jobs
      summary: Retrieve a job
      description: Returns one job, including its `items` and `milestones`.
      operationId: retrieveJob
      parameters:
        - $ref: '#/components/parameters/DoNumberQuery'
        - $ref: '#/components/parameters/DateQuery'
        - $ref: '#/components/parameters/TypeQuery'
      responses:
        '200':
          description: The job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Job'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/JobNotFound'
        '422':
          $ref: '#/components/responses/InvalidDate'
        default:
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    DoNumberQuery:
      name: do_number
      in: query
      required: true
      schema:
        type: string
        example: DO-10001
      description: DO number of the job.
    DateQuery:
      name: date
      in: query
      schema:
        type: string
        format: date
        example: '2026-09-15'
      description: >-
        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.
    TypeQuery:
      name: type
      in: query
      schema:
        type: string
        enum:
          - Delivery
          - Collection
      description: Job type.
  schemas:
    Job:
      type: object
      description: >-
        A delivery or collection job. Only the most-used fields are listed; the
        API returns more.
      properties:
        id:
          type: string
          example: 5b22055510c92b1a046ece04
        type:
          type: string
          enum:
            - Delivery
            - Collection
          example: Delivery
        do_number:
          type: string
          example: DO-10001
        date:
          type: string
          format: date
          example: '2026-09-15'
        status:
          type: string
          description: >-
            Lifecycle status. Use this in integration logic. See [Status
            fields](/concepts/jobs#status-fields).
          example: dispatched
        primary_job_status:
          type: string
          description: Same value as `status`.
          example: dispatched
        tracking_status:
          type: string
          description: >-
            Customer-facing label, which can be customised per account. Don't
            use it in integration logic.
          example: Info received
        attempt:
          type: integer
          example: 1
        detrack_number:
          type: string
          example: DET2000001
        tracking_number:
          type: string
          nullable: true
          example: T0
        order_number:
          type: string
          nullable: true
          example: ORN12345678
        address:
          type: string
          example: Singapore 470140
        postal_code:
          type: string
          nullable: true
          example: '470140'
        deliver_to_collect_from:
          type: string
          nullable: true
          example: James Li
        phone_number:
          type: string
          nullable: true
          example: '65432178'
        notify_email:
          type: string
          nullable: true
          example: test@example.com
        items_count:
          type: integer
          example: 2
        created_at:
          type: string
          format: date-time
          example: '2026-09-15T06:04:06.017Z'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item'
        milestones:
          type: array
          items:
            $ref: '#/components/schemas/Milestone'
    Item:
      type: object
      properties:
        id:
          type: string
          readOnly: true
          example: 5b22055510c92b1a046ece05
        sku:
          type: string
          example: '12345678'
        description:
          type: string
          nullable: true
          example: iPad
        quantity:
          type: number
          example: 10
        checked:
          type: boolean
          readOnly: true
          example: false
    Milestone:
      type: object
      properties:
        status:
          type: string
          example: info_recv
        assign_to:
          type: string
          nullable: true
          example: null
        reason:
          type: string
          nullable: true
          example: null
        pod_at:
          type: string
          format: date-time
          example: '2026-09-15T06:04:06.017Z'
        created_at:
          type: string
          format: date-time
          example: '2026-09-15T06:04:06.017Z'
        user_name:
          type: string
          example: Simon
    Error:
      type: object
      properties:
        code:
          type: string
          example: not_found
        message:
          type: string
          example: Could not find job with this DO number
  responses:
    Unauthorized:
      description: >-
        The API key is missing or invalid. A missing `X-API-KEY` returns `{
        "error": "Missing Authorization header" }`; an invalid key returns `{
        "code": "invalid_key", "message": "Invalid key" }`.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                title: Missing key
                required:
                  - error
                properties:
                  error:
                    type: string
                    example: Missing Authorization header
              - type: object
                title: Invalid key
                required:
                  - code
                properties:
                  code:
                    type: string
                    example: invalid_key
                  message:
                    type: string
                    example: Invalid key
          example:
            code: invalid_key
            message: Invalid key
    Forbidden:
      description: Your API key's user doesn't have permission for this action.
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: string
                example: forbidden
          example:
            code: forbidden
    JobNotFound:
      description: No job matches the DO number (and `date` / `type`, if given).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: not_found
            message: Could not find job with this DO number
    InvalidDate:
      description: '`date` isn''t a valid `YYYY-MM-DD` date.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: invalid_date
            message: Invalid date
    ServerError:
      description: >-
        Unexpected server error. Retry with exponential backoff, and contact
        Detrack support if it persists.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Your Detrack API key, from **Integrations > API Key** in the dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.