Get Shopify Setup State
GET/api/shopify/:integrationInstance/setup
Report what still has to be true before a Shopify connection is usable.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Each step's completed is DERIVED from live data on every read — a mapped location, a stored import horizon, an imported catalog — never from a stored "setup finished" flag. Undo the underlying thing and the step reopens.
Per step:
required— whether it blockscompleteblocking— records this step is holding out of SKU.io, when knowndetail— one line of plain-language statusactionLabel/actionRoute— the single step that resolves it
complete is true when every REQUIRED step is done. deferred records that the merchant chose to finish later — it is never the same as complete, and a deferred connection still reports its outstanding steps.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.