POST api/v1/clienteFinal/{clienteFinalId}/enderecos

Adiciona um novo endereço vinculado ao cliente final

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clienteFinalId

integer

Required

Body Parameters

EnderecoRequest
NameDescriptionTypeAdditional information
Fantasia

string

None.

Endereco

string

None.

Complemento

string

None.

Bairro

string

None.

Cidade

string

None.

Cep

string

None.

Estado

string

None.

Numero

integer

None.

NumeroString

string

None.

Tipo

TipoEndereco

None.

Request Formats

application/json, text/json

Sample:
{
  "fantasia": "sample string 1",
  "endereco": "sample string 2",
  "complemento": "sample string 3",
  "bairro": "sample string 4",
  "cidade": "sample string 5",
  "cep": "sample string 6",
  "estado": "sample string 7",
  "numero": 1,
  "numeroString": "sample string 8",
  "tipo": 0
}

application/xml, text/xml

Sample:
<EnderecoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2B.Integration.GenericIntegration.Contracts.Endereco">
  <Bairro>sample string 4</Bairro>
  <Cep>sample string 6</Cep>
  <Cidade>sample string 5</Cidade>
  <Complemento>sample string 3</Complemento>
  <Endereco>sample string 2</Endereco>
  <Estado>sample string 7</Estado>
  <Fantasia>sample string 1</Fantasia>
  <Numero>1</Numero>
  <NumeroString>sample string 8</NumeroString>
  <Tipo>Cobranca</Tipo>
</EnderecoRequest>

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 'EnderecoRequest'.

Response Information

Resource Description

ClienteFinalEnderecosResponse
NameDescriptionTypeAdditional information
Enderecos

Collection of EnderecoResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "enderecos": [
    {
      "fantasia": "sample string 1",
      "endereco": "sample string 2",
      "complemento": "sample string 3",
      "bairro": "sample string 4",
      "cidade": "sample string 5",
      "cep": "sample string 6",
      "estado": "sample string 7",
      "numero": 1,
      "numeroString": "sample string 8",
      "tipo": 0
    },
    {
      "fantasia": "sample string 1",
      "endereco": "sample string 2",
      "complemento": "sample string 3",
      "bairro": "sample string 4",
      "cidade": "sample string 5",
      "cep": "sample string 6",
      "estado": "sample string 7",
      "numero": 1,
      "numeroString": "sample string 8",
      "tipo": 0
    }
  ]
}

application/xml, text/xml

Sample:
<ClienteFinalEnderecosResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2B.Integration.GenericIntegration.Contracts.ClienteFinal">
  <Enderecos xmlns:d2p1="http://schemas.datacontract.org/2004/07/B2B.Integration.GenericIntegration.Contracts.Endereco">
    <d2p1:EnderecoResponse>
      <d2p1:Bairro>sample string 4</d2p1:Bairro>
      <d2p1:Cep>sample string 6</d2p1:Cep>
      <d2p1:Cidade>sample string 5</d2p1:Cidade>
      <d2p1:Complemento>sample string 3</d2p1:Complemento>
      <d2p1:Endereco>sample string 2</d2p1:Endereco>
      <d2p1:Estado>sample string 7</d2p1:Estado>
      <d2p1:Fantasia>sample string 1</d2p1:Fantasia>
      <d2p1:Numero>1</d2p1:Numero>
      <d2p1:NumeroString>sample string 8</d2p1:NumeroString>
      <d2p1:Tipo>Cobranca</d2p1:Tipo>
    </d2p1:EnderecoResponse>
    <d2p1:EnderecoResponse>
      <d2p1:Bairro>sample string 4</d2p1:Bairro>
      <d2p1:Cep>sample string 6</d2p1:Cep>
      <d2p1:Cidade>sample string 5</d2p1:Cidade>
      <d2p1:Complemento>sample string 3</d2p1:Complemento>
      <d2p1:Endereco>sample string 2</d2p1:Endereco>
      <d2p1:Estado>sample string 7</d2p1:Estado>
      <d2p1:Fantasia>sample string 1</d2p1:Fantasia>
      <d2p1:Numero>1</d2p1:Numero>
      <d2p1:NumeroString>sample string 8</d2p1:NumeroString>
      <d2p1:Tipo>Cobranca</d2p1:Tipo>
    </d2p1:EnderecoResponse>
  </Enderecos>
</ClienteFinalEnderecosResponse>