Retrieves products across one or more locations resolved by location code or jsonTag.

LocationListLocationsProductsPageResponse Locations.ListLocationsProducts(, )

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

ParametersExpand Collapse

LocationListLocationsProductsParams parameters

required string storeNumber

Path param: The store number.

Boolean advanceSearch

Query param: When true, enables advanced search mode.

string customerOrderNumber

Query param: Optional customer order number filter.

string customerOrderShipmentNumber

Query param: Optional customer order shipment number filter.

string jsonTag

Query param: Gall VC style location tag/location search value used to resolve one or more location codes.

string locationCode

Query param: Optional direct location code 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 LocationListLocationsProductsPageResponse:

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

Retrieves products across one or more locations resolved by location code or jsonTag.

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

var page = await client.Locations.ListLocationsProducts(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"
}

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