Skip to content
Colleqtive Developer
Get started
API Reference
Locations

Retrieves locations for a specific store.

locations.list_locations(strstore_number, LocationListLocationsParams**kwargs) -> SyncCursorPage[LocationListLocationsResponse]
GET/api/v2/public/stores/{store_number}/locations

Retrieves locations for a specific store.

ParametersExpand Collapse
store_number: str
accept_language: Optional[str]
app_username: Optional[str]
ignore_customerorder_stock: Optional[bool]

When true, excludes customer order stock from results.

page_size: Optional[int]
formatint32
page_start: Optional[int]
formatint32
search_text: Optional[str]
ReturnsExpand Collapse
class LocationListLocationsResponse: …

Represents a location within a store, including stock and product data.

location_code: str
id: Optional[int]
formatint64
counter: Optional[int]
formatint32
created_on: Optional[datetime]
formatdate-time
customer_orders: Optional[List[str]]
default_stock_pool: Optional[str]
location_order: Optional[int]
formatint32
quantity: Optional[float]
formatdouble
stock: Optional[List[Stock]]
customer_order_line_number: Optional[int]
formatint32
customer_order_number: Optional[str]
customer_order_shipment_line_number: Optional[int]
formatint32
customer_order_shipment_number: Optional[str]
mostlikelypool1: Optional[float]
formatdouble
mostlikelypool10: Optional[float]
formatdouble
mostlikelypool2: Optional[float]
formatdouble
mostlikelypool3: Optional[float]
formatdouble
mostlikelypool4: Optional[float]
formatdouble
mostlikelypool5: Optional[float]
formatdouble
mostlikelypool6: Optional[float]
formatdouble
mostlikelypool7: Optional[float]
formatdouble
mostlikelypool8: Optional[float]
formatdouble
mostlikelypool9: Optional[float]
formatdouble
product_description: Optional[str]
product_number: Optional[str]
quantity: Optional[float]
formatdouble
tags: Optional[List[str]]

Retrieves locations for a specific store.

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(
    store_number="store_number",
)
page = page.list[0]
print(page.id)
{
  "list": [
    {
      "location_code": "location_code",
      "id": 0,
      "counter": 0,
      "created_on": "2019-12-27T18:11:19.117Z",
      "customer_orders": [
        "string"
      ],
      "default_stock_pool": "default_stock_pool",
      "location_order": 0,
      "quantity": 0,
      "stock": [
        {
          "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",
          "mostlikelypool1": 0,
          "mostlikelypool10": 0,
          "mostlikelypool2": 0,
          "mostlikelypool3": 0,
          "mostlikelypool4": 0,
          "mostlikelypool5": 0,
          "mostlikelypool6": 0,
          "mostlikelypool7": 0,
          "mostlikelypool8": 0,
          "mostlikelypool9": 0,
          "product_description": "product_description",
          "product_number": "product_number",
          "quantity": 0
        }
      ],
      "tags": [
        "string"
      ]
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 4,
  "page_size": 25,
  "page_start": 3,
  "previous_page": 2,
  "project_last_modified_date": "2025-06-10T08:00:00Z",
  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2g",
  "server_time": "2025-06-15T14:30:00Z",
  "sort_column": "name",
  "sort_order": "asc",
  "task_last_modified_date": "2025-06-12T10:15:00Z",
  "total_count": 142
}
Returns Examples
{
  "list": [
    {
      "location_code": "location_code",
      "id": 0,
      "counter": 0,
      "created_on": "2019-12-27T18:11:19.117Z",
      "customer_orders": [
        "string"
      ],
      "default_stock_pool": "default_stock_pool",
      "location_order": 0,
      "quantity": 0,
      "stock": [
        {
          "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",
          "mostlikelypool1": 0,
          "mostlikelypool10": 0,
          "mostlikelypool2": 0,
          "mostlikelypool3": 0,
          "mostlikelypool4": 0,
          "mostlikelypool5": 0,
          "mostlikelypool6": 0,
          "mostlikelypool7": 0,
          "mostlikelypool8": 0,
          "mostlikelypool9": 0,
          "product_description": "product_description",
          "product_number": "product_number",
          "quantity": 0
        }
      ],
      "tags": [
        "string"
      ]
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 4,
  "page_size": 25,
  "page_start": 3,
  "previous_page": 2,
  "project_last_modified_date": "2025-06-10T08:00:00Z",
  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2g",
  "server_time": "2025-06-15T14:30:00Z",
  "sort_column": "name",
  "sort_order": "asc",
  "task_last_modified_date": "2025-06-12T10:15:00Z",
  "total_count": 142
}