API atual/Referência completa/Conteúdo da vitrine

FAQ da plataforma

Lista os artigos publicados da base de ajuda da plataforma Venddor e faz busca por pergunta.

O FAQ é a base de conhecimento de ajuda de uso da plataforma: "como rastrear meu pedido", "como trocar a senha". Ela é mantida pela Venddor e é a mesma para todas as lojas. Não é o FAQ da sua loja: perguntas sobre os seus produtos e políticas ficam em Páginas.

GET/api/v1/storefront/faqPública

Listar os artigos do FAQ

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/faq"

Resposta

200Artigos

json

{
  "articles": [
    {
      "id": "5b1f0c3a-8d2e-4f6a-9b7c-3e4d5f6a7b8c",
      "title": "Como acompanhar meu pedido",
      "body": "Acesse Minha conta > Pedidos e clique no número do pedido para ver o rastreio.",
      "tags": ["pedidos", "rastreio"],
      "lang": "pt-BR",
      "status": "published",
      "chunk_count": 1,
      "created_at": "2026-08-01T12:00:00Z",
      "updated_at": "2026-09-15T09:30:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

articlesarray

Artigos publicados, do mais recentemente alterado para o mais antigo. [] quando não há nenhum.

articles[].idstring

Id do artigo.

articles[].titlestring

Título (a pergunta).

articles[].bodystring

Texto da resposta.

articles[].tagsarray

Etiquetas do artigo (lista de textos).

articles[].langstring

Idioma do artigo, por exemplo pt-BR. A rota não filtra por idioma: filtre no cliente se precisar.

articles[].statusstring

Aqui sempre published.

articles[].chunk_countinteger

Em quantos trechos o texto foi dividido para a busca.

articles[].created_atstring

Criação (RFC 3339).

articles[].updated_atstring

Última alteração (RFC 3339).

totalinteger

Quantidade de artigos.

Erros

Status	Quando	Corpo
500	Falha ao ler a base de ajuda.	`{"error":"..."}`

GET/api/v1/storefront/faq/searchPública

Buscar no FAQ

Parâmetros de consulta

qstringobrigatório

Pergunta ou palavras-chave. Sem q, ou só com espaços, devolve results: [] sem erro.

bash

curl -G "$BASE_URL/api/v1/storefront/faq/search" --data-urlencode "q=como rastrear meu pedido"

200Resultados

json

{
  "results": [
    {
      "document_id": "5b1f0c3a-8d2e-4f6a-9b7c-3e4d5f6a7b8c",
      "title": "Como acompanhar meu pedido",
      "section": "Rastreio",
      "chunk_text": "Acesse Minha conta > Pedidos e clique no número do pedido para ver o rastreio.",
      "score": 0.82
    }
  ]
}

Campos da resposta

resultsarray

Até 5 trechos, do mais relevante ao menos. [] quando nada combina.

results[].document_idstring

Id do artigo de onde veio o trecho (articles[].id).

results[].titlestring

Título do artigo.

results[].sectionstring

Cabeçalho mais próximo do trecho, quando existe. Ausente quando não há.

results[].chunk_textstring

Trecho do texto que responde à busca.

results[].scorenumber

Relevância. Quanto maior, mais relevante. A escala depende do modo de busca; use só para ordenar, nunca como porcentagem.

Erros

Status	Quando	Corpo
500	Falha na busca.	`{"error":"..."}`

Veja também

FAQ da plataforma

Lista os artigos publicados da base de ajuda da plataforma Venddor e faz busca por pergunta.

GET/api/v1/storefront/faqPública

Listar os artigos do FAQ

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/faq"

Resposta

200Artigos

json

{
  "articles": [
    {
      "id": "5b1f0c3a-8d2e-4f6a-9b7c-3e4d5f6a7b8c",
      "title": "Como acompanhar meu pedido",
      "body": "Acesse Minha conta > Pedidos e clique no número do pedido para ver o rastreio.",
      "tags": ["pedidos", "rastreio"],
      "lang": "pt-BR",
      "status": "published",
      "chunk_count": 1,
      "created_at": "2026-08-01T12:00:00Z",
      "updated_at": "2026-09-15T09:30:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

articlesarray

Artigos publicados, do mais recentemente alterado para o mais antigo. [] quando não há nenhum.

articles[].idstring

Id do artigo.

articles[].titlestring

Título (a pergunta).

articles[].bodystring

Texto da resposta.

articles[].tagsarray

Etiquetas do artigo (lista de textos).

articles[].langstring

Idioma do artigo, por exemplo pt-BR. A rota não filtra por idioma: filtre no cliente se precisar.

articles[].statusstring

Aqui sempre published.

articles[].chunk_countinteger

Em quantos trechos o texto foi dividido para a busca.

articles[].created_atstring

Criação (RFC 3339).

articles[].updated_atstring

Última alteração (RFC 3339).

totalinteger

Quantidade de artigos.

Erros

Status	Quando	Corpo
500	Falha ao ler a base de ajuda.	`{"error":"..."}`

GET/api/v1/storefront/faq/searchPública

Buscar no FAQ

Parâmetros de consulta

qstringobrigatório

Pergunta ou palavras-chave. Sem q, ou só com espaços, devolve results: [] sem erro.

bash

curl -G "$BASE_URL/api/v1/storefront/faq/search" --data-urlencode "q=como rastrear meu pedido"

200Resultados

json

{
  "results": [
    {
      "document_id": "5b1f0c3a-8d2e-4f6a-9b7c-3e4d5f6a7b8c",
      "title": "Como acompanhar meu pedido",
      "section": "Rastreio",
      "chunk_text": "Acesse Minha conta > Pedidos e clique no número do pedido para ver o rastreio.",
      "score": 0.82
    }
  ]
}

Campos da resposta

resultsarray

Até 5 trechos, do mais relevante ao menos. [] quando nada combina.

results[].document_idstring

Id do artigo de onde veio o trecho (articles[].id).

results[].titlestring

Título do artigo.

results[].sectionstring

Cabeçalho mais próximo do trecho, quando existe. Ausente quando não há.

results[].chunk_textstring

Trecho do texto que responde à busca.

results[].scorenumber

Relevância. Quanto maior, mais relevante. A escala depende do modo de busca; use só para ordenar, nunca como porcentagem.

Erros

Status	Quando	Corpo
500	Falha na busca.	`{"error":"..."}`