# Locations

## List Locations

`LocationListLocationsPageResponse Locations.ListLocations(LocationListLocationsParamsparameters, CancellationTokencancellationToken = default)`

**get** `/api/v2/public/stores/{store_number}/locations`

Retrieves locations for a specific store.

### Parameters

- `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`

  - `Int pageStart`

  - `string searchText`

### Returns

- `class LocationListLocationsPageResponse:`

  Generic paginated response wrapper.

  - `required IReadOnlyList<LocationListLocationsResponse> List`

    Collection of items for the current page.

    - `required string LocationCode`

    - `Long ID`

    - `Int Counter`

    - `DateTimeOffset CreatedOn`

    - `IReadOnlyList<string> CustomerOrders`

    - `string DefaultStockPool`

    - `Int LocationOrder`

    - `Double? Quantity`

    - `IReadOnlyList<Stock> Stock`

      - `Int? CustomerOrderLineNumber`

      - `string? CustomerOrderNumber`

      - `Int? CustomerOrderShipmentLineNumber`

      - `string? CustomerOrderShipmentNumber`

      - `Double? Mostlikelypool1`

      - `Double? Mostlikelypool10`

      - `Double? Mostlikelypool2`

      - `Double? Mostlikelypool3`

      - `Double? Mostlikelypool4`

      - `Double? Mostlikelypool5`

      - `Double? Mostlikelypool6`

      - `Double? Mostlikelypool7`

      - `Double? Mostlikelypool8`

      - `Double? Mostlikelypool9`

      - `string? ProductDescription`

      - `string? ProductNumber`

      - `Double? Quantity`

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

  - `Long PageSize`

    Maximum number of items returned per page.

  - `Long PageStart`

    Current page number (1-based).

  - `Long? PreviousPage`

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

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

### Example

```csharp
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 Products

`LocationListLocationProductsPageResponse Locations.ListLocationProducts(LocationListLocationProductsParamsparameters, CancellationTokencancellationToken = default)`

**get** `/api/v2/public/stores/{store_number}/locations/{location_code}/products`

Retrieves products at a specific store location.

### Parameters

- `LocationListLocationProductsParams parameters`

  - `required string storeNumber`

    Path param: The store number.

  - `required string locationCode`

    Path param: The location code within the store.

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

  - `Int pageSize`

    Query param: The number of items per page.

  - `Int pageStart`

    Query param: The starting page index for pagination.

  - `string searchText`

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

  - `string acceptLanguage`

    Header param: The preferred language for response content.

### Returns

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

    - `string? CustomerOrderNumber`

      Associated customer order number.

    - `Int? CustomerOrderShipmentLineNumber`

      Customer order shipment line number.

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

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

  - `Long PageSize`

    Maximum number of items returned per page.

  - `Long PageStart`

    Current page number (1-based).

  - `Long? PreviousPage`

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

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

### Example

```csharp
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);
}
```