Skip to main content
GET
/
commerce
/
inventory
/
v1
/
queue
Error
A valid request URL is required to generate request examples
[
  {
    "jobID": 123,
    "tenantID": 123,
    "locationCode": "<string>",
    "type": "REFRESH",
    "added": "<string>",
    "started": "<string>",
    "finished": "<string>",
    "originalFilename": "<string>",
    "hasData": true,
    "itemCount": 123,
    "status": "PENDING",
    "success": true,
    "messages": [
      "<string>"
    ],
    "numResults": 123
  }
]

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
locationCode
string

Tenant specified unique Identifier of the owning location

​
limit
integer

The maximum number of results to return, defaults to 100 for most

​
owner
string

User that owns the job

​
types
enum<string>[]

Type of the Job Queue Request

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
​
originalFilename
string

The full name of the file that was picked up at the secure droppoint server before being split up by location.

Response

Success

​
jobID
integer

Internal identifier that uniquely identifies a single job

​
tenantID
integer

Unique internal identifier of the tenant that owns the job

​
locationCode
string

Unique internal Identifier of the owning location

​
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
​
added
string

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

​
started
string

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

​
finished
string

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

​
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

​
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

​
status
enum<string>

Current status of job completion

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

Flag for success

​
messages
string[]

List of messages

​
numResults
integer

Number of results