Skip to content
Colleqtive Developer
Get started
API Reference

Product Lists

Creates a new product list for a store, optionally including initial line items.
product_lists.create_product_list(strstore_number, ProductListCreateProductListParams**kwargs) -> ProductListCreateProductListResponse
POST/api/v2/public/stores/{store_number}/productlists
Retrieves a paginated list of product lists for a specific store, optionally including line items.
product_lists.list_product_lists(strstore_number, ProductListListProductListsParams**kwargs) -> ProductListListProductListsResponse
GET/api/v2/public/stores/{store_number}/productlists
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
Adds or updates lines on an existing product list.
product_lists.update_product_list_lines(intid, ProductListUpdateProductListLinesParams**kwargs) -> ProductListUpdateProductListLinesResponse
POST/api/v2/public/stores/{store_number}/productlists/{id}
ModelsExpand Collapse
class ProductListCreateProductListResponse: …

Response returned after a product list is created. Contains the identifier of the new list.

product_list_id: int

Identifier of the newly created product list.

formatint64
class ProductListListProductListsResponse: …

Generic paginated response wrapper.

page_size: int

Maximum number of items returned per page.

formatint32
page_start: int

Current page number (1-based).

formatint32
total_count: int

Total number of records matching the query across all pages.

formatint64
list: Optional[List[List]]

Collection of items for the current page.

id: int

Unique identifier of the product list.

formatint64
line_count: int

Number of line items on the product list.

formatint32
type: int

Numeric product list type identifier.

formatint32
app_username: Optional[str]

Name of the app user associated with the product list. Separate from the audit created_by / modified_by fields; this is the in-store app user the list belongs to.

free_fields: Optional[List[ListFreeField]]

Custom free-field key/value pairs associated with the product list.

key: Optional[str]

Free-field key.

value: Optional[str]

Free-field value.

lines: Optional[List[ListLine]]

Line items belonging to the product list. Only populated when show_lines=true is passed on the request.

quantity: float

Quantity on the line.

formatdouble
barcode: Optional[str]

The product barcode.

category_code: Optional[str]

Category code of the product.

colli: Optional[float]

Number of items per colli (case pack).

formatdouble
is_decimal: Optional[bool]

Whether decimal quantities are allowed for the product.

parent_category_code: Optional[str]

Parent category code of the product.

product_name: Optional[str]

Display name of the product.

product_number: Optional[str]

The product number.

stock_pool: Optional[str]

Stock pool the line targets.

store_walking_order: Optional[int]

Order in which the product appears in the store walking sequence.

formatint32
modified_on: Optional[datetime]

Date and time the product list was last modified.

formatdate-time
name: Optional[str]

Name of the product list.

type_description: Optional[str]

Human-readable description of the product list type.

list_body: Optional[Dict[str, Optional[object]]]

Additional body-level metadata for the list.

list_filters: Optional[Dict[str, Optional[List[str]]]]

Active filter criteria applied to the result set, keyed by field name.

next_page: Optional[int]

Next page number, or null when on the last page.

formatint32
previous_page: Optional[int]

Previous page number, or null when on the first page.

formatint64
project_last_modified_date: Optional[str]

Last modified date/time of the project.

scroll_id: Optional[str]

Opaque scroll identifier for deep-pagination scenarios.

server_time: Optional[str]

Server UTC date/time when the response was generated.

sort_column: Optional[str]

Column name the results are sorted by.

sort_order: Optional[str]

Sort direction (asc or desc).

task_last_modified_date: Optional[str]

Last modified date/time of the task.

class ProductListUpdateProductListLinesResponse: …
code: Optional[int]
formatint32
data: Optional[str]
message: Optional[str]
status: Optional[str]