API Graph versión

Product Catalog Home Listings

Lectura

No puedes realizar esta operación en este extremo.

Creación

You can make a POST request to home_listings edge from the following paths:
When posting to this edge, a HomeListing will be created.

Parámetros

ParámetroDescripción
address
Object

The address of the home listing

Obligatorio
city
string

Obligatorio
country
string

Obligatorio
latitude
float

Obligatorio
longitude
float

Obligatorio
neighborhoods
list<string>

postal_code
string

region
string

Obligatorio
street_address
string

Obligatorio
availability
string

The availability of the home listing

Obligatorio
currency
ISO 4217 Currency Code

Currency for the listing

Obligatorio
description
string

Description of the home listing

home_listing_id
string

ID of the home listing

Obligatorio
images
list<Object>

Links to home listing images. Please note that carousel format utilizes a square 1:1 aspect ratio images (recommended size - 600x600px) while single hotel ad uses 1.91:1 aspect ratio image(recommended size - 1200x630px). Please provide at least one image.

Obligatorio
image_url
URL

Obligatorio
tags
list<string>

listing_type
string

Listing type of the property

name
string

Name of the home listing

Obligatorio
num_baths
float

Number of baths for the home listing

num_beds
float

Number of beds for the home listing

num_units
float

Number of units for the home listing

price
float

The price for this home listing

Obligatorio
property_type
string

Property type of the home listing

url
URL

Link to the external site where you can view the listing

Obligatorio
year_built
int64

Year built

Obligatorio

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Error Codes

ErrorDescripción
100Invalid parameter

Actualizando

No puedes realizar esta operación en este extremo.

Eliminando

No puedes realizar esta operación en este extremo.