Etsy | Operate As Docs

Website: etsy.com
Connects by: Signing in with Etsy
Category: Online stores
Services: 1
Tools: 102

Service	Key	Base URL
Etsy	`etsy`	`https://openapi.etsy.com`

Connecting

Your client presses Connect on their link and approves on Etsy's own screen. Operate As never sees their password.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "etsy"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "etsy"    ]  }]

Permissions

What the client reads	Permission it asks for
See your shop	`shops_r`
Change your shop's details and sections	`shops_w`
See your listings, including drafts and inactive ones	`listings_r`
Add and change listings	`listings_w`
See your orders and receipts	`transactions_r`
Update your orders, such as marking them shipped	`transactions_w`

Tools

Install Etsy's typed package for your language:

pip install operate-as-etsy

pip install operate-as-etsy

Run etsy.consolidate_shop_return_policies

curl -X POST https://api.operate.as/v1/actions/etsy.consolidate_shop_return_policies \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {
      "shop_id": "<shop_id>"
    }
  }'

curl -X POST https://api.operate.as/v1/actions/etsy.consolidate_shop_return_policies \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {      "shop_id": "<shop_id>"    }  }'

Shows the required inputs. Every input, with its JSON Schema: GET /v1/actions/etsy.consolidate_shop_return_policies

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://openapi.etsy.com. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../etsy/v3/application/users/me" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../etsy/v3/application/users/me" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

Operate As renews the sign-in before it runs out and checks it daily. If Etsy refuses to renew it, the service shows Expired, you're alerted, and your client reconnects from the same link.

See Keeping access alive and Removing access.

Calls answer

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "detail": "Miller Dental's Etsy access ended. Send them their link to reconnect."
}

HTTP/1.1 409 ConflictContent-Type: application/json{  "detail": "Miller Dental's Etsy access ended. Send them their link to reconnect."}

Your webhook receives

{
  "id": "evt_3f9a1c…",
  "type": "connection.expired",
  "createdAt": "2026-10-16T08:00:00+00:00",
  "data": {
    "clientId": "6f1c2a7e-...",
    "clientName": "Miller Dental",
    "provider": "etsy",
    "services": [
      "etsy"
    ],
    "reconnectUrl": "https://…"
  }
}

{  "id": "evt_3f9a1c…",  "type": "connection.expired",  "createdAt": "2026-10-16T08:00:00+00:00",  "data": {    "clientId": "6f1c2a7e-...",    "clientName": "Miller Dental",    "provider": "etsy",    "services": [      "etsy"    ],    "reconnectUrl": "https://…"  }}