Skip to content
Colleqtive Developer
Get started
API Reference
Locations

Retrieves products across one or more locations resolved by location code or jsonTag.

locations.list_locations_products(strstore_number, LocationListLocationsProductsParams**kwargs) -> SyncCursorPage[LocationListLocationsProductsResponse]
GET/api/v2/public/stores/{store_number}/locations/products

Retrieves products across one or more locations resolved by location code or jsonTag.

ParametersExpand Collapse
store_number: str
customer_order_number: Optional[str]

Optional customer order number filter.

customer_order_shipment_number: Optional[str]

Optional customer order shipment number filter.

json_tag: Optional[str]

Gall VC style location tag/location search value used to resolve one or more location codes.

location_code: Optional[str]

Optional direct location code filter.

page_size: Optional[int]

The number of items per page.

formatint32
page_start: Optional[int]

The starting page index for pagination.

formatint32
search_text: Optional[str]

Optional text to search products by name or barcode.

accept_language: Optional[str]
ReturnsExpand Collapse
class LocationListLocationsProductsResponse: …

Represents a product found at a specific store location.

barcode: Optional[str]

Product barcode.

customer_order_line_number: Optional[int]

Customer order line number.

formatint64
customer_order_number: Optional[str]

Associated customer order number.

customer_order_shipment_line_number: Optional[int]

Customer order shipment line number.

formatint32
customer_order_shipment_number: Optional[str]

Customer order shipment number.

image_url: Optional[str]

URL of the product image.

product_description: Optional[str]

Product description.

product_number: Optional[str]

Product number.

quantity: Optional[float]

Current stock quantity at this location.

formatdouble

Retrieves products across one or more locations resolved by location code or jsonTag.

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
)
page = client.locations.list_locations_products(
    store_number="store_number",
)
page = page.list[0]
print(page.barcode)
{
  "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"
}