inventory/stock_take_job/get

This returns the list of stock take jobs available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

item_stock_take_job_id

integer

optional

The item stock take job ID to search for specifically.

filter_date_modified

string

optional

Filter the list of item stock take jobs modified after the spcified date.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "item_stock_take_job_id", "date_added", "date_modified".

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "item_stock_take_job_id": 0,
    "filter_date_modified": "string",
    "page": 0,
    "sort": "string",
    "order": "string",
    "limit": 0
}

Responses

🟢200Success

application/json

Body

error

string

optional

Returns only if there is an error.

total

integer

optional

The total number of results available.

stock_take_jobs

array [object {8}]

optional

The list of stock take jobs available.

stock_take_job_id

integer

required

The stock take job ID.

user_id

integer

required

The user ID last modified the stock take job.

location_id

integer

required

The location ID.

job_status_id

integer

required

The job status ID for the stock take job.

comment

string

required

The comment for the stock take job.

date_added

string

required

The date time the stock take job was created.

date_modified

string

required

The date time the stock take job was last modified.

items

array [object {3}]

required

The list of items for the stock take job.

Example

{
    "error": "string",
    "total": 0,
    "stock_take_jobs": [
        {
            "stock_take_job_id": 0,
            "user_id": 0,
            "location_id": 0,
            "job_status_id": 0,
            "comment": "string",
            "date_added": "string",
            "date_modified": "string",
            "items": [
                {
                    "item_id": 0,
                    "name": "string",
                    "difference": 0
                }
            ]
        }
    ]
}