# Locations

## List Locations

**get** `/api/v2/public/stores/{store_number}/locations`

Retrieves locations for a specific store.

### Path Parameters

- `store_number: string`

### Query Parameters

- `accept_language: optional string`

- `app_username: optional string`

- `ignore_customerorder_stock: optional boolean`

  When true, excludes customer order stock from results.

- `page_size: optional number`

- `page_start: optional number`

- `search_text: optional string`

### Returns

- `list: array of object { location_code, id, counter, 7 more }`

  Collection of items for the current page.

  - `location_code: string`

  - `id: optional number`

  - `counter: optional number`

  - `created_on: optional string`

  - `customer_orders: optional array of string`

  - `default_stock_pool: optional string`

  - `location_order: optional number`

  - `quantity: optional number`

  - `stock: optional array of object { customer_order_line_number, customer_order_number, customer_order_shipment_line_number, 14 more }`

    - `customer_order_line_number: optional number`

    - `customer_order_number: optional string`

    - `customer_order_shipment_line_number: optional number`

    - `customer_order_shipment_number: optional string`

    - `mostlikelypool1: optional number`

    - `mostlikelypool10: optional number`

    - `mostlikelypool2: optional number`

    - `mostlikelypool3: optional number`

    - `mostlikelypool4: optional number`

    - `mostlikelypool5: optional number`

    - `mostlikelypool6: optional number`

    - `mostlikelypool7: optional number`

    - `mostlikelypool8: optional number`

    - `mostlikelypool9: optional number`

    - `product_description: optional string`

    - `product_number: optional string`

    - `quantity: optional number`

  - `tags: optional array of string`

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

- `page_size: optional number`

  Maximum number of items returned per page.

- `page_start: optional number`

  Current page number (1-based).

- `previous_page: optional number`

  Previous page number, or null when on the first page.

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

- `task_last_modified_date: optional string`

  Last modified date/time of the task.

- `total_count: optional number`

  Total number of records matching the query across all pages.

### Example

```http
curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/locations \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
```

## List Location Products

**get** `/api/v2/public/stores/{store_number}/locations/{location_code}/products`

Retrieves products at a specific store location.

### Path Parameters

- `store_number: string`

- `location_code: string`

### Query Parameters

- `advance_search: optional boolean`

  When true, enables advanced search mode.

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

- `page_start: optional number`

  The starting page index for pagination.

- `search_text: optional string`

  Optional text to search products by name or barcode.

### Header Parameters

- `"Accept-Language": optional string`

### Returns

- `list: array of object { product_number, barcode, customer_order_line_number, 6 more }`

  Collection of items for the current page.

  - `product_number: string`

    Product number.

  - `barcode: optional string`

    Product barcode.

  - `customer_order_line_number: optional number`

    Customer order line number.

  - `customer_order_number: optional string`

    Associated customer order number.

  - `customer_order_shipment_line_number: optional number`

    Customer order shipment line number.

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

  - `quantity: optional number`

    Current stock quantity at this location.

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

- `page_size: optional number`

  Maximum number of items returned per page.

- `page_start: optional number`

  Current page number (1-based).

- `previous_page: optional number`

  Previous page number, or null when on the first page.

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

- `task_last_modified_date: optional string`

  Last modified date/time of the task.

- `total_count: optional number`

  Total number of records matching the query across all pages.

### Example

```http
curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/locations/$LOCATION_CODE/products \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
```