GET
https://www.allpost.com.br/api/v1/reversa/situacoes/{tipo}
Retorna os valores válidos das situações de reversa (solicitante, motivo, tipo, resolução, pagador de frete)
Módulo: Pedido
Descrição
Retorna os valores válidos das situações de reversa, para montar os campos (dropdowns) antes de criar um pedido de reversa via POST api/v1/pedido/novo.
Exemplos:
- https://www.allpost.com.br/api/v1/reversa/situacoes (retorna todos os tipos)
- https://www.allpost.com.br/api/v1/reversa/situacoes/motivoReversa (retorna apenas um tipo)
O parâmetro tipo na rota é opcional. Sem ele, o retorno é um objeto com todos os tipos e seus valores. Com ele, o retorno contém apenas a lista do tipo informado.
Tipos de situação de reversa aceitos:
- solicitanteReversa: quem solicitou a reversa.
- motivoReversa: motivo da reversa.
- tipoReversa: tipo/modalidade da reversa.
- resolucaoReversa: resolução da reversa.
- pagadorFreteReversa: quem paga o frete da reversa.
Códigos de retorno:
- 200: sucesso.
- 400: tipo de situação de reversa inválido.
- 401: token ausente, expirado ou inválido.
Exemplos:
- https://www.allpost.com.br/api/v1/reversa/situacoes (retorna todos os tipos)
- https://www.allpost.com.br/api/v1/reversa/situacoes/motivoReversa (retorna apenas um tipo)
O parâmetro tipo na rota é opcional. Sem ele, o retorno é um objeto com todos os tipos e seus valores. Com ele, o retorno contém apenas a lista do tipo informado.
Tipos de situação de reversa aceitos:
- solicitanteReversa: quem solicitou a reversa.
- motivoReversa: motivo da reversa.
- tipoReversa: tipo/modalidade da reversa.
- resolucaoReversa: resolução da reversa.
- pagadorFreteReversa: quem paga o frete da reversa.
Códigos de retorno:
- 200: sucesso.
- 400: tipo de situação de reversa inválido.
- 401: token ausente, expirado ou inválido.
Parâmetros de Path
| Campo | Descrição | Tipo | Obrigatório |
| tipo | Tipo de situação de reversa a consultar. Quando omitido, retorna todos os tipos. Valores aceitos: solicitanteReversa, motivoReversa, tipoReversa, resolucaoReversa, pagadorFreteReversa. | string | não |
Parâmetros de Retorno
| Campo | Descrição | Tipo |
| <tipo> | Sem o parâmetro "tipo": cada chave é um tipo de situação (solicitanteReversa, motivoReversa, tipoReversa, resolucaoReversa, pagadorFreteReversa) e o valor é a lista de valores permitidos. | array |
| tipo | Com o parâmetro "tipo": o tipo de situação de reversa consultado. | string |
| lista | Com o parâmetro "tipo": lista de valores permitidos para o tipo consultado. | array |
Response
// Sem o parametro "tipo": retorna todos os tipos de situacao de reversa.
{
"solicitanteReversa": ["Cliente", "Loja"],
"motivoReversa": ["Arrependimento", "Defeito", "Produto errado", "Avaria no transporte"],
"tipoReversa": ["Postagem em agência", "Coleta no Cliente", "Ponto de coleta"],
"resolucaoReversa": ["Cancelamento (Reembolso Total)", "Troca", "Reparo"],
"pagadorFreteReversa": ["Loja", "Cliente"]
}
// Com o parametro "tipo" (ex.: api/v1/reversa/situacoes/motivoReversa):
{
"tipo": "motivoReversa",
"lista": ["Arrependimento", "Defeito", "Produto errado", "Avaria no transporte"]
}