inventory/reservation/add - Equotix One API

This adds an item reservation to 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.

location_id

integer

required

The location ID for the item reservation.

comment

string

required

The comment for this item reservation.

reservation

array [object {3}]

required

The list of items for the item reservation.

name

string

required

The item name.

item_id

integer

required

The item ID.

quantity

integer

required

The quantity to deduct.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "location_id": 0,
  "comment": "string",
  "reservation": [
    {
      "name": "string",
      "item_id": 0,
      "quantity": 0
    }
  ]
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

success

boolean

optional

Returns only if there is no error.

item_reservation_id

integer

optional

The created item reservation ID.

Example

{
  "error": [
    "string"
  ],
  "success": true,
  "item_reservation_id": 0
}