API atual/Referência completa/Produtos do seller

Consultar produto

Devolve um produto do seller com todos os campos e as descrições em todos os idiomas.

Use para abrir o produto antes de editar. A resposta inclui, além dos campos abaixo, as descrições de cada idioma ativo da loja em descriptions, para o formulário de edição de conteúdo multilíngue.

GET/api/v1/vendor/products/{id}Seller

Consultar um produto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório

Id do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Produto

json

{
  "id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
  "display_id": 10664,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "category_id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
  "name": "Camiseta Básica Algodão Preta",
  "slug": "camiseta-basica-algodao-preta",
  "sku": "CAM-001",
  "barcode": "7891234567895",
  "description": "<p>Camiseta 100% algodão.</p>",
  "short_description": "Camiseta 100% algodão",
  "price": 4990,
  "list_price": 5990,
  "track_inventory": true,
  "quantity": 25,
  "low_stock_alert": 5,
  "min_quantity": 0,
  "max_quantity": 0,
  "quantity_step": 1,
  "sale_unit": "un",
  "zero_price_action": "P",
  "popularity": 0,
  "out_of_stock_action": "N",
  "weight": 0.25,
  "width": 30,
  "height": 2,
  "length": 40,
  "status": "A",
  "intended_status": "A",
  "approval_status": "approved",
  "view_count": 0,
  "sales_count": 0,
  "rating_avg": 0,
  "rating_count": 0,
  "free_shipping": false,
  "shipping_freight": 0,
  "requires_shipping": true,
  "vendor_name": "Loja Seller Teste",
  "vendor_slug": "loja-seller-teste",
  "created_at": "2026-10-11T20:56:24.231132Z",
  "updated_at": "2026-10-11T21:05:40.573283Z"
}

Campos da resposta

idstring (uuid)

Id do produto.

display_idinteger

Número curto do produto, mostrado no painel.

vendor_idstring (uuid)

Id do seller dono do produto. Sempre o seu.

category_idstring (uuid)

Categoria principal.

namestring

Nome. Tags HTML são removidas.

slugstring

Trecho da URL pública, único na loja.

skustring

Código do produto (SKU). Pode ser nulo.

barcodestring

EAN/GTIN. Pode ser nulo.

descriptionstring

Descrição em HTML já sanitizado.

short_descriptionstring

Resumo curto.

priceinteger

Preço de venda em centavos (4990 = R$ 49,90).

list_priceinteger | null

Preço "De" (riscado) em centavos. Ausente quando não definido.

cost_priceinteger | null

Preço de custo em centavos. Ausente quando não definido.

track_inventoryboolean

Se o estoque é controlado.

quantitynumber

Estoque. Aceita fração (até 3 casas) quando allow_fractional está ligado.

low_stock_alertinteger

Limite de alerta de estoque baixo. 0 = sem limite.

min_quantitynumber

Quantidade mínima por pedido. 0 = sem regra.

max_quantitynumber

Quantidade máxima por pedido. 0 = sem limite.

quantity_stepnumber

Múltiplo em que a quantidade pode crescer.

sale_unitstring

Unidade de venda (un, kg, cx...).

zero_price_actionstring

PRA

O que acontece com preço zero: P usa o preço, R esconde o botão de compra, A pede o preço ao cliente.

out_of_stock_actionstring

NBS

Sem estoque: N nada (some o botão), B aceita encomenda, S mostra "avise-me".

weightnumber

Peso em kg.

widthnumber

Largura em cm.

heightnumber

Altura em cm.

lengthnumber

Comprimento em cm.

statusstring

ADHRX

Status atual (letra). Veja a tabela de status na home da seção.

intended_statusstring

Status que o produto terá quando for aprovado (A, D ou H).

approval_statusstring

Leitura amigável do status de moderação (approved, pending, rejected).

rejected_reasonstring

Motivo da recusa, quando status é X.

free_shippingboolean

Frete grátis no produto.

shipping_freightinteger

Frete extra do produto, em centavos.

requires_shippingboolean

false para produto digital.

ncm_codestring

NCM de 8 dígitos para nota fiscal.

seo_titlestring

Título SEO.

seo_descriptionstring

Descrição SEO.

meta_keywordsstring

Palavras-chave.

view_countinteger

Visualizações da página do produto.

sales_countinteger

Unidades vendidas.

rating_avgnumber

Nota média das avaliações.

rating_countinteger

Número de avaliações.

vendor_namestring

Nome do seller.

vendor_slugstring

Slug do seller.

imagesarray

Imagens do produto: id, image_url, alt_text, position, is_primary. Veja Imagens.

created_atstring

Criação, RFC 3339 em UTC.

updated_atstring

Última alteração, RFC 3339 em UTC. Serve de versão para o Modo planilha.

