SearchConfiguration

How to search this shop's catalog. When provider is ALGOLIA the credentials below are a per-request, index-scoped, expiring secured key safe to use from a browser. When provider is POSTGRES no credentials are issued and consumers should use products(filter: {search: ...}).

type SearchConfiguration {
  provider: SearchProvider!
  recordModel: SearchRecordModel!
  schemaVersion: Int!
  indexes: [SearchIndexDescriptor!]!
  applicationId: String
  indexPrefix: String
  searchApiKey: String
  validUntil: DateTime
}

Fields

SearchConfiguration.provider ● SearchProvider! non-null enum

Engine backing search. POSTGRES means fall back to the GraphQL FTS path.

SearchConfiguration.recordModel ● SearchRecordModel! non-null enum

Granularity of index records; VARIANT records collapse to one hit per product.

SearchConfiguration.schemaVersion ● Int! non-null scalar

Version of the record schema, so clients can detect field-shape changes.

SearchConfiguration.indexes ● [SearchIndexDescriptor!]! non-null object

Indexes this client may query. Empty when provider is POSTGRES.

SearchConfiguration.applicationId ● String scalar

Algolia application ID. Null when provider is POSTGRES.

SearchConfiguration.indexPrefix ● String scalar

Index-name prefix owned by this shop. Null when POSTGRES.

SearchConfiguration.searchApiKey ● String scalar

Secured, index-scoped, expiring search key minted for this request. Never the tenant's raw search or admin key. Null when provider is POSTGRES.

SearchConfiguration.validUntil ● DateTime scalar

When searchApiKey stops working. Null when provider is POSTGRES.

Member Of

Shop object