API legada/Referência completa/API 4.0 (app móvel)

Sellers

Lista os sellers abertos da loja e devolve a ficha de um seller para o cliente logado no app.

Um seller (lojista) é uma empresa que vende dentro da loja. O app mostra a lista de lojas e a ficha de cada uma: logotipo, descrição, endereço, contato, pedido mínimo e formas de pagamento aceitas. Só entram sellers ativos; sellers pendentes, suspensos ou recusados não aparecem.

As duas rotas exigem a ekey do cliente logado. Sem ela, a resposta é 401. As respostas nunca são guardadas em cache.

GET/api/4.0/sra_vendorsCliente

Listar sellers

Lista enxuta, em ordem alfabética pelo nome. Não tem filtros nem paginação: todos os sellers ativos vêm de uma vez. A barra final (/sra_vendors/) também funciona.

GET/api/4.0/sra_vendors/{id}Cliente

Ficha de um seller

Devolve a ficha do seller. Dados bancários, chave PIX e comissão nunca saem aqui.

Parâmetros de caminho

idstringobrigatório

company_id do seller (decimal ou UUID), como vem na lista, nos produtos e na home.

Exemplo de requisição

bash

curl "$BASE_URL/api/4.0/sra_vendors/496868694" \
  -H "Authorization: Basic $(printf '%s' "$CUSTOMER_TOKEN" | base64 -w0):"

Resposta

200Lista de sellers

json

{
  "sravendors": [
    { "company_id": "347963034", "company": "Loja Exemplo" },
    { "company_id": "496868694", "company": "Papelaria Central" }
  ]
}

200Ficha do seller

json

{
  "company_id": "496868694",
  "company": "Papelaria Central",
  "logo_url": "https://minhaloja.io.venddor.com.br/uploads/vendors/central.png?w=400",
  "description": "Tudo para o seu escritório.",
  "products_count": 42,
  "shipping_address": {
    "address": "Rua das Flores, 100, Centro, São Paulo",
    "state": "SP",
    "zipcode": "01310-100",
    "country": "BR"
  },
  "contact_information": {
    "email": "contato@papelariacentral.com.br",
    "phone": "(11) 3000-0000",
    "url": "https://papelariacentral.com.br"
  },
  "minimum_order_amount": 50,
  "payment_methods": [ { "payment": "PIX" }, { "payment": "Cartão de crédito" } ],
  "average_rating": "4.5"
}

Campos da resposta

sravendors[].company_idstring

Id decimal do seller.

sravendors[].companystring

Nome fantasia.

company_idstring

(Ficha) Id decimal do seller.

companystring

(Ficha) Nome fantasia.

logo_urlstring

Logotipo em miniatura de 400 px, URL absoluta. Vazio quando não há.

descriptionstring

Descrição pública.

products_countinteger

Quantidade de produtos do seller que a vitrine mostra.

shipping_addressobject

address (rua, número, complemento, bairro e cidade, em uma linha), state, zipcode e country.

contact_informationobject

email, phone (o fixo, ou o celular quando não há fixo) e url do site.

minimum_order_amountnumber

Pedido mínimo do seller, em reais. 0 é sem mínimo.

payment_methodsarray

Formas de pagamento que o seller aceita: payment com o nome, sem os dados de configuração.

average_ratingstring

Nota média das avaliações dos produtos do seller, como texto. "0" quando não há.

Erros

Status	Quando	Corpo
401	Sem ekey, ekey vencida ou de outra loja, ou token que não é de cliente	`{"error":"unauthorized"}`
404	Seller inexistente ou que não está ativo	`{"error":"vendor not found"}`
409	O id decimal corresponde a mais de um seller	`{"error":"vendor not found"}`
500	Falha ao ler	`{"error":"failed to get vendor","detail":"..."}`

Veja também

Sellers

Lista os sellers abertos da loja e devolve a ficha de um seller para o cliente logado no app.

As duas rotas exigem a ekey do cliente logado. Sem ela, a resposta é 401. As respostas nunca são guardadas em cache.

GET/api/4.0/sra_vendorsCliente

Listar sellers

Lista enxuta, em ordem alfabética pelo nome. Não tem filtros nem paginação: todos os sellers ativos vêm de uma vez. A barra final (/sra_vendors/) também funciona.

GET/api/4.0/sra_vendors/{id}Cliente

Ficha de um seller

Devolve a ficha do seller. Dados bancários, chave PIX e comissão nunca saem aqui.

Parâmetros de caminho

idstringobrigatório

company_id do seller (decimal ou UUID), como vem na lista, nos produtos e na home.

Exemplo de requisição

bash

curl "$BASE_URL/api/4.0/sra_vendors/496868694" \
  -H "Authorization: Basic $(printf '%s' "$CUSTOMER_TOKEN" | base64 -w0):"

Resposta

200Lista de sellers

json

{
  "sravendors": [
    { "company_id": "347963034", "company": "Loja Exemplo" },
    { "company_id": "496868694", "company": "Papelaria Central" }
  ]
}

200Ficha do seller

json

{
  "company_id": "496868694",
  "company": "Papelaria Central",
  "logo_url": "https://minhaloja.io.venddor.com.br/uploads/vendors/central.png?w=400",
  "description": "Tudo para o seu escritório.",
  "products_count": 42,
  "shipping_address": {
    "address": "Rua das Flores, 100, Centro, São Paulo",
    "state": "SP",
    "zipcode": "01310-100",
    "country": "BR"
  },
  "contact_information": {
    "email": "contato@papelariacentral.com.br",
    "phone": "(11) 3000-0000",
    "url": "https://papelariacentral.com.br"
  },
  "minimum_order_amount": 50,
  "payment_methods": [ { "payment": "PIX" }, { "payment": "Cartão de crédito" } ],
  "average_rating": "4.5"
}

Campos da resposta

sravendors[].company_idstring

Id decimal do seller.

sravendors[].companystring

Nome fantasia.

company_idstring

(Ficha) Id decimal do seller.

companystring

(Ficha) Nome fantasia.

logo_urlstring

Logotipo em miniatura de 400 px, URL absoluta. Vazio quando não há.

descriptionstring

Descrição pública.

products_countinteger

Quantidade de produtos do seller que a vitrine mostra.

shipping_addressobject

address (rua, número, complemento, bairro e cidade, em uma linha), state, zipcode e country.

contact_informationobject

email, phone (o fixo, ou o celular quando não há fixo) e url do site.

minimum_order_amountnumber

Pedido mínimo do seller, em reais. 0 é sem mínimo.

payment_methodsarray

Formas de pagamento que o seller aceita: payment com o nome, sem os dados de configuração.

average_ratingstring

Nota média das avaliações dos produtos do seller, como texto. "0" quando não há.

Erros

Status	Quando	Corpo
401	Sem ekey, ekey vencida ou de outra loja, ou token que não é de cliente	`{"error":"unauthorized"}`
404	Seller inexistente ou que não está ativo	`{"error":"vendor not found"}`
409	O id decimal corresponde a mais de um seller	`{"error":"vendor not found"}`
500	Falha ao ler	`{"error":"failed to get vendor","detail":"..."}`