Recomendaciones

Todos los endpoints requieren el header Authorization: Bearer {access_token} y devuelven application/json. Construya las URLs como {BASE_URL} + la ruta indicada.

📡 Endpoints de extracción

Listar todas las recomendaciones

GET {BASE_URL}/api/v2/shopping-lists/

Devuelve, paginadas, todas las recomendaciones del dominio de su organización.

<aside> ℹ️

Este endpoint usa paginación con tamaño fijo de 500 registros; el parámetro limit no aplica aquí. Recorra los resultados con page.

</aside>

Recomendaciones de un comercio

GET {BASE_URL}/api/v2/shopping-lists/{commerceId}/lists/

Parámetro de ruta	Descripción
`commerceId`	Identificador del comercio en YOM.

Una recomendación puntual

GET {BASE_URL}/api/v2/shopping-lists/{commerceId}/lists/{id}

Parámetro de ruta	Descripción
`commerceId`	Identificador del comercio.
`id`	Identificador de la shopping list.

⚙️ Parámetros de consulta

Aplican a los endpoints de listado (listar todas las recomendaciones y recomendaciones de un comercio):

Parámetro	Tipo	Default	Descripción
`page`	entero	`1`	Número de página.
`limit`	entero	`10`	Registros por página. Solo aplica al endpoint por comercio (máximo 100). El endpoint de dominio usa tamaño fijo de 500.
`sort`	string	`-updatedAt`	Campo de orden. Prefijo `-` = descendente (ej. `-updatedAt`).
`type`	string	—	Filtra por tipo de lista (ej. `recommendation`).
`q`	string	—	Búsqueda por nombre (`name`).
`populate`	boolean	`false`	Enriquece la respuesta resolviendo referencias del comercio y del producto.

Ejemplo — cURL:

curl "{BASE_URL}/api/v2/shopping-lists/{commerceId}/lists/?limit=100&page=1&sort=-updatedAt" \
  -H "Authorization: Bearer {access_token}"

Opción populate

Agregar ?populate=true enriquece la respuesta resolviendo referencias directamente. Resuelve:

Comercio → identificador externo y canal (commerceId.contact.externalId, commerceId.channel).
Producto → el sku de cada ítem.

<aside> ℹ️

</aside>