Consulta Cliente - POST

Objetivo

Permitir que o parceiro envie dados do cliente para o PDV. Essa operação ocorre nos eventos de identificação do cliente no PDV e também durante o pagamento por convênio, caso o cliente não tenha sido identificado durante a compra. Por favor, siga a documentação de configuração de ambiente para mais detalhes.

Chamada

POST {url}

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

Segurança

Se os parâmetros de autenticação estiver configurado será enviado no Header no formato Basic Auth ou Bearer Token, siga a documentação de configuração para selecionar o modelo de autenticação.

Parâmetros do Corpo (Body Parameters)

Parâmetro	Tipo	Descrição
Id	String	Identificador da requisição
version	Integer	Número da versão
identifications	Array object Json	Lista dos tipos de documento
identifications[0].document	String	Documentos
identifications[0].documentType	String	Tipos de documentos cdtIDInternal - Código interno; cdtCPF - CFP cdtCNPJ - CNPJ cdtIE - Inscrição estadual cdtRG - RG

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

{
  "id":"{58966376-D0D3-44CC-BA9B-22065EC4619E}",
  "version":1,
  "identifications":[
    {
      "document":"12345678909",
      "documentType":"cdtCPF"
    },
    {
      "document":"1000000020",
      "documentType":"cdtIDInternal"
    }
  ]
}

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETRO	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
id	string			Identificado único da resposta
version	Integer			Número da versão
person	Object Json			Objeto json dos dados do cliente
person.documents	Array object Json			Lista de documentos
person.documents[0].document	String		Sim	Documento do cliente
person.documents[0].documentType				Tipo de documento do cliente Tipo de documento de identificação cdtCPF - CFP cdtCNPJ - CNPJ cdtIE - Inscrição estadual cdtRG - RG
person.Name	String	50	Sim	Nome
person.Email	String	80	Não	Email do cliente
person.Kind	String		Sim	Tipo de pessoa cktPhysical - Física cktLegal - Jurídica
person.Taxpayer	String		Não	Contribuinte de ICMS yntYes - Sim yntNo - Não
person.PublicAgency	String		Não	Órgão público yntYes - Sim yntNo - Não
person.customer	Object json			Objeto json dos dados do cliente
person.customerGlobalLimit	Double	9, 2	Não	Valor limite global
person.customer.Deadline	Integer	3	Não	Prazo máximo em dias
person.customer.CreditStatus	String		Não	Situação do crédito ccsAlert - Alerta ccsReleased - Liberado ccsBlocked - Bloqueado ccsSuspended - Suspenso
person.customer.Note	String	250	Não	Observação
person.customer.CardNumber	Integer	15	Não	Número do cartão
person.customer.BusinessSituation	String		Não	Situação comercial bstReleased - Liberado bstBlocked - Bloqueado
person.addresses	Object json			Objeto json com os dados de endereço
person.addresses.KindAddress	String		Sim	Tipo do endereço katMain - Principal katCharge - Cobrança katDelivery - Entrega katCorrespondence - Correspondência katPickUp - Retirada
person.addresses.PublicPlace	String	60	Sim	Descrição do logradouro
person.addresses.PublicPlaceNumber	String	10	Não	Número do logradouro
person.addresses.Neighbourhood	String	50	Sim	Descrição do bairro
person.addresses.Complement	String	60	Não	Complemento de endereço
person.addresses.City	String	60	Sim	Nome da cidade
person.addresses.FederativeUnit	String	2	Sim	Estado da cidade
person.addresses.ZipCode	Integer	8	Sim	Cep sem formatação
person.addresses.IBGE	Integer	12	Não	Código da cidade no IBGE

Formatos de Resposta (Response Formats)

application/json

Exemplo simplificado (Sample)

{
  "id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
  "version": 1,
  "person": {
    "documents":[
      {
        "document":"91347879846",
        "documentType":"cdtCPF"
      },
      {
        "document":"253716652",
        "documentType":"cdtRG"
      }
    ],
    "Name": "Edson Luan Bernardo Nogueira",
    "kind": "cktPhysical",
    "addresses": [
      {
        "kindAddress": "katMain",
        "publicPlace": "Rua Baiacu",
        "publicPlaceNumber": "482",
        "neighbourhood": "Eldorado",
        "complement": "",
        "city": "Diadema",
        "federativeUnit": "SP",
        "zipCode": "14065540",
        "iBGE": 1234
      }
    ]
  }
}

application/json

Exemplo completo (Sample)

{
  "id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
  "version": 1,
  "person": {
    "documents":[
      {
        "document":"91347879846",
        "documentType":"cdtCPF"
      },
      {
        "document":"253716652",
        "documentType":"cdtRG"
      }
    ],
    "Name": "Antonio Arthur João da Mota",
    "email":"[email protected]",
    "kind":"cktPhysical",
    "taxpayer":"yntNo",
    "publicAgency":"yntNo",
    "customer":{
      "globalLimit":0,
      "deadline":0,
      "creditStatus":"ccsReleased",
      "note":"",
      "cardNumber":0,
      "businessSituation":"bstReleased"
    },
    "addresses": [
      {
        "kindAddress": "katMain",
        "publicPlace": "Rua Nestor Ferreira da Rocha",
        "publicPlaceNumber": "368",
        "neighbourhood": "Vila Iolanda II",
        "complement": "",
        "city": "São Paulo",
        "federativeUnit": "SP",
        "zipCode": "08473400",
        "iBGE": 1234
      }
    ]
  }
}

Árvore de páginas

Consulta Cliente - POST

Objetivo

Chamada

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

Segurança

Formatos de Requisição (Request Formats)

application/json

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)

Formatos de Resposta (Response Formats)

application/json

application/json