Skip to main content
POST
/
commerce
/
inventory
/
v5
/
inventory
/
delete
Error
A valid request URL is required to generate request examples
{
  "dryRun": true,
  "itemsDeleted": [
    {
      "auditIDs": [
        123
      ],
      "inventoryIDs": [
        123
      ],
      "itemIdentifier": {
        "partNumber": "<string>",
        "sku": "<string>",
        "upc": "<string>"
      },
      "locationCodes": [
        "<string>"
      ],
      "locationIDs": [
        123
      ],
      "productID": 123
    }
  ],
  "jobIDs": true,
  "totalAuditsDeleted": true,
  "totalInventoryEntriesDeleted": true,
  "totalLocationsAffected": true,
  "totalPickWavesDeleted": true,
  "totalProductsDeleted": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
x-vol-site
integer

Site ID

Body

application/json

Request to delete item(s)

Request needed for deleting inventory

​
allLocations
boolean

Flag used to request deletion of inventory across all locations (overrides locationCodes).

​
dryRun
boolean

Flag used to differentiate between a test and a non-test run.

​
explicit
boolean

Flag used to request explicit inventory, location, pick wave, and audit information for each request item.

​
locationCodes
string[]

An array of locationCodes to be considered for item-deletion purposes. Optional. All locationCodes associated with the requesting tenant will be considered if no locationCodes are provided.

​
partNumber
string

The part number of the item to be deleted. Supports basic regex operators: .*+?^$[]

​
sku
string

The sku of the item to be deleted. Supports basic regex operators: .*+?^$[]

​
tags
object

Associative Map of <String, String> for tagCategoryName => tagName

​
upc
string

The upc of the item to be deleted. Supports basic regex operators: .*+?^$[]

Response

Success

Delete Item Response

​
dryRun
boolean

Flag used to differentiate between a test and a non-test run.

​
itemsDeleted
M_DeleteItem · object[]

Items deleted due to the request

​
jobIDs
boolean

Flag used to differentiate between a test and a non-test run.

​
totalAuditsDeleted
boolean

Flag used to differentiate between a test and a non-test run.

​
totalInventoryEntriesDeleted
boolean

Flag used to differentiate between a test and a non-test run.

​
totalLocationsAffected
boolean

Flag used to differentiate between a test and a non-test run.

​
totalPickWavesDeleted
boolean

Flag used to differentiate between a test and a non-test run.

​
totalProductsDeleted
boolean

Flag used to differentiate between a test and a non-test run.