GET
https://www.allpost.com.br/api/v1/reversa/pontos-devolucao

Lista os pontos de devolução cadastrados pela loja (usados em reversa)

Módulo: Pedido

Descrição

Lista os pontos de devolução cadastrados pela loja autenticada. Utilizados nos fluxos de reversa para indicar onde o produto pode ser devolvido/postado.

Exemplo:
- https://www.allpost.com.br/api/v1/reversa/pontos-devolucao
- https://www.allpost.com.br/api/v1/reversa/pontos-devolucao?tipo=agencia&limite=100

Todos os parâmetros são opcionais. O isolamento é feito automaticamente pela loja do token.
Ordenado por tipoPontoDeDevolucao e nome.

Códigos de retorno:
- 200: sucesso (lista de pontos).
- 400: parâmetro inválido.
- 401: token ausente, expirado ou inválido.

Parâmetros de Path

Parâmetro Tipo Obrigatório Descrição
tipo string Não Filtra pelo tipo do ponto de devolução (tipoPontoDeDevolucao).
limite inteiro Não Quantidade máxima de registros (1–5000, default: 5000).

Parâmetros de Retorno

Campo Tipo Descrição
total inteiro Quantidade de pontos retornados.
pontos[] array Lista de pontos de devolução.
pontos[].id string Identificador do ponto de devolução (_id).
pontos[].nome string Nome do ponto de devolução.
pontos[].cep string CEP (somente dígitos).
pontos[].endereco string Logradouro.
pontos[].numero string Número.
pontos[].referencia string Ponto de referência.
pontos[].bairro string Bairro.
pontos[].cidade string Cidade.
pontos[].uf string Unidade federativa (sigla).
pontos[].tipoPontoDeDevolucao string Tipo do ponto de devolução.
pontos[].status string Situação do ponto (ex.: "Ativo").

Response

{
  "total": 2,
  "pontos": [
    {
      "id": "38bf46a77456ca9d4c740a418cdb55c2",
      "nome": "Loja Centro",
      "cep": "30110001",
      "endereco": "Avenida Afonso Pena",
      "numero": "1000",
      "referencia": "Em frente à praça",
      "bairro": "Centro",
      "cidade": "Belo Horizonte",
      "uf": "MG",
      "tipoPontoDeDevolucao": "loja",
      "status": "Ativo"
    },
    {
      "id": "a8450623c886bda5f4be1356e2482d28",
      "nome": "Agência Zona Sul",
      "cep": "04567000",
      "endereco": "Rua das Flores",
      "numero": "250",
      "referencia": "",
      "bairro": "Vila Mariana",
      "cidade": "São Paulo",
      "uf": "SP",
      "tipoPontoDeDevolucao": "agencia",
      "status": "Ativo"
    }
  ]
}