Clientes

Criando um novo cliente

Criar cliente.

POST https://registroeletronico-homolog.cdxti.com.br/api/customers

Cria um novo cliente.

Headers

Name	Type	Description
Authorization	Bearer Token	Token gerado pelo método de autenticação

Request Body

Name	Type	Description
partnerCustomerId*	string	Id do cliente no sistema do parceiro
name*	string	Razão Social do cliente
identifier*	string	CNPJ do cliente
phoneNumber*	string	Telefone do cliente
zipCode*	string	CEP do cliente
address*	string	Endereço do cliente
addressNumber*	integer	Número do endereço do cliente
additionalAddress	string	Complemento do endereço do cliente
district*	string	Bairro do cliente
ibgeCode*	string	Código IBGE do município do cliente
appUserName*	string	Nome de usuário principal a ser criado no sistema CDX
appUserIdentifier*	string	CPF do usuário principal a ser criado no sistema CDX
appUserPhoneNumber*	string	Telefone do usuário principal a ser criado no sistema CDX
appUserEmail*	string	E-mail do usuário principal a ser criado no sistema CDX
organization*	object	Organização autorizada a realizar essa operação

201: Created Cliente criado com sucesso

{
    "id": 1109,
    "partnerCustomerId": "18238167237678124",
    "name": "Cliente XPTO Ltda",
    "identifier": "00000000000000",
    "phoneNumber": "4199999999",
    "zipCode": "80000000",
    "address": "Rua do Sol",
    "addressNumber": 100,
    "additionalAddress": "N/A",
    "district": "Bairro",
    "ibgeCode": "4106902",
    "appUserName": "Nome do Usuário",
    "appUserIdentifier": "11111111111",
    "appUserPhoneNumber": "4199999999",
    "appUserEmail": "[email protected]",
    "customerType": "LEAD",
    "ticket": "5c9fcc4a-693f-4d11-b20e-71d9eaaba858",
    "organization": {
        "id": 1051,
        "identifier": "20061411000102"
    }
}

400 Bad Request

{
    "type": "https://registroeletronico.certdox.com.br/problem/constraint-violation",
    "title": "Method argument not valid",
    "status": 400,
    "path": "/api/customers-with-representatives",
    "message": "error.validation",
    "fieldErrors": [
        {
            "objectName": "customerWithRepresentatives",
            "field": "phoneNumber",
            "message": "must not be null"
        }
    ]
}

401 Unauthorized

{
    "type": "https://registroeletronico.certdox.com.br/problem/problem-with-message",
    "title": "Unauthorized",
    "status": 401,
    "detail": "Full authentication is required to access this resource",
    "path": "/api/customers-with-representatives",
    "message": "error.http.401"
}

Organization - Schema

{
    "identifier": "00000000000000" // CNPJ | String | Required | mix = 14, max = 14
}

Representative - Schema

[
    {
        "name": "Representante Um", // String | Required | max = 50
        "identifier": "00000000001", // CPF | String | Required | min = 11, max = 11
        "email": "[email protected]" // E-mail | String | Required | max = 50
    }
]

Exemplo de Payload Completo

{
    "organization": {
        "identifier": "00000000000000" //CNPJ do parceiro
    },
    "partnerCustomerId": "18238167237678124",
    "name": "Cliente XPTO Ltda",
    "identifier": "20061411000102",
    "phoneNumber": "4199999999",
    "zipCode": "80000000",
    "address": "Rua do Sol",
    "addressNumber": 100,
    "additionalAddress": "N/A",
    "district": "Bairro",
    "ibgeCode": "4106902",
    "appUserName": "Nome do Usuário",
    "appUserIdentifier": "11111111111",
    "appUserPhoneNumber": "4199999999",
    "appUserEmail": "[email protected]"
}