Graph API Version

Product Catalog Home Listings

Reading

You can't perform this operation on this endpoint.

You can make a POST request to home_listings edge from the following paths:

When posting to this edge, a HomeListing will be created.

Parameter	Description
`address` Object	The address of the home listing Required
`city` string	Required
`country` string	Required
`latitude` float	Required
`longitude` float	Required
`neighborhoods` list<string>
`postal_code` string
`region` string	Required
`street_address` string	Required
`availability` string	The availability of the home listing Required
`currency` ISO 4217 Currency Code	Currency for the listing Required
`description` string	Description of the home listing
`home_listing_id` string	ID of the home listing Required
`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. Required
`image_url` URL	Required
`tags` list<string>
`listing_type` string	Listing type of the property
`name` string	Name of the home listing Required
`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 Required
`property_type` string	Property type of the home listing
`url` URL	Link to the external site where you can view the listing Required
`year_built` int64	Year built Required

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

}

Error	Description
10800	Duplicate retailer_id when attempting to create a store collection
100	Invalid parameter

You can't perform this operation on this endpoint.

You can't perform this operation on this endpoint.