Listing Statuses

📘

El endpoint disponible lo encuentras en el apartado Listing Statuses en la referencia de nuestra API.

Cómo usar este endpoint

Primero, este endpoint te ayudará a saber los cambios que hagan las agencias en las propiedades. De forma fácil podrás saber si hay una propiedad nueva, si una propiedad sufrió de cambios y debes actualizarla o si una propiedad cambió su estatus y debes darla de baja.

Consultar propiedades

Puedes obtener la lista de todas las propiedades que se envían hacia tu aplicación haciendo un GET al endpoint /integration_partners/listing_statuses.

Los filtros disponibles son:

  • Page: Te ayudará con la paginación de los resultados.
  • Limit: Por defecto la cantidad de resultados que entregamos es de 100 y el límite también es de 100 por página.

Search, estos son filtros opcionales pero que te pueden ayudar a acotar tu búsqueda.

  • [updated_after]: Podrás obtener las propiedades actualizadas después de la fecha que indiques, el formato que debes usar es date-time. Por ejemplo: 2024-03-20T14:26:53.402-06:00
  • [updated_before]: Podrás obtener las propiedades actualizadas antes de la fecha que indiques, el formato que debes usar es date-time. Por ejemplo: 2024-03-20T14:26:53.402-06:00
  • [published]: Booleano con el que puedes obtener propiedades solo Publicadas o No Publicadas.
  • [agency_id]: Con este podrás obtener solo el inventario de una agencia.
  • [property_types]: Array de strings en el cual deberás indicar si buscas un tipo de propiedad en especial. Es opcional y puedes incluir más de 1 tipo de propiedad.

Ejemplo de request

En el siguiente request lo que hacemos es obtener todas las propiedades que se envían a una aplicación y no estamos aplicando algún filtro, por lo que en la respuesta recibiremos propiedades de varias agencias y con diferentes estatus.

curl --request GET \
     --url 'https://api.stagingeb.com/v1/integration_partners/listing_statuses?page=1&limit=100' \
     --header 'Country-Code: MX' \
     --header 'X-Authorization: $API_KEY' \
     --header 'accept: application/json'

Ejemplo de respuesta

De acuerdo al request que hicimos esta puede ser la respuesta que recibiremos, encontrarás varios datos importantes que puedes usar.

  • El número total de resultados.
  • next_page: Que puede ayudarte a paginar.
  • public_id: Es el ID único de cada propiedad, este lo usarás para obtener los detalles de la propiedad con el endpoint Properties
  • updated_at: Es la fecha de la última actualización que recibió la propiedad.
{
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 5310,
    "next_page": "https://api.stagingeb.com/v1/integration_partners/listing_statuses?limit=100&page=2"
  },
  "content": [
    {
      "public_id": "EB-F3464",
      "published": true,
      "updated_at": "2024-03-22T18:41:44-06:00"
    },
    {
      "public_id": "EB-F1516",
      "published": false,
      "updated_at": "2024-03-25T10:23:12-06:00"
    }`
   ...
  ]
}

Continúa con