Recommendations API

Integrating with the Recommendations API lets YOM customers query and download the order recommendations generated for their commerces, through REST endpoints over HTTPS with OAuth 2.0 authentication (client credentials).

What is it?

YOM generates order recommendations that are made available to the customer through REST endpoints. The customer sends GET requests to retrieve the recommendation lists for their commerces. Access is:

Read-only — you can query and download data; you cannot create, modify, or delete it.
Scoped to your domain — each credential can access only its own organization's data.

<aside> ℹ️

Data availability depends on recommendations having been generated for your organization in the corresponding environment.

</aside>

🌎 Environments

The technical contract applies to both Staging and Production. The endpoints, parameters, response structure, authentication, and consumption rules are identical in both environments.

Environment	Base URL (`BASE_URL`)	Your organization's domain
Staging	`https://api.solopide.me`	`{cliente}.solopide.me`
Production	`https://api.youorder.me`	`{cliente}.youorder.me`

<aside> 🔑

Credentials are specific to each environment and will be delivered by YOM through a secure channel. Do not use Staging credentials in Production, or vice versa.

</aside>

Previous steps

Changelog

</aside>

Next steps

Authentication

</aside>