Retrieves locations for a specific store.
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
formatint32
page_start: optional number
formatint32
search_text: optional string
Returns
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.
formatint32
page_size: optional number
Maximum number of items returned per page.
formatint64
page_start: optional number
Current page number (1-based).
formatint64
previous_page: optional number
Previous page number, or null when on the first page.
formatint64
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.
formatint64
Retrieves locations for a specific store.
curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/locations \
-H "Authorization: $COLLEQTIVE_BEARER_TOKEN"{
"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
}