API legada/Referência completa/Lojas, vendors e companies

Consultar loja

Retorna o cadastro completo de um seller pelo UUID.

Retorna o cadastro completo de um seller, incluindo data de criação, descrição, nota média, número de produtos e de pedidos. Use depois de achar o UUID na lista, ou para conferir o resultado de uma criação ou alteração.

As contagens são calculadas na hora e são "melhor esforço": se o cálculo falhar, a rota ainda responde 200 com as contagens em zero.

GET/api/v1.0/stores/{id}Admin

Consultar uma loja pelo id

Parâmetros de caminho

iduuidobrigatório

Id da loja (UUID), como devolvido em company_id por /api/v1.0. O id decimal que a forma /api/... devolve não é aceito aqui.

GET/api/stores/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).

GET/api/v1.0/vendors/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/vendors/{id}Admin

Mesma operação, caminho alternativo

GET/api/v1.0/companies/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/companies/{id}Admin

Mesma operação, caminho alternativo

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/stores/c0000000-0000-0000-0000-000000000001" \
  -u "$EMAIL:$API_KEY"

Resposta

200Loja encontrada

json

{
  "company_id": "c0000000-0000-0000-0000-000000000001",
  "company": "Tech Brasil",
  "company_name": "Tech Brasil",
  "status": "A",
  "email": "contato@techbrasil.example",
  "phone": "(11) 3333-4444",
  "url": "https://techbrasil.example",
  "address": "",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "zipcode": "01310-100",
  "storefront": "tech-brasil.venddor.com.br",
  "slug": "tech-brasil",
  "logo_url": "https://cdn.example/techbrasil.png",
  "company_address": "",
  "company_city": "São Paulo",
  "company_country": "BR",
  "company_state": "SP",
  "company_zipcode": "01310-100",
  "company_phone": "(11) 3333-4444",
  "company_website": "https://techbrasil.example",
  "timestamp": 1772792737,
  "company_description": "Eletrônicos e acessórios.",
  "logo": "https://cdn.example/techbrasil.png",
  "avg_rating": 0,
  "product_count": 214,
  "order_count": 4,
  "payments_default": [],
  "shippings_default": [],
  "countries_list": ["BR"]
}

Campos da resposta

company_idstring

Id da loja (UUID em /api/v1.0; decimal em string em /api).

companystring

Nome fantasia. company_name repete o mesmo valor.

statusstring

APDR

Letra da situação: A ativa, P pendente, D desativada, R recusada.

emailstring

E-mail de contato da loja.

phonestring

Telefone. Vazio quando não cadastrado.

urlstring

Site da loja. Vazio quando não cadastrado.

addressstring

Logradouro. Vazio quando não cadastrado.

citystring

Cidade.

statestring

UF (SP).

countrystring

País, código ISO de 2 letras (BR).

zipcodestring

CEP como foi gravado (com ou sem hífen).

storefrontstring

Endereço da vitrine da loja: slug mais .venddor.com.br.

slugstring

Identificador curto da loja na URL.

logo_urlstring

URL do logotipo. A chave some quando não há logo.

company_addressstring

Cópia de address no vocabulário de configurações da 1.0. Há também company_city, company_state, company_country, company_zipcode, company_phone e company_website, sempre iguais ao campo sem prefixo.

avg_ratingnumber

Nota média das avaliações. Na lista é sempre 0.

product_countinteger

Quantidade de produtos. Na lista é sempre 0.

order_countinteger

Quantidade de pedidos. Na lista é sempre 0.

payments_defaultarray

Sempre vazio. Existe só para o cliente da 1.0 não quebrar.

shippings_defaultarray

Sempre vazio.

countries_listarray

Lista com o país da loja. Na lista vem null.

timestampinteger

Só no detalhe. Criação da loja em Unix timestamp (segundos, UTC).

company_descriptionstring

Só no detalhe, e só quando há descrição.

logostring

Só no detalhe, e só quando há logo. Mesmo valor de logo_url.

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial.	`{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}`
401	E-mail ou chave de API inválidos.	`{"status":401,"message":"Invalid credentials"}`
403	A credencial é válida, mas o usuário não é administrador.	`{"status":403,"message":"Forbidden: admin scope required"}`
404	Nenhuma loja com esse UUID, ou a loja já foi excluída.	`{"status":404,"message":"store not found"}`
500	O id não tem formato de UUID (por exemplo o id decimal da forma `/api`). É uma falha conhecida: deveria ser 404.	`{"status":500,"message":"..."}` (mensagem interna de erro (não estável))

