TypeScript / JavaScript SDK

This page starts with setup prerequisites and then provides an overview of available TypeScript / JavaScript SDK examples.

Before You Start

Before implementing the examples, make sure you have the following in place:

• A Dataset ID and API Key from API Credentials in My Relewise. These examples use API Key authentication. Keep backend keys private and configure allowed origins for browser keys. See SDK Authentication for method selection.
• A TypeScript or JavaScript project with npm.
• Implementation context from Implementation Steps.

Install the SDK package from npm:

npm install @relewise/client

Not using npm?

You can reference the SDK from CDN providers jsDelivr or UNPKG.

For integration examples, you may also need:

npm install @relewise/integrations

To learn more about the SDK, view it on GitHub.

Examples

• Common use cases

  • Filtering products in search or recommendations with our TS/JS client

• Entities

  • Integrating and Updating Entities with TS/JS
  • Deleting Entities from Relewise
  • Enabling and disabling entities

• Recommendations

  • Product Recommendations using our SDK
  • Sorting a product collection

• Recommendation

  • Configuring a SimilarProducts recommendation

• Search

  • Product category search with our TS/JS clients
  • Product search with our TS/JS client
  • Search term prediction with our TS/JS client

• Tracking

  • Client-side tracking
  • Using Google Tag Manager for tracking

---

Check out our StackBlitz playground to try common Relewise TypeScript SDK requests and see the responses instantly.