# Franca Venda ## Docs - [Introdução](https://docs.francavenda.com.br/doc-2110010.md): ## API Docs - Escritório Virtual > Autenticação [Criar Access Token](https://docs.francavenda.com.br/api-9923261.md): - Escritório Virtual > Autenticação [Solicitar token de recuperação de senha](https://docs.francavenda.com.br/api-13904154.md): - Escritório Virtual > Autenticação [Redefinir/Renovar senha](https://docs.francavenda.com.br/api-13922497.md): Endpoint para atualizar a senha do usuário. - Escritório Virtual > Usuário [Meus dados](https://docs.francavenda.com.br/api-9923334.md): - Escritório Virtual > Usuário [Atualizar dados](https://docs.francavenda.com.br/api-13874088.md): - Escritório Virtual > Usuário [Listando endereços](https://docs.francavenda.com.br/api-13886043.md): Listando os endereços cadastrados do usuário logado. - Escritório Virtual > Usuário [Exibir adesão](https://docs.francavenda.com.br/api-14470111.md): Exibe informações da adesão do usuário afiliado. - Escritório Virtual > Usuário [Pagamento da adesão](https://docs.francavenda.com.br/api-14549292.md): Exibe informações da adesão do usuário afiliado. - Escritório Virtual > Usuário [Minha rede](https://docs.francavenda.com.br/api-16781505.md): Retorna informações sobre a rede do afiliado, como seu patrocinador e seus embaixadores. - Escritório Virtual > Pedidos [Listar pedidos](https://docs.francavenda.com.br/api-11479356.md): - Escritório Virtual > Pedidos [Listar meus pedidos](https://docs.francavenda.com.br/api-14920640.md): Lista apenas os pedidos do usuário logado. - Escritório Virtual > Pedidos [Visualizar pedido](https://docs.francavenda.com.br/api-12548494.md): - Escritório Virtual > Pedidos [Visualizar pagamentos do pedido](https://docs.francavenda.com.br/api-14046246.md): Acompanha os pagamentos realizados pelo cliente no serviço do fornecedor. - Escritório Virtual > Pedidos [Listar situação dos pedidos](https://docs.francavenda.com.br/api-14702530.md): Lista todas as situações que um pedido pode estar. - Escritório Virtual > Pedidos [Exportar pedidos](https://docs.francavenda.com.br/api-14757759.md): Gera um link temporário para baixar um arquivo com o relatório dos pedidos. - Escritório Virtual > Pedidos [Novo pedido](https://docs.francavenda.com.br/api-15397172.md): Recebendo um novo pedido através do escritório virtual. - Escritório Virtual > Pedidos [Novo pedido - Adicionar novo titular](https://docs.francavenda.com.br/api-19627298.md): Este endpoint é para ser usado quando um novo pedido é relacionado a um pedido de empresa. - Escritório Virtual > Pedidos [Checar restrições do pedido](https://docs.francavenda.com.br/api-15691287.md): Consulta com o fornecedor se pedido possui restrições de cadastro. - Escritório Virtual > Pedidos [Enviar pedido para o fornecedor](https://docs.francavenda.com.br/api-15692984.md): Envia as informações do pedido para ser cadastrado no fornecedor. - Escritório Virtual > Afiliados [Listar afiliados](https://docs.francavenda.com.br/api-11706058.md): - Escritório Virtual > Afiliados [Visualizar afiliado](https://docs.francavenda.com.br/api-12717640.md): - Escritório Virtual > Afiliados [Cadastrar afiliado](https://docs.francavenda.com.br/api-12727574.md): - Escritório Virtual > Afiliados [Atualizar afiliado](https://docs.francavenda.com.br/api-12909769.md): - Escritório Virtual > Afiliados [Atualizar situação do afiliado](https://docs.francavenda.com.br/api-12924102.md): Para alterar a situação do afiliado, não é possível fazê-lo atualizando seus dados. - Escritório Virtual > Códigos de afiliado [Listar códigos do afiliado](https://docs.francavenda.com.br/api-12947946.md): - Escritório Virtual > Códigos de afiliado [Adicionar código](https://docs.francavenda.com.br/api-12948040.md): - Escritório Virtual > Códigos de afiliado [Remover Código](https://docs.francavenda.com.br/api-12993419.md): - Escritório Virtual > Cadastro de clientes [Listar clientes](https://docs.francavenda.com.br/api-10384320.md): Lista e faz busca por clientes cadastrados. - Escritório Virtual > Cadastro de clientes [Cadastrar cliente](https://docs.francavenda.com.br/api-10395659.md): - Escritório Virtual > Cadastro de clientes [Consultar cliente](https://docs.francavenda.com.br/api-10395832.md): Lista e faz busca por clientes cadastrados. - Escritório Virtual > Cadastro de empresas [Cadastrar uma nova empresa](https://docs.francavenda.com.br/api-15396022.md): - Escritório Virtual > Cadastro de fornecedores [Listar fornecedores](https://docs.francavenda.com.br/api-10340244.md): - Escritório Virtual > Cadastro de fornecedores [Visualizar fornecedor](https://docs.francavenda.com.br/api-13219947.md): - Escritório Virtual > Cadastro de fornecedores [Atualizar logotipo](https://docs.francavenda.com.br/api-13243706.md): - Escritório Virtual > Cadastro de marcas [Listar marcas](https://docs.francavenda.com.br/api-13225962.md): - Escritório Virtual > Cadastro de marcas [Visualizar marca](https://docs.francavenda.com.br/api-13225963.md): - Escritório Virtual > Cadastro de marcas [Atualizar logotipo](https://docs.francavenda.com.br/api-13235805.md): - Escritório Virtual > Cadastro de marcas [Atualizar banner](https://docs.francavenda.com.br/api-13241439.md): - Escritório Virtual > Cadastro de produtos [Listar produtos](https://docs.francavenda.com.br/api-13271440.md): - Escritório Virtual > Cadastro de produtos [Visualizar produto](https://docs.francavenda.com.br/api-13271441.md): - Escritório Virtual > Cadastro de ofertas [Visualizar oferta](https://docs.francavenda.com.br/api-15327484.md): Visualizar dados da oferta - Escritório Virtual > Cadastro de ofertas [Listar ofertas](https://docs.francavenda.com.br/api-14211345.md): - Escritório Virtual > Cadastro de departamentos [Listar departamentos](https://docs.francavenda.com.br/api-17347473.md): - Escritório Virtual > Cadastro de departamentos [Visualizar departamento](https://docs.francavenda.com.br/api-17347472.md): Visualizar dados da oferta - Escritório Virtual > Financeiro > Lançamentos [Listar lançamentos](https://docs.francavenda.com.br/api-14427100.md): - Escritório Virtual > Financeiro > Lançamentos [Exportar lançamentos](https://docs.francavenda.com.br/api-14847826.md): - Escritório Virtual > Financeiro > Saques [Listar saques](https://docs.francavenda.com.br/api-14927528.md): Relatório de saques realizados pelo afiliado logado - Escritório Virtual > Financeiro > Saques [Visualizar saque](https://docs.francavenda.com.br/api-15056681.md): Relatório de saques realizados pelo afiliado logado - Escritório Virtual > Financeiro > Saques [Solicitar saque](https://docs.francavenda.com.br/api-14962319.md): Solicitar novo saque. - Escritório Virtual > Financeiro > Saques [Anexar nota fiscal](https://docs.francavenda.com.br/api-15020063.md): Solicitar novo saque. - Escritório Virtual > Financeiro > Saques [Excluir nota fiscal](https://docs.francavenda.com.br/api-15054924.md): Solicitar novo saque. - Escritório Virtual > Financeiro > Saques [Baixar nota fiscal](https://docs.francavenda.com.br/api-15056699.md): Gera uma URL temporária para baixar nota fiscal. - Escritório Virtual > Financeiro > Saques [Aprovar saque](https://docs.francavenda.com.br/api-15246150.md): Solicitar novo saque. - Escritório Virtual > Financeiro [Listar categorias](https://docs.francavenda.com.br/api-14828805.md): - Escritório Virtual > Financeiro [Consultar saldo disponível](https://docs.francavenda.com.br/api-14921738.md): Retorna o saldo do afiiado logado. - Escritório Virtual > Outros cadastros > Arquivos [Relatório de arquivos armazenados](https://docs.francavenda.com.br/api-15241975.md): Lista todos os arquivos armazenados. - Escritório Virtual > Outros cadastros > Arquivos [Relatório de arquivos armazenados Copy](https://docs.francavenda.com.br/api-15242111.md): Lista todos os arquivos armazenados. - Escritório Virtual > Outros cadastros > Bancos [Listar bancos](https://docs.francavenda.com.br/api-12768699.md): - Escritório Virtual > Outros cadastros > Serviço de assinatura [Listar serviços](https://docs.francavenda.com.br/api-12837354.md): - Escritório Virtual > Outros cadastros > Sexo [Listar sexos](https://docs.francavenda.com.br/api-12836676.md): - Escritório Virtual > Outros cadastros > Municípios [Listar estados](https://docs.francavenda.com.br/api-15386754.md): - Escritório Virtual > Outros cadastros > Municípios [Listar municípios](https://docs.francavenda.com.br/api-13840410.md): - Escritório Virtual > Outros cadastros > Tipos de empresa [Listar os tipos de empresa](https://docs.francavenda.com.br/api-15386685.md): - Escritório Virtual > Métricas [Pedidos realizados](https://docs.francavenda.com.br/api-16703632.md): Retorna os números dos pedidos realizados de acordo os parâmetros informados. - Escritório Virtual > Métricas [Ranking de vendas](https://docs.francavenda.com.br/api-16763954.md): - E-Commerce > Autenticação [Criar Access Token - Aplicação](https://docs.francavenda.com.br/api-13041196.md): - E-Commerce > Autenticação [Criar Access Token - Cliente/Usuário](https://docs.francavenda.com.br/api-15073835.md): - E-Commerce > Autenticação [Redefinir/Renovar senha Copy](https://docs.francavenda.com.br/api-17530181.md): Endpoint para atualizar a senha do usuário. - E-Commerce > Destaques [Listar destaques da página principal](https://docs.francavenda.com.br/api-13159063.md): - E-Commerce > Ofertas [Listar ofertas](https://docs.francavenda.com.br/api-13454740.md): - E-Commerce > Ofertas [Visualizar oferta](https://docs.francavenda.com.br/api-13454741.md): - E-Commerce > Departamentos [Listar departamentos](https://docs.francavenda.com.br/api-17348907.md): - E-Commerce > Departamentos [Visualizar departamento](https://docs.francavenda.com.br/api-17348908.md): Visualizar dados da oferta - E-Commerce > Municipio [Listar municípios](https://docs.francavenda.com.br/api-17352447.md): - E-Commerce > Municipio [Visualizar municipio](https://docs.francavenda.com.br/api-17352448.md): Visualizar dados da oferta - E-Commerce > Marcas [Listar marcas](https://docs.francavenda.com.br/api-16511704.md): - E-Commerce > Marcas [Visualizar marca](https://docs.francavenda.com.br/api-16511705.md): - E-Commerce > Pedidos [Novo pedido](https://docs.francavenda.com.br/api-10857320.md): - E-Commerce > Pedidos [Novo pedido (solicitação)](https://docs.francavenda.com.br/api-17484285.md): Pedido de um plano que a contratação não realizada através de pagamento imediado, como cartão de crédito ou boleto. - E-Commerce > Pedidos [Novo pedido | Cliente já cadastrado](https://docs.francavenda.com.br/api-16173296.md): - E-Commerce > Pedidos [Listar pedidos](https://docs.francavenda.com.br/api-15823159.md): Listar pedidos realizados pelo cliente. - E-Commerce > Pedidos [Visualizar pedido](https://docs.francavenda.com.br/api-11418408.md): - E-Commerce > Pedidos [Novo pagamento](https://docs.francavenda.com.br/api-15757895.md): Faz uma nova tentativa de cobrança com novos dados de pagamento. - E-Commerce > Usuario [Consultar dados do cliente](https://docs.francavenda.com.br/api-15066951.md): - E-Commerce > Clientes [Listar clientes](https://docs.francavenda.com.br/api-10429153.md): - E-Commerce > Clientes [Cadastrar cliente](https://docs.francavenda.com.br/api-16349506.md): - E-Commerce > Afiliado [Cadastrar novo afiliado](https://docs.francavenda.com.br/api-30413937.md): - E-Commerce > Afiliado [Consultar código](https://docs.francavenda.com.br/api-24330115.md): Faz a consulta de afiliado através de seu código ou ID - E-Commerce > Afiliado [Inscrição de embaixador](https://docs.francavenda.com.br/api-11544563.md): - E-Commerce > Afiliado [Visualizar adesão](https://docs.francavenda.com.br/api-13111528.md): - E-Commerce > Afiliado [Pagamento da adesão](https://docs.francavenda.com.br/api-13132676.md): - E-Commerce > Afiliado [Checar afiliado](https://docs.francavenda.com.br/api-19469268.md): - E-Commerce > Produtos [Listar produtos](https://docs.francavenda.com.br/api-13448083.md): - E-Commerce > Produtos [Visualizar produto](https://docs.francavenda.com.br/api-13448196.md): - E-Commerce > Usuário | E-Commerce > Endereços [Listar endereços do usuário](https://docs.francavenda.com.br/api-15467129.md): - E-Commerce > Usuário | E-Commerce > Endereços [Adicionar endereço](https://docs.francavenda.com.br/api-15515303.md): - E-Commerce > Usuário | E-Commerce > Endereços [Excluir um endereço](https://docs.francavenda.com.br/api-15531917.md): - E-Commerce > Usuário | E-Commerce > Endereços [Tornat um endereço padrão](https://docs.francavenda.com.br/api-15534968.md): - E-Commerce > Usuário | E-Commerce [Visualizar dados do usuário](https://docs.francavenda.com.br/api-15073914.md): - E-Commerce > Usuário | E-Commerce [Listar pedidos do usuário](https://docs.francavenda.com.br/api-15073823.md): - E-Commerce > Usuário | E-Commerce [Renovar senha](https://docs.francavenda.com.br/api-15473393.md): - E-Commerce > Banco [Listar bancos](https://docs.francavenda.com.br/api-30140580.md): ## Schemas - [cpf](https://docs.francavenda.com.br/schema-3717969.md): - [celular](https://docs.francavenda.com.br/schema-3717970.md): - [cep](https://docs.francavenda.com.br/schema-3717971.md): - [sexo](https://docs.francavenda.com.br/schema-3717972.md): - [parentesco](https://docs.francavenda.com.br/schema-3717973.md): - [data](https://docs.francavenda.com.br/schema-3717987.md): - [rg](https://docs.francavenda.com.br/schema-5159668.md): - [municipioId](https://docs.francavenda.com.br/schema-3717988.md):