Query Pre-Start-Date Etsy Orders
GET/api/etsy/instances/:integrationInstance/orders/pre-start-date
Queries Etsy live for orders created before the order import start date and reports which are eligible to import. Requires an order import start date on the instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Without search_term, returns orders from created_at_min (default: one year before the start date) up to the start date, newest first. With search_term, looks up a single Etsy receipt ID.
Query parameters:
created_at_min(date, optional) — Earliest creation date to include.status(string, optional) —any(default),paid,shipped, orcanceled.search_by(string, optional) —receipt_id.search_term(string, optional, max 64) — Etsy receipt ID to look up.
Response: data rows include eligible (paid and not canceled), eligibility_reason, and already_imported. meta.eligible_count excludes already-imported orders.
Returns 422 when Etsy cannot be reached.
Authentication: Bearer token (Personal Access Token).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.