API docs by Redocly

CRM CISS Api - APIs de integração das Fidelizações do CRM CISS (1.0)

Download OpenAPI specification:Download

Voucher

CRM CISS Api Voucher

Consultar um voucher

Consulta a disponibilidade de um voucher antes da reserva.

header Parameters
Authorization
required
any

Token de acesso a API.

Accept
required
any

application/json

Content Type
required
any

application/json

Request Body schema: application/json
dsVoucher
required
string [ 1 .. 50 ] characters

Código do voucher

nrCnpj
required
string [ 1 .. 14 ] characters

CNPJ da empresa que está consultando o voucher

required
object (IdentificacaoUsuarioDTO)

Identificação do Usuário

Responses

Request samples

Content type
application/json
{
  • "dsVoucher": "NAMORADOS2021",
  • "nrCnpj": "11111111111111",
  • "identificacaoUsuario": {
    }
}

Response samples

Content type
application/json
{
  • "fgSucesso": true,
  • "cdMotivo": "VO200",
  • "dsMotivo": "Voucher encontrado",
  • "dsVoucher": "NAMORADOS2021",
  • "vlVendaMinima": 100,
  • "tpIdentificacaoCliente": "NENHUM",
  • "nrParticipacaoCliente": 0,
  • "peDesconto": 10,
  • "vlLimiteDesconto": 10,
  • "vlSaldo": 0,
  • "dhInicio": "2021-07-01T00:00:00",
  • "dhFim": "2021-07-31T23:59:59"
}

Resgata um voucher

Realiza o resgate/utilziação de um voucher.

header Parameters
Authorization
required
any

Token de acesso a API.

Accept
required
any

application/json

Content Type
required
any

application/json

Request Body schema: application/json
dsVoucher
required
string [ 1 .. 50 ] characters

Código do voucher

nrCnpj
required
string [ 1 .. 14 ] characters

CNPJ da empresa que está consultando o voucher

vlCupom
required
decimal >= 0

Valor do venda que está utilizando o voucher

tpIdentificacaoCliente
required
string (TipoIdentificacaoClienteEnum)
Enum: "NENHUM" "CPF_CNPJ" "EMAIL" "FONE" "CODIGO"

Tipo de identificação do cliente

nrIdentificacao
string [ 1 .. 50 ] characters

Identificação do cliente

required
object (IdentificacaoUsuarioDTO)

Identificação do Usuário

Responses

Request samples

Content type
application/json
{
  • "dsVoucher": "NAMORADOS2021",
  • "nrCnpj": "11111111111111",
  • "vlCupom": 100,
  • "tpIdentificacaoCliente": "NENHUM",
  • "nrIdentificacao": "11111111111",
  • "identificacaoUsuario": {
    }
}

Response samples

Content type
application/json
{
  • "fgSucesso": true,
  • "cdMotivo": "VO201",
  • "dsMotivo": "Voucher resgatado",
  • "vlResgatado": 10,
  • "dsHash": "181CE2EFBC52D44A54E84E6F9BE1B1F1"
}

Estornar a utilização de um voucher

Estorna a utilização de um voucher resgatado anteriormente.

path Parameters
hash
required
string
Example: 181CE2EFBC52D44A54E84E6F9BE1B1F1

Hash do resgate do voucher

header Parameters
Authorization
required
any

Token de acesso a API.

Accept
required
any

application/json

Content Type
required
any

application/json

Request Body schema: application/json
required
object (IdentificacaoUsuarioDTO)

Identificação do Usuário

Responses

Request samples

Content type
application/json
{
  • "identificacaoUsuario": {
    }
}

Response samples

Content type
application/json
{
  • "fgSucesso": true,
  • "cdMotivo": "VO202",
  • "dsMotivo": "Voucher estornado",
  • "identificacaoUsuario": {
    }
}

Relaciona nota com voucher

Relaciona a nota em que o voucher foi utilziado com o voucher utilziado.

header Parameters
Authorization
required
any

Token de acesso a API.

Accept
required
any

application/json

Content Type
required
any

application/json

Request Body schema: application/json
dsDocumentoResgateChave
required
string non-empty

Chave da nota da venda

nrDocumentoResgate
required
integer <int32> >= 0

Número da nota da venda

dsDocumentoResgateSerie
required
string non-empty

Série da nota da venda

hashs
required
Array of strings non-empty

Lista de hashs dos vouchers utilizados na venda

Responses

Request samples

Content type
application/json
{
  • "dsDocumentoResgateChave": "",
  • "nrDocumentoResgate": "123456",
  • "dsDocumentoResgateSerie": "101",
  • "hashs": [
    ]
}

Response samples

Content type
application/json
{
  • "fgSucesso": true,
  • "cdMotivo": "VO203",
  • "dsMotivo": "Nota relacionada"
}