ListDropoffLocationsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/loggi/main/json-schema/loggi-list-dropoff-locations-request-schema.json",
  "title": "ListDropoffLocationsRequest",
  "description": "Filtros desejados para a listagem de Loggi Pontos.",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/loggi-pontos-openapi.yml#/components/schemas/ListDropoffLocationsRequest",
  "type": "object",
  "required": [
    "categories"
  ],
  "properties": {
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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.\n\nOs 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.\n\n**Categorias de Perfil:**\n\n- **Ponto Profissional**: Inclui *Leves* e *Agências*.\n- **Ponto Comercial**: Inclui *LoggiPonto Terceiro*.\n- **LoggiPonto**: Inclui todos os pontos. *Esta é a categoria padrão*.\n\n**Categorias de Serviço:**\n\n- **DropOff Sem Etiqueta**\n- **DropOff**\n- **Reversa**\n\nUtilize 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.\n",
      "default": [
        "LoggiPonto"
      ]
    },
    "limit": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Quantidade máxima de Loggi Pontos a serem retornados por página.",
      "default": 100
    },
    "offset": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Posição do primeiro Loggi Ponto a ser retornado.",
      "default": 0
    },
    "location_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Filtro por identificador único para retornar um Loggi Ponto específico.",
      "default": null
    },
    "postal_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Filtro por proximidade de CEP.",
      "default": null
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "description": "Filtro por país.",
      "default": "Brasil"
    },
    "city": {
      "type": [
        "string",
        "null"
      ],
      "description": "Filtro de cidade.",
      "default": null
    },
    "state": {
      "type": [
        "string",
        "null"
      ],
      "description": "Filtro por estado.",
      "default": null
    },
    "longitude": {
      "type": [
        "number",
        "null"
      ],
      "description": "Filtro por longitude.",
      "default": null
    },
    "latitude": {
      "type": [
        "number",
        "null"
      ],
      "description": "Filtro por latitude.",
      "default": null
    },
    "distance": {
      "type": [
        "number",
        "null"
      ],
      "description": "Filtro por distância (em metros).",
      "default": null
    }
  }
}