Skip to main content

Get Integration Readiness

GET 
/api/integrations/readiness

List outstanding integration setup across every connected sales channel, expressed as records the merchant cannot see yet.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

A channel's records reach SKU.io in two hops: they are first downloaded into staging, then turned into usable SKU.io records (catalog products, sales orders). Work that stalls between the two is invisible — a catalog can read empty while listings sit downloaded but unimported. Each item here is one such stall.

Per item:

  • staged — records downloaded from the channel
  • inSku — of those, how many became usable SKU.io records
  • missing — staged - inSku, always greater than zero (items with nothing missing are omitted, so a healthy account returns an empty list)
  • message — one sentence written for the merchant, safe to render verbatim
  • actionLabel / actionRoute — the single step that closes it, deep-linked to the specific store via filter[integration_instance_ids]
  • surface — which SKU.io area it blocks: products, orders or locations
  • statusBreakdown — for the products surface, the missing listings grouped by channel status (active, draft, …) so active listings can be told apart from drafts; null on other surfaces

Every count is a local comparison between two tables SKU.io already holds, so this endpoint keeps working when the channel is unreachable or its credentials have been revoked.

Query parameters:

  • surface (optional, one of products, orders, locations)

Request​

Responses​

OK

Response Headers
    Content-Type