USusenash
Job

Get Job

Changed on

Retrieve a job by its ID, including all job configurations, tasks, deliveries, and quotes. Pass compressed_payload=true by default — it drops the quotes and failedQuotes arrays and collapses advancedTask to just its id, which typically shrinks the response 10x+. Only omit it (or pass false) when the caller explicitly needs quote details: pricing, provider selection, or failed-dispatch error messages.

get/v1/jobs/{id}

Request

Path parameters

idstring required

job id

Query parameters

compressedPayloadboolean nullable

Return a slimmer job payload by excluding the full quotes and failedQuotes arrays and reducing advancedTask to just {id}. Prefer compressed_payload=true by default for status / ETA / tracking / cancellation flows — it can shrink responses by 10x+ on jobs that shopped many providers. Set to false (or omit) only when the caller needs quote data: pricing breakdowns, provider selection rationale, or failed-dispatch error messages.

Response

OK

idstring required

Job ID

createdAtstring required

Created at

portalUrlstring required

Portal URL

externalIdentifierstring nullable

External identifier

jobMetadataobject nullable

Job metadata

isActiveboolean required

Is the job active

isBatchboolean required

Is the job a batch

shortReferenceCodestring nullable

7-digit non-unique human-readable reference code for the job.

selectedConfigurationobject nullable

Selected configuration

jobSpecificationobject nullable

Job specification

Changes

  • e3713837c5c9Revision changes
    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/statusHistory/anyOf[subschema #1]/items/additionalProperties/ list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/stops/items/distanceFromPrevious list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/stops/items/durationFromPrevious list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/stops/items/serviceTime list-of-types was widened by adding types integer to media type application/json of response 200

    • warning

      added the new cargo_bike enum value to the /// response property for the response status

    • warning

      added the new cargo_bike enum value to the //// response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status