USusenash
Job

Get Job by External Identifier

Changed on

Retrieve a job using your external identifier instead of the Nash job ID. Useful when integrating with external systems that track their own order IDs.

get/v1/jobs/external_identifier/{externalIdentifier}

Request

Path parameters

externalIdentifierstring required

job external identifier

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