Deletes products by product numbers.

products.delete_products() -> ProductDeleteProductsResponse

DELETE/api/v2/public/products

ParametersExpand Collapse

product_number: Optional[SequenceNotStr[str]]

The product numbers to target.

ReturnsExpand Collapse

class ProductDeleteProductsResponse: …

Standard success response returned by mutation endpoints.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

success: Optional[bool]

Indicates whether the operation completed successfully.

Deletes products by product numbers.

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.products.delete_products()
print(response.data)

{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}

Returns Examples

{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}