# Get Pickup Locations according to the results of filtration by Search Request

**GET /V1/inventory/in-store-pickup/pickup-locations/**

Get Pickup Locations according to the results of filtration by Search Request.


## Servers
- https://magento2.winkelstraat.mac/rest/all: https://magento2.winkelstraat.mac/rest/all ()



## Parameters


#### Query parameters
- **searchRequest[area][radius]** (integer)
  Search radius in KM.
- **searchRequest[area][searchTerm]** (string)
  Search term string.
- **searchRequest[filters][country][value]** (string)
  Value.
- **searchRequest[filters][country][conditionType]** (string)
  Condition Type.
- **searchRequest[filters][postcode][value]** (string)
  Value.
- **searchRequest[filters][postcode][conditionType]** (string)
  Condition Type.
- **searchRequest[filters][region][value]** (string)
  Value.
- **searchRequest[filters][region][conditionType]** (string)
  Condition Type.
- **searchRequest[filters][regionId][value]** (string)
  Value.
- **searchRequest[filters][regionId][conditionType]** (string)
  Condition Type.
- **searchRequest[filters][city][value]** (string)
  Value.
- **searchRequest[filters][city][conditionType]** (string)
  Condition Type.
- **searchRequest[filters][street][value]** (string)
  Value.
- **searchRequest[filters][street][conditionType]** (string)
  Condition Type.
- **searchRequest[filters][name][value]** (string)
  Value.
- **searchRequest[filters][name][conditionType]** (string)
  Condition Type.
- **searchRequest[filters][pickupLocationCode][value]** (string)
  Value.
- **searchRequest[filters][pickupLocationCode][conditionType]** (string)
  Condition Type.
- **searchRequest[pageSize]** (integer)
  Page size.
- **searchRequest[currentPage]** (integer)
  Current page.
- **searchRequest[scopeType]** (string)
  Sales Channel Type.
- **searchRequest[scopeCode]** (string)
  Sales Channel code.
- **searchRequest[sort][0][field]** (string)
  Sorting field.
- **searchRequest[sort][0][direction]** (string)
  Sorting direction.
- **searchRequest[extensionAttributes][productsInfo][0][sku]** (string)
  Product SKU.


## Responses
### 200: 200 Success.

#### Body Parameters:  (object)
- **items** (array[object])
  Represents sources projection on In-Store Pickup context. Realisation must follow immutable DTO concept. Partial immutability done according to restriction of current Extension Attributes implementation.
- **search_request** (object)
  Endpoint used to search Pickup Locations by different parameters: - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface Also, endpoint supports paging and sort orders.
- **total_count** (integer)
  Total count.

### default: Unexpected error

#### Body Parameters:  (object)
- **message** (string)
  Error message
- **errors** (array[object])
  Error details
- **code** (integer)
  Error code
- **parameters** (array[object])
  Error parameters item
- **trace** (string)
  Stack trace


[Powered by Bump.sh](https://bump.sh)