DELETE /catalog/products

To delete Product objects, you must include a filter. This prevents inadvertently deleting all Product objects in a store.

Note

The maximum number of products you can delete at one time is 250.

Example: To delete products with IDs 1,2 and 3, use DELETE /v3/catalog/products?id:in=1,2,3.

Servers

Request headers

Name Type Required Description
Accept String Yes

The MIME type of the response body.

Default value: "application/json"

Query parameters

Name Type Required Description
price Number No

Filter items by price.

date_modified String No

Filter items by date_modified.

inventory_level Integer No

Filter items by inventory_level.

is_featured Integer No

Filter items by is_featured. 1 for true, 0 for false.

Valid values:

  • 0
  • 1
keyword String No

Filter items by keywords found in the name, description, or sku fields, or in the brand name.

is_visible Boolean No

Filter items based on whether the product is currently visible on the storefront.

id:in[] Array No

Pass a comma-separated list to filter by one or more product IDs.

total_sold Integer No

Filter items by total_sold.

date_last_imported String No

Filter items by date_last_imported.

name String No

Filter items by name.

sku String No

Filter items by main SKU. To filter by variant SKU, see Get all variants.

brand_id Integer No

Filter items by brand ID.

categories Integer No

Filter items by categories. If a product is in more than one category, using this query will not return the product. Instead use categories:in=12.

condition String No

Filter items by condition.

Valid values:

  • "new"
  • "used"
  • "refurbished"
type String No

Filter items by type.

Valid values:

  • "digital"
  • "physical"
weight Number No

Filter items by weight.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.