BranchGeofence

Representa a una Geocerca de un Comercio. Si no se especifica branch_id, entonces la Geocerca es global para la Company. La Geocerca define un área segura para realizar pedidos. Cualquier pedido que esté fuera de las geocercas será rechazado automáticamente.

Modelo BranchGeofence

{
    "id": 12,
    "name": "geofence_1591995180",
    "type": "circle",
    "data": {
        "shape": "circle",
        "radius": 10000,
        "coordinates": [
            -64.177137,
            10.46951
        ]
    },
    "enabled": true,
    "inverted": false,
    "created_at": "2020-06-12 20:53:00",
    "updated_at": "2020-08-01 01:31:56",
    "branch_id": 34
}
Atributo Tipo Descripción
id int -
name string -
type string -
data GeoShape -
enabled bool -
inverted bool -
created_at datetime\|null -
updated_at datetime\|null -
branch_id int\|null -

Insertar BranchGeofence

Método URI Cabeceras
POST /companies/{companyId}/branch-geofences Authorization 
{
    "name": "string|max:64",
    "type": "required|string|in:circle,polygon,multi_polygon,polygon_array",
    "data": "required|array",
    "enabled": "boolean",
    "inverted": "boolean",
    "format": "string|in:flat_lon_lat_e6,flat_lat_lon_e6,flat_lon_lat,flat_lat_lon,point_lon_lat_e6,point_lat_lon_e6,point_lon_lat,point_lat_lon"
}

Insertar BranchGeofence de Branch

Método URI Cabeceras
POST /companies/{companyId}/branches/{branchId}/branch-geofences Authorization 
{
    "name": "string|max:64",
    "type": "required|string|in:circle,polygon,multi_polygon,polygon_array",
    "data": "required|array",
    "enabled": "boolean",
    "inverted": "boolean",
    "format": "string|in:flat_lon_lat_e6,flat_lat_lon_e6,flat_lon_lat,flat_lat_lon,point_lon_lat_e6,point_lat_lon_e6,point_lon_lat,point_lat_lon"
}

Listar BranchGeofence

Listar BranchGeofence de Branch

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/branch-geofences Authorization

Mostrar BranchGeofence

{info} Soporta: Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/branch-geofences/{branchGeofenceId} Authorization

Actualizar BranchGeofence

Método URI Cabeceras
PATCH /companies/{companyId}/branch-geofences/{branchGeofenceId} Authorization 
{
    "name": "string|max:64",
    "type": "string|in:circle,polygon,multi_polygon,polygon_array",
    "data": "required_with:type|array",
    "enabled": "boolean",
    "inverted": "boolean",
    "format": "string|in:flat_lon_lat_e6,flat_lat_lon_e6,flat_lon_lat,flat_lat_lon,point_lon_lat_e6,point_lat_lon_e6,point_lon_lat,point_lat_lon"
}

Eliminar BranchGeofence

Método URI Cabeceras
DELETE /companies/{companyId}/branch-geofences/{branchGeofenceId} Authorization

Acciones de BranchGeofence

Check

Método URI Cabeceras
GET /companies/{companyId}/branch-geofences/check Authorization 
{
    "latitude_e6": "required|integer|between:-90000000,90000000",
    "longitude_e6": "required|integer|between:-180000000,180000000"
}

Check

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/branch-geofences/check Authorization 
{
    "latitude_e6": "required|integer|between:-90000000,90000000",
    "longitude_e6": "required|integer|between:-180000000,180000000"
}

Index For Company

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/branch-geofences Authorization

Replace

Método URI Cabeceras
POST /companies/{companyId}/branch-geofences/replace-from-json Authorization

Replace

Método URI Cabeceras
POST /companies/{companyId}/branches/{branchId}/branch-geofences/replace-from-json Authorization

Enlaces de BranchGeofence