Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Etsy Shop Receipt Transactions API

The Shop Receipt Transactions API from Etsy — 4 operation(s) for shop receipt transactions.

Etsy Shop Receipt Transactions API is one of 28 APIs that Etsy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shop Receipt Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 4 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.2, at version 3.0.0.

Requests are made against a single base URL, https://openapi.etsy.com.

4 operations 4 paths 6 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
3.0.0
Base URL
https://openapi.etsy.com
Authentication
API Key, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Etsy Shop Receipt Transactions API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 20 scopes. By default, every request must be authenticated.

  • api_key — Every request to a v3 API endpoint must include this data in the format keystring:sharedsecret. Your keystring and shared secret are available on the [Your App…
  • oauth2 — Open API v3 supports authenticating via OAuth 2.0. More information about Etsy's specific implementation of OAuth2 can be found [here](/documentation/essential…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Shop Receipt Transactions 4
GET
/v3/application/shops/{shop_id}/listings/{listing_id}/transactions
Etsy Get Shop Receipt Transactions by Listing
getShopReceiptTransactionsByListing 5 params → 200403404400401500
GET
/v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions
Etsy Get Shop Receipt Transactions by Receipt
getShopReceiptTransactionsByReceipt 3 params → 200404403400401500
GET
/v3/application/shops/{shop_id}/transactions/{transaction_id}
Etsy Get Shop Receipt Transaction
getShopReceiptTransaction 2 params → 200404403400401500
GET
/v3/application/shops/{shop_id}/transactions
Etsy Get Shop Receipt Transactions by Shop
getShopReceiptTransactionsByShop 4 params → 200403404401500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ShopReceiptTransaction (30 properties), ListingPropertyValue (6 properties), TransactionVariations (5 properties), Money (3 properties). Each schema is shown below with its type and property counts.

ErrorSchema
object
1 property 1 required
ShopReceiptTransaction
object
A transaction object associated with a shop receipt. Etsy generates one transaction per listing purchased as recorded on the order receipt.
30 properties
ListingPropertyValue
object
A representation of structured data values.
6 properties
ShopReceiptTransactions
object
A set of ShopReceiptTransaction resources
2 properties
Money
object
A representation of an amount of money.
3 properties
TransactionVariations
object
A list of variations chosen by the buyer during checkout.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etsy-shop-receipt-transactions-api-openapi.yml Raw ↑

Other APIs Etsy publishes across the network.

Etsy Open API v3 Webhooks
Etsy BuyerTaxonomy API
Etsy Ledger Entry API
Etsy Other API
Etsy Payment API
Etsy Review API
Etsy SellerTaxonomy API
Etsy Shop API
Etsy Shop HolidayPreferences API
Etsy Shop ProcessingProfiles API
Etsy Shop ProductionPartner API
Etsy Shop Receipt API