Skip to content
Colleqtive Developer
Get started
API Reference
Locations

Retrieves products at a specific store location.

GET/api/v2/public/stores/{store_number}/locations/{location_code}/products

Retrieves products at a specific store location.

Path ParametersExpand Collapse
store_number: string
location_code: string
Query ParametersExpand Collapse
customer_order_number: optional string

Optional customer order number filter.

customer_order_shipment_number: optional string

Optional customer order shipment number filter.

page_size: optional number

The number of items per page.

formatint32
page_start: optional number

The starting page index for pagination.

formatint32
search_text: optional string

Optional text to search products by name or barcode.

Header ParametersExpand Collapse
"Accept-Language": optional string
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 { barcode, customer_order_line_number, customer_order_number, 6 more }

Collection of items for the current page.

barcode: optional string

Product barcode.

customer_order_line_number: optional number

Customer order line number.

formatint64
customer_order_number: optional string

Associated customer order number.

customer_order_shipment_line_number: optional number

Customer order shipment line number.

formatint32
customer_order_shipment_number: optional string

Customer order shipment number.

image_url: optional string

URL of the product image.

product_description: optional string

Product description.

product_number: optional string

Product number.

quantity: optional number

Current stock quantity at this location.

formatdouble
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 products at a specific store location.

curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/locations/$LOCATION_CODE/products \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "barcode": "barcode",
      "customer_order_line_number": 0,
      "customer_order_number": "customer_order_number",
      "customer_order_shipment_line_number": 0,
      "customer_order_shipment_number": "customer_order_shipment_number",
      "image_url": "image_url",
      "product_description": "product_description",
      "product_number": "product_number",
      "quantity": 0
    }
  ],
  "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": [
    {
      "barcode": "barcode",
      "customer_order_line_number": 0,
      "customer_order_number": "customer_order_number",
      "customer_order_shipment_line_number": 0,
      "customer_order_shipment_number": "customer_order_shipment_number",
      "image_url": "image_url",
      "product_description": "product_description",
      "product_number": "product_number",
      "quantity": 0
    }
  ],
  "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"
}