inventory/reservation/get - Equotix One API

This returns the list of item reservations 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_reservation_id

integer

optional

The item reservation ID to search for specifically.

filter_date_modified

string

optional

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

filter_deleted

boolean

optional

Filter the list of item reservations 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_reservation_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_reservation_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]

required

Returns only if there is an error.

total

integer

optional

The total number of results available.

reservations

array [object {10}]

optional

The list of item reservations available.

item_reservation_id

integer

required

The item reservation ID.

imported_order_id

string

required

The imported order ID from channels.

user_id

integer

required

The user ID last modified the item reservation.

channel_id

integer

required

The channel ID related to the imported order ID..

location_id

integer

required

The location ID.

comment

string

required

The comment for the item reservation.

date_added

string

required

The date time the item reservation was created.

date_modified

string

required

The date time the item reservation was last modified.

items

array [object {3}]

required

The list of items for the item reservation.

deleted

boolean

optional

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

Example

{
  "error": [
    "string"
  ],
  "total": 0,
  "reservations": [
    {
      "item_reservation_id": 0,
      "imported_order_id": "string",
      "user_id": 0,
      "channel_id": 0,
      "location_id": 0,
      "comment": "string",
      "date_added": "string",
      "date_modified": "string",
      "items": [
        {
          "item_id": 0,
          "name": "string",
          "quantity": 0
        }
      ],
      "deleted": true
    }
  ]
}