Exibir origem

CONTEÚDO

Visão Geral
Endpoint
Exemplo de Utilização
Respostas da Requisição
Links

01. VISÃO GERAL

Este endpoint é responsável por retornar os dados dos clientes cadastrados, sendo esses dados, dados pessoais do cliente, tipo de desconto, tipo de resgate e produtos.

02. ENDPOINT

Método	URL	Ambiente
GET	https://api-barramento.meuelevestage.com/loyalty/getCustomersLoyalty	Homologação
GET	https://api-barramento.meueleve.com.br/loyalty/getCustomersLoyalty	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"`

04. RESPOSTAS DA REQUISIÇÃO

Status Code

Corpo da Resposta

Dicionário

200

{
  "loyalty": [
    {
      "user": {
        "name": "Fidelidade",
        "phone": {
          "countryCode": "55",
          "areaCode": "21",
          "number": "912345678"
        },
        "email": "[email protected]",
        "documentNumber": "24950282840",
        "notes": "Observação sobre o cliente"
      },
      "loyaltyType": [
        "Stamps"
      ],
      "loyaltyTypeValue": 0,
      "redeemType": "DISCOUNT",
      "discounts": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "products": [
        {
          "name": "string",
          "externalCode": "string",
          "price": 0
        }
      ]
    }
  ]
}

Campo	Tipo	Descrição
{ loyalty [	lista de objetos	Lista com os clientes("user"), com algumas informações de cadastro, tipo de fidelidade, desconto e os produtos.
user {	objeto	Objeto que lista alguns dados do usuário.
name	string	Nome do cliente.
phone {	objeto	Dados de telefone.
countryCode	string	Código do país.
areaCode	string	Código de área.
number },	string	Número do telefone.
email	string	Campo E-mail.
documentNumber	string	Campo recebe o CPF do cliente fidelizado.
notes	string	Campo de notas.
loyaltyType [ "Stamps" ]	lista de string	Tipos de fidelidade.
loyaltyTypeValue	number	Valor do tipo de fidelidade.
redeemType	string	Tipo do resgate.
discounts [ {	lista de objeto	Lista os descontos disponíveis para o cliente.
name	string	Nome do desconto ou cupom.
value } ]	number	Valor do desconto
products [ {	lista de objeto	Lista de produtos
name	string	Nome do produto
externalCode	string	Código do produto
price } ] } ] }	number	Preço do produto

Status Code

Corpo da Resposta

Dicionário

404

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

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"
    }
  ]
}

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.

05. LINKS

Load
Redeem
Cancel