Skip to content

studeba/etsy_api

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
.idea
.idea
 
 
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
lib
lib
 
 
spec
spec
 
 
.gitignore
.gitignore
 
 
.gitlab-ci.yml
.gitlab-ci.yml
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.rspec
.rspec
 
 
.rubocop.yml
.rubocop.yml
 
 
.travis.yml
.travis.yml
 
 
Gemfile
Gemfile
 
 
README.md
README.md
 
 
Rakefile
Rakefile
 
 
etsy_api.gemspec
etsy_api.gemspec
 
 
git_push.sh
git_push.sh
 
 

Repository files navigation

etsy_api

EtsyApi - the Ruby gem for the Etsy Open API v3

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.

© 2021-2022 Etsy, Inc. All Rights Reserved. Use of this code is subject to Etsy's API Developer Terms of Use.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 3.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build etsy_api.gemspec

Then either install the gem locally:

gem install ./etsy_api-1.0.0.gem

(for development, run gem install --dev ./etsy_api-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'etsy_api', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'etsy_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'etsy_api'

# Setup authorization
EtsyApi.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['api_key'] = 'Bearer'
end

api_instance = EtsyApi::BuyerTaxonomyApi.new

begin
  result = api_instance.get_buyer_taxonomy_nodes
  p result
rescue EtsyApi::ApiError => e
  puts "Exception when calling BuyerTaxonomyApi->get_buyer_taxonomy_nodes: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
EtsyApi::BuyerTaxonomyApi get_buyer_taxonomy_nodes GET /v3/application/buyer-taxonomy/nodes
EtsyApi::BuyerTaxonomyApi get_properties_by_buyer_taxonomy_id GET /v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties
EtsyApi::LedgerEntryApi get_shop_payment_account_ledger_entries GET /v3/application/shops/{shop_id}/payment-account/ledger-entries
EtsyApi::LedgerEntryApi get_shop_payment_account_ledger_entry GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}
EtsyApi::OtherApi ping GET /v3/application/openapi-ping
EtsyApi::OtherApi token_scopes POST /v3/application/scopes
EtsyApi::PaymentApi get_payment_account_ledger_entry_payments GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments
EtsyApi::PaymentApi get_payments GET /v3/application/shops/{shop_id}/payments
EtsyApi::PaymentApi get_shop_payment_by_receipt_id GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments
EtsyApi::ReviewApi get_reviews_by_listing GET /v3/application/listings/{listing_id}/reviews
EtsyApi::ReviewApi get_reviews_by_shop GET /v3/application/shops/{shop_id}/reviews
EtsyApi::SellerTaxonomyApi get_properties_by_taxonomy_id GET /v3/application/seller-taxonomy/nodes/{taxonomy_id}/properties
EtsyApi::SellerTaxonomyApi get_seller_taxonomy_nodes GET /v3/application/seller-taxonomy/nodes
EtsyApi::ShopApi find_shops GET /v3/application/shops
EtsyApi::ShopApi get_shop GET /v3/application/shops/{shop_id}
EtsyApi::ShopApi get_shop_by_owner_user_id GET /v3/application/users/{user_id}/shops
EtsyApi::ShopApi update_shop PUT /v3/application/shops/{shop_id}
EtsyApi::ShopListingApi create_draft_listing POST /v3/application/shops/{shop_id}/listings
EtsyApi::ShopListingApi delete_listing DELETE /v3/application/listings/{listing_id}
EtsyApi::ShopListingApi delete_listing_property DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
EtsyApi::ShopListingApi find_all_active_listings_by_shop GET /v3/application/shops/{shop_id}/listings/active
EtsyApi::ShopListingApi find_all_listings_active GET /v3/application/listings/active
EtsyApi::ShopListingApi get_featured_listings_by_shop GET /v3/application/shops/{shop_id}/listings/featured
EtsyApi::ShopListingApi get_listing GET /v3/application/listings/{listing_id}
EtsyApi::ShopListingApi get_listing_properties GET /v3/application/shops/{shop_id}/listings/{listing_id}/properties
EtsyApi::ShopListingApi get_listing_property GET /v3/application/listings/{listing_id}/properties/{property_id}
EtsyApi::ShopListingApi get_listings_by_listing_ids GET /v3/application/listings/batch
EtsyApi::ShopListingApi get_listings_by_shop GET /v3/application/shops/{shop_id}/listings
EtsyApi::ShopListingApi get_listings_by_shop_receipt GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/listings
EtsyApi::ShopListingApi get_listings_by_shop_return_policy GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}/listings
EtsyApi::ShopListingApi get_listings_by_shop_section_id GET /v3/application/shops/{shop_id}/shop-sections/listings
EtsyApi::ShopListingApi update_listing PATCH /v3/application/shops/{shop_id}/listings/{listing_id}
EtsyApi::ShopListingApi update_listing_deprecated PUT /v3/application/shops/{shop_id}/listings/{listing_id}
EtsyApi::ShopListingApi update_listing_property PUT /v3/application/shops/{shop_id}/listings/{listing_id}/properties/{property_id}
EtsyApi::ShopListingFileApi delete_listing_file DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}
EtsyApi::ShopListingFileApi get_all_listing_files GET /v3/application/shops/{shop_id}/listings/{listing_id}/files
EtsyApi::ShopListingFileApi get_listing_file GET /v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}
EtsyApi::ShopListingFileApi upload_listing_file POST /v3/application/shops/{shop_id}/listings/{listing_id}/files
EtsyApi::ShopListingImageApi delete_listing_image DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
EtsyApi::ShopListingImageApi get_listing_image GET /v3/application/listings/{listing_id}/images/{listing_image_id}
EtsyApi::ShopListingImageApi get_listing_image_deprecated GET /v3/application/shops/{shop_id}/listings/{listing_id}/images/{listing_image_id}
EtsyApi::ShopListingImageApi get_listing_images GET /v3/application/listings/{listing_id}/images
EtsyApi::ShopListingImageApi get_listing_images_deprecated GET /v3/application/shops/{shop_id}/listings/{listing_id}/images
EtsyApi::ShopListingImageApi upload_listing_image POST /v3/application/shops/{shop_id}/listings/{listing_id}/images
EtsyApi::ShopListingInventoryApi get_listing_inventory GET /v3/application/listings/{listing_id}/inventory
EtsyApi::ShopListingInventoryApi update_listing_inventory PUT /v3/application/listings/{listing_id}/inventory
EtsyApi::ShopListingOfferingApi get_listing_offering GET /v3/application/listings/{listing_id}/products/{product_id}/offerings/{product_offering_id}
EtsyApi::ShopListingProductApi get_listing_product GET /v3/application/listings/{listing_id}/inventory/products/{product_id}
EtsyApi::ShopListingTranslationApi create_listing_translation POST /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
EtsyApi::ShopListingTranslationApi get_listing_translation GET /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
EtsyApi::ShopListingTranslationApi update_listing_translation PUT /v3/application/shops/{shop_id}/listings/{listing_id}/translations/{language}
EtsyApi::ShopListingVariationImageApi get_listing_variation_images GET /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images
EtsyApi::ShopListingVariationImageApi update_variation_images POST /v3/application/shops/{shop_id}/listings/{listing_id}/variation-images
EtsyApi::ShopListingVideoApi delete_listing_video DELETE /v3/application/shops/{shop_id}/listings/{listing_id}/videos/{video_id}
EtsyApi::ShopListingVideoApi get_listing_video GET /v3/application/listings/{listing_id}/videos/{video_id}
EtsyApi::ShopListingVideoApi get_listing_videos GET /v3/application/listings/{listing_id}/videos
EtsyApi::ShopListingVideoApi upload_listing_video POST /v3/application/shops/{shop_id}/listings/{listing_id}/videos
EtsyApi::ShopProductionPartnerApi get_shop_production_partners GET /v3/application/shops/{shop_id}/production-partners
EtsyApi::ShopReceiptApi create_receipt_shipment POST /v3/application/shops/{shop_id}/receipts/{receipt_id}/tracking
EtsyApi::ShopReceiptApi get_shop_receipt GET /v3/application/shops/{shop_id}/receipts/{receipt_id}
EtsyApi::ShopReceiptApi get_shop_receipts GET /v3/application/shops/{shop_id}/receipts
EtsyApi::ShopReceiptApi update_shop_receipt PUT /v3/application/shops/{shop_id}/receipts/{receipt_id}
EtsyApi::ShopReceiptTransactionsApi get_shop_receipt_transaction GET /v3/application/shops/{shop_id}/transactions/{transaction_id}
EtsyApi::ShopReceiptTransactionsApi get_shop_receipt_transactions_by_listing GET /v3/application/shops/{shop_id}/listings/{listing_id}/transactions
EtsyApi::ShopReceiptTransactionsApi get_shop_receipt_transactions_by_receipt GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/transactions
EtsyApi::ShopReceiptTransactionsApi get_shop_receipt_transactions_by_shop GET /v3/application/shops/{shop_id}/transactions
EtsyApi::ShopReturnPolicyApi consolidate_shop_return_policies POST /v3/application/shops/{shop_id}/policies/return/consolidate
EtsyApi::ShopReturnPolicyApi create_shop_return_policy POST /v3/application/shops/{shop_id}/policies/return
EtsyApi::ShopReturnPolicyApi delete_shop_return_policy DELETE /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
EtsyApi::ShopReturnPolicyApi get_shop_return_policies GET /v3/application/shops/{shop_id}/policies/return
EtsyApi::ShopReturnPolicyApi get_shop_return_policy GET /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
EtsyApi::ShopReturnPolicyApi update_shop_return_policy PUT /v3/application/shops/{shop_id}/policies/return/{return_policy_id}
EtsyApi::ShopSectionApi create_shop_section POST /v3/application/shops/{shop_id}/sections
EtsyApi::ShopSectionApi delete_shop_section DELETE /v3/application/shops/{shop_id}/sections/{shop_section_id}
EtsyApi::ShopSectionApi get_shop_section GET /v3/application/shops/{shop_id}/sections/{shop_section_id}
EtsyApi::ShopSectionApi get_shop_sections GET /v3/application/shops/{shop_id}/sections
EtsyApi::ShopSectionApi update_shop_section PUT /v3/application/shops/{shop_id}/sections/{shop_section_id}
EtsyApi::ShopShippingProfileApi create_shop_shipping_profile POST /v3/application/shops/{shop_id}/shipping-profiles
EtsyApi::ShopShippingProfileApi create_shop_shipping_profile_destination POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
EtsyApi::ShopShippingProfileApi create_shop_shipping_profile_upgrade POST /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
EtsyApi::ShopShippingProfileApi delete_shop_shipping_profile DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
EtsyApi::ShopShippingProfileApi delete_shop_shipping_profile_destination DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
EtsyApi::ShopShippingProfileApi delete_shop_shipping_profile_upgrade DELETE /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
EtsyApi::ShopShippingProfileApi get_shipping_carriers GET /v3/application/shipping-carriers
EtsyApi::ShopShippingProfileApi get_shop_shipping_profile GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
EtsyApi::ShopShippingProfileApi get_shop_shipping_profile_destinations_by_shipping_profile GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations
EtsyApi::ShopShippingProfileApi get_shop_shipping_profile_upgrades GET /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades
EtsyApi::ShopShippingProfileApi get_shop_shipping_profiles GET /v3/application/shops/{shop_id}/shipping-profiles
EtsyApi::ShopShippingProfileApi update_shop_shipping_profile PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}
EtsyApi::ShopShippingProfileApi update_shop_shipping_profile_destination PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/destinations/{shipping_profile_destination_id}
EtsyApi::ShopShippingProfileApi update_shop_shipping_profile_upgrade PUT /v3/application/shops/{shop_id}/shipping-profiles/{shipping_profile_id}/upgrades/{upgrade_id}
EtsyApi::UserApi get_me GET /v3/application/users/me
EtsyApi::UserApi get_user GET /v3/application/users/{user_id}
EtsyApi::UserAddressApi api_application_open_api_users_addresses_delete DELETE /v3/application/user/addresses/{user_address_id}
EtsyApi::UserAddressApi get_user_address GET /v3/application/user/addresses/{user_address_id}
EtsyApi::UserAddressApi get_user_addresses GET /v3/application/user/addresses

Documentation for Models

Documentation for Authorization

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

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages