Documentação do fornecedor

Alimente seu aplicativo e recupere os pedidos através da API.

Conecte seu ERP, plataforma de e-commerce, POS ou software de negócios para SellViaApp. Envie categorias, produtos e preços, e depois recupere os pedidos confirmados como JSON.

URL basehttps://api.sellviaapp.com/
Formatoapplication/json; charset=utf-8
Versão actual2026.08
TransportesHTTPS

Do seu software para os clientes

Um fluxo de dados simples bidirecional

Seu sistema continua a ser a fonte de seus dados de negócios. Ele alimenta a loja SellViaApp enquanto as ordens confirmadas pelo cliente voltam para o seu ERP ou software de negócios.

1

O seu ERP

Produtos, categorias, preços e conteúdo.

2

API SellViaApp

Secure trocas JSON sobre HTTPS.

3

Aplicativo móvel

Os clientes navegam e fazem pedidos.

4

As suas ordens.

O seu sistema recupera-os automaticamente.

Não existe entrada duplicada

Identificadores externos preservam o mapeamento para suas referências ERP, enquanto a paginação mantém grandes sincronizações confiáveis.

Início rápido

Conecte o sistema em três etapas

1

Obtenha suas credenciais

A chave API identifica sua loja. O token de administrador protege as operações do servidor.

2

Alimente o catálogo

Crie categorias, então envie ou atualize produtos do seu ERP.

3

Obter ordens

Pesquise a rota do fornecedor paginado e guarde cada GUID processado.

Criar um produto · cURL
curl -X POST "https://api.sellviaapp.com/product/add" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_SUPPLIER_KEY" \
  -H "X-Admin-Token: YOUR_ADMIN_TOKEN" \
  -d '{
    "external_key": "ERP-ARTICLE-1042",
    "code": "ART-1042",
    "name": "Premium product",
    "description": "Complete product description",
    "base_price": 24.90,
    "vat_rate": 21,
    "category_id": 12,
    "active": true
  }'
Obter ordens · cURL
curl "https://api.sellviaapp.com/admin/order/list?page=1&per_page=25&from_date=2026-08-01" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_SUPPLIER_KEY" \
  -H "X-Admin-Token: YOUR_ADMIN_TOKEN"
Cada ordem contémGUID, número, cliente, linhas, quantidades, preços, IVA, total, moeda, modo de cumprimento, endereço e data.

Segurança

Credenciais separadas para cada uso

CHAVE

X-API-Key

Obrigação de identificar o fornecedor. Nunca expresse a chave em JavaScript público.

JWT

Autorização: Bearer

Necessário para dados de clientes autenticados. Renove através de auth/refresh.

ADM

X-Admin-Token

Reservado para integrações de servidores aprovadas que modificam catálogos e categorias.

Apenas integração do lado do servidor

Mantenha X-API-Key e X-Admin-Token dentro do seu servidor ou ERP. Nunca os coloque em um site público, aplicativo móvel ou repositório de origem.

Pontos finais

Autenticação

Crie, atualize e feche sessões seguras.

POST /auth/login Chave da API

Assine um cliente usando seu login e senha.

POST /auth/refresh Chave da API

Renove um token de acesso usando um token de atualização.

POST /auth/logout Chave + Carregador

Fecha a sessão activa.

POST /auth/guest Chave da API

Crie uma sessão de convidados quando habilitada pelo fornecedor.

POST /auth/forgot-password Chave da API

Iniciar a recuperação da conta sem revelar se uma conta existe.

Pontos finais

Fornecedores e branding

Encontre uma loja e recupere a sua configuração pública.

GET /admin/supplier/list Público

Pesquisar fornecedores visíveis no diretório.

GET /admin/supplier/logo Público

Recuperar um logotipo do fornecedor otimizado.

GET /admin/supplier/contact Chave da API

Recupere os dados de contacto público configurados.

GET /admin/supplier/legal Chave da API

Recuperar termos, privacidade, aviso legal e sobre conteúdo.

GET /admin/megawinappcheck/check_supplier_to_use Público

Resolver um fornecedor a partir de um sufixo ou identificador.

Pontos finais

Clientes

Crie e gerencie contas de clientes para cada loja.

POST /customer/add Chave da API

Crie um cliente e gere o login do fornecedor.

GET /customer/list Chave + Carregador

Listar ou filtrar informações autorizadas do cliente.

GET /customer/me Chave + Carregador

Obtenha o perfil do cliente autenticado.

PATCH /customer/update Chave + Carregador

Atualizar perfil, idioma, tipo, e-mail ou senha.

DELETE /customer/deleteaccount Chave + Carregador

Desativar a conta do cliente na loja ativa.

Pontos finais

Catálogo

Categorias, produtos, imagens, preços, ações, promoções e favoritos.

GET /fam1/list Chave + Carregador

Listar as categorias primárias.

POST /fam1/add Administrador

Criar uma categoria primária.

PATCH /fam1/update Administrador

Atualizar uma categoria primária.

DELETE /fam1/delete Administrador

Esconder uma categoria primária.

GET /fam2/list Chave + Carregador

Listar subcategorias.

POST /fam2/add Administrador

Criar uma subcategoria.

PATCH /fam2/update Administrador

Actualizar uma subcategoria.

DELETE /fam2/delete Administrador

Esconder uma subcategoria.

GET /product/list Chave + Carregador

Listar e procurar produtos com paginação.

GET /product/image URL Assinado

Sirva uma imagem de produto assinada e cashável.

POST /product/add Administrador

Criar um produto.

PATCH /product/update Administrador

Actualize um produto.

DELETE /product/delete Administrador

Esconder um produto.

POST /product/favoris Chave + Carregador

Adicione ou remova um produto dos favoritos.

GET /price/list Chave + Carregador

Lista de preços aplicáveis ao grupo de clientes.

GET /mark/list Chave + Carregador

Listar as marcas disponíveis.

GET /size/list Chave + Carregador

Listar os tamanhos disponíveis.

GET /libweb/list Chave + Carregador

Listar as etiquetas de referência Web.

Pontos finais

Carrinho e encomendas

Gerencie o carrinho e confirme uma ordem atomicamente.

GET /admin/order/list Administrador

Recuperar todas as encomendas de fornecedores confirmadas com clientes, linhas e paginação.

GET /order/add Chave + Carregador

Recupere ou inicie o carrinho atual.

GET /order/list Chave + Carregador

Liste o histórico do carrinho e da ordem.

DELETE /order/delete Chave + Carregador

Limpar e apagar o carrinho atual.

GET /order/total Chave + Carregador

Calcular o carrinho subtotal, o IVA e o total.

GET /order/count/line Chave + Carregador

Conta as linhas na carroça.

POST /order/sendtomegawin Chave + Carregador

Confirme a ordem, o modo de cumprimento e o endereço.

POST /orderline/add Chave + Carregador

Adicionar um produto e quantidade ao carrinho.

GET /orderline/list Chave + Carregador

Recupera as linhas atuais do carrinho.

PATCH /orderline/update Chave + Carregador

Atualizar uma quantidade de linha.

DELETE /orderline/delete Chave + Carregador

Remova uma linha do carrinho.

Pontos finais

Documentos

Faturas, estimativas, ordens e suas linhas.

POST /document/add Chave + Carregador

Crie um documento ligado ao cliente.

GET /document/list Chave + Carregador

Listar ou filtrar documentos.

PATCH /document/update Chave + Carregador

Atualizar um documento identificado pelo GUID.

DELETE /document/delete Chave + Carregador

Apagar um documento e as suas linhas.

POST /documentline/add Chave + Carregador

Adicione uma linha e recalcule o documento.

GET /documentline/list Chave + Carregador

Recupere um documento com todas as suas linhas.

PATCH /documentline/update Chave + Carregador

Atualizar uma linha identificada pelo GUID.

DELETE /documentline/delete Chave + Carregador

Apagar uma linha e recalcular os totais.

Pontos finais

Suporte, notificações e integrações

Comunicação, suporte e sincronização externa do cliente.

GET /support/ticket/list Chave + Carregador

Listar os bilhetes disponíveis para o cliente.

POST /support/ticket/create Chave + Carregador

Criar uma solicitação de suporte.

GET /support/ticket/list/log_reply Chave + Carregador

Recuperar um ticket e suas respostas.

GET /support/ticket/list/waiting_reply_by_support Chave + Carregador

Solicitações de lista à espera de apoio.

POST /support/ticket/reply/send Chave + Carregador

Responder a um bilhete.

POST /admin/supplier/sendfeedbackfromapp Chave + Carregador

Envie comentários ao fornecedor.

POST /admin/supplier/sendemailtosalesupport Chave + Carregador

Contacte o suporte de vendas.

GET /admin/notification/sendtomobile Chave + Carregador

Recupere notificações móveis.

POST /admin/notification/setdelivery Chave + Carregador

Marcar uma notificação conforme entregue.

POST /woocommerce/menu/synchronisation Administrador

Sincronizar categorias WooCommerce.

POST /woocommerce/product/synchronisation Administrador

Sincronizar produtos WooCommerce.

Contratos principais

Parâmetros detalhados

Parâmetros podem ser enviados como JSON ou, para rotas GET, na string de consulta.

