Create Etsy Integration Instance
POST/api/etsy/instances
Creates a new, not-yet-connected Etsy integration instance. After creating it, call Get Etsy Authorization URL and send the shop owner to the returned URL to connect the Etsy shop.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request body:
name(string, required, max 255) — Display name. Must be unique across all integration instances in the account.store_id(integer, optional, nullable) — SKU.io store used for orders imported from this shop. Must exist.order_import_start_date(date, optional, nullable) — Only Etsy orders created on or after this date are imported automatically (e.g.2026-09-01).
Response: 201 Created with the new instance.
Authentication: Bearer token (Personal Access Token).
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.