# Locations ## 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` - `page_start: optional number` - `search_text: optional string` ### Returns - `page_size: number` Maximum number of items returned per page. - `page_start: number` Current page number (1-based). - `total_count: number` Total number of records matching the query across all pages. - `list: optional array of object { id, counter, created_on, 7 more }` Collection of items for the current page. - `id: number` Internal location identifier. - `counter: number` Number of products counted at this location. - `created_on: string` Date and time the location was created. - `location_order: number` Order in which the location appears in walking sequences. - `customer_orders: optional array of string` Customer orders associated with this location. - `default_stock_pool: optional string` Name of the default stock pool for this location. - `location_code: optional string` Code identifying the location within the store. - `quantity: optional number` Total stock quantity at this location. - `stock: optional array of object { customer_order_line_number, customer_order_number, customer_order_shipment_line_number, 14 more }` Per-product stock breakdown at this location. - `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. - `mostlikelypool1: optional number` Most likely quantity in stock pool 1. - `mostlikelypool10: optional number` Most likely quantity in stock pool 10. - `mostlikelypool2: optional number` Most likely quantity in stock pool 2. - `mostlikelypool3: optional number` Most likely quantity in stock pool 3. - `mostlikelypool4: optional number` Most likely quantity in stock pool 4. - `mostlikelypool5: optional number` Most likely quantity in stock pool 5. - `mostlikelypool6: optional number` Most likely quantity in stock pool 6. - `mostlikelypool7: optional number` Most likely quantity in stock pool 7. - `mostlikelypool8: optional number` Most likely quantity in stock pool 8. - `mostlikelypool9: optional number` Most likely quantity in stock pool 9. - `product_description: optional string` Product description. - `product_number: optional string` Product number. - `quantity: optional number` Live total quantity at this location. - `tags: optional array of string` Tags applied to the 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. - `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 (asc or desc). - `task_last_modified_date: optional string` Last modified date/time of the task. ### Example ```http curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/locations \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### 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" } ``` ## Retrieves products at a specific store location. **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 - `page_size: number` Maximum number of items returned per page. - `page_start: number` Current page number (1-based). - `total_count: number` Total number of records matching the query across all pages. - `list: optional array of object { barcode, customer_order_line_number, customer_order_number, 6 more }` Collection of items for the current page. - `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. - `product_number: optional string` Product number. - `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. - `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 (asc or desc). - `task_last_modified_date: optional string` Last modified date/time of the task. ### Example ```http curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/locations/$LOCATION_CODE/products \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "page_size": 0, "page_start": 0, "total_count": 0, "list": [ { "barcode": "barcode", "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", "image_url": "image_url", "product_description": "product_description", "product_number": "product_number", "quantity": 0 } ], "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" } ``` ## Retrieves products across one or more locations resolved by location code or jsonTag. **get** `/api/v2/public/stores/{store_number}/locations/products` Retrieves products across one or more locations resolved by location code or jsonTag. ### Path Parameters - `store_number: 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. - `jsonTag: optional string` Gall VC style location tag/location search value used to resolve one or more location codes. - `location_code: optional string` Optional direct location code 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 - `page_size: number` Maximum number of items returned per page. - `page_start: number` Current page number (1-based). - `total_count: number` Total number of records matching the query across all pages. - `list: optional array of object { barcode, customer_order_line_number, customer_order_number, 6 more }` Collection of items for the current page. - `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. - `product_number: optional string` Product number. - `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. - `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 (asc or desc). - `task_last_modified_date: optional string` Last modified date/time of the task. ### Example ```http curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/locations/products \ -H "Authorization: $COLLEQTIVE_BEARER_TOKEN" ``` #### Response ```json { "page_size": 0, "page_start": 0, "total_count": 0, "list": [ { "barcode": "barcode", "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", "image_url": "image_url", "product_description": "product_description", "product_number": "product_number", "quantity": 0 } ], "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" } ``` ## Domain Types ### Location List Locations Response - `LocationListLocationsResponse object { id, counter, created_on, 7 more }` Represents a location within a store, including stock and product data. - `id: number` Internal location identifier. - `counter: number` Number of products counted at this location. - `created_on: string` Date and time the location was created. - `location_order: number` Order in which the location appears in walking sequences. - `customer_orders: optional array of string` Customer orders associated with this location. - `default_stock_pool: optional string` Name of the default stock pool for this location. - `location_code: optional string` Code identifying the location within the store. - `quantity: optional number` Total stock quantity at this location. - `stock: optional array of object { customer_order_line_number, customer_order_number, customer_order_shipment_line_number, 14 more }` Per-product stock breakdown at this location. - `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. - `mostlikelypool1: optional number` Most likely quantity in stock pool 1. - `mostlikelypool10: optional number` Most likely quantity in stock pool 10. - `mostlikelypool2: optional number` Most likely quantity in stock pool 2. - `mostlikelypool3: optional number` Most likely quantity in stock pool 3. - `mostlikelypool4: optional number` Most likely quantity in stock pool 4. - `mostlikelypool5: optional number` Most likely quantity in stock pool 5. - `mostlikelypool6: optional number` Most likely quantity in stock pool 6. - `mostlikelypool7: optional number` Most likely quantity in stock pool 7. - `mostlikelypool8: optional number` Most likely quantity in stock pool 8. - `mostlikelypool9: optional number` Most likely quantity in stock pool 9. - `product_description: optional string` Product description. - `product_number: optional string` Product number. - `quantity: optional number` Live total quantity at this location. - `tags: optional array of string` Tags applied to the location. ### Location List Location Products Response - `LocationListLocationProductsResponse object { barcode, customer_order_line_number, customer_order_number, 6 more }` Represents a product found at a specific store location. - `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. - `product_number: optional string` Product number. - `quantity: optional number` Current stock quantity at this location. ### Location List Locations Products Response - `LocationListLocationsProductsResponse object { barcode, customer_order_line_number, customer_order_number, 6 more }` Represents a product found at a specific store location. - `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. - `product_number: optional string` Product number. - `quantity: optional number` Current stock quantity at this location.