Log in
Interface

SearchRequestInterface

Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface

What it does

This interface defines the contract for searching pickup locations in Magento's In-Store Pickup feature.

Developers use this to build search requests that can filter pickup locations by attributes, distance/area, and include pagination, sorting, and scope (sales channel) parameters.

It's typically used when implementing store locator functionality or finding available pickup locations for customer orders.

Public Methods

  • getArea()
  • getFilters()
  • getPageSize()
  • getCurrentPage()
  • getScopeType()
  • getScopeCode()
  • getSort()
  • setExtensionAttributes()
  • getExtensionAttributes()