/auth/login+
NomeTipoNecessárioDesignação das mercadorias
loginstringSim.

Email, login do cliente ou login, incluindo sufixo do fornecedor.

passwordstringSim.

Senha do cliente.

supplierstringNão

Sufixo ou chave do fornecedor quando não estiver incluído no login.

/customer/add+
NomeTipoNecessárioDesignação das mercadorias
nomstringSim.

Sobrenome do cliente.

prenomstringSim.

Primeiro nome do cliente.

emaile- mailSim.

Email único dentro do fornecedor.

denominationstringNão

Nome da empresa, opcional.

passwordstringSim.

Pelo menos oito caracteres.

languestringNão

Linguagem preferida.

/product/list+
NomeTipoNecessárioDesignação das mercadorias
pageinteiroNão

Número da página, começando em 1.

per_pageinteiroNão

Produtos por página.

searchstringNão

Pesquisa por código, nome ou descrição.

category_idinteiroNão

Filtro de categoria primária.

subcategory_idinteiroNão

Filtro de subcategoria.

/product/add+
NomeTipoNecessárioDesignação das mercadorias
codestringSim.

Código do produto único dentro da loja.

namestringSim.

Nome exibido na aplicação.

descriptionstringNão

Descrição detalhada do produto.

base_pricedecimalSim.

Preço de venda excluindo imposto de acordo com sua configuração.

vat_ratedecimalNão

Taxa de IVA, por exemplo 21.

category_idinteiroNão

Identificador de categoria SellViaApp.

external_keystringNão

Identificador estável do seu ERP.

image_urlurlNão

URL HTTPS da imagem principal.

activebooleanoNão

Controla a visibilidade do produto.

/admin/order/list+
NomeTipoNecessárioDesignação das mercadorias
pageinteiroNão

Página solicitada, começando em 1.

per_pageinteiroNão

Ordens por página, no máximo 100.

from_datedataNão

Só devolucione ordens a partir desta data.

guidstringNão

Recupere uma ordem pelo GUID.

statusstringNão

Filtro disponível dependendo do modo de armazenamento: pendente, preparado, pronto, entregue ou cancelado.

/order/sendtomegawin+
NomeTipoNecessárioDesignação das mercadorias
order_guiduuidNão

GUID do carrinho para confirmar.

delivery_modeenumSim.

pickup | delivery

delivery_addressstringNão

Requerido para entrega.

delivery_datedataNão

AAAA-MM-DD

delivery_commentstringNão

Instruções de cumprimento.

languagestringNão

Linguagem de e-mail transacional.

/document/add+
NomeTipoNecessárioDesignação das mercadorias
doc_typestringSim.

invoice | estimate | purchase_order

customer_idinteiroNão

Compatibilidade com o legado; o cliente autenticado tem precedência.

doc_numberstringSim.

Número do documento.

doc_datedataSim.

AAAA-MM-DD

due_datedataNão

AAAA-MM-DD

payment_methodstringNão

Método de pagamento.

remarkstringNão

Observação em forma livre.

/documentline/add+
NomeTipoNecessárioDesignação das mercadorias
document_guiduuidSim.

GUIA DO Documento.

textstringSim.

Descrição da linha.

quantitydecimalSim.

Quantidade.

unit_pricedecimalSim.

Preço unitário, excluindo IVA.

vat_ratedecimalNão

Taxa de IVA.

discount_percentagedecimalNão

Desconto percentual.

JSON

Envelope de resposta

200 OK
{
  "success": true,
  "message": "OK",
  "data": {
    "items": []
  },
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 0
  }
}

Diagnósticos

Erros estruturados

Cada erro expõe um código legível por máquina, categoria, mensagem legível por humano e, quando disponível, um identificador de solicitação.

400Pedido inválido
401Autenticação necessária
403Acesso negado
404Recurso ou rota não encontrado
409Conflito de negócios
422A validação falhou
429Muitos pedidos
5xxIncidente técnico
Conteúdo não processável 422
{
  "success": false,
  "message": "The delivery address is required.",
  "data": null,
  "error": {
    "code": "DELIVERY_ADDRESS_REQUIRED",
    "category": "validation",
    "message": "The delivery address is required.",
    "details": {}
  }
}

Documentação de legado

URLs legados permanecem reconhecidos

A nova API aceita variantes publicadas em doc.sellviaapp.com para que as integrações existentes continuem a funcionar.

/api/document/*/document/*
/user/add/customer/add
/fam1/insert/fam1/add
/product/insert/product/add
/product/favorites/product/favoris
/order/count/order/count/line
/CUSTOMER/LIST/customer/list
Verificação completa

Cada rota publicada na documentação legada agora tem uma rota nativa ou um alias de compatibilidade.