Delete Products in a Batch

This endpoint lets you delete products in a batch. It can be really useful when you want to remove multiple products in bulk.

delete
Delete Product Batch

https://api.studio.whisk.com/products/v1/delete/batch
You can specify the body parameter to delete products from Whisk Studio:
Request
Response
Request
Headers
Authentication
required
string
Server token to track down who is emptying our stocks.
Body Parameters
body
required
object
This body object contains a list of product identifiers to delete the related products.
Response
200: OK
This is how a successful response looks.
{}
400: Bad Request
This failed response appears when error codes are found in the endpoint query.
{
"error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
"message": "Additional details about error are not static and can be changed"
}
401: Unauthorized
This failed response appears due to API authentication failure. The possible error codes that may appear are: auth.tokenNotFound , auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.
{
"code": "auth.tokenNotFound"
}
500: Internal Server Error
This failed response appears when something is not right on Whisk's end. Please send a message to help@whisk.com, and be sure to include both the Request and Response data. We’ll get back to you soon.
This is unexpected response, something is wrong on our side, please contact: help@whisk.com

Request Body Object Example

{
"product_ids": [
"5fe5a94f642e29bec369c986", "5fe5a94e642e29bec369c92f"
],
"integration_id": "e07032d4-ab74-4736-ae84-57091fae6210"
}

You can add a list of product identifiers in the product_ids array to delete them in a batch.

Sample Request and Response

Curl Request
Response
Curl Request
curl -X DELETE "https://api.studio.whisk.com/products/v1/delete/batch"
-H "Accept: application/json"
-H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"
-H "Content-Type: application/json"
-d "{ \"product_ids\": [ \"5fe5a94f642e29bec369c986\", \"5fe5a94e642e29bec369c92f\" ], \"integration_id\": \"e07032d4-ab74-4736-ae84-57091fae6210\"}"

Note: Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.

Response
{}