Skip to content
Colleqtive Developer
Get started
API Reference
Locations

Retrieves products at a specific store location.

LocationListLocationProductsPageResponse Locations.ListLocationProducts(LocationListLocationProductsParamsparameters, CancellationTokencancellationToken = default)
GET/api/v2/public/stores/{store_number}/locations/{location_code}/products

Retrieves products at a specific store location.

ParametersExpand Collapse
LocationListLocationProductsParams parameters
required string storeNumber

Path param: The store number.

required string locationCode

Path param: The location code within the store.

string customerOrderNumber

Query param: Optional customer order number filter.

string customerOrderShipmentNumber

Query param: Optional customer order shipment number filter.

Int pageSize

Query param: The number of items per page.

formatint32
Int pageStart

Query param: The starting page index for pagination.

formatint32
string searchText

Query param: Optional text to search products by name or barcode.

string acceptLanguage

Header param: The preferred language for response content.

ReturnsExpand Collapse
class LocationListLocationProductsPageResponse:

Generic paginated response wrapper.

required IReadOnlyList<LocationListLocationProductsResponse> List

Collection of items for the current page.

required string ProductNumber

Product number.

string? Barcode

Product barcode.

Long? CustomerOrderLineNumber

Customer order line number.

formatint64
string? CustomerOrderNumber

Associated customer order number.

Int? CustomerOrderShipmentLineNumber

Customer order shipment line number.

formatint32
string? CustomerOrderShipmentNumber

Customer order shipment number.

string? ImageUrl

URL of the product image.

string ProductDescription

Product description.

Double? Quantity

Current stock quantity at this location.

formatdouble
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 products at a specific store location.

LocationListLocationProductsParams parameters = new()
{
    StoreNumber = "store_number",
    LocationCode = "location_code",
};

var page = await client.Locations.ListLocationProducts(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
{
  "list": [
    {
      "product_number": "PRD-001",
      "barcode": "8710400000123",
      "customer_order_line_number": 1,
      "customer_order_number": "CO-2025-001",
      "customer_order_shipment_line_number": 1,
      "customer_order_shipment_number": "SH-2025-001",
      "image_url": "https://cdn.example.com/products/prd-001.jpg",
      "product_description": "Organic Milk 1L",
      "quantity": 15
    }
  ],
  "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": [
    {
      "product_number": "PRD-001",
      "barcode": "8710400000123",
      "customer_order_line_number": 1,
      "customer_order_number": "CO-2025-001",
      "customer_order_shipment_line_number": 1,
      "customer_order_shipment_number": "SH-2025-001",
      "image_url": "https://cdn.example.com/products/prd-001.jpg",
      "product_description": "Organic Milk 1L",
      "quantity": 15
    }
  ],
  "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
}