Skip to main content

Get Instance

GET 
/api/storefront/instances/:id

One instance with its full settings, connection state, per-entity sync cursors and live counts.

Not yet available to API tokens

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

Notable fields:

  • auth — oauth when the store's owner approved and the store issued the key, api_key when a key was pasted in. connection carries the store's own record of an owner-approved connection (id, name, tenant, scopes, created_at) and is null for a pasted key.
  • pricing — the canonical pricing node: master_of_price (sku.io, sales_channel or neither), pricing_tier and compare_at_pricing_tier. The flat product_pricing_tier_id / compare_at_pricing_tier_id fields are the same values, kept for older clients.
  • inventory.master_of_stock — sku.io or neither. The store never masters stock (the Store API has no inbound inventory feed), and an instance that has never been configured reads as sku.io so an existing store's inventory sync does not go quiet.
  • last_products_sync — when the store's catalogue was last imported. Falls back to the inbound sweep's cursor_at when no completion timestamp has been recorded yet.
  • api_key_hint — the last four characters of the key. The key itself is never returned.

Authentication: Bearer token (session or PAT).

Request​

Responses​

OK

Response Headers
    Content-Type