inventory/transfer/add - Equotix One API

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

comment

string

required

The comment for this item transfer.

transfer

array [object {5}]

required

The list of items for the item transfer.

name

string

required

The item name.

item_id

integer

required

The item ID.

from_location_id

integer

required

The location ID to transfer out from.

to_location_id

integer

required

The location ID to transfer into.

quantity

integer

required

The quantity to transfer.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "comment": "string",
    "transfer": [
        {
            "name": "string",
            "item_id": 0,
            "from_location_id": 0,
            "to_location_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_transfer_id

integer

optional

The created item transfer ID.

Example

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