VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/App do seller (1.0)

Início, painel e avisos

Configuração do app, blocos do painel do seller e contador de avisos não lidos.

Três leituras que montam a tela inicial do app: a configuração fixa (start), os números do negócio (dashboard) e o contador de mensagens não lidas (notifications). Todas são GET, sem parâmetros.

Configuração do app

GET/api/v1.0/vendor_startSeller

Configuração do app

GET/api/vendor_startSeller

Mesma operação, caminho alternativo

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

GET/api/v1.0/vn_start_apiSeller

Mesma operação, caminho alternativo

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

GET/api/vn_start_apiSeller

Mesma operação, caminho alternativo

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

Painel do seller

GET/api/v1.0/vendor_dashboardSeller

Painel do seller

GET/api/vendor_dashboardSeller

Mesma operação, caminho alternativo

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

GET/api/v1.0/vn_dashboard_apiSeller

Mesma operação, caminho alternativo

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

GET/api/vn_dashboard_apiSeller

Mesma operação, caminho alternativo

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

Avisos e mensagens não lidas

GET/api/v1.0/vendor_notificationsSeller

Avisos e mensagens não lidas

GET/api/vendor_notificationsSeller

Mesma operação, caminho alternativo

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

GET/api/v1.0/vn_communication_apiSeller

Mesma operação, caminho alternativo

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

GET/api/vn_communication_apiSeller

Mesma operação, caminho alternativo

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

Exemplo de requisição

bash
curl "$BASE_URL/api/v1.0/vendor_dashboard" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configuração do app
json
{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "app_version": "2.0.0",
    "api_version": "2.0",
    "platform": "venddor",
    "default_currency": "BRL",
    "default_language": "pt-BR",
    "currencies": [{ "code": "BRL", "symbol": "R$", "name": "Real Brasileiro" }],
    "languages": [{ "code": "pt-BR", "name": "Portugues (Brasil)" }, { "code": "en", "name": "English" }]
  }
}

Campos da resposta

data.app_versionstring
Versão da API do app. Valor fixo.
data.api_versionstring
Fixo 2.0.
data.platformstring
Fixo venddor.
data.default_currencystring
Moeda padrão, fixo BRL.
data.default_languagestring
Idioma padrão, fixo pt-BR.
data.currenciesarray
Lista fixa com code, symbol e name do real.
data.languagesarray
Lista fixa com pt-BR e en.
200Painel do seller
json
{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "blocks": [
      { "title": "Produtos Ativos", "value": "412" },
      { "title": "Pedidos", "value": "1893" },
      { "title": "Pedidos Pendentes", "value": "27" },
      { "title": "Receita Total", "value": "182340.50" },
      { "title": "Vendas do Mes", "value": "21490.30" }
    ],
    "vendor_data_for_sidebar": {
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "company_name": "Moda Aurora Ltda",
      "logo_url": "https://cdn.example/logo.png"
    }
  }
}

Campos da resposta

data.blocksarray
Cartões da tela inicial, cada um com title e value (texto). Os títulos saem em português: Produtos Ativos, Pedidos, Pedidos Pendentes, Receita Total e, quando o cálculo do mês funciona, Vendas do Mes. Valores em dinheiro são string decimal com ponto ("182340.50").
data.vendor_data_for_sidebarobject
company_id, company_name e logo_url (pode ser null) para o cabeçalho do menu lateral.
200Avisos e mensagens não lidas
json
{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "notifications": [],
    "unread_messages": 3,
    "total_unread_count": 3
  }
}

Campos da resposta

data.notificationsarray
Sempre vazio, mantido por compatibilidade.
data.unread_messagesinteger
Mensagens não lidas nos chats do seller.
data.total_unread_countinteger
Mesmo valor de unread_messages.

Erros

StatusQuandoCorpo de exemplo
401Sem credencial, ou credencial inválida.{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}
403Token de cliente comum (nem seller nem administrador).{"status":403,"message":"Forbidden: vendor scope required"}
200Autenticado, mas o usuário não é de um seller (por exemplo, um administrador).{"status":200,"data":{"success":false,"message":"User is not a vendor","action":"logout"}}
200O usuário não tem seller vinculado.{"status":200,"data":{"success":false,"message":"No vendor assigned to this account","action":"logout"}}
200O seller não está ativo.{"status":200,"data":{"success":false,"message":"Vendor account is not active","action":"logout"}}
start não é aberta

Embora seja a primeira chamada do app, vendor_start também exige credencial (a de serviço do app serve). Sem ela, 401.

Painel só para seller

vendor_dashboard precisa de um usuário ligado a um seller ativo. Com administrador ou seller desativado ele responde success: false e action: "logout". vendor_notifications não tem essa exigência: com um usuário sem seller ele responde 0 não lidas.

Veja também

  • Login e cadastro
  • Empresa e perfil
  • Chats
Anterior
Login e cadastro
Próxima
Empresa e perfil
Nesta página
  • Configuração do app
  • Painel do seller
  • Avisos e mensagens não lidas
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também