API Reference

Product Lists

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deletes a product list by id, optionally archiving it or removing only its header.

product_lists.delete_product_list(strstore_number, ProductListDeleteProductListParams**kwargs) -> ProductListDeleteProductListResponse

DELETE/api/v2/public/stores/{store_number}/productlists

Deletes a product list by id, optionally archiving it or removing only its header.

ParametersExpand Collapse

store_number: str

product_list_id: int

The product list identifier to delete.

formatint64

is_archived: Optional[bool]

When true, archives the product list instead of permanently deleting it.

is_delete_header: Optional[bool]

When true, deletes only the product list header (and its lines).

accept_language: Optional[str]

api_key: Optional[str]

ReturnsExpand Collapse

bool

Deletes a product list by id, optionally archiving it or removing only its header.

Python

HTTP

C#

Python

TypeScript

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.product_lists.delete_product_list(
    store_number="store_number",
    product_list_id=0,
)
print(response)

200 example

true

Returns Examples

200 example

true