Desarrolladores Api Orzame

Direcciones

Gestiona direcciones asociadas a contactos.

Crear una dirección

Crear una dirección asociada a un contacto

Petición HTTP

POST/contacts/{contact_id}/addresses

Parámetros

Nombre	Tipo	Descripción
street	Cadena / Obligatoria	Calle / Dirección
city	Cadena / Opcional	Ciudad / Población
postal_code	Cadena / Opcional	Código postal
province	Cadena / Opcional	Provincia / Estado
country	Cadena / Obligatoria	Código del país Códigos disponibles en *data.options.countries* del endpoint: /info.
default	Boolean / Opcional / true, false (Si no se envía será `false´ por defecto)	Establecer como dirección por defecto
receptor	Cadena / Opcional	Receptor

Datos petición

{
    "street": "My street nº99 - 2ºA",
    "country": "ES"
}

201Respuesta

{
    "data": {
        "id": 60,
        "receptor": "",
        "street": "My street nº99 - 2ºA",
        "city": "",
        "postal_code": "",
        "province": "",
        "country": "ES",
        "default": false,
        "contact_id": 120,
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}

Listar direcciones

Este endpoint permite la consulta de las direcciones de un contacto.

Petición HTTP

GET/contacts/{contact_id}/addresses

200 Respuesta

{
    "data": [
        {
            "id": 65,
            "receptor": "John Doe",
            "street": "My street nº99 - 2ºA",
            "city": "Madrid",
            "postal_code": "28080",
            "province": "Madrid",
            "country": "ES",
            "default": true,
            "contact_id": 120,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        {
            "id": 60,
            "receptor": "",
            "street": "My street nº99 - 2ºA",
            "city": "",
            "postal_code": "",
            "province": "",
            "country": "ES",
            "default": false,
            "contact_id": 120,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        }
    ]
}

Obtener una dirección

Este endpoint permite la consulta de una dirección de un contacto.

Petición HTTP

GET/contacts/{contact_id}/addresses/{address_id}

200 Respuesta

{
    "data": {
        "id": 65,
        "receptor": "John Doe",
        "street": "My street nº99 - 2ºA",
        "city": "Madrid",
        "postal_code": "28080",
        "province": "Madrid",
        "country": "ES",
        "default": true,
        "contact_id": 120,
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}

Actualizar una dirección

Este endpoint permite la actualización de una dirección de contacto.

Petición HTTP

PATCH/contacts/{contact_id}/addresses/{address_id}

Parámetros

Nombre	Tipo	Descripción
street	Cadena / Opcional	Calle / Dirección
city	Cadena / Opcional	Ciudad / Población
postal_code	Cadena / Opcional	Código postal
province	Cadena / Opcional	Provincia / Estado
country	Cadena / Opcional	Código del país Códigos disponibles en *data.options.countries* del endpoint: /info.
default	Boolean / Opcional / true, false	Establecer como dirección por defecto
receptor	Cadena / Opcional	Receptor

Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.

Datos petición

{
    "receptor": "Mary Doe",
    "default": false
}

204 Respuesta

Respuesta sin cuerpo.

Eliminar una dirección

Este endpoint permite la eliminación de una dirección de un contacto.

Petición HTTP

DELETE/contacts/{contact_id}/addresses/{address_id}

204 Respuesta

Respuesta sin cuerpo.