etsy

ShopApi

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

Method	HTTP request	Description
findShops	GET /v3/application/shops
getShop	GET /v3/application/shops/{shop_id}
getShopByOwnerUserId	GET /v3/application/users/{user_id}/shops
updateShop	PUT /v3/application/shops/{shop_id}

findShops

Shops findShops(shopName, limit, offset)

<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 for searching shops by name. Note: We make every effort to ensure that frozen or removed shops are not included in the search results. However, rarely, due to timing issues, they may appear.

Example

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

val apiInstance = ShopApi()
val shopName : kotlin.String = shopName_example // kotlin.String | The shop's name string.
val limit : kotlin.Int = 56 // kotlin.Int | The maximum number of results to return.
val offset : kotlin.Int = 56 // kotlin.Int | The number of records to skip before selecting the first result.
try {
    val result : Shops = apiInstance.findShops(shopName, limit, offset)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopApi#findShops")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopApi#findShops")
    e.printStackTrace()
}

Parameters

Return type

Shops

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

getShop

Shop getShop(shopId)

<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 shop identified by a specific shop ID.

Example

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

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

Parameters

Return type

Shop

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

getShopByOwnerUserId

Shop getShopByOwnerUserId(userId)

<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 shop identified by the shop owner's user ID.

Example

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

val apiInstance = ShopApi()
val userId : kotlin.Long = 789 // kotlin.Long | The numeric user ID of the [user](/documentation/reference#tag/User) who owns this shop.
try {
    val result : Shop = apiInstance.getShopByOwnerUserId(userId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopApi#getShopByOwnerUserId")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopApi#getShopByOwnerUserId")
    e.printStackTrace()
}

Parameters

Return type

Shop

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateShop

Shop updateShop(shopId, title, announcement, saleMessage, digitalSaleMessage, policyAdditional)

<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 shop. Assumes that all string parameters are provided in the shop's primary language. Please note that the policy_additional field should only be set for shops located in the EU. Passing a value for this field for shops outside of the EU, will result in an error.

Example

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

val apiInstance = ShopApi()
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 | A brief heading string for the shop's main page.
val announcement : kotlin.String = announcement_example // kotlin.String | An announcement string to buyers that displays on the shop's homepage.
val saleMessage : kotlin.String = saleMessage_example // kotlin.String | A message string sent to users who complete a purchase from this shop.
val digitalSaleMessage : kotlin.String = digitalSaleMessage_example // kotlin.String | A message string sent to users who purchase a digital item from this shop.
val policyAdditional : kotlin.String = policyAdditional_example // kotlin.String | The shop's additional policies string (may be blank).
try {
    val result : Shop = apiInstance.updateShop(shopId, title, announcement, saleMessage, digitalSaleMessage, policyAdditional)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopApi#updateShop")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopApi#updateShop")
    e.printStackTrace()
}

Parameters

Return type

Shop

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.