TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela criação de novos Clientes

  • Endpoint: /api/retaguarda/v2/clientes
  • Versão: 2
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Este endpoint recebe uma lista de Clientes para que possam ser enviados vários na mesma requisição

Para que a baixa do Cliente criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  0 = Cliente

[
    {
        "atividade": "string",
        "avatarUrl": "string",
        "bairro": "string",
        "celular": "string",
        "cep": "string",
        "cidade": "string",
        "complemento": "string",
        "cpfCnpj": "string",
        "cracha": "string",
        "dataNascimento": "2024-04-02T18:58:17.727Z",
        "descricao": "string",
        "email": "string",
        "endereco": "string",
        "estado": "string",
        "estadoCivil": 0,
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "loteOrigem": "string",
        "nome": "string",
        "numero": "string",
        "pessoaFisica": 0,
        "rgInscricao": "string",
        "sexo": 0,
        "situacao": 0,
        "telefone": "string",
        "tipoEndereco": 0
    }
]

Campo

Tipo

Descrição

Observações

Obrigatório

nomeStringNome do cliente

Tamanho máximo: 250 caracteres

Sim

enderecoStringEndereço principal do cliente

Tamanho máximo: 150 caracteres

Não

numeroStringNúmero do endereço principal do cliente

Tamanho máximo: 15 caracteres

Não

complementoStringComplemente do endereço principal do cliente

Tamanho máximo: 50 caracteres

Não

bairroStringBairro principal do cliente

Tamanho máximo: 100 caracteres

Não

cidadeStringCidade principal do cliente

Tamanho máximo: 100 caracteres

Não

estadoStringEstado principal do cliente

Tamanho máximo: 30 caracteres

Não

cepStringCEP do endereço principal do cliente

Tamanho máximo: 10 caracteres

Não

telefoneStringTelefone do cliente

Tamanho máximo: 20 caracteres

Não

celularStringCelular do cliente

Tamanho máximo:  20 caracteres

Não

emailStringEmail do cliente

Tamanho máximo: 80 caracteres

Não

dataNascimentoDatetime

Data de nascimento do cliente


Não
situacaoIntSituação do cliente 

0 - Inativo, 1 - Ativo

Sim

pessoaFisicaIntIndica se o cliente é uma pessoa física ou jurídica0 - Pessoa Física, 1 - Pessoa JurídicaSim
cpfCnpjStringCPF ou CNPJ do cliente

Tamanho máximo: 25 caracteres

Não

rgInscricaoStringRG do cliente

Tamanho máximo: 25 caracteres

Não

sexoIntIndica o genero do cliente 
DescriçãoCódigo
Não informado0
Masculino1
Feminino2

Não

estadoCivilIntIndica o estado civil do cliente
DescriçãoCódigo
Não informado0
Casado1
Solteiro2
Viúvo3
Separado4
Devorciado5
Outros6

Não

avatarUrlStringDEFASADODEFASADONão
atividadeStringAtividade

Tamanho máximo: 500 caracteres

Não

crachaStringDEFASADO

DEFASADO

Não

idInquilinoString

Identificador do inquilino 


Sim
idRetaguardaStringIdentificador do cliente na retaguardaTamanho máximo: 100 caracteresSim
idProprietarioStringIdentificador do proprietário
Sim
loteOrigemStringIdentificador do lote em que serão enviados os dados
Sim
tipoEnderecoIntTipo Endereço
DescriçãoCódigo
Entrega0
Comercial1
Cobrança2
Não
descricaoStringDescrição

Tamanho maxímo: 100 caracteres

Não

Campo

Tipo

Descrição

SuccessboolIndica se a criação do cliente foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do cliente eles serão enviados nesse campo
DataobjetoObjeto cliente criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

{
    "success": true,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint

    Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório

    Campo

    Tipo

    Descrição
    code string Código de erro
    message string Mensagem do erro
    detailedMessage string Detalhamento do erro
    helpUrl string url de ajuda
    TotalTime string Tempo total de busca
    details lista de objeto Lista de objeto de erros
    details.guid string Identificador do erro
    details.code string Código do erro
    details.message string Mensagem do erro 
    details.detailedMessage string Detalhamento do erro

    Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma excessão é lançada pela aplicação

    Campo

    Tipo

    Descrição
    Success bool Indica se a criação do cliente foi feita com sucesso
    Message string Messagem com os erros
    Data objeto Objeto cliente
    Errors Lista Listas com os erros encontrados no processo
    TotalTime int tempo da requisição
    NumberOfRecords int número de dados inseridos

    {
        "success": false,
        "message": "",
        "data": null,
        "errors": null,
        "totalTime": 0,
        "numberOfRecords": 0
    }

    • Sem rótulos