Home TOTVS Varejo Supermercados

Árvore de páginas

Versões comparadas

Versão antiga 24

changes.mady.by.user Lucas de Souza Andrade

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Lucas de Souza Andrade

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Permitir que o parceiro envie dados do cliente para o PDV. Esta Essa operação ocorre nos eventos 'Identificar o cliente', 'Cadastrar pessoa' e também no 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âmetroTipoDescrição
Document
IdString
Número do documento de identificação da pessoa
Identificador da requisição
versionIntegerNúmero da versão
identificationsArray object JsonLista dos tipos de documento
identifications[0].documentStringDocumentos
identifications[0].documentTypeString

Tipos de documentos

DocumentTypeStringTipo de documento de identificação

cdtIDInternal - Código interno;

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIDForeign - Identificador único 

cdtIE -  Inscrição estadual

cdtRG - RG

Formatos de Requisição (Request Formats)

...

Bloco de código
languageactionscript3
{
   "id":"{E20B519258966376-1CDBD0D3-4F9244CC-99C4BA9B-BB0F8CD700DB22065EC4619E}",
   "version":1,
  "identifications":[
    {
      "document":"12345678909",
      "identificationdocumentType":"cdtCPF"
    },
    {
      "document":"1111000000020",
      "documentType":"cdtCPFcdtIDInternal"
    }
  ]
}


Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETROTIPOTAMANHOOBRIGATÓRIODESCRIÇÃO
Identification
idstring

Identificado único da resposta
versionInteger

Número da versão
personObject Json
True

Informações do tipo de identificação do cliente



Objeto json dos dados do cliente
person.documentsArray object Json

Lista de documentos
person.documents[0].documentString
SimDocumento do cliente
person.documents[0].documentType


Tipo de documento do cliente

ParâmetroTipoDescriçãoDocumentStringNúmero do documento de
identificação da pessoaDocumentTypeString

Tipo de documento de identificação

cdtIDInternal - Código interno

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIE -  Inscrição estadual

cdtIDForeign

cdtRG -

Identificador único 

RG

person.NameString50
TrueNome / Razão social
SimNome
person.EmailString80NãoEmail do cliente
person.KindString
True

Sim

Tipo de pessoa

cktPhysical - Física 
cktLegal - Jurídica

person.TaxpayerString
False

Não

Contribuinte de ICMS

yntYes - Sim
yntNo - Não

person.PublicAgencyString
False

Não

Órgão público

yntYes - Sim
yntNo - Não

TaxRegimeInteger5FalseRegime de tributaçãoGlobalLimit
person.customerObject json

Objeto json dos dados do cliente
person.customerGlobalLimitDouble9, 2
False
NãoValor limite global
person.customer.DeadlineInteger3
False
NãoPrazo máximo em dias
person.customer.CreditStatusString
False

Não

Situação do crédito

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

person.customer.NoteString250
False
NãoObservação
person.customer.CardNumberInteger15
False
NãoNúmero do cartão
person.customer.BusinessSituationString
False

Não

Situação comercial

bstReleased - Liberado 
bstBlocked - Bloqueado

person.addressesObject json

Objeto json com os dados de endereço
person.addresses[0].KindAddressString
True

Sim

Tipo do endereço

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

person.addresses[0].PublicPlaceString60
True
SimDescrição do logradouro
person.addresses[0].PublicPlaceNumberString10
False
NãoNúmero do logradouro
person.addresses[0].NeighbourhoodString50
True
SimDescrição do bairro
person.addresses[0].ComplementString60
False
NãoComplemento de endereço
person.addresses[0].CityString60
True
SimNome da cidade
person.addresses[0].FederativeUnitString2
True
SimEstado da cidade
person.addresses[0].ZipCodeInteger8
True
SimCep sem formatação
person.addresses[0].IBGEInteger12
False
NãoCódigo da cidade no IBGE

Request Exemplo

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

Response Example

...

Formatos de Resposta (Response Formats)

application/json

Exemplosimplificado(Sample)

Bloco de código
languageactionscript3
{
  "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

Exemplocompleto(Sample)

Bloco de código
languageactionscript3
{
  "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
      }
    ]
  }
}