Áreas de Restrição de Entrega

Este módulo permite gerenciar (criar, consultar, editar e excluir) polígonos geográficos onde o estabelecimento não realiza entregas.

Regras Importantes

• Limitação por Loja: É permitido o cadastro de no máximo 10 áreas de restrição por loja (store_id).
• Polígono Fechado Obrigatório: A geometria da área é definida por um array de coordenadas. É obrigatório que o último ponto seja idêntico ao primeiro ponto para fechar o polígono. Caso contrário, a requisição falhará.
• Quantidade Mínima de Pontos: Para formar uma área fechada válida, o array region deve conter no mínimo 4 pontos (ex: Ponto A -> Ponto B -> Ponto C → Ponto A).

Criar Área de Restrição

Cadastra uma nova região geométrica restrita para a loja.

POST

/store/{store_id}/restricted-regions

Payload Criar Área de Restrição

{
  "name": "Área de Risco Centro",
  "active": false,
  "region": [
    {
      "latitude": -8,
      "longitude": -48
    },
    {
      "latitude": -8.1,
      "longitude": -48.1
    },
    {
      "latitude": -8.2,
      "longitude": -48.2
    },
    {
      "latitude": -8,
      "longitude": -48
    }
  ]
}

Detalhamento dos Campos (Payload)

Campo	Obrigatório	Descrição
name	✅	Nome amigável da área.
active	✅	false a loja não está entregando nesta área (restrição habilitada); true a loja está entregando nesta área (restrição desabilitada).
region	✅	Array de objetos contendo as coordenadas geográficas da área.
region[].latitude	✅	Latitude do ponto geográfico.
region[].longitude	✅	Longitude do ponto geográfico.

Atualizar Área de Restrição

Modifica as configurações, nome, status ou redesenha a geometria de uma área existente através do region_id.

PUT

/store/{store_id}/restricted-regions/{id}

Payload Atualizar Área de Restrição

{
  "name": "Área de Risco Centro",
  "active": false,
  "region": [
    {
      "latitude": -8,
      "longitude": -48
    },
    {
      "latitude": -8.1,
      "longitude": -48.1
    },
    {
      "latitude": -8.2,
      "longitude": -48.2
    },
    {
      "latitude": -8,
      "longitude": -48
    }
  ]
}

Listar Áreas de Restrição

Retorna todas as áreas de restrição cadastradas para a loja especificada.

GET

/store/{store_id}/restricted-regions

Exemplo de Resposta de Sucesso

{
  "data": [
    {
      "id": 451,
      "name": "Zona Norte - Restrição Total",
      "active": true,
      "region": [
        {
          "latitude": -23.5,
          "longitude": -46.6
        },
        {
          "latitude": -23.5,
          "longitude": -46.65
        },
        {
          "latitude": -23.55,
          "longitude": -46.65
        },
        {
          "latitude": -23.55,
          "longitude": -46.6
        },
        {
          "latitude": -23.5,
          "longitude": -46.6
        }
      ],
      "created_at": "2026-04-14T11:47:35.000000Z",
      "updated_at": "2026-04-14T14:10:59.000000Z"
    },
    {
      "id": 452,
      "name": "Perímetro de Risco Córrego",
      "active": true,
      "region": [
        {
          "latitude": -23.52,
          "longitude": -46.62
        },
        {
          "latitude": -23.52,
          "longitude": -46.64
        },
        {
          "latitude": -23.54,
          "longitude": -46.64
        },
        {
          "latitude": -23.54,
          "longitude": -46.62
        },
        {
          "latitude": -23.52,
          "longitude": -46.62
        }
      ],
      "created_at": "2026-04-24T19:29:39.000000Z",
      "updated_at": "2026-04-24T19:29:39.000000Z"
    },
    {
      "id": 453,
      "name": "Área Festiva - Bloqueio Temporário",
      "active": false,
      "region": [
        {
          "latitude": -23.56,
          "longitude": -46.61
        },
        {
          "latitude": -23.56,
          "longitude": -46.63
        },
        {
          "latitude": -23.58,
          "longitude": -46.63
        },
        {
          "latitude": -23.58,
          "longitude": -46.61
        },
        {
          "latitude": -23.56,
          "longitude": -46.61
        }
      ],
      "created_at": "2026-04-24T19:43:17.000000Z",
      "updated_at": "2026-04-24T19:43:17.000000Z"
    }
  ]
}

Consultar Detalhe da Área de Restrição

Busca as informações detalhadas e as coordenadas geográficas de uma única área de restrição específica.

GET

/store/{store_id}/restricted-regions/{id}

Exemplo de Resposta de Sucesso

{
  "data": {
    "id": 451,
    "name": "Área de Risco Centro",
    "active": false,
    "region": [
      {
        "latitude": -8,
        "longitude": -48
      },
      {
        "latitude": -8.1,
        "longitude": -48.1
      },
      {
        "latitude": -8.2,
        "longitude": -48.2
      },
      {
        "latitude": -8,
        "longitude": -48
      }
    ],
    "created_at": "2026-04-14T11:47:35.000000Z",
    "updated_at": "2026-04-14T14:10:59.000000Z"
  }
}

Deletar Área de Restrição

Remove permanentemente uma área de restrição da loja. Uma vez deletada, o marketplace voltará a aceitar pedidos na região imediatamente.

DELETE

/store/{store_id}/restricted-regions/{id}