inventory/transfer/get - Equotix One API

This returns the list of item transfers 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_transfer_id

integer

optional

The item transfer ID to search for specifically.

filter_date_modified

string

optional

Filter the list of item transfers 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_transfer_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_transfer_id": 0,
  "filter_date_modified": "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.

transfers

array [object {6}]

optional

The list of item transfers available.

item_transfer_id

integer

required

The item transfer ID.

user_id

integer

required

The user ID last modified the item transfer.

comment

string

required

The comment for the item transfer.

date_added

string

required

The date time the item transfer was created.

date_modified

string

required

The date time the item transfer was last modified.

items

array [object {5}]

required

The list of items for the item transfer.

Example

{
  "error": [
    "string"
  ],
  "total": 0,
  "transfers": [
    {
      "item_transfer_id": 0,
      "user_id": 0,
      "comment": "string",
      "date_added": "string",
      "date_modified": "string",
      "items": [
        {
          "item_id": 0,
          "name": "string",
          "from_location_id": 0,
          "to_location_id": 0,
          "quantity": 0
        }
      ]
    }
  ]
}