## 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.

### Parameters

- `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]`

- `page_start: Optional[int]`

- `search_text: Optional[str]`

### Returns

- `class LocationListLocationsResponse: …`

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

  - `id: int`

    Internal location identifier.

  - `counter: int`

    Number of products counted at this location.

  - `created_on: datetime`

    Date and time the location was created.

  - `location_order: int`

    Order in which the location appears in walking sequences.

  - `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.

  - `stock: Optional[List[Stock]]`

    Per-product stock breakdown at this location.

    - `customer_order_line_number: Optional[int]`

      Customer order line number.

    - `customer_order_number: Optional[str]`

      Associated customer order number.

    - `customer_order_shipment_line_number: Optional[int]`

      Customer order shipment line number.

    - `customer_order_shipment_number: Optional[str]`

      Customer order shipment number.

    - `mostlikelypool1: Optional[float]`

      Most likely quantity in stock pool 1.

    - `mostlikelypool10: Optional[float]`

      Most likely quantity in stock pool 10.

    - `mostlikelypool2: Optional[float]`

      Most likely quantity in stock pool 2.

    - `mostlikelypool3: Optional[float]`

      Most likely quantity in stock pool 3.

    - `mostlikelypool4: Optional[float]`

      Most likely quantity in stock pool 4.

    - `mostlikelypool5: Optional[float]`

      Most likely quantity in stock pool 5.

    - `mostlikelypool6: Optional[float]`

      Most likely quantity in stock pool 6.

    - `mostlikelypool7: Optional[float]`

      Most likely quantity in stock pool 7.

    - `mostlikelypool8: Optional[float]`

      Most likely quantity in stock pool 8.

    - `mostlikelypool9: Optional[float]`

      Most likely quantity in stock pool 9.

    - `product_description: Optional[str]`

      Product description.

    - `product_number: Optional[str]`

      Product number.

    - `quantity: Optional[float]`

      Live total quantity at this location.

  - `tags: Optional[List[str]]`

    Tags applied to the location.

### Example

```python
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)
```

#### Response

```json
{
  "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"
}
```