Skip to main content

Preview Remove Duplicate Product Images

POST 
/api/products/duplicate-images/preview

Show what removing duplicate images from a set of products would do, without changing anything.

Required scope: products:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Body fields:

  • ids (array of integers, required unless apply_to_all): the products to include
  • apply_to_all (boolean, optional): true to include every product matching filters instead of ids
  • filters (object, optional): the same filters List Products accepts, without the filter[...] wrapper (e.g. {"has_duplicate_images.is": true})

Response: products_selected, products_affected (products with duplicates), images_to_remove (only images confirmed to show the same picture — the same image at another size, or a pixel-level match), images_kept (one per duplicate group), images_pending_fingerprint (images not compared yet — the removal reads and compares them first, so it can remove more than the preview shows) images_possible and products_with_possible (images that only look like another image of their product — possibly a different shot of the same item — on how many products; never removed in bulk, review them per product) and samples (up to four products with the images kept and removed).

Requires permission: products.update

Request​

Responses​

OK

Response Headers
    Content-Type