API Reference

Locations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieves locations for a specific store.

LocationListLocationsPageResponse Locations.ListLocations(LocationListLocationsParamsparameters, CancellationTokencancellationToken = default)

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

Retrieves locations for a specific store.

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 Int PageSize

Maximum number of items returned per page.

formatint32

required Int PageStart

Current page number (1-based).

formatint32

required Long TotalCount

Total number of records matching the query across all pages.

formatint64

IReadOnlyList<LocationListLocationsResponse>? List

Collection of items for the current page.

required Long ID

Internal location identifier.

formatint64

required Int Counter

Number of products counted at this location.

formatint32

required DateTimeOffset CreatedOn

Date and time the location was created.

formatdate-time

required Int LocationOrder

Order in which the location appears in walking sequences.

formatint32

IReadOnlyList<string>? CustomerOrders

Customer orders associated with this location.

string? DefaultStockPool

Name of the default stock pool for this location.

string? LocationCode

Code identifying the location within the store.

Double? Quantity

Total stock quantity at this location.

formatdouble

IReadOnlyList<Stock>? Stock

Per-product stock breakdown at this location.

Int? CustomerOrderLineNumber

Customer order line number.

formatint32

string? CustomerOrderNumber

Associated customer order number.

Int? CustomerOrderShipmentLineNumber

Customer order shipment line number.

formatint32

string? CustomerOrderShipmentNumber

Customer order shipment number.

Double? Mostlikelypool1

Most likely quantity in stock pool 1.

formatdouble

Double? Mostlikelypool10

Most likely quantity in stock pool 10.

formatdouble

Double? Mostlikelypool2

Most likely quantity in stock pool 2.

formatdouble

Double? Mostlikelypool3

Most likely quantity in stock pool 3.

formatdouble

Double? Mostlikelypool4

Most likely quantity in stock pool 4.

formatdouble

Double? Mostlikelypool5

Most likely quantity in stock pool 5.

formatdouble

Double? Mostlikelypool6

Most likely quantity in stock pool 6.

formatdouble

Double? Mostlikelypool7

Most likely quantity in stock pool 7.

formatdouble

Double? Mostlikelypool8

Most likely quantity in stock pool 8.

formatdouble

Double? Mostlikelypool9

Most likely quantity in stock pool 9.

formatdouble

string? ProductDescription

Product description.

string? ProductNumber

Product number.

Double? Quantity

Live total quantity at this location.

formatdouble

IReadOnlyList<string>? Tags

Tags applied to the location.

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

string? TaskLastModifiedDate

Last modified date/time of the task.

Retrieves locations for a specific store.

C#

HTTP

C#

Python

TypeScript

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

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

200 example

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

200 example

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