etsy

BuyerTaxonomyApi

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

Method HTTP request Description
getBuyerTaxonomyNodes GET /v3/application/buyer-taxonomy/nodes  
getPropertiesByBuyerTaxonomyId GET /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties  

getBuyerTaxonomyNodes

BuyerTaxonomyNodes getBuyerTaxonomyNodes()

<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 the full hierarchy tree of buyer taxonomy nodes.

Example

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

val apiInstance = BuyerTaxonomyApi()
try {
    val result : BuyerTaxonomyNodes = apiInstance.getBuyerTaxonomyNodes()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BuyerTaxonomyApi#getBuyerTaxonomyNodes")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BuyerTaxonomyApi#getBuyerTaxonomyNodes")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

BuyerTaxonomyNodes

Authorization

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

HTTP request headers

getPropertiesByBuyerTaxonomyId

BuyerTaxonomyNodeProperties getPropertiesByBuyerTaxonomyId(taxonomyId)

<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 list of product properties, with applicable scales and values, supported for a specific buyer taxonomy ID.

Example

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

val apiInstance = BuyerTaxonomyApi()
val taxonomyId : kotlin.Long = 789 // kotlin.Long | The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the \"shoes\" taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than \"girls' shoes\" (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes \"shoes\" or \"girls' shoes\" support access to the \"EU\" shoe size scale with its associated property names and IDs for EU shoe sizes, such as property `value_id`:\"1394\", and `name`:\"38\".
try {
    val result : BuyerTaxonomyNodeProperties = apiInstance.getPropertiesByBuyerTaxonomyId(taxonomyId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BuyerTaxonomyApi#getPropertiesByBuyerTaxonomyId")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BuyerTaxonomyApi#getPropertiesByBuyerTaxonomyId")
    e.printStackTrace()
}

Parameters

| Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | taxonomyId | kotlin.Long| The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the \"shoes\" taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than \"girls' shoes\" (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes \"shoes\" or \"girls' shoes\" support access to the \"EU\" shoe size scale with its associated property names and IDs for EU shoe sizes, such as property `value_id`:\"1394\", and `name`:\"38\". | |

Return type

BuyerTaxonomyNodeProperties

Authorization

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

HTTP request headers