@convermax/api/README.md

A package for searching products via Convermax API

---
title: Convermax npm package
---

A lightweight JavaScript client for Convermax Year-Make-Model (YMM) vehicle search API.

### Installation

```
npm install @convermax/api
```

### Usage example

In your JS code:

```js
import Convermax from '@convermax/api';

const storeId = 'your-store-id';

// Define vehicle parameters
const vehicle = {
  Year: 2020,
  Make: 'Toyota',
  Model: 'Corolla',
};

// Search for products matching the vehicle
const results = await Convermax.searchByVehicle(storeId, vehicle);

console.log(results);
/* Example output (array of products):
[
  {
    "id": "6761941303496",
    "title": "K&N Universal Rubber Filter 5in Flange ID...",
    "url": "/products/k-n-universal-rubber-filter-5in-flange-id-x-6-5in-base-od-x-4-5in-top-od-x-4-125in-height",
    "price": 48.99,
    "image": "https://cdn.shopify.com/s/files/1/0562/7704/1352/products/5d64409aa1a444d96889ef0d01b5169a.jpg?v=1619199536",
    // ... other fields
  },
  // ... more products
]
*/
```

> [!NOTE]
> If you are not sure what your `store-id` is, please contact support@convermax.com