Sign in

v1

latestOpenAPI 3.0.02026-07-24102197.9 KB
DropoffLocationsAPI

Listar Loggi Pontos.

Lista os Loggi Pontos disponíveis para dropoff.

Teste abaixo o endpoint</h2> <div class="warning-docs">

⚠️ <em>Os campos abaixo precisam ser preenchidos para realização dos testes de endpoint.</em>

</div>
post/dropoff/locations

Request body

categoriesstring[] required

As categorias representam o agrupamento que nossa equipe de negócios faz do tipo de serviço que o Loggi Ponto fornece, ou a categoria na qual queremos inserir esse Loggi Ponto.

Os pontos devem ser filtrados por Perfil (Profissional ou Comercial) e Serviço, sendo possível utilizar categorias de maneira simultânea para resultados com interseção.

Categorias de Perfil:

  • Ponto Profissional: Inclui Leves e Agências.
  • Ponto Comercial: Inclui LoggiPonto Terceiro.
  • LoggiPonto: Inclui todos os pontos. Esta é a categoria padrão.

Categorias de Serviço:

  • DropOff Sem Etiqueta
  • DropOff
  • Reversa

Utilize as categorias de perfil e serviço conforme necessário para refinar sua busca. Por exemplo, para obter pontos comerciais que oferecem o serviço de DropOff, inclua ambas as categorias no filtro.

limitinteger nullable

Quantidade máxima de Loggi Pontos a serem retornados por página.

offsetinteger nullable

Posição do primeiro Loggi Ponto a ser retornado.

location_idstring nullable

Filtro por identificador único para retornar um Loggi Ponto específico.

postal_codestring nullable

Filtro por proximidade de CEP.

countrystring nullable

Filtro por país.

citystring nullable

Filtro de cidade.

statestring nullable

Filtro por estado.

longitudenumber nullable

Filtro por longitude.

latitudenumber nullable

Filtro por latitude.

distancenumber nullable

Filtro por distância (em metros).

Example request

{
  "categories": [
    "Ponto Comercial",
    "DropOff"
  ],
  "limit": 50,
  "offset": 10,
  "location_id": "ALF001",
  "postal_code": "05407002",
  "country": "Brasil",
  "city": "Rio de Janeiro",
  "state": "Minas Gerais",
  "longitude": -43.2096,
  "latitude": -43.2096,
  "distance": 10000
}

Response

Loggi Pontos retornados com sucesso.

status'success' required

Informa que houve sucesso na pesquisa.

Example response

{
  "status": "success",
  "message": {
    "limit": 50,
    "current_page": 2,
    "total_pages": 3,
    "total_locations": 100,
    "pagination": [
      {
        "location_id": "ALF001",
        "location_name": "Loggi Ponto Faria Lima",
        "location_type": "DROP_POINT",
        "categories": [
          "Ponto Comercial",
          "DropOff"
        ],
        "longitude": -463913.79,
        "latitude": -233324.59,
        "country": "Brasil",
        "city": "Belo Horizonte",
        "district": "Barreiro",
        "postal_code": "50721200",
        "address": "Avenida Brigadeiro Faria Lima, 200",
        "neighborhood": "Centro",
        "state": "Bahia",
        "complement": "Sala 201",
        "opening_hours": "Mon - Tue: 08:00 - 20:00, Wed - Sun: Closed",
        "opening_hours_detail": "Mon - Tue: 08:00 - 20:00, Wed - Sun: Closed",
        "opening_hours_details": [
          {
            "day": "Mon",
            "open": "0800",
            "close": "2000"
          }
        ]
      }
    ]
  }
}