Hello Retail Search API
On-site search across products, categories, brands, and content.
Hello Retail Search API is one of 4 APIs that Hello Retail 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, API documentation, a getting-started guide, and authentication docs.
This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://core.helloretail.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hello Retail Search API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (API Key) (bearerAuth).
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
On-site search across products, categories, brands, and content.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SearchRequest (13 properties), SearchResponse (9 properties), ContentTypeResult (8 properties), ContentTypeQuery (8 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 Hello Retail 3
Other APIs Hello Retail publishes across the network.