etsy

ShopReceiptTransactionsApi

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

Method	HTTP request	Description
getShopReceiptTransaction	GET /v3/application/shops/{shop_id}/transactions/{transaction_id}
getShopReceiptTransactionsByListing	GET /v3/application/shops/{shop_id}/listings/{listing_id}/transactions
getShopReceiptTransactionsByReceipt	GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions
getShopReceiptTransactionsByShop	GET /v3/application/shops/{shop_id}/transactions

getShopReceiptTransaction

ShopReceiptTransaction getShopReceiptTransaction(shopId, transactionId)

<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 transaction by transaction ID.

Example

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

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

Parameters

Return type

ShopReceiptTransaction

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

getShopReceiptTransactionsByListing

ShopReceiptTransactions getShopReceiptTransactionsByListing(shopId, listingId, limit, offset, legacy)

Example

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

val apiInstance = ShopReceiptTransactionsApi()
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 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 legacy : kotlin.Boolean = true // kotlin.Boolean | This parameter needed to enable new parameters and response values related to processing profiles.
try {
    val result : ShopReceiptTransactions = apiInstance.getShopReceiptTransactionsByListing(shopId, listingId, limit, offset, legacy)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopReceiptTransactionsApi#getShopReceiptTransactionsByListing")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopReceiptTransactionsApi#getShopReceiptTransactionsByListing")
    e.printStackTrace()
}

Parameters

Return type

ShopReceiptTransactions

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

getShopReceiptTransactionsByReceipt

ShopReceiptTransactions getShopReceiptTransactionsByReceipt(shopId, receiptId, legacy)

Example

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

val apiInstance = ShopReceiptTransactionsApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val receiptId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
val legacy : kotlin.Boolean = true // kotlin.Boolean | This parameter needed to enable new parameters and response values related to processing profiles.
try {
    val result : ShopReceiptTransactions = apiInstance.getShopReceiptTransactionsByReceipt(shopId, receiptId, legacy)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopReceiptTransactionsApi#getShopReceiptTransactionsByReceipt")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopReceiptTransactionsApi#getShopReceiptTransactionsByReceipt")
    e.printStackTrace()
}

Parameters

Return type

ShopReceiptTransactions

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

getShopReceiptTransactionsByShop

ShopReceiptTransactions getShopReceiptTransactionsByShop(shopId, limit, offset, legacy)

Example

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

val apiInstance = ShopReceiptTransactionsApi()
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 legacy : kotlin.Boolean = true // kotlin.Boolean | This parameter needed to enable new parameters and response values related to processing profiles.
try {
    val result : ShopReceiptTransactions = apiInstance.getShopReceiptTransactionsByShop(shopId, limit, offset, legacy)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopReceiptTransactionsApi#getShopReceiptTransactionsByShop")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopReceiptTransactionsApi#getShopReceiptTransactionsByShop")
    e.printStackTrace()
}

Parameters

Return type

ShopReceiptTransactions

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

This site is open source. Improve this page.