Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hello Retail Recommendations API

Managed and unmanaged product recommendation requests.

Hello Retail Recommendations 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 Recommendations. 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 6 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.

1 operations 1 paths 6 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://core.helloretail.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hello Retail Recommendations 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.

Recommendations 1

Managed and unmanaged product recommendation requests.

POST
/serve/recoms
Request product recommendations
getRecommendations body → 200400401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Product (8 properties), UnmanagedRecomRequest (6 properties), RecomRequest (6 properties), ManagedRecomRequest (5 properties). Each schema is shown below with its type and property counts.

RecomRequest
object
6 properties 1 required
UnmanagedRecomRequest
object
6 properties 3 required
ProductSource
object
2 properties 1 required
ManagedRecomRequest
object
5 properties 2 required
Product
object
8 properties
RecomResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hello-retail-recommendations-api-openapi.yml Raw ↑

Other APIs Hello Retail publishes across the network.

Hello Retail Customer Bias API
Hello Retail Pages API
Hello Retail Search API