Recomendações

Todos os endpoints exigem o header Authorization: Bearer {access_token} e devolvem application/json. Construa as URLs como {BASE_URL} + a rota indicada.

📡 Endpoints de extração

Listar todas as recomendações

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

Devolve, paginadas, todas as recomendações do domínio da sua organização.

<aside> ℹ️

Este endpoint usa paginação com tamanho fixo de 500 registros; o parâmetro limit não se aplica aqui. Percorra os resultados com page.

</aside>

Recomendações de um comércio

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

Parâmetro de rota	Descrição
`commerceId`	Identificador do comércio na YOM.

Uma recomendação pontual

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

Parâmetro de rota	Descrição
`commerceId`	Identificador do comércio.
`id`	Identificador da shopping list.

⚙️ Parâmetros de consulta

Aplicam-se aos endpoints de listagem (listar todas as recomendações e recomendações de um comércio):

Parâmetro	Tipo	Default	Descrição
`page`	inteiro	`1`	Número da página.
`limit`	inteiro	`10`	Registros por página. Aplica-se apenas ao endpoint por comércio (máximo 100). O endpoint de domínio usa tamanho fixo de 500.
`sort`	string	`-updatedAt`	Campo de ordenação. Prefixo `-` = descendente (ex. `-updatedAt`).
`type`	string	—	Filtra por tipo de lista (ex. `recommendation`).
`q`	string	—	Busca por nome (`name`).
`populate`	boolean	`false`	Enriquece a resposta resolvendo referências do comércio e do produto.

Exemplo — cURL:

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

Opção populate

Adicionar ?populate=true enriquece a resposta resolvendo referências diretamente. Resolve:

Comércio → identificador externo e canal (commerceId.contact.externalId, commerceId.channel).
Produto → o sku de cada item.

<aside> ℹ️

</aside>