API legada/Referência completa/Catálogo do app do vendedor

GETProduto: leitura

Lê um produto do seller pelo id, com descrição, preço, estoque, peso e SKU.

Devolve os dados de um produto do seller autenticado. Use depois de listar, para abrir a tela de edição do app. Se o produto é de outro seller, a resposta é Access denied, e se não existe, Product not found.

GET/api/v1.0/vendor_product/{id}Seller

Ler um produto do seller

Parâmetros de caminho

iduuidobrigatório

Id do produto, o product_id da lista. Na URL sem v1.0, o inteiro devolvido pela lista não funciona aqui: use o UUID.

Cabeçalhos

Authorizationstringobrigatório

Basic base64(e-mail:chave_de_api) ou Bearer $TOKEN do usuário de um seller ativo.

GET/api/vendor_product/{id}Seller

Alias de GET /api/v1.0/vendor_product/{id}

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_product/{id}. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

GET/api/v1.0/vn_product_api/{id}Seller

Alias de GET /api/v1.0/vendor_product/{id}

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_product/{id}.

GET/api/vn_product_api/{id}Seller

Alias de GET /api/v1.0/vendor_product/{id}

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_product/{id}. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/vendor_product/22fbd12a-1b6e-41ea-a84f-4d9cf06c8766"

Resposta

200Produto

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "product": {
      "product_id": "22fbd12a-1b6e-41ea-a84f-4d9cf06c8766",
      "product": "Camisa do Flamengo Masculina I 26 Adidas",
      "price": "300.00",
      "list_price": "449.90",
      "amount": 38,
      "status": "A",
      "description": "Camisa oficial do Flamengo I 26 Adidas, listrada em vermelho e preto.",
      "short_description": "Camisa oficial Flamengo I 26 Adidas",
      "main_image": "/uploads/dfe2555e/product/22fbd12a/camisa.png",
      "weight": 0.4,
      "sku": "FLA-I-26"
    }
  }
}

Campos da resposta

data.product.product_iduuid

Id do produto.

data.product.productstring

Nome.

data.product.pricestring

Preço de venda em reais, string decimal ("300.00").

data.product.list_pricestring

Preço "de" no mesmo formato. "0.00" se não houver.

data.product.amountinteger

Saldo em estoque, arredondado para baixo.

data.product.statusstring

ADHRX

A ativo, D desativado, H oculto, R aguardando moderação, X recusado.

data.product.descriptionstring

Descrição completa.

data.product.short_descriptionstring

Descrição curta.

data.product.main_imagestring

URL da primeira imagem, ou vazio.

data.product.weightnumber|null

Peso em kg. Pode ser null.

data.product.skustring|null

Código do produto.

Erros

Status	Quando	Corpo
200	Produto inexistente, inválido ou id não UUID	`{"status": 200, "data": {"success": false, "message": "Product not found"}}`
200	Produto de outro seller	`{"status": 200, "data": {"success": false, "message": "Access denied"}}`
200	Conta que não é de seller ativo	`{"status": 200, "data": {"success": false, "message": "User is not a vendor", "action": "logout"}}`
401	Sem credencial ou credencial inválida	`{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}`
403	Usuário cliente (não seller nem administrador)	`{"message": "Forbidden: vendor scope required", "status": 403}`

Veja também

GETProduto: leitura

Lê um produto do seller pelo id, com descrição, preço, estoque, peso e SKU.

GET/api/v1.0/vendor_product/{id}Seller

Ler um produto do seller

Parâmetros de caminho

iduuidobrigatório

Id do produto, o product_id da lista. Na URL sem v1.0, o inteiro devolvido pela lista não funciona aqui: use o UUID.

Cabeçalhos

Authorizationstringobrigatório

Basic base64(e-mail:chave_de_api) ou Bearer $TOKEN do usuário de um seller ativo.

GET/api/vendor_product/{id}Seller

Alias de GET /api/v1.0/vendor_product/{id}

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_product/{id}. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

GET/api/v1.0/vn_product_api/{id}Seller

Alias de GET /api/v1.0/vendor_product/{id}

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_product/{id}.

GET/api/vn_product_api/{id}Seller

Alias de GET /api/v1.0/vendor_product/{id}

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/vendor_product/{id}. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/vendor_product/22fbd12a-1b6e-41ea-a84f-4d9cf06c8766"

Resposta

200Produto

json

{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "product": {
      "product_id": "22fbd12a-1b6e-41ea-a84f-4d9cf06c8766",
      "product": "Camisa do Flamengo Masculina I 26 Adidas",
      "price": "300.00",
      "list_price": "449.90",
      "amount": 38,
      "status": "A",
      "description": "Camisa oficial do Flamengo I 26 Adidas, listrada em vermelho e preto.",
      "short_description": "Camisa oficial Flamengo I 26 Adidas",
      "main_image": "/uploads/dfe2555e/product/22fbd12a/camisa.png",
      "weight": 0.4,
      "sku": "FLA-I-26"
    }
  }
}

Campos da resposta

data.product.product_iduuid

Id do produto.

data.product.productstring

Nome.

data.product.pricestring

Preço de venda em reais, string decimal ("300.00").

data.product.list_pricestring

Preço "de" no mesmo formato. "0.00" se não houver.

data.product.amountinteger

Saldo em estoque, arredondado para baixo.

data.product.statusstring

ADHRX

A ativo, D desativado, H oculto, R aguardando moderação, X recusado.

data.product.descriptionstring

Descrição completa.

data.product.short_descriptionstring

Descrição curta.

data.product.main_imagestring

URL da primeira imagem, ou vazio.

data.product.weightnumber|null

Peso em kg. Pode ser null.

data.product.skustring|null

Código do produto.

Erros

Status	Quando	Corpo
200	Produto inexistente, inválido ou id não UUID	`{"status": 200, "data": {"success": false, "message": "Product not found"}}`
200	Produto de outro seller	`{"status": 200, "data": {"success": false, "message": "Access denied"}}`
200	Conta que não é de seller ativo	`{"status": 200, "data": {"success": false, "message": "User is not a vendor", "action": "logout"}}`
401	Sem credencial ou credencial inválida	`{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}`
403	Usuário cliente (não seller nem administrador)	`{"message": "Forbidden: vendor scope required", "status": 403}`