Veja também

Consultar loja

Retorna o cadastro completo de um seller pelo UUID.

As contagens são calculadas na hora e são "melhor esforço": se o cálculo falhar, a rota ainda responde 200 com as contagens em zero.

GET/api/v1.0/stores/{id}Admin

Consultar uma loja pelo id

Parâmetros de caminho

iduuidobrigatório

Id da loja (UUID), como devolvido em company_id por /api/v1.0. O id decimal que a forma /api/... devolve não é aceito aqui.

GET/api/stores/{id}Admin

Mesma operação, caminho alternativo

GET/api/v1.0/vendors/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/vendors/{id}Admin

Mesma operação, caminho alternativo

GET/api/v1.0/companies/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/companies/{id}Admin

Mesma operação, caminho alternativo

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/stores/c0000000-0000-0000-0000-000000000001" \
  -u "$EMAIL:$API_KEY"

Resposta

200Loja encontrada

json

{
  "company_id": "c0000000-0000-0000-0000-000000000001",
  "company": "Tech Brasil",
  "company_name": "Tech Brasil",
  "status": "A",
  "email": "contato@techbrasil.example",
  "phone": "(11) 3333-4444",
  "url": "https://techbrasil.example",
  "address": "",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "zipcode": "01310-100",
  "storefront": "tech-brasil.venddor.com.br",
  "slug": "tech-brasil",
  "logo_url": "https://cdn.example/techbrasil.png",
  "company_address": "",
  "company_city": "São Paulo",
  "company_country": "BR",
  "company_state": "SP",
  "company_zipcode": "01310-100",
  "company_phone": "(11) 3333-4444",
  "company_website": "https://techbrasil.example",
  "timestamp": 1772792737,
  "company_description": "Eletrônicos e acessórios.",
  "logo": "https://cdn.example/techbrasil.png",
  "avg_rating": 0,
  "product_count": 214,
  "order_count": 4,
  "payments_default": [],
  "shippings_default": [],
  "countries_list": ["BR"]
}

Campos da resposta

company_idstring

Id da loja (UUID em /api/v1.0; decimal em string em /api).

companystring

Nome fantasia. company_name repete o mesmo valor.

statusstring

APDR

Letra da situação: A ativa, P pendente, D desativada, R recusada.

emailstring

E-mail de contato da loja.

phonestring

Telefone. Vazio quando não cadastrado.

urlstring

Site da loja. Vazio quando não cadastrado.

addressstring

Logradouro. Vazio quando não cadastrado.

citystring

Cidade.

statestring

UF (SP).

countrystring

País, código ISO de 2 letras (BR).

zipcodestring

CEP como foi gravado (com ou sem hífen).

storefrontstring

Endereço da vitrine da loja: slug mais .venddor.com.br.

slugstring

Identificador curto da loja na URL.

logo_urlstring

URL do logotipo. A chave some quando não há logo.

company_addressstring

avg_ratingnumber

Nota média das avaliações. Na lista é sempre 0.

product_countinteger

Quantidade de produtos. Na lista é sempre 0.

order_countinteger

Quantidade de pedidos. Na lista é sempre 0.

payments_defaultarray

Sempre vazio. Existe só para o cliente da 1.0 não quebrar.

shippings_defaultarray

Sempre vazio.

countries_listarray

Lista com o país da loja. Na lista vem null.

timestampinteger

Só no detalhe. Criação da loja em Unix timestamp (segundos, UTC).

company_descriptionstring

Só no detalhe, e só quando há descrição.

logostring

Só no detalhe, e só quando há logo. Mesmo valor de logo_url.

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial.	`{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}`
401	E-mail ou chave de API inválidos.	`{"status":401,"message":"Invalid credentials"}`
403	A credencial é válida, mas o usuário não é administrador.	`{"status":403,"message":"Forbidden: admin scope required"}`
404	Nenhuma loja com esse UUID, ou a loja já foi excluída.	`{"status":404,"message":"store not found"}`
500	O id não tem formato de UUID (por exemplo o id decimal da forma `/api`). É uma falha conhecida: deveria ser 404.	`{"status":500,"message":"..."}` (mensagem interna de erro (não estável))