etsy

ShopReceiptApi

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

Method	HTTP request	Description
createReceiptShipment	POST /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking
getShopReceipt	GET /v3/application/shops/{shop_id}/receipts/{receipt_id}
getShopReceipts	GET /v3/application/shops/{shop_id}/receipts
updateShopReceipt	PUT /v3/application/shops/{shop_id}/receipts/{receipt_id}

createReceiptShipment

ShopReceipt createReceiptShipment(shopId, receiptId, legacy, trackingCode, carrierName, sendBcc, noteToBuyer)

<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> Submits tracking information for a Shop Receipt, which creates a Shop Receipt Shipment entry for the given receipt_id. Each time you successfully submit tracking info, Etsy sends a notification email to the buyer User. When send_bcc is true, Etsy sends shipping notifications to the seller as well. When tracking_code and carrier_name aren't sent, the receipt is marked as shipped only. If the carrier is not supported, you may use `other` as the carrier name so you can provide the tracking code. NOTES When shipping within the United States AND the order is over $10 _or when shipping to India, tracking code and carrier name ARE required. Access to ShopReceipt's first_line, second_line, city, state, zip, country_iso and formatted_address is contingent in some regions to a preferred partnership status with Etsy

Example

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

val apiInstance = ShopReceiptApi()
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 receipt to submit tracking for.
val legacy : kotlin.Boolean = true // kotlin.Boolean | This parameter needed to enable new parameters and response values related to processing profiles.
val trackingCode : kotlin.String = trackingCode_example // kotlin.String | The tracking code for this receipt.
val carrierName : kotlin.String = carrierName_example // kotlin.String | The carrier name for this receipt.
val sendBcc : kotlin.Boolean = true // kotlin.Boolean | If true, the shipping notification will be sent to the seller as well
val noteToBuyer : kotlin.String = noteToBuyer_example // kotlin.String | Message to include in notification to the buyer.
try {
    val result : ShopReceipt = apiInstance.createReceiptShipment(shopId, receiptId, legacy, trackingCode, carrierName, sendBcc, noteToBuyer)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopReceiptApi#createReceiptShipment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopReceiptApi#createReceiptShipment")
    e.printStackTrace()
}

Parameters

Return type

ShopReceipt

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

getShopReceipt

ShopReceipt getShopReceipt(shopId, receiptId, legacy)

Example

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

val apiInstance = ShopReceiptApi()
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 : ShopReceipt = apiInstance.getShopReceipt(shopId, receiptId, legacy)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopReceiptApi#getShopReceipt")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopReceiptApi#getShopReceipt")
    e.printStackTrace()
}

Parameters

Return type

ShopReceipt

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

getShopReceipts

ShopReceipts getShopReceipts(shopId, minCreated, maxCreated, minLastModified, maxLastModified, limit, offset, sortOn, sortOrder, wasPaid, wasShipped, wasDelivered, wasCanceled, legacy)

Example

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

val apiInstance = ShopReceiptApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
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.
val minLastModified : kotlin.Int = 56 // kotlin.Int | The earliest unix timestamp for when a record last changed.
val maxLastModified : kotlin.Int = 56 // kotlin.Int | The latest unix timestamp for when a record last changed.
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 sortOn : kotlin.String = sortOn_example // kotlin.String | The value to sort a search result of listings on.
val sortOrder : kotlin.String = sortOrder_example // kotlin.String | The ascending(up) or descending(down) order to sort receipts by.
val wasPaid : kotlin.Boolean = true // kotlin.Boolean | When `true`, returns receipts where the seller has recieved payment for the receipt. When `false`, returns receipts where payment has not been received.
val wasShipped : kotlin.Boolean = true // kotlin.Boolean | When `true`, returns receipts where the seller shipped the product(s) in this receipt. When `false`, returns receipts where shipment has not been set.
val wasDelivered : kotlin.Boolean = true // kotlin.Boolean | When `true`, returns receipts that have been marked as delivered. When `false`, returns receipts where shipment has not been marked as delivered.
val wasCanceled : kotlin.Boolean = true // kotlin.Boolean | When `true`, the endpoint will only return the canceled receipts. When `false`, the endpoint will only return non-canceled receipts.
val legacy : kotlin.Boolean = true // kotlin.Boolean | This parameter needed to enable new parameters and response values related to processing profiles.
try {
    val result : ShopReceipts = apiInstance.getShopReceipts(shopId, minCreated, maxCreated, minLastModified, maxLastModified, limit, offset, sortOn, sortOrder, wasPaid, wasShipped, wasDelivered, wasCanceled, legacy)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopReceiptApi#getShopReceipts")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopReceiptApi#getShopReceipts")
    e.printStackTrace()
}

Parameters

Return type

ShopReceipts

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

updateShopReceipt

ShopReceipt updateShopReceipt(shopId, receiptId, legacy, wasShipped, wasPaid)

Example

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

val apiInstance = ShopReceiptApi()
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.
val wasShipped : kotlin.Boolean = true // kotlin.Boolean | When `true`, returns receipts where the seller shipped the product(s) in this receipt. When `false`, returns receipts where shipment has not been set.
val wasPaid : kotlin.Boolean = true // kotlin.Boolean | When `true`, returns receipts where the seller has recieved payment for the receipt. When `false`, returns receipts where payment has not been received.
try {
    val result : ShopReceipt = apiInstance.updateShopReceipt(shopId, receiptId, legacy, wasShipped, wasPaid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ShopReceiptApi#updateShopReceipt")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ShopReceiptApi#updateShopReceipt")
    e.printStackTrace()
}

Parameters

Return type

ShopReceipt

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.