Skip to content
Colleqtive Developer
Get started
API Reference
Locations

List Location Products

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

Products at one location, addressed by location_code. To query several locations at once use /stores/{store_number}/locations/products.

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: Number of products per page.

formatint32
Int pageStart

Query param: Page number, starting at 1. Defaults to 1.

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 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<LocationListLocationProductsResponse>? List

Collection of items for the current page.

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.

string? ProductNumber

Product number.

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? 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.

List Location Products

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);
}
{
  "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"
}
{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}
{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}
Returns Examples
{
  "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"
}
{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}
{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}