ClientAddress

Representa a una dirección de un Cliente. Las direcciones de clientes son privadas y no pueden ser accedidas por usuarios diferentes al propio cliente.

Modelo ClientAddress

{
    "id": 1,
    "name": "home",
    "address_line_1": "assssdaa",
    "reference": "sssda adsaasdaas",
    "latitude_e6": 10451257,
    "longitude_e6": -64138431,
    "created_at": "2020-04-28 18:39:57",
    "updated_at": "2020-04-28 18:39:57",
    "client_id": 42,
    "address_line_2": null,
    "address_line_3": null,
    "country": null,
    "postal_code": null,
    "state": null,
    "city": null,
    "type": "legacy",
    "address": "assssdaa",
    "geofence_check": {
        "coordinates_e6": [
            -64138431,
            10451257
        ],
        "distance_in_meters": null,
        "is_valid": true,
        "geofence": {
            "id": 316,
            "name": "oficina",
            "type": "circle",
            "data": {
                "shape": "circle",
                "radius": 8000,
                "coordinates.0": -64.16839,
                "coordinates.1": 10.476237
            },
            "enabled": true,
            "inverted": false,
            "created_at": "2024-08-15 19:35:43",
            "updated_at": "2024-08-26 19:10:41",
            "branch_id": null
        }
    },
    "is_selected": false
}
Atributo Tipo Descripción
id int -
name string -
address_line_1 string\|null -
reference string\|null -
latitude_e6 int\|null -
longitude_e6 int\|null -
created_at datetime\|null -
updated_at datetime\|null -
client_id int -
type string\|null -
address string -
geofence_check array\|null -
is_selected bool -

Insertar ClientAddress

Insertar ClientAddress de Client

Método URI Cabeceras
POST /companies/{companyId}/clients/{clientId}/client-addresses Authorization 
{
    "name": "required|string|max:32",
    "latitude_e6": "required_if:type,delivery|integer|between:-90000000,90000000",
    "longitude_e6": "required_if:type,delivery|integer|between:-180000000,180000000",
    "country": "required_with:type|string|max:80",
    "postal_code": "required_if:type,shipping|string|max:16",
    "state": "required_if:type,shipping|string|max:80",
    "city": "required_if:type,shipping|string|max:80",
    "address": "required_without:type|string|max:255",
    "address_line_1": "required_with:type|string|max:255",
    "address_line_2": "required_if:type,shipping|string|max:255",
    "address_line_3": "required_if:type,shipping|string|max:255",
    "reference": "string|max:255",
    "type": "string|in:delivery,shipping"
}

Listar ClientAddress

Listar ClientAddress de Client

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

Método URI Cabeceras
GET /companies/{companyId}/clients/{clientId}/client-addresses Authorization

Mostrar ClientAddress

{info} Soporta: Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/client-addresses/{clientAddressId} Authorization

Actualizar ClientAddress

Método URI Cabeceras
PATCH /companies/{companyId}/client-addresses/{clientAddressId} Authorization 
{
    "name": "string|max:32",
    "latitude_e6": "integer|between:-90000000,90000000",
    "longitude_e6": "integer|between:-180000000,180000000",
    "country": "string|max:80",
    "postal_code": "string|max:16",
    "state": "string|max:80",
    "city": "string|max:80",
    "address": "string|max:255",
    "address_line_1": "required_with:type|string|max:255",
    "address_line_2": "string|max:255",
    "address_line_3": "string|max:255",
    "reference": "string|max:255",
    "type": "string|in:delivery,shipping"
}

Eliminar ClientAddress

Método URI Cabeceras
DELETE /companies/{companyId}/client-addresses/{clientAddressId} Authorization

Acciones de ClientAddress

Missing

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

Método URI Cabeceras
GET /companies/{companyId}/client-addresses Authorization

Select

Método URI Cabeceras
POST /companies/{companyId}/client-addresses/{clientAddressId}/set-selected Authorization

Enlaces de ClientAddress