POST api/v1/clienteFinal/pessoaFisica

Cadastra um novo cliente final pessoa física a partir dos dados fornecidos no site

Request Information

URI Parameters

None.

Body Parameters

ClienteFinalFisicoRequest
NameDescriptionTypeAdditional information
Nome

string

None.

Cpf

string

None.

Telefone

string

None.

Telefone2

string

None.

Email

string

None.

DataNascimento

date

None.

Request Formats

application/json, text/json

Sample:
{
  "nome": "sample string 1",
  "cpf": "sample string 2",
  "telefone": "sample string 3",
  "telefone2": "sample string 4",
  "email": "sample string 5",
  "dataNascimento": "2025-12-12T18:14:04.207435-03:00"
}

application/xml, text/xml

Sample:
<ClienteFinalFisicoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2B.Integration.GenericIntegration.Contracts.ClienteFinal">
  <Cpf>sample string 2</Cpf>
  <DataNascimento>2025-12-12T18:14:04.207435-03:00</DataNascimento>
  <Email>sample string 5</Email>
  <Nome>sample string 1</Nome>
  <Telefone>sample string 3</Telefone>
  <Telefone2>sample string 4</Telefone2>
</ClienteFinalFisicoRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClienteFinalFisicoRequest'.

Response Information

Resource Description

ClienteFinalResponse
NameDescriptionTypeAdditional information
ClienteFinalId

Id do cliente final no ambiente cliente

integer

None.

Ativo

boolean

None.

PessoaFisica

Preencher somente o objeto correspondente ao tipo de pessoa

ClienteFinalPessoaFisicaResponse

None.

PessoaJuridica

Preencher somente o objeto correspondente ao tipo de pessoa

ClienteFinalPessoaJuridicaResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "clienteFinalId": 1,
  "ativo": true,
  "pessoaFisica": {
    "nome": "sample string 1",
    "cpf": "sample string 2",
    "telefone": "sample string 3",
    "telefone2": "sample string 4",
    "email": "sample string 5"
  },
  "pessoaJuridica": {
    "razaoSocial": "sample string 1",
    "cnpj": "sample string 2",
    "fantasia": "sample string 3",
    "contato": "sample string 4",
    "inscricaoEstadual": "sample string 5",
    "email": "sample string 6",
    "telefone": "sample string 7",
    "telefone2": "sample string 8"
  }
}

application/xml, text/xml

Sample:
<ClienteFinalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2B.Integration.GenericIntegration.Contracts.ClienteFinal">
  <Ativo>true</Ativo>
  <ClienteFinalId>1</ClienteFinalId>
  <PessoaFisica>
    <Cpf>sample string 2</Cpf>
    <Email>sample string 5</Email>
    <Nome>sample string 1</Nome>
    <Telefone>sample string 3</Telefone>
    <Telefone2>sample string 4</Telefone2>
  </PessoaFisica>
  <PessoaJuridica>
    <Cnpj>sample string 2</Cnpj>
    <Contato>sample string 4</Contato>
    <Email>sample string 6</Email>
    <Fantasia>sample string 3</Fantasia>
    <InscricaoEstadual>sample string 5</InscricaoEstadual>
    <RazaoSocial>sample string 1</RazaoSocial>
    <Telefone>sample string 7</Telefone>
    <Telefone2>sample string 8</Telefone2>
  </PessoaJuridica>
</ClienteFinalResponse>