Exibir origem

CONTEÚDO

Visão Geral
Endpoint
Exemplo de Utilização
Dicionário
Links

01. VISÃO GERAL

Este endpoint é responsável por cancelar um cupom de uma venda venda, nesse caso na requisição você deve enviar os campos do json da venda feita previamente que você quer cancelar.

02. ENDPOINT

Método	URL	Ambiente
POST	https://api-barramento.meuelevestage.com/loyalty/cancel	Homologação
POST	https://api-barramento.meueleve.com.br/loyalty/cancel	Produção

03. EXEMPLO DE UTILIZAÇÃ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"`	token	`Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1OWRiYTMxODBhZWYzMDE5MTBiNDAwYjgiLCJuYW1lIjoidmFtb3MiLCJwb3NpdGlvbiI6IkNFTyIsImVtYWlsIjoidmFtb3NAdmFtb3MuY29tLmJyIiwicm9sZSI6IkNsaWVudCIsImlhdCI6MTUwODM3MTc4MiwiZXhwIjoxNTA4MzgxODYyfQ.H1PgEa3fvUWQVqHHBocPfkoJ-cC8pFgTsGy_puY3kC"`

Segue abaixo um exemplo do corpo da requisição:

{
  "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

Estrutura cancel:

Campo	Valor	Descrição
saleId *	string/uuid	Id da venda
saleValue *	integer	Valor da venda
saleDate*	string	Data da venda no formato yyyy-mm-dd hh:mm:ss
customerId*	string	Id do cliente/comprador que é representado por seu cpf
checkout*	string	Número do caixa
merchantName*	string	Nome do estabelecimento
products*	string	Lista de objetos de produto, aqui são listados alguns dados dos produtos

Estrutura lista products

Campo	Valor	Descrição
code *	string	Código do produto
name *	integer	Nome do produto
quantity*	string	Quantidade do produto

05. RESPOSTAS DA REQUISIÇÃ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

{
    "errors": [
    {
        "key": "string",
        "message": "string"
    }
  ]
}

espaço

Campo

Tipo

Descrição

{

errors [ {

lista de objetos

Lista de objeto de erro

key

string

Demonstra qual campo não foi encontrado na requisição

message

}

]

}

string

Mensagem do erro.

Status Code

Corpo da Resposta

Dicionário

500

{
    "errors": [
    {
        "key": "string",
        "message": "string"
    }
  ]
}

espaço

Campo

Tipo

Descrição

{

errors [ {

lista de objetos

Lista de objeto de erro

key

string

Demonstra qual campo apresentou problema

message

}

]

}

string

Mensagem do erro.

06. LINKS

Get Customers Loyalty
Load
Redeem