etsy

ShopListingTranslationApi

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

Method	HTTP request	Description
createListingTranslation	POST /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
getListingTranslation	GET /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
updateListingTranslation	PUT /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}

createListingTranslation

ListingTranslation createListingTranslation(shopId, listingId, language, title, description, tags)

<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> Creates a ListingTranslation by listing_id and language

Example

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

val apiInstance = ShopListingTranslationApi()
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 language : kotlin.String = language_example // kotlin.String | The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.
val title : kotlin.String = title_example // kotlin.String | The title of the Listing of this Translation.
val description : kotlin.String = description_example // kotlin.String | The description of the Listing of this Translation.
val tags : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | The tags of the Listing of this Translation.
try {
    val result : ListingTranslation = apiInstance.createListingTranslation(shopId, listingId, language, title, description, tags)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingTranslationApi#createListingTranslation")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingTranslationApi#createListingTranslation")
    e.printStackTrace()
}

Parameters

Return type

ListingTranslation

Authorization

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

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

getListingTranslation

ListingTranslation getListingTranslation(shopId, listingId, language)

<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> Get a Translation for a Listing in the given language

Example

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

val apiInstance = ShopListingTranslationApi()
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 language : kotlin.String = language_example // kotlin.String | The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.
try {
    val result : ListingTranslation = apiInstance.getListingTranslation(shopId, listingId, language)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingTranslationApi#getListingTranslation")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingTranslationApi#getListingTranslation")
    e.printStackTrace()
}

Parameters

Return type

ListingTranslation

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateListingTranslation

ListingTranslation updateListingTranslation(shopId, listingId, language, title, description, tags)

<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> Updates a ListingTranslation by listing_id and language

Example

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

val apiInstance = ShopListingTranslationApi()
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 language : kotlin.String = language_example // kotlin.String | The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.
val title : kotlin.String = title_example // kotlin.String | The title of the Listing of this Translation.
val description : kotlin.String = description_example // kotlin.String | The description of the Listing of this Translation.
val tags : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | The tags of the Listing of this Translation.
try {
    val result : ListingTranslation = apiInstance.updateListingTranslation(shopId, listingId, language, title, description, tags)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopListingTranslationApi#updateListingTranslation")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopListingTranslationApi#updateListingTranslation")
    e.printStackTrace()
}

Parameters

Return type

ListingTranslation

Authorization

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

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

This site is open source. Improve this page.