Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.

API Documentation

PropertyValue

Overview

A representation of structured data values.

Fields

Field Visibility Level Permission Scope Type Description
property_id public none int The numeric ID of this property.
property_name public none string The name of the property, in the requested locale language.
scale_id public none int The numeric ID of the scale (if any).
scale_name public none string The label used to describe the chosen scale (if any).
value_ids public none array(int) The numeric IDs of the values.
values public none array(string) The literal values of the value.

Associations

This resource has no associations.

Methods

getAttributes

Method Name getAttributes
Synopsis Get all of the attributes for a listing
HTTP Method GET
URI /listings/:listing_id/attributes
Parameters
Name Required Default Type
listing_id Y   int
Requires OAuth N
Permission Scope none

getAttribute

Method Name getAttribute
Synopsis Get an attribute for a listing
HTTP Method GET
URI /listings/:listing_id/attributes/:property_id
Parameters
Name Required Default Type
listing_id Y   int
property_id Y   int
Requires OAuth N
Permission Scope none

updateAttribute

Method Name updateAttribute
Synopsis Update or populate an attribute for a listing
HTTP Method PUT
URI /listings/:listing_id/attributes/:property_id
Parameters
Name Required Default Type
listing_id Y   int
property_id Y   int
value_ids N   array(int)
values N   array(string)
scale_id N   int
Requires OAuth Y
Permission Scope listings_w
Notes
Either values or value_ids is required.

deleteAttribute

Method Name deleteAttribute
Synopsis Delete an attribute for a listing
HTTP Method DELETE
URI /listings/:listing_id/attributes/:property_id
Parameters
Name Required Default Type
listing_id Y   int
property_id Y   int
Requires OAuth Y
Permission Scope listings_w

Open API v3New

Your developer account