inventory/item/delete

POST

/inventory/item/delete

This deletes an item 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_id

integer

optional

The item ID to delete. Choose to delete only by item_id, model, SKU or barcode.

model

string

optional

The model of the item to delete. Choose to delete only by item_id, model, SKU or barcode.

sku

string

optional

The SKU of the item to delete. Choose to delete only by item_id, model, SKU or barcode.

barcode

string

optional

The barcode of the item to delete. Choose to delete only by item_id, model, SKU or barcode.

batch_id

object

optional

An array of item ID to delete. If defined, this will take priority over item_id, model, sku and barcode parameter. Max 500 item IDs.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "item_id": 0,
  "model": "string",
  "sku": "string",
  "barcode": "string",
  "batch_id": {}
}

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_id

integer

optional

The item ID deleted if there is no error.

item_ids

object

optional

The item IDs deleted if using batch_id parameter for deletion.

Example

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

Modified at 2025-02-19 07:33:47

inventory/item/edit

inventory/item/get