Histórico da Página

...

Realizar a solicitação ao parceiro (fiscal de caixa remoto), informando qual a rotina e demais dados para a liberação ou não da rotina do PDV.

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

Parâmetros do Corpo (Body Parameters)

PARÂMETRO	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
Authenticator	Object Json	-	Sim	Grupo com os dados para autenticação
Authenticator.Header	Object Json	-	Sim	Grupo com os dados do cabeçalho
Authenticator.Header.Description	String	-	Sim	Descrição da

...

rotina a ser liberada
Authenticator.Header.IdStore
Authenticator.Header.IdTerminal
Authenticator.Header.IdUser
Authenticator.Header.Method
Authenticator.Header.MethodStatus
Authenticator.Header.MethodTitle
Authenticator.Sale	Object Json	-	Sim	Grupo com os dados da venda
Authenticator.Sale.AccountingDate
Authenticator.Sale.DateTimeIssue
Authenticator.Sale.IdDocument
Authenticator.Sale.Items
Authenticator.Sale.Items[0].Description
Authenticator.Sale.Items[0].InternalCode
Authenticator.Sale.Items[0].ItemNumber
Event
Execution
ID
Operation
Version

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

Bloco de código

language	actionscript3

{
    "Authenticator": {
        "Header": {
            "Description": "Cancelamento do documento",
            "IdStore": 1,
            "IdTerminal": 301,
            "IdUser": 2,
            "Method": "mtCancelarCupom",
            "MethodStatus": "arNone",
            "MethodTitle": "Autenticacao de usuario"
        },
        "Sale": {
            "AccountingDate": "2023-11-23T00:00:00",
            "DateTimeIssue": "2023-11-23T08:03:41",
            "IdDocument": 122552,
            "Items": [
                {
                    "Description": "AJINOMOTO REFIL 100G",
                    "InternalCode": "7274",
                    "ItemNumber": 1
                },
                {
                    "Description": "ACENDEDOR IMPERIAL TOCA FOGO C/6",
                    "InternalCode": "1825",
                    "ItemNumber": 2
                }
            ]
        }
    },
    "Event": "cetBefore",
    "Execution": "cetContinue",
    "ID": "00130120231123080341",
    "Operation": "cotAuthenticator",
    "Version": 1
}

...

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

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

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

Parâmetros do Corpo (Body Parameters)

Formatos de Requisição (Request Formats)

application/json

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)