Store Integrations

Match a store to a project

Changed on

Tells a store app whether the API key's account can use it and which project the store belongs to: the live project whose domain equals the store domain, else one whose domain is a parent or a subdomain of it, else null. candidates lists every live project of the account so the app can offer a picker. Pitch projects are never matched or listed, since a store is a data connection a pitch project does not take. Takes no project_id. Not available to accounts with a white-label portal or an embed (ERR_INTEGRATION_UNAVAILABLE).

get/store_connection

Request

  • Base URL
    https://api.llmpulse.ai/api/v1
  • URL
    https://api.llmpulse.ai/api/v1/store_connection
  • Auth
    API key in header Authorization

Query parameters

platform'shopify' required

Store platform

domainstring required

Store domain, with or without scheme, e.g. acme-store.com

Response

Eligibility, the matching project and the candidates

platformstring required

The store platform, e.g. shopify

domainstring required

The store domain as compared: lowercase, without scheme, www or path

ambiguousboolean required

True when several live projects match the store domain (for example one project per market). project is then null and the app asks the key holder to pick from candidates.

request_idstring required

Changes