Etsy Shop Receipt API
The Shop Receipt API from Etsy — 3 operation(s) for shop receipt.
Etsy Shop Receipt 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. 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 3 paths, and defines 9 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Etsy Shop Receipt 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 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ShopReceipt (40 properties), ShopReceiptTransaction (30 properties), ListingPropertyValue (6 properties), ShopRefund (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Etsy 12
Other APIs Etsy publishes across the network.