inventory/addition/get - Equotix One API

This returns the list of item additions 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_addition_id

integer

optional

The item addition ID to search for.

filter_date_modified

string

optional

Filter the list of item additions modified after the spcified date.

filter_deleted

boolean

optional

Filter the list of item additions to include deleted records.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "item_addition_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_addition_id": 0,
  "filter_date_modified": "string",
  "filter_deleted": true,
  "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 if there is no error.

additions

array [object {10}]

optional

The list of item additions available if there is no error.

item_addition_id

integer

required

The item addition ID.

user_id

integer

required

The user ID last modified the stock addition.

purchase_order_id

integer

required

The purchase order ID this item addition is associated to.

comment

string

required

The comment for this item addition.

currency

string

required

The currency code for this item addition.

currency_value

number

required

The currency value for this item addition.

date_added

string

required

The date time this item addition was created.

date_modified

string

required

The date time this item addition was last modified.

items

array [object {5}]

required

The list of items for the item addition.

deleted

boolean

optional

Indicates if the item addition has been deleted. Only returned if filter_deleted is "1".

Example

{
  "error": [
    "string"
  ],
  "total": 0,
  "additions": [
    {
      "item_addition_id": 0,
      "user_id": 0,
      "purchase_order_id": 0,
      "comment": "string",
      "currency": "string",
      "currency_value": 0,
      "date_added": "string",
      "date_modified": "string",
      "items": [
        {
          "item_id": 0,
          "name": "string",
          "location_id": 0,
          "quantity": 0,
          "cost": 0
        }
      ],
      "deleted": true
    }
  ]
}