Retrieves locations for a specific store.

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

Path ParametersExpand Collapse

store_number: string

Query ParametersExpand Collapse

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

ReturnsExpand Collapse

page_size: number

Maximum number of items returned per page.

formatint32

page_start: number

Current page number (1-based).

formatint32

total_count: number

Total number of records matching the query across all pages.

formatint64

list: optional array of object { id, counter, created_on, 7 more }

Collection of items for the current page.

id: number

Internal location identifier.

formatint64

counter: number

Number of products counted at this location.

formatint32

created_on: string

Date and time the location was created.

formatdate-time

location_order: number

Order in which the location appears in walking sequences.

formatint32

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.

formatdouble

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.

formatint32

customer_order_number: optional string

Associated customer order number.

customer_order_shipment_line_number: optional number

Customer order shipment line number.

formatint32

customer_order_shipment_number: optional string

Customer order shipment number.

mostlikelypool1: optional number

Most likely quantity in stock pool 1.

formatdouble

mostlikelypool10: optional number

Most likely quantity in stock pool 10.

formatdouble

mostlikelypool2: optional number

Most likely quantity in stock pool 2.

formatdouble

mostlikelypool3: optional number

Most likely quantity in stock pool 3.

formatdouble

mostlikelypool4: optional number

Most likely quantity in stock pool 4.

formatdouble

mostlikelypool5: optional number

Most likely quantity in stock pool 5.

formatdouble

mostlikelypool6: optional number

Most likely quantity in stock pool 6.

formatdouble

mostlikelypool7: optional number

Most likely quantity in stock pool 7.

formatdouble

mostlikelypool8: optional number

Most likely quantity in stock pool 8.

formatdouble

mostlikelypool9: optional number

Most likely quantity in stock pool 9.

formatdouble

product_description: optional string

Product description.

product_number: optional string

Product number.

quantity: optional number

Live total quantity at this location.

formatdouble

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.

formatint32

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 (asc or desc).

task_last_modified_date: optional string

Last modified date/time of the task.

Retrieves locations for a specific store.

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

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