How to register an OAuth app for Etsy

Etsy is an e-commerce website focused on handmade or vintage items and craft supplies. This guide explains how to set up OAuth scopes for the Etsy connector in Apideck.

Configure Etsy in Apideck

Go to the Apideck Dashboard
Review the scopes to ensure they match your application's needs
Click "Save settings"

Required Scopes for Apideck Integration

For the Apideck Etsy connector to function properly, you need to request the following scopes when configuring your OAuth application:

Scope	Description	Why It's Required
listings_r	Read listings	Required to access product listings from Etsy shops. This scope allows the connector to retrieve product details, images, pricing, and inventory information.
transactions_r	Read receipts	Required to access order information and transaction history. This scope enables the connector to fetch order details, customer purchases, and sales data.
shops_r	Read shops	Required to access shop information and metadata. This scope allows the connector to retrieve shop details, policies, and other store-related information.

When configuring your OAuth application in Etsy, make sure to request at least the three required scopes (

listings_r

transactions_r

, and

shops_r

) to ensure full functionality with the Apideck connector.

Test your integration

After connecting your Etsy account through Vault, you can test the integration using the Apideck Unified APIs.

To retrieve products (listings) from your Etsy shop using the Ecommerce API:


curl --location --request GET 'https://unify.apideck.com/ecommerce/products' \
--header 'x-apideck-consumer-id: test-consumer' \
--header 'x-apideck-app-id: {APIDECK_APP_ID}' \
--header 'x-apideck-service-id: etsy' \
--header 'Authorization: Bearer {APIDECK_API_KEY}'

Start building with the Etsy API

Learn what else you can build with the Etsy API or explore the Apideck Ecommerce API documentation.

Interested in a personalized demo? Let us know.

Troubleshooting

Error: Invalid redirect_uri

If you receive an error about an invalid redirect URI, ensure that:

The redirect URI is exactly
```
https://unify.apideck.com/vault/callback
```
(case-sensitive)
The redirect URI has been properly added to your application's callback URLs in the Etsy Developer Portal

Error: API key not approved

New API keys require approval from Etsy before they can be used. Check the status of your API key in the "See API Key Details" dropdown on the "Manage Your Apps" page.

Error: Insufficient scopes

If you're receiving permission errors, ensure that you've requested all the necessary scopes for the endpoints you're trying to access. You may need to reauthorize the application with additional scopes.