API reference
A valid request URL is required to generate request examples{
"dryRun": true,
"itemsDeleted": [
{
"productID": 123,
"inventoryIDs": [
123
],
"locationIDs": [
123
],
"locationCodes": [
"<string>"
],
"auditIDs": [
123
],
"itemIdentifier": {
"partNumber": "<string>",
"upc": "<string>",
"sku": "<string>"
}
}
],
"totalAuditsDeleted": true,
"totalInventoryEntriesDeleted": true,
"totalLocationsAffected": true,
"totalPickWavesDeleted": true,
"totalProductsDeleted": true,
"jobIDs": true
}Delete Inventory
Deletes inventory for a single product identifier (by partNumber, upc, or sku) across all or selected locations. Supports basic regex operators in the identifier field, making it well-suited for pattern-based deletion — for example, removing all products whose part number starts with a given prefix. The operation is asynchronous: the endpoint returns immediately with a list of job IDs (one per affected location) which you can monitor using the Get Job API. Use dryRun: true to preview the scope of deletion before executing. For step-by-step guidance including dry run workflow, job monitoring, and self-throttling patterns, see the Bulk Inventory Deletion guide.
A valid request URL is required to generate request examples{
"dryRun": true,
"itemsDeleted": [
{
"productID": 123,
"inventoryIDs": [
123
],
"locationIDs": [
123
],
"locationCodes": [
"<string>"
],
"auditIDs": [
123
],
"itemIdentifier": {
"partNumber": "<string>",
"upc": "<string>",
"sku": "<string>"
}
}
],
"totalAuditsDeleted": true,
"totalInventoryEntriesDeleted": true,
"totalLocationsAffected": true,
"totalPickWavesDeleted": true,
"totalProductsDeleted": true,
"jobIDs": true
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
Site ID
Body
Request to delete item(s)
Request needed for deleting inventory
Flag used to differentiate between a test and a non-test run.
Flag used to request explicit inventory, location, pick wave, and audit information for each request item.
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.
Flag used to request deletion of inventory across all locations (overrides locationCodes).
The part number of the item to be deleted. Supports basic regex operators: .*+?^$[]
The upc of the item to be deleted. Supports basic regex operators: .*+?^$[]
The sku of the item to be deleted. Supports basic regex operators: .*+?^$[]
Associative Map of <String, String> for tagCategoryName => tagName
Show child attributes
Show child attributes
Response
Success
Delete Item Response
Flag used to differentiate between a test and a non-test run.
Items deleted due to the request
Show child attributes
Show child attributes
Flag used to differentiate between a test and a non-test run.
Flag used to differentiate between a test and a non-test run.
Flag used to differentiate between a test and a non-test run.
Flag used to differentiate between a test and a non-test run.
Flag used to differentiate between a test and a non-test run.
Flag used to differentiate between a test and a non-test run.