etsy

ReviewApi

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

Method HTTP request Description
getReviewsByListing GET /v3/application/listings/{listing_id}/reviews  
getReviewsByShop GET /v3/application/shops/{shop_id}/reviews  

getReviewsByListing

ListingReviews getReviewsByListing(listingId, limit, offset, minCreated, maxCreated)

<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 to retrieve the reviews for a listing given its ID.

Example

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

val apiInstance = ReviewApi()
val listingId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.
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.
val minCreated : kotlin.Int = 56 // kotlin.Int | The earliest unix timestamp for when a record was created.
val maxCreated : kotlin.Int = 56 // kotlin.Int | The latest unix timestamp for when a record was created.
try {
    val result : ListingReviews = apiInstance.getReviewsByListing(listingId, limit, offset, minCreated, maxCreated)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReviewApi#getReviewsByListing")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReviewApi#getReviewsByListing")
    e.printStackTrace()
}

Parameters

| listingId | kotlin.Long| The numeric ID for the listing associated to this transaction. | | | limit | kotlin.Int| The maximum number of results to return. | [optional] [default to 25] | | offset | kotlin.Int| The number of records to skip before selecting the first result. | [optional] [default to 0] | | minCreated | kotlin.Int| The earliest unix timestamp for when a record was created. | [optional] | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | maxCreated | kotlin.Int| The latest unix timestamp for when a record was created. | [optional] |

Return type

ListingReviews

Authorization

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

HTTP request headers

getReviewsByShop

TransactionReviews getReviewsByShop(shopId, limit, offset, minCreated, maxCreated)

<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 to retrieve the reviews from a shop given its ID.

Example

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

val apiInstance = ReviewApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
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.
val minCreated : kotlin.Int = 56 // kotlin.Int | The earliest unix timestamp for when a record was created.
val maxCreated : kotlin.Int = 56 // kotlin.Int | The latest unix timestamp for when a record was created.
try {
    val result : TransactionReviews = apiInstance.getReviewsByShop(shopId, limit, offset, minCreated, maxCreated)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReviewApi#getReviewsByShop")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReviewApi#getReviewsByShop")
    e.printStackTrace()
}

Parameters

| shopId | kotlin.Long| The unique positive non-zero numeric ID for an Etsy Shop. | | | limit | kotlin.Int| The maximum number of results to return. | [optional] [default to 25] | | offset | kotlin.Int| The number of records to skip before selecting the first result. | [optional] [default to 0] | | minCreated | kotlin.Int| The earliest unix timestamp for when a record was created. | [optional] | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | maxCreated | kotlin.Int| The latest unix timestamp for when a record was created. | [optional] |

Return type

TransactionReviews

Authorization

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

HTTP request headers