Mídia do produto

A mídia de um produto é tudo o que acompanha o cadastro dele e ajuda a vender. Pela API legada, compatível com a Venddor 1.0, você lê a galeria de imagens do produto: o endereço de cada foto, a ordem de exibição e qual delas é a principal.

A API trabalha com endereços (URLs): ela não guarda o arquivo da imagem, ela devolve onde o arquivo está hospedado (CDN, armazenamento da loja).

Como funciona

Um produto novo nasce sem imagens. Para conferir a galeria de um produto, chame Imagens do produto com o product_id. A lista vem na ordem de position.

Conceitos-chave

Posição e imagem principal

Cada imagem tem uma position (inteiro, a partir de 0) que define a ordem de exibição. Duas imagens podem ter o mesmo número.

A imagem principal (is_primary) é a que aparece nas listagens, no carrinho e nos compartilhamentos. Há no máximo uma por produto.

Identificadores

O {id} do produto nas rotas é sempre o UUID do produto, nunca o código. Na forma sem versão (/api/products/...), o id do produto no caminho pode ser o número decimal e os ids da resposta saem como números decimais em string.

Quem pode ler

A rota exige um administrador (HTTP Basic com e-mail:chave_de_api, ou Bearer). Um usuário sem permissão de administrador recebe 403.

Endpoints

Auth: Admin é o administrador (Basic ou Bearer).

Erros comuns

• Usar o código do produto no caminho. O {id} é o UUID do produto. Um valor que não é UUID (nem decimal válido) devolve 500.
• Esperar 404 para um produto que não existe. A lista de um produto inexistente volta 200 com "images": [] e "total": 0. Confirme o produto antes.
• Esperar imagens em um produto novo. Um produto recém-criado não tem galeria.

Próximos passos