Retrieves a paginated list of product lists for a specific store, optionally including line items.

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

Path ParametersExpand Collapse

store_number: string

Query ParametersExpand Collapse

last_updated_on: optional string

Filter product lists modified on or after this date.

formatdate-time

name: optional string

Optional product list name filter.

product_list_id: optional number

Optional product list identifier to filter by.

formatint64

show_lines: optional boolean

When true, includes the line items for each product list.

type: optional number

Optional product list type filter.

formatint32

ReturnsExpand Collapse

page_size: number

Maximum number of items returned per page.

formatint32

page_start: number

Current page number (1-based).

formatint32

total_count: number

Total number of records matching the query across all pages.

formatint64

list: optional array of object { id, line_count, type, 6 more }

Collection of items for the current page.

id: number

Unique identifier of the product list.

formatint64

line_count: number

Number of line items on the product list.

formatint32

type: number

Numeric product list type identifier.

formatint32

app_username: optional string

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 array of object { key, value }

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

key: optional string

Free-field key.

value: optional string

Free-field value.

lines: optional array of object { quantity, barcode, category_code, 7 more }

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

quantity: number

Quantity on the line.

formatdouble

barcode: optional string

The product barcode.

category_code: optional string

Category code of the product.

colli: optional number

Number of items per colli (case pack).

formatdouble

is_decimal: optional boolean

Whether decimal quantities are allowed for the product.

parent_category_code: optional string

Parent category code of the product.

product_name: optional string

Display name of the product.

product_number: optional string

The product number.

stock_pool: optional string

Stock pool the line targets.

store_walking_order: optional number

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

formatint32

modified_on: optional string

Date and time the product list was last modified.

formatdate-time

name: optional string

Name of the product list.

type_description: optional string

Human-readable description of the product list type.

list_body: optional map[unknown]

Additional body-level metadata for the list.

list_filters: optional map[array of string]

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

next_page: optional number

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

formatint32

previous_page: optional number

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

formatint64

project_last_modified_date: optional string

Last modified date/time of the project.

scroll_id: optional string

Opaque scroll identifier for deep-pagination scenarios.

server_time: optional string

Server UTC date/time when the response was generated.

sort_column: optional string

Column name the results are sorted by.

sort_order: optional string

Sort direction (asc or desc).

task_last_modified_date: optional string

Last modified date/time of the task.

Retrieves a paginated list of product lists for a specific store, optionally including line items.

curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/productlists \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "id": 0,
      "line_count": 0,
      "type": 0,
      "app_username": "app_username",
      "free_fields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "lines": [
        {
          "quantity": 0,
          "barcode": "barcode",
          "category_code": "category_code",
          "colli": 0,
          "is_decimal": true,
          "parent_category_code": "parent_category_code",
          "product_name": "product_name",
          "product_number": "product_number",
          "stock_pool": "stock_pool",
          "store_walking_order": 0
        }
      ],
      "modified_on": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "type_description": "type_description"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

Returns Examples

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "id": 0,
      "line_count": 0,
      "type": 0,
      "app_username": "app_username",
      "free_fields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "lines": [
        {
          "quantity": 0,
          "barcode": "barcode",
          "category_code": "category_code",
          "colli": 0,
          "is_decimal": true,
          "parent_category_code": "parent_category_code",
          "product_name": "product_name",
          "product_number": "product_number",
          "stock_pool": "stock_pool",
          "store_walking_order": 0
        }
      ],
      "modified_on": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "type_description": "type_description"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}