Logo da Plataforma Yep
API REST · Plataforma Yep Documentação técnica para integrações homologadas

Novidades da API REST

Resumo das evoluções recentes já incorporadas à API e refletidas nesta documentação.

Changelog Hardening 2026

Setembro de 2026 — Exclusão total e seletiva de imagens em lote Novo

Nova operação de escrita na rota plural de imagens. A exclusão individual existente continua com o mesmo contrato.

Limpar a galeriaDELETE /api2/products/imagens com delete_all: true remove todas as imagens de um produto.
Exclusão seletiva em loteModo items remove imagens específicas de vários produtos em uma chamada.
Sem exclusão parcialO lote é validado antes; qualquer erro rejeita a requisição inteira.
  • Até 50 produtos e 500 image_ids únicos por requisição.
  • Validação de ownership: cada image_id precisa pertencer ao produto informado.
  • IDs já ausentes são contabilizados em already_absent_count, sem erro.
  • A exclusão em lote é global e não recebe store_id.
  • Exige a permissão products/images.
  • DELETE /api2/products/imagem continua disponível para remover uma imagem por chamada.

Ver em detalhe

Contrato completo em Catálogo › Imagens.

Setembro de 2026 — Consulta e inventário de imagens de produtos Novo

Publicação dos GETs somente leitura de imagens de produto, já validados em produção. A alteração é aditiva: os endpoints de upload, atualização e exclusão de imagens permanecem com o mesmo contrato.

Novo GET /api2/products/imagemConsulta as imagens de um produto por SKU ou ID, com papéis, rótulo, posição e disabled.
Novo GET /api2/products/imagensInventário global de imagens do catálogo para carga inicial e reconciliação completa.
Paginação por cursorhas_next e next_cursor, sem page ou offset.
  • Suporte explícito a store_id; 0 é o escopo administrativo/global.
  • Retorno dos papéis image, small_image e thumbnail; types=[] é válido.
  • Imagens desabilitadas são incluídas com disabled=true.
  • Produto existente sem imagens retorna 200 com images=[]; produto inexistente retorna 404.
  • Os novos GETs utilizam a permissão products/read e são somente leitura: não alteram produto, galeria, fila ou índices.
  • A atualização de imagem usa PUT; PATCH responde 405. A documentação foi corrigida.

Ver em detalhe

Documentação técnica completa na nova página Catálogo › Imagens. A coleção Postman foi atualizada com os três novos requests.

Setembro de 2026 — Consultas enriquecidas de catálogo Novo

Publicação das consultas homologadas de produto, preço e estoque. A alteração é aditiva: nenhum endpoint de criação, atualização, exclusão, fila ou listagem foi alterado.

Produto enriquecidoA consulta individual do GET /api2/products passa a incluir referências legíveis, resumo de preço e resumo de estoque.
Novo GET /api2/priceConsulta detalhada de preço com contexto explícito de store e grupo de cliente.
Novo GET /api2/stockConsulta detalhada da configuração de estoque, com disponibilidade efetiva para venda.
  • A consulta individual de produto passa a responder HTTP 200.
  • Os novos GETs são somente leitura: não criam filas nem executam reindexação.
  • Produtos configuráveis expõem a faixa indexada de preço quando aplicável e não agregam artificialmente a quantidade dos produtos associados.
  • Os campos históricos permanecem inalterados — os objetos enriquecidos são aditivos.

Ver em detalhe

Documentação técnica completa nas páginas de Produtos, Preços e Estoque.

Melhorias recentes da API

Principais entregas que reforçaram a estabilidade, a segurança e a previsibilidade da API.

  • Maior robustez no processamento de estoque e preços em fila.
  • Validação mais clara para campos, atributos e valores inválidos no update de produto.
  • Semântica melhorada para partial_success.
  • Reindex mais enxuto e seletivo.
  • Hardening de OAuth, auditoria e endpoints operacionais.

Novas capacidades já disponíveis

OAuth seguroNovos client_secret com armazenamento protegido e mascaramento no admin.
Update parcial transparenteResposta clara com invalid_fields, invalid_attributes e invalid_attribute_values.
Operação mais previsívelFila robusta, claim atômico e reindex seletivo.

Evoluções no endpoint de produtos

Três melhorias recentes tornam o GET /api2/products mais determinístico em multi-store e mais eficiente para sincronizações em lote.

store_id opcionalSeleção explícita da store em ambientes multi-store.
Metadados de paginaçãototal, last_page e has_next via include_pagination=1.
limit configurávelPadrão 20, máximo 200, inválidos normalizados.

Ver em detalhe

Documentação técnica completa na página de Produtos.

Evoluções no endpoint de categorias Novo

O GET /api2/category agora suporta listagem paginada com as mesmas garantias já disponíveis no endpoint de produtos. É possível percorrer toda a árvore sem precisar consultar uma categoria por vez.

Listagem completaGET /api2/category retorna todas as categorias com paginação previsível.
limit configurávelPadrão 20, máximo 200, inválidos normalizados para o padrão.
store_id opcionalContexto multi-store explícito e determinístico.
Metadados opcionaistotal, last_page e has_next via include_pagination=1.
Busca por ID?id=61 preservado para consulta individual.
Paginação determinística?page=N percorre a árvore com segurança.

Ver em detalhe

Documentação técnica completa na página de Categorias.