Imagens do produto

Lista as imagens de um produto, com a posição, a imagem principal e os endereços de cada uma.

As imagens de um produto formam a galeria da página dele na loja. Cada imagem tem uma posição (a ordem de exibição) e pode ser a imagem principal, a que aparece nas listagens e no carrinho. Esta página cobre a leitura da galeria.

Toda imagem é referenciada por URL: a API não guarda o arquivo, ela devolve o endereço onde a imagem está hospedada (um CDN, o armazenamento da loja).

Listar as imagens

GET/api/v1.0/products/{id}/imagesAdmin

Listar as imagens de um produto

Autenticação: HTTP Basic (e-mail:chave_de_api) de um administrador, ou Authorization: Bearer <JWT>. Também responde em /api/products/{id}/images; nessa forma, o id do produto no caminho pode ser o número decimal e os ids na resposta saem como números decimais dentro de uma string.

Parâmetros de caminho

idstringobrigatório

Id do produto (UUID em /api/v1.0, UUID ou decimal em /api/products).

GET/api/products/{id}/imagesAdmin

Listar as imagens de um produto

Mesma operação, na forma sem versão. Muda só o formato dos ids: product_id, image_id e pair_id voltam como números decimais em string ("95805399"), derivados do UUID.

Parâmetros de caminho

idstringobrigatório

Id do produto (UUID ou decimal).

Exemplo de requisição

Resposta

200Imagens do produto

Campos da resposta

product_idstring

Id do produto, ecoado. UUID em /api/v1.0, decimal em string em /api/products.

totalinteger

Quantidade de imagens.

imagesarray

Imagens em ordem de position.

pair_idstring

Id da imagem. É igual a image_id (na Venddor 1.0, o "par" é o conjunto imagem grande e miniatura).

image_idstring

Id da imagem. Identificador da imagem.

positioninteger

Posição de exibição, a partir de 0.

is_primarystring

"Y" na imagem principal, "N" nas demais.

detailedobject

Imagem em tamanho cheio: image_path (URL) e alt (texto alternativo, pode ser vazio).

iconsobject

Miniatura: o mesmo endereço com ?w=100 no final, e o mesmo alt. Não é um arquivo separado: é um pedido de largura 100 ao CDN.

Erros

Status	Quando	Corpo
401	Sem credenciais.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	O usuário não é administrador.	`{"message":"...","status":403}`
500	O id não tem formato de UUID (nem decimal válido).	`{"message":"Failed to retrieve product images","status":500}`

Um produto que não existe devolve 200 com "images": [] e "total": 0: não há 404 nesta rota.

Veja também

Mídia do produto: visão geral, limites e o mapa das rotas.
Consultar produto: a galeria também vem dentro do produto.

Imagens do produto

Lista as imagens de um produto, com a posição, a imagem principal e os endereços de cada uma.

Toda imagem é referenciada por URL: a API não guarda o arquivo, ela devolve o endereço onde a imagem está hospedada (um CDN, o armazenamento da loja).

Listar as imagens

GET/api/v1.0/products/{id}/imagesAdmin

Listar as imagens de um produto

Parâmetros de caminho

idstringobrigatório

Id do produto (UUID em /api/v1.0, UUID ou decimal em /api/products).

GET/api/products/{id}/imagesAdmin

Listar as imagens de um produto

Mesma operação, na forma sem versão. Muda só o formato dos ids: product_id, image_id e pair_id voltam como números decimais em string ("95805399"), derivados do UUID.

Parâmetros de caminho

idstringobrigatório

Id do produto (UUID ou decimal).

Exemplo de requisição

Resposta

200Imagens do produto

Campos da resposta

product_idstring

Id do produto, ecoado. UUID em /api/v1.0, decimal em string em /api/products.

totalinteger

Quantidade de imagens.

imagesarray

Imagens em ordem de position.

pair_idstring

Id da imagem. É igual a image_id (na Venddor 1.0, o "par" é o conjunto imagem grande e miniatura).

image_idstring

Id da imagem. Identificador da imagem.

positioninteger

Posição de exibição, a partir de 0.

is_primarystring

"Y" na imagem principal, "N" nas demais.

detailedobject

Imagem em tamanho cheio: image_path (URL) e alt (texto alternativo, pode ser vazio).

iconsobject

Miniatura: o mesmo endereço com ?w=100 no final, e o mesmo alt. Não é um arquivo separado: é um pedido de largura 100 ao CDN.

Erros

Status	Quando	Corpo
401	Sem credenciais.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	O usuário não é administrador.	`{"message":"...","status":403}`
500	O id não tem formato de UUID (nem decimal válido).	`{"message":"Failed to retrieve product images","status":500}`

Um produto que não existe devolve 200 com "images": [] e "total": 0: não há 404 nesta rota.

Veja também

Mídia do produto: visão geral, limites e o mapa das rotas.
Consultar produto: a galeria também vem dentro do produto.