Sign in
jobs

Get the detailed information about a specific job.

get/{storeName}/jobs/{jobId}

Path parameters

storeNamestring required

The name of the store

jobIdstring GUID required

The unique identifier of the job

Response

Successful response

jobIdstring GUID required

The unique identifier of the job

labelstring

A user-friendly label for the job specified when the job was queued.

jobStatus'Pending' | 'Started' | 'CompletedOk' | 'TransactionError' | 'Unknown'

The current processing state of the job.

statusMessagestring

The last progress message recorded by the server for the processing of this job.

storeNamestring

The name of the store that the job is queued on

queuedTimestring date-time

The date/time when the job was queued on the server.

startTimestring date-time

The date/time when the job started processing.

This value will not be available when the jobStatus is "Pending".

endTimestring date-time

The date/time when the job completed processing.

This value will not be available when the jobStatus is "Pending" or "Started".

Changes

Changed in 3 of the 11 revisions of this API.13