Delete Collect

Removes an association between a product and a collection by deleting a collect object.

🔒

Requires write_collection access scope. More access scope

The Delete Collect API removes an association between a product and a collection by deleting a collect object. This operation ensures the product is no longer part of the specified collection.This API is especially useful for:

  1. Removing products from collections no longer relevant for marketing or categorization.
  2. Cleaning up collections during inventory updates or reorganization.

Request Parameters

Public Request Parameters

📘

Path Parameters

ParameterTypeRequiredExampleDescription
idstringYesa1b2c3d4-e5f6-7890-abcd-1234567890efThe unique identifier of the collect. Must be a valid UUID.

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring200Error code (200 indicates success)
messagestringSuccessError message
dataobject{...}

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!