etsy

ShopListingVideoApi

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

Method	HTTP request	Description
deleteListingVideo	DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}
getListingVideo	GET /v3/application/listings/{listing_id}/videos/{video_id}
getListingVideos	GET /v3/application/listings/{listing_id}/videos
uploadListingVideo	POST /v3/application/shops/{shop_id}/listings/{listing_id}/videos

deleteListingVideo

deleteListingVideo(shopId, listingId, videoId)

<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> Open API V3 endpoint to delete a listing video. A copy of the video remains on our servers, and so a deleted video may be re-associated with the listing without re-uploading the original video; see uploadListingVideo.

Example

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

val apiInstance = ShopListingVideoApi()
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 videoId : kotlin.Long = 789 // kotlin.Long | The unique ID of a video associated with a listing.
try {
    apiInstance.deleteListingVideo(shopId, listingId, videoId)
} catch (e: ClientException) {
    println("4xx response calling ShopListingVideoApi#deleteListingVideo")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingVideoApi#deleteListingVideo")
    e.printStackTrace()
}

Parameters

| shopId | kotlin.Long| The unique positive non-zero numeric ID for an Etsy Shop. | | | listingId | kotlin.Long| The numeric ID for the listing associated to this transaction. | | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | videoId | kotlin.Long| The unique ID of a video associated with a listing. | |

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

getListingVideo

ListingVideo getListingVideo(videoId, listingId)

<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> Retrieves a single video associated with the given listing. Requesting a video from a listing returns an empty result.

Example

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

val apiInstance = ShopListingVideoApi()
val videoId : kotlin.Long = 789 // kotlin.Long | The unique ID of a video associated with a listing.
val listingId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
try {
    val result : ListingVideo = apiInstance.getListingVideo(videoId, listingId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingVideoApi#getListingVideo")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingVideoApi#getListingVideo")
    e.printStackTrace()
}

Parameters

| videoId | kotlin.Long| The unique ID of a video associated with a listing. | | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | listingId | kotlin.Long| The numeric ID for the listing associated to this transaction. | |

Return type

ListingVideo

Authorization

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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getListingVideos

ListingVideos getListingVideos(listingId)

<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> Retrieves all listing video resources for a listing with a specific listing ID.

Example

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

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

Parameters

| Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | listingId | kotlin.Long| The numeric ID for the listing associated to this transaction. | |

Return type

ListingVideos

Authorization

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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

uploadListingVideo

ListingVideo uploadListingVideo(shopId, listingId, videoId, video, name)

<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 a new video for a listing, or associates an existing video with a specific listing. You must either provide the `video_id` of an existing video, or the name and binary file data for a video to upload.

Example

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

val apiInstance = ShopListingVideoApi()
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 videoId : kotlin.Long = 789 // kotlin.Long | The unique ID of a video associated with a listing.
val video : 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> | A video file to upload.
val name : kotlin.String = name_example // kotlin.String | The file name string for the video to upload.
try {
    val result : ListingVideo = apiInstance.uploadListingVideo(shopId, listingId, videoId, video, name)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingVideoApi#uploadListingVideo")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingVideoApi#uploadListingVideo")
    e.printStackTrace()
}

Parameters

| shopId | kotlin.Long| The unique positive non-zero numeric ID for an Etsy Shop. | | | listingId | kotlin.Long| The numeric ID for the listing associated to this transaction. | | | videoId | kotlin.Long| The unique ID of a video associated with a listing. | [optional] | | video | io.ktor.client.request.forms.FormPart<io.ktor.client.request.forms.InputProvider>| A video file to upload. | [optional] | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | name | kotlin.String| The file name string for the video to upload. | [optional] |

Return type

ListingVideo

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.