etsy

ShopSectionApi

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

Method	HTTP request	Description
createShopSection	POST /v3/application/shops/{shop_id}/sections
deleteShopSection	DELETE /v3/application/shops/{shop_id}/sections/{shop_section_id}
getShopSection	GET /v3/application/shops/{shop_id}/sections/{shop_section_id}
getShopSections	GET /v3/application/shops/{shop_id}/sections
updateShopSection	PUT /v3/application/shops/{shop_id}/sections/{shop_section_id}

createShopSection

ShopSection createShopSection(shopId, title)

<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 new section in a specific shop.

Example

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

val apiInstance = ShopSectionApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val title : kotlin.String = title_example // kotlin.String | The title string for a shop section.
try {
    val result : ShopSection = apiInstance.createShopSection(shopId, title)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopSectionApi#createShopSection")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopSectionApi#createShopSection")
    e.printStackTrace()
}

Parameters

Return type

ShopSection

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

deleteShopSection

deleteShopSection(shopId, shopSectionId)

Example

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

val apiInstance = ShopSectionApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val shopSectionId : kotlin.Long = 789 // kotlin.Long | The numeric ID of a section in a specific Etsy shop.
try {
    apiInstance.deleteShopSection(shopId, shopSectionId)
} catch (e: ClientException) {
    println("4xx response calling ShopSectionApi#deleteShopSection")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopSectionApi#deleteShopSection")
    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

getShopSection

ShopSection getShopSection(shopId, shopSectionId)

Example

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

val apiInstance = ShopSectionApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val shopSectionId : kotlin.Long = 789 // kotlin.Long | The numeric ID of a section in a specific Etsy shop.
try {
    val result : ShopSection = apiInstance.getShopSection(shopId, shopSectionId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopSectionApi#getShopSection")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopSectionApi#getShopSection")
    e.printStackTrace()
}

Parameters

Return type

ShopSection

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

getShopSections

ShopSections getShopSections(shopId)

Example

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

val apiInstance = ShopSectionApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
try {
    val result : ShopSections = apiInstance.getShopSections(shopId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopSectionApi#getShopSections")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopSectionApi#getShopSections")
    e.printStackTrace()
}

Parameters

Return type

ShopSections

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateShopSection

ShopSection updateShopSection(shopId, shopSectionId, title)

Example

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

val apiInstance = ShopSectionApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val shopSectionId : kotlin.Long = 789 // kotlin.Long | The numeric ID of a section in a specific Etsy shop.
val title : kotlin.String = title_example // kotlin.String | The title string for a shop section.
try {
    val result : ShopSection = apiInstance.updateShopSection(shopId, shopSectionId, title)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopSectionApi#updateShopSection")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopSectionApi#updateShopSection")
    e.printStackTrace()
}

Parameters

Return type

ShopSection

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.