Skip to main content
Use DELETE /v1/products/lists/{list_id}/products to remove specific products from an existing list. Pass an array of product IDs to remove in the request body. The response confirms which IDs were removed and which were skipped because they were not found in the list.
If you submit product IDs that are not in the list, the API does not return an error. Those IDs appear in ignored_product_ids in the response. Only IDs that were present in the list are removed and appear in removed_product_ids.

Request

Endpoint: DELETE /v1/products/lists/{list_id}/products

Headers

string
required
Your API key as a Bearer token: Bearer {your_api_key}.
string
required
Must be application/json.

Path parameters

string
required
The unique identifier of the list to remove products from.

Body parameters

string[]
required
An array of product ID strings to remove from the list.

Example request

cURL

Response

A 200 OK response confirms which product IDs were removed and which were not found in the list.

Response fields

string
The ID of the list that was modified.
string[]
Product IDs that were successfully removed from the list.
string[]
Product IDs that were not removed because they were not found in the list. No error is thrown for these IDs.
object