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.

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.
Hide response attributes Show response attributes object
Search results for providing pickup locations.
- items array[object] Required
  
  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.
  
  Hide items attributes Show items attributes 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.
  
  pickup_location_code string Required
  
  Source code of Pickup Location.
  
  name string
  
  Pickup Location name.
  
  email string
  
  Pickup Location contact email.
  
  fax string
  
  Fax contact info.
  
  contact_name string
  
  Pickup Location contact name.
  
  description string
  
  Pickup Location description.
  
  latitude number
  
  Pickup Location latitude.
  
  longitude number
  
  Pickup Location longitude.
  
  country_id string
  
  Pickup Location country ID.
  
  region_id integer
  
  Pickup Location region ID.
  
  region string
  
  Pickup Location region.
  
  city string
  
  Pickup Location city.
  
  street string
  
  Pickup Location street.
  
  postcode string
  
  Pickup Location postcode.
  
  phone string
  
  Pickup Location phone.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface
- search_request object Required
  
  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.
  
  Hide search_request attributes Show search_request attributes object
  
  area object
  
  Filter by Distance to the Address. Pickup Locations will be filtered by distance according to the geo-position of the entered address. Required fields for the address are country and one of the field: region or city or postcode.
  
  Hide area attributes Show area attributes object
  
  radius integer Required
  
  Search radius in KM.
  
  search_term string Required
  
  Search term string.
  
  filters object
  
  Filter to filter by Fields. Each field may be filtered with different condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface
  
  Hide filters attributes Show filters attributes object
  
  country object
  
  Filter for Pickup Location search.
  
  Hide country attributes Show country attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  postcode object
  
  Filter for Pickup Location search.
  
  Hide postcode attributes Show postcode attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  region object
  
  Filter for Pickup Location search.
  
  Hide region attributes Show region attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  region_id object
  
  Filter for Pickup Location search.
  
  Hide region_id attributes Show region_id attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  city object
  
  Filter for Pickup Location search.
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  street object
  
  Filter for Pickup Location search.
  
  Hide street attributes Show street attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  name object
  
  Filter for Pickup Location search.
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  pickup_location_code object
  
  Filter for Pickup Location search.
  
  Hide pickup_location_code attributes Show pickup_location_code attributes object
  
  value string Required
  
  Value.
  
  condition_type string Required
  
  Condition Type.
  
  page_size integer
  
  Page size.
  
  current_page integer Required
  
  Current page.
  
  scope_type string Required
  
  Sales Channel Type.
  
  scope_code string Required
  
  Sales Channel code.
  
  sort array[object]
  
  Data object for sort order.
  
  Hide sort attributes Show sort attributes object
  
  Data object for sort order.
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  products_info array[object]
  
  Product Info Data Transfer Object.
  
  Hide products_info attributes Show products_info attributes object
  
  Product Info Data Transfer Object.
  
  sku string Required
  
  Product SKU.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface
- total_count integer Required
  
  Total count.
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

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

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/inventory/in-store-pickup/pickup-locations/

Response examples (200)

{
  "items": [
    {
      "pickup_location_code": "string",
      "name": "string",
      "email": "string",
      "fax": "string",
      "contact_name": "string",
      "description": "string",
      "latitude": 42.0,
      "longitude": 42.0,
      "country_id": "string",
      "region_id": 42,
      "region": "string",
      "city": "string",
      "street": "string",
      "postcode": "string",
      "phone": "string",
      "extension_attributes": {}
    }
  ],
  "search_request": {
    "area": {
      "radius": 42,
      "search_term": "string"
    },
    "filters": {
      "country": {
        "value": "string",
        "condition_type": "string"
      },
      "postcode": {
        "value": "string",
        "condition_type": "string"
      },
      "region": {
        "value": "string",
        "condition_type": "string"
      },
      "region_id": {
        "value": "string",
        "condition_type": "string"
      },
      "city": {
        "value": "string",
        "condition_type": "string"
      },
      "street": {
        "value": "string",
        "condition_type": "string"
      },
      "name": {
        "value": "string",
        "condition_type": "string"
      },
      "pickup_location_code": {
        "value": "string",
        "condition_type": "string"
      }
    },
    "page_size": 42,
    "current_page": 42,
    "scope_type": "string",
    "scope_code": "string",
    "sort": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "extension_attributes": {
      "products_info": [
        {
          "sku": "string",
          "extension_attributes": {}
        }
      ]
    }
  },
  "total_count": 42
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}