Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

jobID
integer<int64>
required

Id of bin to get

Response

Success

Response for getting a job

added
string

Time and date the job was added to the queue in ISO8601 format in UTC

finished
string

Time and date the job was finished in ISO8601 format in UTC

hasData
boolean

True if the job was not created from a fetched file

itemCount
integer

The number of items processed, only for job types REFRESH and ADJUST

jobID
integer

Internal identifier that uniquely identifies a single job

locationCode
string

Unique internal Identifier of the owning location

messages
string[]

List of messages

numResults
integer

Number of results

originalFilename
string

The full name of the file that was picked up at the secure droppoint server before being split up by location. Applies only to refresh and adjust jobs created via file fetch process

started
string

Time and date the job was started in ISO8601 format in UTC

status
enum<string>

Current status of job completion

Available options:
PENDING,
WORKING,
SUCCESS,
FAILED
success
boolean

Flag for success

tenantID
integer

Unique internal identifier of the tenant that owns the job

type
enum<string>

Purpose of the job

Available options:
REFRESH,
ADJUST,
RELEASE_SHIPMENTS,
CREATE_PICK_WAVE,
CLOSE_PICK_WAVE,
PUT_AWAY_FILE,
SHORT_PICK_ERROR,
BIN_AUDIT_START,
BIN_AUDIT_COMPLETION,
CREATE_BIN_AUDIT,
RELEASE_PENDING_ITEMS,
ALLOCATE,
DEALLOCATE,
FULFILL,
DELETE