Busca de países e estados
GET
/common/country/{countryId}
Busca de países e estados
Descrição
Este endpoint é responsável por retornar todos os estados de um país informado, trazendo para cada estado o seu ID e nome. A resposta permite consultar de forma simples e estruturada as unidades federativas associadas ao país buscado.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {userToken} | Token de autenticação |
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| countryId | string | Sim | Código alfa 3 do país (Exemplo: BRA) |
Exemplo de Requisição
1curl --request GET \2 --url https://sua-loja-uappi.com.br/api/v3/common/country/{countryId}\3 --header "Authorization: Bearer userToken" \✅ Resposta de Sucesso
1{2 "registers": [3 4 ],5 "id": "BRA",6 "code": "BR",7 "name": "Brasil",8 "ddi": "+55",9 "currency": "BRL",10 "states": {11 "BR-AC": {12 "id": "BR-AC",13 "name": "Acre"14 },15 "BR-AL": {16 "id": "BR-AL",17 "name": "Alagoas"18 },19 "BR-AP": {20 "id": "BR-AP",21 "name": "Amapá"22 }23 }24}⚠️ 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 países e estados
GET
/common/countries
Listagem de países e estados
Descrição
Este endpoint é responsável por retornar todos os países e seus respectivos estados cadastrados, permitindo a consulta estruturada das informações disponíveis na API.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {token} | Token de autenticação |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/common/countries\Estrutura do Response
1{2 "id": "BRA",3 "code": "BR",4 "name": "Brasil",5 "ddi": "+55",6 "currency": "BRL",7 "states": {8 "BR-AC": {9 "id": "BR-AC",10 "name": "Acre"11 },12 "BR-AL": {13 "id": "BR-AL",14 "name": "Alagoas"15 },16 "BR-AP": {17 "id": "BR-AP",18 "name": "Amapá"19 }20 }21}