First Import & Next Steps¶
Your Etsy shop is connected. Let's import your first data and set up automatic synchronization.
First Data Import¶
Import Listings¶
- In your Etsy Shop document, click Import Listings
- The app will fetch all active listings from your Etsy shop
- Check the Etsy Listing doctype to see imported listings
- Items, Item Attributes, and Item Variants will be created automatically


Import Orders¶
- In your Etsy Shop document, click Import Receipts
- The app will import recent orders from Etsy
- For each order, the app creates:
- Customer (if new)
- Contact (with shipping/billing addresses)
- Sales Order (with line items)
- Sales Invoice (if payment is complete)
- Payment Entry (if payment is complete)

Import Historical Orders¶
To import orders from a specific date range:
- Click Import Historic Receipts button
- Enter a From Date (how far back to import)
- Click Import
- The app will bulk import all orders since that date

Initial Import Recommendation
For your first import, consider importing 30-90 days of historical data to establish a baseline.
Enabling Automatic Synchronization¶
Step 1: Open Etsy Settings¶
- Search for Etsy Settings in the Awesome Bar
- This is a singleton doctype (only one instance)

Step 2: Enable Synchronization¶
- Check Enable Synchronisation
- Configure sync intervals:
- Sales Order Sync Interval: In minutes (default: 5, range: 1-60)
- Item Sync Interval: In hours (default: 24, range: 1-24)
- Click Save
The app will automatically create Scheduled Job Types and start syncing in the background.

Step 3: Monitor Sync Status¶
Back in Etsy Settings, you can view:
- Last Sync: Timestamp of last successful sync
- Next Sync: When the next sync is scheduled
- Scheduler Link: Link to the Scheduled Job Type
Disable Sync Temporarily
Set sync interval to 0 to disable automatic sync for that data type.
Quick Reference¶
Etsy Shop Buttons¶
| Button | Action |
|---|---|
| Login | Start OAuth2 authentication flow |
| Disconnect | Revoke tokens and disconnect shop |
| Import Listings | Fetch all active listings |
| Import Receipts | Import recent orders |
| Import Historic Receipts | Bulk import orders from date |
Default Naming Series¶
| DocType | Default Pattern |
|---|---|
| Customer | EtsyUser-{ETSY_BUYER_ID} |
| Sales Order | EtsyOrder-{ETSY_ORDER_ID} |
| Sales Invoice | EtsyInvoice-{ETSY_ORDER_ID} |
Customizable Naming
All naming series can be customized in the Etsy Shop document.
Common Commands¶
# Uninstall the app
bench --site your-site-name uninstall-app etsy --no-backup
# Reinstall after updates
bench --site your-site-name migrate
# Run tests
bench --site your-site-name run-tests --app etsy
# Build assets after changes
bench build --app etsy
What's Next?¶
Now that you're up and running, explore the User Guide for deeper configuration:
- Shop Configuration — All Etsy Shop doctype fields and options
- Listings & Items — How listings become Items in ERPNext
- Orders & Customers — Sales Order sync details and edge cases
- Synchronization — Manual vs automatic sync, scheduling, and monitoring
- Troubleshooting — Common issues and solutions