Adobe Commerce only. Learn more.

Live Search SDK

Live Search SDK includes a GraphQL Playground that can be used to query products and associated facets from the Magento Admin. As an API counterpart/wrapper, it also provides a Javascript SDK.

Requirements

The GraphOL Playground API is unauthenticated, but requires an API key with the value set to “search_gql The following headers are required for this API:

  Required Headers
productSearch - MagentoEnvironmentId
- MagentoWebsiteCode
- MagentoStoreCode
- MagentoStoreViewCode
- x-api-key:{Magento api key}
- x-gw-signature:{jwt}
attributeMetadata (same as above)`

Example request

productAttribute

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
query {
  attributeMetadata
  {
    attributes {
      attributeCode
      dataType
      multiSelect
      label
      required
      unique
      global
      visible
      searchable
      filterable
      visibleInCompareList
      visibleInListing
      sortable
      visibleInSearch
      filterableInSearch
      searchWeight
      usedForRules
      deleted
      numeric
    }
  }
}