Erros

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`
400	Algum segmento do caminho é `0` ou um inteiro negativo.	`{"error":"invalid id parameter"}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`

Veja também

Consultar produto

Devolve um produto do seller com todos os campos e as descrições em todos os idiomas.

GET/api/v1/vendor/products/{id}Seller

Consultar um produto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório

Id do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Produto

json

{
  "id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
  "display_id": 10664,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "category_id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
  "name": "Camiseta Básica Algodão Preta",
  "slug": "camiseta-basica-algodao-preta",
  "sku": "CAM-001",
  "barcode": "7891234567895",
  "description": "<p>Camiseta 100% algodão.</p>",
  "short_description": "Camiseta 100% algodão",
  "price": 4990,
  "list_price": 5990,
  "track_inventory": true,
  "quantity": 25,
  "low_stock_alert": 5,
  "min_quantity": 0,
  "max_quantity": 0,
  "quantity_step": 1,
  "sale_unit": "un",
  "zero_price_action": "P",
  "popularity": 0,
  "out_of_stock_action": "N",
  "weight": 0.25,
  "width": 30,
  "height": 2,
  "length": 40,
  "status": "A",
  "intended_status": "A",
  "approval_status": "approved",
  "view_count": 0,
  "sales_count": 0,
  "rating_avg": 0,
  "rating_count": 0,
  "free_shipping": false,
  "shipping_freight": 0,
  "requires_shipping": true,
  "vendor_name": "Loja Seller Teste",
  "vendor_slug": "loja-seller-teste",
  "created_at": "2026-10-11T20:56:24.231132Z",
  "updated_at": "2026-10-11T21:05:40.573283Z"
}

Campos da resposta

idstring (uuid)

Id do produto.

display_idinteger

Número curto do produto, mostrado no painel.

vendor_idstring (uuid)

Id do seller dono do produto. Sempre o seu.

category_idstring (uuid)

Categoria principal.

namestring

Nome. Tags HTML são removidas.

slugstring

Trecho da URL pública, único na loja.

skustring

Código do produto (SKU). Pode ser nulo.

barcodestring

EAN/GTIN. Pode ser nulo.

descriptionstring

Descrição em HTML já sanitizado.

short_descriptionstring

Resumo curto.

priceinteger

Preço de venda em centavos (4990 = R$ 49,90).

list_priceinteger | null

Preço "De" (riscado) em centavos. Ausente quando não definido.

cost_priceinteger | null

Preço de custo em centavos. Ausente quando não definido.

track_inventoryboolean

Se o estoque é controlado.

quantitynumber

Estoque. Aceita fração (até 3 casas) quando allow_fractional está ligado.

low_stock_alertinteger

Limite de alerta de estoque baixo. 0 = sem limite.

min_quantitynumber

Quantidade mínima por pedido. 0 = sem regra.

max_quantitynumber

Quantidade máxima por pedido. 0 = sem limite.

quantity_stepnumber

Múltiplo em que a quantidade pode crescer.

sale_unitstring

Unidade de venda (un, kg, cx...).

zero_price_actionstring

PRA

O que acontece com preço zero: P usa o preço, R esconde o botão de compra, A pede o preço ao cliente.

out_of_stock_actionstring

NBS

Sem estoque: N nada (some o botão), B aceita encomenda, S mostra "avise-me".

weightnumber

Peso em kg.

widthnumber

Largura em cm.

heightnumber

Altura em cm.

lengthnumber

Comprimento em cm.

statusstring

ADHRX

Status atual (letra). Veja a tabela de status na home da seção.

intended_statusstring

Status que o produto terá quando for aprovado (A, D ou H).

approval_statusstring

Leitura amigável do status de moderação (approved, pending, rejected).

rejected_reasonstring

Motivo da recusa, quando status é X.

free_shippingboolean

Frete grátis no produto.

shipping_freightinteger

Frete extra do produto, em centavos.

requires_shippingboolean

false para produto digital.

ncm_codestring

NCM de 8 dígitos para nota fiscal.

seo_titlestring

Título SEO.

seo_descriptionstring

Descrição SEO.

meta_keywordsstring

Palavras-chave.

view_countinteger

Visualizações da página do produto.

sales_countinteger

Unidades vendidas.

rating_avgnumber

Nota média das avaliações.

rating_countinteger

Número de avaliações.

vendor_namestring

Nome do seller.

vendor_slugstring

Slug do seller.

imagesarray

Imagens do produto: id, image_url, alt_text, position, is_primary. Veja Imagens.

created_atstring

Criação, RFC 3339 em UTC.

updated_atstring

Última alteração, RFC 3339 em UTC. Serve de versão para o Modo planilha.

Erros

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`
400	Algum segmento do caminho é `0` ou um inteiro negativo.	`{"error":"invalid id parameter"}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`