Retrieves locations for a specific store.

LocationListLocationsPageResponse Locations.ListLocations(, )

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

ParametersExpand Collapse

LocationListLocationsParams parameters

required string storeNumber

The store number to get locations for.

string acceptLanguage

string appUsername

Boolean ignoreCustomerorderStock

When true, excludes customer order stock from results.

Int pageSize

formatint32

Int pageStart

formatint32

string searchText

ReturnsExpand Collapse

class LocationListLocationsPageResponse:

Generic paginated response wrapper.

required IReadOnlyList<LocationListLocationsResponse> List

Collection of items for the current page.

required string LocationCode

Long ID

formatint64

Int Counter

formatint32

DateTimeOffset CreatedOn

formatdate-time

IReadOnlyList<string> CustomerOrders

string DefaultStockPool

Int LocationOrder

formatint32

Double? Quantity

formatdouble

IReadOnlyList<Stock> Stock

Int? CustomerOrderLineNumber

formatint32

string? CustomerOrderNumber

Int? CustomerOrderShipmentLineNumber

formatint32

string? CustomerOrderShipmentNumber

Double? Mostlikelypool1

formatdouble

Double? Mostlikelypool10

formatdouble

Double? Mostlikelypool2

formatdouble

Double? Mostlikelypool3

formatdouble

Double? Mostlikelypool4

formatdouble

Double? Mostlikelypool5

formatdouble

Double? Mostlikelypool6

formatdouble

Double? Mostlikelypool7

formatdouble

Double? Mostlikelypool8

formatdouble

Double? Mostlikelypool9

formatdouble

string? ProductDescription

string? ProductNumber

Double? Quantity

formatdouble

IReadOnlyList<string> Tags

IReadOnlyDictionary<string, JsonElement>? ListBody

Additional body-level metadata for the list.

IReadOnlyDictionary<string, IReadOnlyList<string>>? ListFilters

Active filter criteria applied to the result set, keyed by field name.

Int? NextPage

Next page number, or null when on the last page.

formatint32

Long PageSize

Maximum number of items returned per page.

formatint64

Long PageStart

Current page number (1-based).

formatint64

Long? PreviousPage

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

formatint64

string? ProjectLastModifiedDate

Last modified date/time of the project.

string? ScrollID

Opaque scroll identifier for deep-pagination scenarios.

string? ServerTime

Server UTC date/time when the response was generated.

string? SortColumn

Column name the results are sorted by.

string? SortOrder

Sort direction.

string? TaskLastModifiedDate

Last modified date/time of the task.

Long TotalCount

Total number of records matching the query across all pages.

formatint64

Retrieves locations for a specific store.

LocationListLocationsParams parameters = new() { StoreNumber = "store_number" };

var page = await client.Locations.ListLocations(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

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