Skip to main content
POST
/
commerce
/
inventory
/
v5
/
inventory
/
deleteFutureInventory
Error
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>"
      }
    }
  ],
  "totalInventoryEntriesDeleted": true,
  "totalLocationsAffected": true,
  "jobIDs": true
}

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 future item(s)

Request needed for deleting future inventory

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.

allLocations
boolean

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

partNumber
string

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

upc
string

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

sku
string

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

futureStartDate
string<date-time>

Start of future date range to search on. Required field example '2023-01-26T19:59:00+0000'

futureEndDate
string<date-time>

End of future date range to search on. Required Field example '2023-01-26T19:59:00+0000'

Response

Success

Delete Future 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

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.

jobIDs
boolean

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