Início > Clientes Smartforce
Versão: 2.0
Clientes Smartforce
Última Atualização: 12/05/2025
Nossa API de Cadastro de Clientes permite aos fornecedores registrarem novos clientes diretamente na plataforma do Smartforce. Essa funcionalidade possibilita uma integração eficiente entre os sistemas dos fornecedores e a nossa plataforma, garantindo uma experiência contínua para os clientes finais.
Parâmetros da requisição
Status: String
Ex: "Novo", "Rejeitado", "Processando" ou "Finalizado"
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição
Tipo: JSON.
data
Lista de clientes.
Tipo: Array de JSON.
id
ID do cliente.
Tipo: Integer
cnpj
CNPJ do cliente.
Tipo: String
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
success
Status da requisição
Tipo: Boolean
message
Mensagem do status da requisição
Tipo: String
razao_social
Razão social do cliente.
Tipo: String
nome_fantasia
Nome fantasia do cliente.
Tipo: String
ramo_atividade
Ramo de atividade do cliente.
Tipo: String
data_fundacao
Data de fundação do cliente.
Tipo: String
cep
CEP do cliente.
Tipo: String
endereco
Nome do logradouro do cliente.
Tipo: String
numero
Número do endereço do cliente.
Tipo: String
complemento
Complemento do endereço do cliente.
Tipo: String
bairro
Bairro do endereço do cliente.
Tipo: String
cidade
Cidade do cliente.
Tipo: String
uf
Estado do cliente.
Tipo: String
contato
Contato do cliente.
Tipo: String
telefone_1
Telefone do cliente.
Tipo: String
email_nfe_1
E-mail da nota fiscal do cliente.
Tipo: String
email_nfe_2
E-mail da nota fiscal do cliente.
Tipo: String
email_comercial
E-mail comercial do cliente.
Tipo: String
email_cobranca
E-mail para cobrança do cliente.
Tipo: String
obs_nota
Observação da nota fiscal do cliente.
Tipo: String
observacao
Observação geral do cliente.
Tipo: String
data_avaliacao
Data da avaliação do cadastro do cliente.
Tipo: String
motivo
Motivo do status do cliente.
Tipo: String
status
Status do cadsatro do cliente.
Tipo: String
Whatsapp de contato do cliente.
Tipo: String
GET Clientes Smartforce
Última Atualização: 12/05/2025
Este endpoint coleta os clientes cadastrados pelo fornecedor.
Endpoint GET
Sintaxe da Requisição
Para que a requisição do método PATCH seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
status *
Status do cliente.
Opções: "Novo", "Rejeitado", "Processado" ou "Finalizado".
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
reason
Justificativa para o status.
Tipo: String.
Caso um mesmo status seja enviado:
404 Not Found
Caso o cliente não seja encontrado:
PATCH Clientes Smartforce
Última Atualização: 04/06/2025
O patch de cliente altera os dados do clientes para o fornecedor.