New Shopee's Openapi Announcement (ID: 1572)
1. [BR] Novas APIs de Buybox (Hot Listing) para gerenciamento de produtos e dados de desempenho
**Olá desenvolvedores,
**
A Buybox, chamada de Hot Listing para os sellers, foi lançada no Brasil para destacar ofertas elegíveis e competitivas na página de detalhes do produto.Atualmente, sellers que gerenciam suas lojas por meio de sistemas ISV, como ERPs, não conseguem gerenciar a participação na Buybox nem consultar dados de desempenho relacionados a ela pela OpenAPI. Para atender a esses casos, serão disponibilizadas novas APIs que permitem consultar produtos participantes, atualizar o status de participação e obter dados de desempenho.
Escopo
ISVs e sellers do Brasil.
O que muda
Serão disponibilizadas as seguintes APIs de Buybox (Hot Listing):
| API |
Descrição |
| v2.buybox.get_buybox_models_by_shop_id |
Consulta informações de Buybox para as variações de produto aplicáveis da loja autorizada. Visualiza o vínculo com a Buybox, a elegibilidade, o status atual de participação e a data da última atualização. |
| v2.buybox.get_buybox_models_by_model_id |
Consulta o vínculo com a Buybox, a elegibilidade, o status atual de participação e a data da última atualização para os IDs de modelo informados. |
| v2.buybox.get_buybox_shop_performance |
Consulta dados de desempenho da loja na Buybox, incluindo unidades vendidas nos últimos sete dias, unidades vendidas no total, vendas e data de atualização dos dados. |
| v2.buybox.get_buybox_model_performance |
Consulta dados de desempenho na Buybox para as variações de produto informadas, incluindo unidades vendidas nos últimos sete dias e data de atualização dos dados. |
| v2.buybox.update_buybox_model_enrollment |
Atualiza a participação na Buybox no nível do modelo. Defina model_toggle_on_status como true para ativar a participação ou false para desativá-la. |
| v2.business_insights.get_marketing_hot_listing |
Consulta as métricas de Buybox (Hot Listing) disponíveis no Business Insights, incluindo CTR e outros indicadores de desempenho da loja e dos produtos. |
Observações- Buybox e Hot Listing são nomes diferentes para a mesma funcionalidade.
-
A participação na Buybox é gerenciada no nível do modelo. Ao chamar v2.buybox.update_buybox_model_enrollment, o sistema verificará se a atualização é permitida com base nas permissões da loja e nas regras de negócio aplicáveis.
-
Sellers Mall/Oficial podem gerenciar o próprio status de participação na Buybox. Para sellers que não são Mall/Oficial, a participação é gerenciada pela plataforma.
-
Os dados de desempenho seguem as definições de métricas e a lógica de cálculo já usadas no Business Insights da Central do Vendedor.
-
Esta atualização não incluirá notificações push da Buybox. Para consultar o status de participação e os dados de desempenho mais recentes, os desenvolvedores deverão chamar as APIs correspondentes.
APIs relacionadasv2.buybox.get_buybox_models_by_shop_id v2.buybox.get_buybox_models_by_model_id v2.buybox.get_buybox_shop_performance v2.buybox.get_buybox_model_performance
v2.buybox.update_buybox_model_enrollment v2.business_insights.get_marketing_hot_listing
Data de vigência: 24/09/2026
2. APIs de Produto passam a permitir buscar e vincular produtos padrão Shopee
O Produto Padrão Shopee (SSP) reúne informações padronizadas de produtos definidas pela Shopee, como título, imagens, categoria, marca, atributos principais e descrição. O Produto Padrão Shopee Filho (CSSP) representa essas informações padronizadas no nível do modelo.
Para permitir que sellers que usam ERPs ou sistemas próprios pesquisem SSPs, recebam recomendações, consultem detalhes, vinculem produtos e desfaçam vínculos, novas APIs serão disponibilizadas. Além disso, algumas APIs existentes de criação de produto e gerenciamento de modelos receberão atualizações.
Escopo
Filipinas (PH), Tailândia (TH), Brasil (BR), Indonésia (ID), Vietnã (VN) e Malásia (MY).
**O que muda:
****1. Atualizações em APIs existentes**As APIs abaixo passarão a aceitar ou retornar informações de vínculo com SSP/CSSP:
| API |
Descrição |
| v2.product.add_item |
Novos campos na requisição para enviar informações de vínculo com SSP/CSSP ao criar um produto. |
| v2.product.batch_add_item |
Novos campos na requisição para enviar informações de vínculo com SSP/CSSP ao criar produtos em lote. |
| v2.product.init_tier_variation |
Novos campos na requisição para enviar o ID do SSP e o ID do CSSP ao inicializar variações de produto. |
| v2.product.add_model |
Novos campos na requisição para enviar o ID do SSP e o ID do CSSP ao adicionar um modelo de produto. |
| v2.product.get_model_list |
Novos campos na resposta para retornar os IDs correspondentes de SSP e CSSP e as informações de vínculo ao consultar modelos de produto. |
2. Novas APIs
| API |
Descrição |
| v2.product.search_ssp_list |
Pesquisa SSPs/CSSPs compatíveis com base no título ou na imagem informada pelo seller. |
| v2.product.get_ssp_detail |
Consulta informações padronizadas do SSP/CSSP especificado, seu status atual e os vínculos com modelos. |
| v2.product.get_ssp_recommendation |
Consulta recomendações de SSP para um produto existente. Inclui opções que precisam da confirmação do seller e opções elegíveis para vínculo automático. |
| v2.product.link_item_to_ssp |
Vincula um produto existente ou modelos específicos a um SSP/CSSP. |
| v2.product.unlink_item_from_ssp |
Desfaz o vínculo de modelos específicos com um SSP/CSSP. Se for necessária uma análise, a API enviará uma solicitação de revisão do desvínculo. |
**Observações
- **Ao chamar v2.product.search_ssp_list, é necessário informar pelo menos o título do produto ou uma imagem. Se ambos forem enviados, a imagem terá prioridade na pesquisa.
**- **Apenas SSPs/CSSPs com status ACTIVE podem ser vinculados aos produtos.- v2.product.get_ssp_recommendation retorna dois tipos de recomendação: - Possível correspondência com SSP: pode corresponder ao produto e exige confirmação do seller antes do vínculo. - SSP elegível para vínculo automático: pode ser vinculado automaticamente. Se o seller não tomar nenhuma ação durante o período especificado, o sistema poderá concluir o vínculo ao fim da contagem regressiva.
- Vincular um produto existente a um SSP/CSSP não substituirá nem bloqueará as informações já cadastradas de categoria, especificações ou variações.- Após a chamada da API de desvínculo, o sistema concluirá o processo e não retornará um status de revisão. Os resultados de validação de consistência, notificações de vínculo automático, resultados de desvínculo e resultados de revisão do desvínculo poderão ser recebidos de forma assíncrona por meio de v2.ssp_update_push.- As mensagens push podem ser entregues mais de uma vez. Use event_id para evitar o processamento duplicado.- Os desenvolvedores devem atualizar a lógica de criação de produtos, gerenciamento de modelos e vínculo com SSP para considerar as novas APIs e os novos campos, além de processar corretamente os resultados assíncronos de validação e atualização de status.
APIs relacionadasv2.product.add_item v2.product.batch_add_item v2.product.init_tier_variation v2.product.get_model_list v2.product.add_model v2.product.search_ssp_list v2.product.get_ssp_recommendation v2.product.get_ssp_detail v2.product.link_item_to_ssp v2.product.unlink_item_from_ssp v2.ssp_update_push
Data de vigência: 24/09/2026
Announcement URL: https://open.shopee.com/announcements/1572
@junie-agent Please review the API changes described above. Focus ONLY on major updates such as adding new endpoints or removing/taking legacy APIs offline. You can safely ignore any other changes regarding request/response parameters or fields. Update the PHP code and create a new PR for review. Close issue if nothing changes applied.
New Shopee's Openapi Announcement (ID: 1572)
1. [BR] Novas APIs de Buybox (Hot Listing) para gerenciamento de produtos e dados de desempenho
**Olá desenvolvedores,
**
A Buybox, chamada de Hot Listing para os sellers, foi lançada no Brasil para destacar ofertas elegíveis e competitivas na página de detalhes do produto.Atualmente, sellers que gerenciam suas lojas por meio de sistemas ISV, como ERPs, não conseguem gerenciar a participação na Buybox nem consultar dados de desempenho relacionados a ela pela OpenAPI. Para atender a esses casos, serão disponibilizadas novas APIs que permitem consultar produtos participantes, atualizar o status de participação e obter dados de desempenho.
Escopo
ISVs e sellers do Brasil.
O que muda
Serão disponibilizadas as seguintes APIs de Buybox (Hot Listing):
Observações- Buybox e Hot Listing são nomes diferentes para a mesma funcionalidade.
A participação na Buybox é gerenciada no nível do modelo. Ao chamar v2.buybox.update_buybox_model_enrollment, o sistema verificará se a atualização é permitida com base nas permissões da loja e nas regras de negócio aplicáveis.
Sellers Mall/Oficial podem gerenciar o próprio status de participação na Buybox. Para sellers que não são Mall/Oficial, a participação é gerenciada pela plataforma.
Os dados de desempenho seguem as definições de métricas e a lógica de cálculo já usadas no Business Insights da Central do Vendedor.
Esta atualização não incluirá notificações push da Buybox. Para consultar o status de participação e os dados de desempenho mais recentes, os desenvolvedores deverão chamar as APIs correspondentes.
APIs relacionadasv2.buybox.get_buybox_models_by_shop_id v2.buybox.get_buybox_models_by_model_id v2.buybox.get_buybox_shop_performance v2.buybox.get_buybox_model_performance
v2.buybox.update_buybox_model_enrollment v2.business_insights.get_marketing_hot_listing
Data de vigência: 24/09/2026
2. APIs de Produto passam a permitir buscar e vincular produtos padrão Shopee
O Produto Padrão Shopee (SSP) reúne informações padronizadas de produtos definidas pela Shopee, como título, imagens, categoria, marca, atributos principais e descrição. O Produto Padrão Shopee Filho (CSSP) representa essas informações padronizadas no nível do modelo.
Para permitir que sellers que usam ERPs ou sistemas próprios pesquisem SSPs, recebam recomendações, consultem detalhes, vinculem produtos e desfaçam vínculos, novas APIs serão disponibilizadas. Além disso, algumas APIs existentes de criação de produto e gerenciamento de modelos receberão atualizações.
Escopo
Filipinas (PH), Tailândia (TH), Brasil (BR), Indonésia (ID), Vietnã (VN) e Malásia (MY).
**O que muda:
****1. Atualizações em APIs existentes**As APIs abaixo passarão a aceitar ou retornar informações de vínculo com SSP/CSSP:
2. Novas APIs
**Observações
- **Ao chamar v2.product.search_ssp_list, é necessário informar pelo menos o título do produto ou uma imagem. Se ambos forem enviados, a imagem terá prioridade na pesquisa.
**- **Apenas SSPs/CSSPs com status ACTIVE podem ser vinculados aos produtos.- v2.product.get_ssp_recommendation retorna dois tipos de recomendação: - Possível correspondência com SSP: pode corresponder ao produto e exige confirmação do seller antes do vínculo. - SSP elegível para vínculo automático: pode ser vinculado automaticamente. Se o seller não tomar nenhuma ação durante o período especificado, o sistema poderá concluir o vínculo ao fim da contagem regressiva.
- Vincular um produto existente a um SSP/CSSP não substituirá nem bloqueará as informações já cadastradas de categoria, especificações ou variações.- Após a chamada da API de desvínculo, o sistema concluirá o processo e não retornará um status de revisão. Os resultados de validação de consistência, notificações de vínculo automático, resultados de desvínculo e resultados de revisão do desvínculo poderão ser recebidos de forma assíncrona por meio de v2.ssp_update_push.- As mensagens push podem ser entregues mais de uma vez. Use event_id para evitar o processamento duplicado.- Os desenvolvedores devem atualizar a lógica de criação de produtos, gerenciamento de modelos e vínculo com SSP para considerar as novas APIs e os novos campos, além de processar corretamente os resultados assíncronos de validação e atualização de status.
APIs relacionadasv2.product.add_item v2.product.batch_add_item v2.product.init_tier_variation v2.product.get_model_list v2.product.add_model v2.product.search_ssp_list v2.product.get_ssp_recommendation v2.product.get_ssp_detail v2.product.link_item_to_ssp v2.product.unlink_item_from_ssp v2.ssp_update_push
Data de vigência: 24/09/2026
Announcement URL: https://open.shopee.com/announcements/1572
@junie-agent Please review the API changes described above. Focus ONLY on major updates such as adding new endpoints or removing/taking legacy APIs offline. You can safely ignore any other changes regarding request/response parameters or fields. Update the PHP code and create a new PR for review. Close issue if nothing changes applied.