ShopSavvy for Jetpack Compose

A Kotlin package with Material 3 composables for product cards, price comparison lists, and deal feeds. StateFlow-based view models with the ShopSavvy Kotlin SDK.

Set up ShopSavvy for Jetpack Compose

1. 1

   Get a ShopSavvy Data API key

   Create a key at shopsavvy.com/data. Keys look like ss_live_ followed by 32 characters. Keep it out of source control.

2. 2

   Install

   Get the integration from its repository and follow the README's install section: https://github.com/shopsavvy/jetpack-compose-shopsavvy

   git clone https://github.com/shopsavvy/jetpack-compose-shopsavvy.git

3. 3

   Add your API key

   Enter your key where Jetpack Compose asks for ShopSavvy credentials, as the README describes. Store it as a secret, not in code.

4. 4

   Make your first call

   From the shopsavvy/jetpack-compose-shopsavvy README (Installation):

   dependencies {
       implementation("com.shopsavvy:jetpack-compose-shopsavvy:1.0.0")
   }

   Copied from the repository README.

5. 5

   Quick Start

   From the shopsavvy/jetpack-compose-shopsavvy README (Quick Start):

   import com.shopsavvy.compose.*
   import com.shopsavvy.compose.ui.*
   import com.shopsavvy.compose.viewmodel.*
   
   val client = ShopSavvyComposeClient("ss_live_your_api_key_here")
   val viewModel = ProductSearchViewModel(client)
   
   @Composable
   fun ProductScreen() {
       val state by viewModel.state.collectAsState()
   
       LaunchedEffect(Unit) {
           viewModel.search("airpods pro")
       }
   
       LazyColumn {
           items(state.products) { product ->
               ProductCard(
                   product = product,
                   onClick = { /* navigate */ }
               )
           }
       }
   }

   Copied from the repository README.

Keys come with a Data API plan. See plans.

Features

Use Cases

What data, how often, which direction

Data

Product records, current offers from tens of thousands of retailers and price history back to 2011, dense from 2019, from the ShopSavvy Data API. Prices are in US dollars.

How often

Every offer carries the time it was last checked. With the Data API you can schedule refreshes hourly, daily or weekly for retailers we can re-check through an official retailer API; other retailers update as ShopSavvy sees them.

Direction

ShopSavvy data flows into Jetpack Compose. Requests carry only what you ask about (identifiers, search terms or schedules) and your API key.

FAQ

Related Integrations