inventory/flow/get - Equotix One API

This returns the list of item stock flow 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.

filter_item_id

integer

optional

The item ID stock flow to search for specifically.

filter_location_id

integer

optional

Filter the list by location ID.

filter_date_added_start

string

optional

Filter the list by records added after the specified date time.

filter_date_added_end

string

optional

Filter the list by records added before the specified date time.

page

integer

optional

Page number of the results.

sort

string

optional

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

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",
    "filter_item_id": 0,
    "filter_location_id": 0,
    "filter_date_added_start": "string",
    "filter_date_added_end": "string",
    "page": 0,
    "sort": "string",
    "order": "string",
    "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available.

flows

array [object {16}]

optional

The list of item flows available.

item_flow_id

integer

required

The item flow ID.

item_id

integer

required

The user ID that created this item flow.

name

string

required

The item name.

model

string

required

The item model code.

sku

string

required

The item SKU code.

cost

number

optional

The current cost of the item. Only available if API has view cost permission.

average_cost

number

optional

The current average cost of the item. Only available if API has view cost permission.

pool_cost

number

optional

The current pool cost of the item. Only available if API has view cost permission.

user_id

integer

required

The user ID that created this stock flow.

user

string

required

The username of the user.

location_id

integer

required

The location ID the stock flow was created at.

location

string

required

The location name.

quantity

integer

required

The quantity added or subtracted.

balance

integer

required

The balance quantity as at point.

comment

string

required

The comment for the stock flow.

date_added

string

required

The date time the stock flow was created.

Example

{
    "error": [
        "string"
    ],
    "total": 0,
    "flows": [
        {
            "item_flow_id": 0,
            "item_id": 0,
            "name": "string",
            "model": "string",
            "sku": "string",
            "cost": 0,
            "average_cost": 0,
            "pool_cost": 0,
            "user_id": 0,
            "user": "string",
            "location_id": 0,
            "location": "string",
            "quantity": 0,
            "balance": 0,
            "comment": "string",
            "date_added": "string"
        }
    ]
}