Consultar seller
Devolve a ficha pública de um seller, por UUID ou por slug.
Devolve a ficha pública de um seller: o que a página dele precisa para o cabeçalho. Se o seller editou a "Minha Loja", logotipo, banner e descrição vêm de lá, junto com as cores, as redes sociais, o CSS e o SEO dele.
Por UUID ou slug
/api/v1/storefront/vendors/{id}PúblicaConsulta um seller por UUID ou slug
Aceita o UUID ou o slug em {id}; o servidor decide pelo formato.
Parâmetros de caminho
idstringobrigatórioUUID ou slug do seller.
Somente por slug
/api/v1/storefront/vendors/by-slug/{slug}PúblicaConsulta um seller por slug
Igual à rota anterior, mas só entende slug. Útil quando o seu código já sabe que o trecho da URL é um slug e não quer ambiguidade.
Parâmetros de caminho
slugstringobrigatórioSlug do seller.
Exemplo de requisição
Resposta
200Ficha do seller
Campos da resposta
iduuidId do seller.
display_idintegerNúmero curto sequencial.
company_namestringNome fantasia.
slugstringSlug.
logo_urlstringLogotipo (da Minha Loja, se houver; senão da ficha). Ausente se não houver.
banner_urlstringBanner, com a mesma regra. Ausente se não houver.
descriptionstringDescrição, com a mesma regra. Ausente se não houver.
citystringCidade.
statestringUF.
product_countintegerProdutos ativos.
min_order_amountintegerPedido mínimo do seller em centavos. Ausente (equivale a 0) quando não há mínimo.
is_on_vacationbooleanSeller em modo férias.
vacation_messagestringMensagem de férias, quando houver.
created_atstringRFC 3339.
color_schemeobjectCores da Minha Loja (nome da cor para valor CSS). Só aparece quando o seller definiu.
social_linksobjectRedes sociais (nome da rede para URL). Só aparece quando o seller definiu.
custom_cssstringCSS próprio da Minha Loja. Aplique com cuidado: é conteúdo do seller.
seo_titlestringTítulo da página para buscadores.
seo_descriptionstringMeta descrição para buscadores.
Erros
| Status | Quando | Corpo |
|---|---|---|
| 400 | Slug vazio em by-slug. | {"error":"slug is required"} |
| 401 | Loja que exige login para navegar e chamada sem token. | {"error":"shopping_requires_login","message":"this storefront requires login to browse"} |
| 404 | Seller inexistente, inativo, apagado, com a Minha Loja despublicada, restrito a outro grupo de clientes, ou que não entrega ao cliente. Sempre a mesma resposta, para não revelar quais existem. | {"error":"vendor not found"} |
| 500 | Falha ao ler o seller. | {"error":"failed to get vendor","detail":"..."} |