Objetivo

Permitir que o parceiro envie dados cliente para o PDV.

Esta operação ocorre nos eventos 'Identificar o cliente', 'Cadastrar pessoa' e também no pagamento por convênio, caso o cliente não tenha sido identificado durante a compra.

Chamada

POST {url}

Informações da Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
DocumentStringNúmero do documento de identificação da pessoa
DocumentTypeString

Tipo de documento de identificação

cdtIDInternal - Código interno

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIDForeign


A seguir exemplos de como executar esta operação.

O campo para identificação do cliente,Identification, contém os seguintes campos : 

Document : 11111111111 ==> Dados do documento apresentado
DocumentType: cdtCPF  (cdtIDInternal, cdtCPF, cdtCNPJ, cdtIDForeign) ==> Tipo de documento


PARÂMETROTIPOTAMANHOOBRIGATÓRIODESCRIÇÃO
IdentificationArray of objects
true

Informações para identificação da pessoa

ParâmetroTipoDescrição
DocumentStringNúmero do documento de
identificação da pessoa
DocumentTypeStringTipo de documento de
identificação
CorporateNameString50trueNome / Razão social
FantasyNameString 50trueApelido / Nome fantasia
KindString
true

Tipo de pessoa

cktPhysical - Física 
cktLegal - Jurídica

TaxpayerString
true

Contribuinte de ICMS

yntYes - Sim
yntNo - Não

PublicAgencyString
true

Órgão público

yntYes - Sim
yntNo - Não

TaxRegimeInteger5falseRegime de tributação
GlobalLimitDouble(9, 2)falseValor limite global
DeadlineInteger3falsePrazo máximo em dias
CreditStatusString
true

Situação do crédito

ccsAlert - Alerta 
ccsReleased - Liberado
ccsBlocked - Bloqueado
ccsSuspended - Suspenso

NoteString250falseObservação
CardNumberInteger15falseNúmero do cartão
BusinessSituationString
true

Situação comercial

bstReleased - Liberado 
bstBlocked - Bloqueado

IdSegmentInteger3trueNúmero do segmento
PublicPlaceCodeInteger
trueCódigo do logradouro
KindAddressString
true

Tipo do endereço

katMain - Principal 
katCharge - Cobrança 
katDelivery - Entrega 
katCorrespondence - Correspondência 
katPickUp - Retirada

PublicPlaceString60trueDescrição do logradouro
PublicPlaceNumberString10falseNúmero do logradouro
NeighbourhoodString50trueDescrição do bairro
ComplementString60falseComplemento de endereço
CityString60trueNome da cidade
FederativeUnitString2trueEstado da cidade
ZipCodeInteger8trueCep
IBGEInteger12falseCódigo da cidade no IBGE


Request Exemplo

{
   "id":"{E20B5192-1CDB-4F92-99C4-BB0F8CD700DB}",
   "version":1,
   "identification":{
      "document":"11111111111",
      "documentType":"cdtCPF"
   }
}

Response Example

{
   "id":"{B0DAC044-3540-4EBF-988F-18BE345A9609}",
   "version":1,
   "person":{
      "identification":{
         "document":"11111111111",
         "personCode":0,
         "documentType":"cdtCPF",
         "identificationType":"citInternal"
      },
      "corporateName":"Razao social",
      "fantasyName":"Nome fantasia",
      "kind":"cktPhysical",
      "taxpayer":"yntYes",
      "publicAgency":"yntNo",
      "customer":{
         "taxRegime":1,
         "globalLimit":1000.5,
         "deadline":30,
         "lastConstraintDateTime":"2022-09-21T10:00:00.000Z",
         "creditStatus":"cstReleased",
         "note":"Observacao do cliente",
         "cardNumber":12345,
         "businessSituation":"bstReleased"
      },
      "customerSegments":[
         {
            "idSegment":1,
         },
         {
            "idSegment":2,
         }
      ],
      "addresses":[
         {
            "publicPlaceCode":1000,
            "kindAddress":"katMain",
            "publicPlace":"Rua nova uniao",
            "publicPlaceNumber":"100",
            "neighbourhood":"Santa Monica",
            "complement":"Cond Novo, bl 50 apto 400",
            "city":"Uberlandia",
            "federativeUnit":"MG",
            "zipCode":38411108,
            "iBGE":10
         },
         {
            "publicPlaceCode":500,
            "kindAddress":"katDelivery",
            "publicPlace":"Rua Araguari",
            "publicPlaceNumber":"95",
            "neighbourhood":"Centro",
            "complement":"Edif Plaza, 10 andar",
            "city":"Uberlandia",
            "federativeUnit":"MG",
            "zipCode":38411108,
            "iBGE":10
         },
         {
            "publicPlaceCode":71,
            "kindAddress":"katCorrespondence",
            "publicPlace":"Av Sebastiao Salgado",
            "publicPlaceNumber":"32",
            "neighbourhood":"Centro",
            "complement":"Edif Central, 15 andar",
            "city":"Uberlandia",
            "federativeUnit":"MG",
            "zipCode":38411108,
            "iBGE":10
         }
      ]
   }
}