Delete Product List

product_lists.delete_product_list(, ) -> ProductListDeleteProductListResponse

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

Deletes a product list from a store. It can also archive the list, or remove only the header, depending on the request.

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

Delete Product List

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)

true

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

true

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}