TOTVS Food Service

Páginas filhas
  • API Loyalty - Cancel

Versões comparadas

Versão antiga 5

changes.mady.by.user Raphael Silva Maciel

Gravado em

comparado com

Nova versão 6

changes.mady.by.user Raphael Silva Maciel

Gravado em

Chave

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

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

POSThttps://api-barramento.meuelevestage.com/loyalty/cancelHomologação
POSThttps://api-barramento.meueleve.com.br/loyalty/cancelProduçã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"tokenBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1OWRiYTMxODBhZWYzMDE5MTBiNDAwYjgiLCJuYW1lIjoidmFtb3MiLCJwb3NpdGlvbiI6IkNFTyIsImVtYWlsIjoidmFtb3NAdmFtb3MuY29tLmJyIiwicm9sZSI6IkNsaWVudCIsImlhdCI6MTUwODM3MTc4MiwiZXhwIjoxNTA4MzgxODYyfQ.H1PgEa3fvUWQVqHHBocPfkoJ-cC8pFgTsGy_puY3kC"


JSON do Corpo da requisição

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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


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*

string

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


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.