Retrieves locations for a specific store.

locations.list_locations(, ) -> SyncCursorPage[LocationListLocationsResponse]

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

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.

id: int

Internal location identifier.

formatint64

counter: int

Number of products counted at this location.

formatint32

created_on: datetime

Date and time the location was created.

formatdate-time

location_order: int

Order in which the location appears in walking sequences.

formatint32

customer_orders: Optional[List[str]]

Customer orders associated with this location.

default_stock_pool: Optional[str]

Name of the default stock pool for this location.

location_code: Optional[str]

Code identifying the location within the store.

quantity: Optional[float]

Total stock quantity at this location.

formatdouble

stock: Optional[List[Stock]]

Per-product stock breakdown at this location.

customer_order_line_number: Optional[int]

Customer order line number.

formatint32

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.

mostlikelypool1: Optional[float]

Most likely quantity in stock pool 1.

formatdouble

mostlikelypool10: Optional[float]

Most likely quantity in stock pool 10.

formatdouble

mostlikelypool2: Optional[float]

Most likely quantity in stock pool 2.

formatdouble

mostlikelypool3: Optional[float]

Most likely quantity in stock pool 3.

formatdouble

mostlikelypool4: Optional[float]

Most likely quantity in stock pool 4.

formatdouble

mostlikelypool5: Optional[float]

Most likely quantity in stock pool 5.

formatdouble

mostlikelypool6: Optional[float]

Most likely quantity in stock pool 6.

formatdouble

mostlikelypool7: Optional[float]

Most likely quantity in stock pool 7.

formatdouble

mostlikelypool8: Optional[float]

Most likely quantity in stock pool 8.

formatdouble

mostlikelypool9: Optional[float]

Most likely quantity in stock pool 9.

formatdouble

product_description: Optional[str]

Product description.

product_number: Optional[str]

Product number.

quantity: Optional[float]

Live total quantity at this location.

formatdouble

tags: Optional[List[str]]

Tags applied to the location.

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)

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "id": 0,
      "counter": 0,
      "created_on": "2019-12-27T18:11:19.117Z",
      "location_order": 0,
      "customer_orders": [
        "string"
      ],
      "default_stock_pool": "default_stock_pool",
      "location_code": "location_code",
      "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": 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,
      "counter": 0,
      "created_on": "2019-12-27T18:11:19.117Z",
      "location_order": 0,
      "customer_orders": [
        "string"
      ],
      "default_stock_pool": "default_stock_pool",
      "location_code": "location_code",
      "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": 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"
}