POST /V1/inventory/in-store-pickup/pickup-locations/
POST /V1/inventory/in-store-pickup/pickup-locations/ is a Magento 2 REST endpoint in the InventoryInStorePickupApi module. Get Pickup Locations according to the results of filtration by Search Request. Callable anonymously — no Authorization header required.
Last verified: against Magento 2.4.9.
Returns
Magento\InventoryInStorePickupApi\Api\Data\SearchResultInterface
Service contract
Magento\InventoryInStorePickupApi\Api\GetPickupLocationsInterface::execute
Authorization
Anonymous — no Authorization header required.
Body parameters
Example request
Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.
Headers
Path
/V1/inventory/in-store-pickup/pickup-locations/Body
{
"searchRequest": {
"area": {
"radius": 0,
"search_term": ""
},
"current_page": 0,
"extension_attributes": {},
"filters": {
"city": {
"condition_type": "",
"value": ""
},
"country": {
"condition_type": "",
"value": ""
},
"name": {
"condition_type": "",
"value": ""
},
"pickup_location_code": {
"condition_type": "",
"value": ""
},
"postcode": {
"condition_type": "",
"value": ""
},
"region": {
"condition_type": "",
"value": ""
},
"region_id": {
"condition_type": "",
"value": ""
},
"street": {
"condition_type": "",
"value": ""
}
},
"page_size": 0,
"scope_code": "",
"scope_type": "",
"sort": [
{
"direction": "",
"field": ""
}
]
}
}Related in InventoryInStorePickupApi
Other endpoints shipped by the same module.
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.