etsy

ShopListingImageApi

All URIs are relative to https://openapi.etsy.com

Method	HTTP request	Description
deleteListingImage	DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
getListingImage	GET /v3/application/listings/{listing_id}/images/{listing_image_id}
getListingImages	GET /v3/application/listings/{listing_id}/images
uploadListingImage	POST /v3/application/shops/{shop_id}/listings/{listing_id}/images

deleteListingImage

deleteListingImage(shopId, listingId, listingImageId)

Example

// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*

val apiInstance = ShopListingImageApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val listingId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
val listingImageId : kotlin.Long = 789 // kotlin.Long | The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
try {
    apiInstance.deleteListingImage(shopId, listingId, listingImageId)
} catch (e: ClientException) {
    println("4xx response calling ShopListingImageApi#deleteListingImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingImageApi#deleteListingImage")
    e.printStackTrace()
}

Parameters

Return type

null (empty response body)

Authorization

Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”

HTTP request headers

Content-Type: Not defined
Accept: application/json

getListingImage

ListingImage getListingImage(listingId, listingImageId)

Example

// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*

val apiInstance = ShopListingImageApi()
val listingId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
val listingImageId : kotlin.Long = 789 // kotlin.Long | The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
try {
    val result : ListingImage = apiInstance.getListingImage(listingId, listingImageId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingImageApi#getListingImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingImageApi#getListingImage")
    e.printStackTrace()
}

Parameters

Return type

ListingImage

Authorization

Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “”

HTTP request headers

Content-Type: Not defined
Accept: application/json

getListingImages

ListingImages getListingImages(listingId)

Example

// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*

val apiInstance = ShopListingImageApi()
val listingId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
try {
    val result : ListingImages = apiInstance.getListingImages(listingId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingImageApi#getListingImages")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingImageApi#getListingImages")
    e.printStackTrace()
}

Parameters

Return type

ListingImages

Authorization

Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “”

HTTP request headers

Content-Type: Not defined
Accept: application/json

uploadListingImage

ListingImage uploadListingImage(shopId, listingId, image, listingImageId, rank, overwrite, isWatermarked, altText)

<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge–notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div> Uploads or assigns an image to a listing identified by a shop ID with a listing ID. To upload a new image, set the image file as the value for the `image` parameter. You can assign a previously deleted image to a listing using the deleted image's image ID in the `listing_image_id` parameter. When a request contains both `image` and `listing_image_id` parameter values, the endpoint uploads the image in the `image` parameter only. Note: When uploading a new image, data such as colors and size may return as null values due to asynchronous processing of the image. Use getListingImage endpoint to fetch these values.

Example

// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*

val apiInstance = ShopListingImageApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val listingId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
val image : io.ktor.client.request.forms.FormPart<io.ktor.client.request.forms.InputProvider> = BINARY_DATA_HERE // io.ktor.client.request.forms.FormPart<io.ktor.client.request.forms.InputProvider> | The file name string of a file to upload
val listingImageId : kotlin.Long = 789 // kotlin.Long | The numeric ID of the primary [listing image](/documentation/reference#tag/ShopListing-Image) for this transaction.
val rank : kotlin.Int = 56 // kotlin.Int | The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing.
val overwrite : kotlin.Boolean = true // kotlin.Boolean | When true, this request replaces the existing image at a given rank.
val isWatermarked : kotlin.Boolean = true // kotlin.Boolean | When true, indicates that the uploaded image has a watermark.
val altText : kotlin.String = altText_example // kotlin.String | Alt text for the listing image. Max length 500 characters.
try {
    val result : ListingImage = apiInstance.uploadListingImage(shopId, listingId, image, listingImageId, rank, overwrite, isWatermarked, altText)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingImageApi#uploadListingImage")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingImageApi#uploadListingImage")
    e.printStackTrace()
}

Parameters

Return type

ListingImage

Authorization

Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

This site is open source. Improve this page.