etsy-open-api-client

Etsy Open API v3

API version: 3.0.0
- Build date: 2023-06-08T08:37:51.285-04:00[America/Toronto]

NOTE

Updated StatusEnum manually as the enum values returned from the API do not match the spec as provided.

Etsy's Open API provides a simple RESTful interface for various Etsy.com features. The API endpoints are meant to replace Etsy's Open API v2, which is scheduled to end service in 2022.

All of the endpoints are callable and the majority of the API endpoints are now in a beta phase. This means we do not expect to make any breaking changes before our general release. A handful of endpoints are currently interface stubs (labeled “Feedback Only”) and returns a \"501 Not Implemented\" response code when called.

If you'd like to report an issue or provide feedback on the API design, please add an issue in Github.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

Java 1.7+
Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.gordonturner.etsy</groupId>
  <artifactId>etsy-open-api-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'etsy-open-api-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'etsy-open-api-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.gordonturner.etsy:etsy-open-api-client:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

target/etsy-open-api-client-1.0.0.jar
target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.BuyerTaxonomyApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://openapi.etsy.com");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    BuyerTaxonomyApi apiInstance = new BuyerTaxonomyApi(defaultClient);
    try {
      BuyerTaxonomyNodes result = apiInstance.getBuyerTaxonomyNodes();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BuyerTaxonomyApi#getBuyerTaxonomyNodes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class	Method	HTTP request
BuyerTaxonomyApi	getBuyerTaxonomyNodes	GET /v3/application/buyer-taxonomy/nodes
BuyerTaxonomyApi	getPropertiesByBuyerTaxonomyId	GET /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties
LedgerEntryApi	getShopPaymentAccountLedgerEntries	GET /v3/application/shops/{shop_id}/payment-account/ledger-entries
LedgerEntryApi	getShopPaymentAccountLedgerEntry	GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}
OtherApi	ping	GET /v3/application/openapi-ping
OtherApi	tokenScopes	POST /v3/application/scopes
PaymentApi	getPaymentAccountLedgerEntryPayments	GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments
PaymentApi	getPayments	GET /v3/application/shops/{shop_id}/payments
PaymentApi	getShopPaymentByReceiptId	GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments
ReviewApi	getReviewsByListing	GET /v3/application/listings/{listing_id}/reviews
ReviewApi	getReviewsByShop	GET /v3/application/shops/{shop_id}/reviews
SellerTaxonomyApi	getPropertiesByTaxonomyId	GET /v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties
SellerTaxonomyApi	getSellerTaxonomyNodes	GET /v3/application/seller-taxonomy/nodes
ShopApi	findShops	GET /v3/application/shops
ShopApi	getShop	GET /v3/application/shops/{shop_id}
ShopApi	getShopByOwnerUserId	GET /v3/application/users/{user_id}/shops
ShopApi	updateShop	PUT /v3/application/shops/{shop_id}
ShopListingApi	createDraftListing	POST /v3/application/shops/{shop_id}/listings
ShopListingApi	deleteListing	DELETE /v3/application/listings/{listing_id}
ShopListingApi	deleteListingProperty	DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
ShopListingApi	findAllActiveListingsByShop	GET /v3/application/shops/{shop_id}/listings/active
ShopListingApi	findAllListingsActive	GET /v3/application/listings/active
ShopListingApi	getFeaturedListingsByShop	GET /v3/application/shops/{shop_id}/listings/featured
ShopListingApi	getListing	GET /v3/application/listings/{listing_id}
ShopListingApi	getListingProperties	GET /v3/application/shops/{shop_id}/listings/{listing_id}/properties
ShopListingApi	getListingProperty	GET /v3/application/listings/{listing_id}/properties/{property_id}
ShopListingApi	getListingsByListingIds	GET /v3/application/listings/batch
ShopListingApi	getListingsByShop	GET /v3/application/shops/{shop_id}/listings
ShopListingApi	getListingsByShopReceipt	GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/listings
ShopListingApi	getListingsByShopReturnPolicy	GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings
ShopListingApi	getListingsByShopSectionId	GET /v3/application/shops/{shop_id}/shop-sections/listings
ShopListingApi	updateListing	PATCH /v3/application/shops/{shop_id}/listings/{listing_id}
ShopListingApi	updateListingDeprecated	PUT /v3/application/shops/{shop_id}/listings/{listing_id}
ShopListingApi	updateListingProperty	PUT /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
ShopListingFileApi	deleteListingFile	DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}
ShopListingFileApi	getAllListingFiles	GET /v3/application/shops/{shop_id}/listings/{listing_id}/files
ShopListingFileApi	getListingFile	GET /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}
ShopListingFileApi	uploadListingFile	POST /v3/application/shops/{shop_id}/listings/{listing_id}/files
ShopListingImageApi	deleteListingImage	DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
ShopListingImageApi	getListingImage	GET /v3/application/listings/{listing_id}/images/{listing_image_id}
ShopListingImageApi	getListingImageDeprecated	GET /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
ShopListingImageApi	getListingImages	GET /v3/application/listings/{listing_id}/images
ShopListingImageApi	getListingImagesDeprecated	GET /v3/application/shops/{shop_id}/listings/{listing_id}/images
ShopListingImageApi	uploadListingImage	POST /v3/application/shops/{shop_id}/listings/{listing_id}/images
ShopListingInventoryApi	getListingInventory	GET /v3/application/listings/{listing_id}/inventory
ShopListingInventoryApi	updateListingInventory	PUT /v3/application/listings/{listing_id}/inventory
ShopListingOfferingApi	getListingOffering	GET /v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id}
ShopListingProductApi	getListingProduct	GET /v3/application/listings/{listing_id}/inventory/products/{product_id}
ShopListingTranslationApi	createListingTranslation	POST /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
ShopListingTranslationApi	getListingTranslation	GET /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
ShopListingTranslationApi	updateListingTranslation	PUT /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
ShopListingVariationImageApi	getListingVariationImages	GET /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images
ShopListingVariationImageApi	updateVariationImages	POST /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images
ShopListingVideoApi	deleteListingVideo	DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}
ShopListingVideoApi	getListingVideo	GET /v3/application/listings/{listing_id}/videos/{video_id}
ShopListingVideoApi	getListingVideos	GET /v3/application/listings/{listing_id}/videos
ShopListingVideoApi	uploadListingVideo	POST /v3/application/shops/{shop_id}/listings/{listing_id}/videos
ShopProductionPartnerApi	getShopProductionPartners	GET /v3/application/shops/{shop_id}/production-partners
ShopReceiptApi	createReceiptShipment	POST /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking
ShopReceiptApi	getShopReceipt	GET /v3/application/shops/{shop_id}/receipts/{receipt_id}
ShopReceiptApi	getShopReceipts	GET /v3/application/shops/{shop_id}/receipts
ShopReceiptApi	updateShopReceipt	PUT /v3/application/shops/{shop_id}/receipts/{receipt_id}
ShopReceiptTransactionsApi	getShopReceiptTransaction	GET /v3/application/shops/{shop_id}/transactions/{transaction_id}
ShopReceiptTransactionsApi	getShopReceiptTransactionsByListing	GET /v3/application/shops/{shop_id}/listings/{listing_id}/transactions
ShopReceiptTransactionsApi	getShopReceiptTransactionsByReceipt	GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions
ShopReceiptTransactionsApi	getShopReceiptTransactionsByShop	GET /v3/application/shops/{shop_id}/transactions
ShopReturnPolicyApi	consolidateShopReturnPolicies	POST /v3/application/shops/{shop_id}/policies/return/consolidate
ShopReturnPolicyApi	createShopReturnPolicy	POST /v3/application/shops/{shop_id}/policies/return
ShopReturnPolicyApi	deleteShopReturnPolicy	DELETE /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
ShopReturnPolicyApi	getShopReturnPolicies	GET /v3/application/shops/{shop_id}/policies/return
ShopReturnPolicyApi	getShopReturnPolicy	GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
ShopReturnPolicyApi	updateShopReturnPolicy	PUT /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
ShopSectionApi	createShopSection	POST /v3/application/shops/{shop_id}/sections
ShopSectionApi	deleteShopSection	DELETE /v3/application/shops/{shop_id}/sections/{shop_section_id}
ShopSectionApi	getShopSection	GET /v3/application/shops/{shop_id}/sections/{shop_section_id}
ShopSectionApi	getShopSections	GET /v3/application/shops/{shop_id}/sections
ShopSectionApi	updateShopSection	PUT /v3/application/shops/{shop_id}/sections/{shop_section_id}
ShopShippingProfileApi	createShopShippingProfile	POST /v3/application/shops/{shop_id}/shipping-profiles
ShopShippingProfileApi	createShopShippingProfileDestination	POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
ShopShippingProfileApi	createShopShippingProfileUpgrade	POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
ShopShippingProfileApi	deleteShopShippingProfile	DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
ShopShippingProfileApi	deleteShopShippingProfileDestination	DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
ShopShippingProfileApi	deleteShopShippingProfileUpgrade	DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
ShopShippingProfileApi	getShippingCarriers	GET /v3/application/shipping-carriers
ShopShippingProfileApi	getShopShippingProfile	GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
ShopShippingProfileApi	getShopShippingProfileDestinationsByShippingProfile	GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
ShopShippingProfileApi	getShopShippingProfileUpgrades	GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
ShopShippingProfileApi	getShopShippingProfiles	GET /v3/application/shops/{shop_id}/shipping-profiles
ShopShippingProfileApi	updateShopShippingProfile	PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
ShopShippingProfileApi	updateShopShippingProfileDestination	PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
ShopShippingProfileApi	updateShopShippingProfileUpgrade	PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
UserApi	getMe	GET /v3/application/users/me
UserApi	getUser	GET /v3/application/users/{user_id}
UserAddressApi	deleteUserAddress	DELETE /v3/application/user/addresses/{user_address_id}
UserAddressApi	getUserAddress	GET /v3/application/user/addresses/{user_address_id}
UserAddressApi	getUserAddresses	GET /v3/application/user/addresses

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://www.etsy.com/oauth/connect
Scopes:
- address_r: see billing and shipping addresses
- address_w: update billing and shipping addresses
- billing_r: see all billing statement data
- cart_r: read shopping carts
- cart_w: add/remove from shopping carts
- email_r: Read a member's email address
- favorites_r: see private favorites
- favorites_w: add/remove favorites
- feedback_r: see purchase info in feedback
- listings_d: delete listings
- listings_r: see all listings (including expired etc)
- listings_w: create/edit listings
- profile_r: see all profile data
- profile_w: update user profile, avatar, etc
- recommend_r: see recommended listings
- recommend_w: accept/reject recommended listings
- shops_r: see private shop info
- shops_w: update shop
- transactions_r: see all checkout/payment data
- transactions_w: update receipts

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]

gordonturner / etsy-open-api-client Goto Github PK