Log in
Interface

SearchRequestBuilderInterface

Magento\InventoryInStorePickupApi\Model\SearchRequestBuilderInterface

What it does

This builder interface creates search requests for finding in-store pickup locations.

Developers use it to build queries with various filters (address, location name, radius), pagination, and sorting options before executing the search.

It follows the builder pattern, allowing method chaining to construct complex search criteria for pickup location lookups.

Public Methods

  • create()
  • setStreetFilter()
  • setPostcodeFilter()
  • setCityFilter()
  • setRegionIdFilter()
  • setRegionFilter()
  • setCountryFilter()
  • setAreaRadius()
  • setAreaSearchTerm()
  • setSearchRequestExtension()
  • setSortOrders()
  • setScopeCode()
  • setScopeType()
  • setPickupLocationCodeFilter()
  • setNameFilter()
  • setCurrentPage()
  • setPageSize()