Skip to content

Busca por moedas cadastradas

GET /common/currency/{currencyId}

Busca por moedas cadastradas

Descrição

Este endpoint é responsável por retornar uma moeda previamente cadastrada, permitindo a consulta de suas informações com base nos dados registrados na API.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {token}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
currencyIdstringSimID da moeda que deve ser retornada (Exemplo: BRL)

Exemplo de Requisição

1curl --request GET \
2 --url https://sua-loja-uappi.com.br/api/v3/common/currency/{currencyId}\
3 --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2 "id": "BRL",
3 "name": "Brazilian Real",
4 "prefix": "R$",
5 "precision": 2,
6 "decimalSeparator": ",",
7 "thousandsSeparator": "."
8}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

1{
2 "status": false,
3 "data": {
4 "code": 404,
5 "errorCode": "NOT_FOUND",
6 "message": "Não encontrado."
7 }
8}

Listagem de moedas de países

GET /common/currencies

Listagem de moedas de países

Descrição

Este endpoint é responsável por retornar todas as moedas cadastradas, permitindo a consulta das informações disponíveis na API.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {token}Token de autenticação

Exemplo de Requisição

1curl --request GET \
2 --url {{MAIN_URL}}/common/currencies\
3 --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2 {
3 "id": "BRL",
4 "name": "Brazilian Real",
5 "prefix": "R$",
6 "precision": 2,
7 "decimalSeparator": ",",
8 "thousandsSeparator": "."
9 },
10 {
11 "id": "USD",
12 "name": "United States Dollar",
13 "prefix": "U$",
14 "precision": 2,
15 "decimalSeparator": ".",
16 "thousandsSeparator": ","
17 },
18 {
19 "id": "EUR",
20 "name": "Euro",
21 "prefix": "€",
22 "precision": 2,
23 "decimalSeparator": ",",
24 "thousandsSeparator": "."
25 },
26 {
27 "id": "GBP",
28 "name": "British Pound Sterling",
29 "prefix": "£",
30 "precision": 2,
31 "decimalSeparator": ".",
32 "thousandsSeparator": ","
33 }
34}

Uappi é a melhor opção para o crescimento da sua loja!

;