Páginas filhas
  • API Loyalty - Redeem

Versões comparadas

Chave

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

CONTEÚDO

01. VISÃO GERAL
Âncora
VisãoGeral
VisãoGeral

Este endpoint é responsável por resgatar os cupons de desconto e se tiver, aplicá-los na venda enviada nesse caminho.


02. ENDPOINT
Âncora
Endpoint
Endpoint

03. EXEMPLO DE UTILIZAÇÃO
Âncora
ExemploDeUtilização
ExemploDeUtilização

Para realizar essa requisição é necessário enviar o header com o campo Authorization e seu respectivo valor:
Exemplo:

Campo chave

Tipo

Valor

"Authorization"tokenBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1OWRiYTMxODBhZWYzMDE5MTBiNDAwYjgiLCJuYW1lIjoidmFtb3MiLCJwb3NpdGlvbiI6IkNFTyIsImVtYWlsIjoidmFtb3NAdmFtb3MuY29tLmJyIiwicm9sZSI6IkNsaWVudCIsImlhdCI6MTUwODM3MTc4MiwiZXhwIjoxNTA4MzgxODYyfQ.H1PgEa3fvUWQVqHHBocPfkoJ-cC8pFgTsGy_puY3kC"
Bloco de código
titleJSON Corpo da requisição
linenumberstrue
{
  "saleId": "423513a9-eb39-4769-938d-a974d2956448",
  "saleValue": 100,
  "saleDate": "2024-05-15 15:24:49",
  "customerId": "39791541736",
  "checkout": "563412",
  "merchantName": "Bar FixCRM",
  "products": [
    {
      "code": "00005",
      "name": "Vodka Smirnoff 25000",
      "quantity": 1
    }
  ]
}

04. DICIONÁRIO
Âncora
Dicionário
Dicionário


  • Estrutura redeem:

Campo

Valor

Descrição

saleId *string/uuid Id da venda

saleValue *

integerValor da venda

saleDate*

stringData da venda no formato yyyy-mm-dd hh:mm:ss

customerId*

stringId do cliente/comprador que é representado por seu cpf

checkout*

stringNúmero do caixa

merchantName*

stringNome do estabelecimento

products*

stringLista de objetos de produto, aqui são listados alguns dados dos produtos


  • Estrutura lista products

Campo

Valor

Descrição

code *stringCódigo do produto

name *

integerNome do produto

quantity*

stringQuantidade do produto

05. RESPOSTAS DA REQUISIÇÃO
Âncora
RespostasDaRequisição
RespostasDaRequisição


Status Code

Corpo da Resposta

Dicionário

200


Não possui resposta, apenas o Status Code é retornado

Status Code

Corpo da Resposta

Dicionário

404

Bloco de código
titleResposta Status Code 400
linenumberstrue
{
    "errors": [
    {
        "key": "string",
        "message": "string"
    }
  ]
}


espaço

Campo

TipoDescrição

{

errors [ {

lista de objetos

Lista de objeto de erro


key stringDemonstra qual campo não foi encontrado na requisição 

message

}

]

}

stringMensagem do erro.

Status Code

Corpo da Resposta

Dicionário

500

Bloco de código
titleResposta Status Code 400
linenumberstrue
{
    "errors": [
    {
        "key": "string",
        "message": "string"
    }
  ]
}


espaço

Campo

TipoDescrição

{

errors [ {

lista de objetosLista de objeto de erro                                                          
key stringDemonstra qual campo apresentou problema

message

}

]

}

stringMensagem do erro.

01. DADOS GERAIS

...



Templatedocumentos