Elastic Path Search API
The Search API enables you to search for products in your published catalogs. Search provides powerful capabilities including full-text search, filtering, faceting, and sorting to help shoppers find products quickly and efficiently.### How Search WorksWhen you publish a catalog with search enabled, the catalog's products are automatically indexed for search. The search index contains product data optimized for fast querying, including product names, descriptions, SKUs, categories, prices, and any custom fields you've configured.There are two types of search operations:- **Search**: Execute a single search query against a catalog. Use the GET endpoint for simple searches with query parameters.- **Multi-search**: Execute multiple search queries in a single request. Use the POST endpoint to batch searches together for improved performance.### Search Features- **Full-text search**: Search across product names, descriptions, SKUs, and custom fields with typo tolerance and relevance ranking- **Filtering**: Narrow results using conditions on product attributes, categories, prices, and custom fields- **Faceting**: Get aggregated counts for attribute values to build dynamic navigation and refinement options- **Sorting**: Order results by price, name, custom fields, or relevance score- **Highlighting**: Get highlighted snippets showing where search terms match in product fields- **Autocomplete**: Get search suggestions as shoppers type their queries### Shopper ContextSearch results are personalized based on the shopper's context. The system automatically determines which catalog and prices to use based on:- **Channel**: The shopping experience (web, mobile, B2B portal)- **Account**: For B2B scenarios, the account and parent accounts- **Customer**: The logged-in customer's segment- **Tags**: Custom context tags for advanced segmentationThis context is provided via request headers and is used to resolve the appropriate catalog rules and price books.### Admin vs Shopper Endpoints- **Shopper endpoints** (`/pcm/catalog/search`, `/pcm/catalog/multi-search`): Use shopper context headers to automatically resolve the correct catalog and prices.- **Admin endpoints** (`/pcm/catalogs/{catalog_id}/releases/{release_id}/search`): Directly specify the catalog and release to search, useful for previewing releases or testing.
Elastic Path Search API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 4 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Search API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The Search API enables you to search for products in your published catalogs. Search provides powerful capabilities including full-text search, filtering, faceting, and sorting to…
Schemas 17
The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are SearchQuery (9 properties), SearchResult (9 properties), Product (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.