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

ListingVariationImage

Overview

A representation of the associations of variations and images on a listing

Fields

Field Visibility Level Permission Scope Type Description
variation_images public none VariationImageArray The variation images on a listing. An array with inputs for the property_id, value_id, and image_id fields.

Associations

This resource has no associations.

Methods

getVariationImages

Method Name getVariationImages
Synopsis Gets all variation images on a listing
HTTP Method GET
URI /listings/:listing_id/variation-images
Parameters
Name Required Default Type
listing_id Y   int
Requires OAuth N
Permission Scope none

updateVariationImages

Method Name updateVariationImages
Synopsis Creates variation images on a listing
HTTP Method POST
URI /listings/:listing_id/variation-images
Parameters
Name Required Default Type
listing_id Y   int
variation_images Y   VariationImageArray
Requires OAuth Y
Permission Scope listings_w
Notes
variation_images is an array with inputs for the property_id, value_id, and image_id fields.
image_ids are associated with a ListingImage on the Listing associated with the provided listing_id.
property_id and value_id pairs are associated with a ListingProduct on the Listing associated with the provided listing_id.
variation_images does not contain any duplicates.
variation_images does not contain more than one property_id as variation images can only be associated on one property.
The update overwrites all existing variation images on a listing, so if your request is successful, the variation images on the listing will be exactly those you specify.

Open API v3New

Your developer account