# clover-rest-api

> Clover Rest API for Node.js

Latest version **0.0.4** (published 2018-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install clover-rest-api
pnpm add clover-rest-api
yarn add clover-rest-api
bun add clover-rest-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2018-12-26 |
| First published | 2018-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Yoga Lin |
| Maintainers | yogalin |
| Keywords | Clover, RESTFul, API, Server, Web, NodeJS |

## Links

- npm: https://www.npmjs.com/package/clover-rest-api
- Repository: https://github.com/Menupedia/clover-rest-api
- Homepage: https://github.com/Menupedia/clover-rest-api#readme
- Issues: https://github.com/Menupedia/clover-rest-api/issues
- npm.io page: https://npm.io/package/clover-rest-api

## Dependencies (1)

- [got](https://npm.io/package/got.md) ^9.5.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2018-12-26
- 0.0.3 — 2018-12-16
- 0.0.2 — 2018-12-16
- 0.0.1 — 2018-12-08

## README

# clover-rest-api

Clover Rest API for Node.js

It is **NOT** official NPM package from Clover. **For official documentation, please read [Clover V3 API Documentation](https://www.clover.com/api_docs/)**

[![npm version](https://badge.fury.io/js/clover-rest-api.svg)](https://badge.fury.io/js/clover-rest-api)
[![](https://img.shields.io/npm/dt/clover-rest-api.svg)](https://www.npmjs.com/package/clover-rest-api)
![issues](https://img.shields.io/github/issues/Menupedia/clover-rest-api.svg)
![starts](https://img.shields.io/github/stars/Menupedia/clover-rest-api.svg)
![License](https://img.shields.io/github/license/Menupedia/clover-rest-api.svg)

```
const CloverRestful = require('clover-rest-api')
const CloverClient = CloverRestful.client('https://apisandbox.dev.clover.com')

const cloverToken = 'xxxxxxxxxxxxxxxxxxxxx'
const merchantId = 'merchantIdXXXX'
const cloverInventories = (await CloverClient.inventory.getAllInventoryItems(
        cloverToken,
        merchantId,
        {
          limit: 1000,
          expand: 'categories'
        }
      )).elements
```

## Installation

```
$ npm install clover-rest-api
or
$ yarn add clover-rest-api
```

## Features

The project under developing now, so it just implements some APIs

### Inventory

`getAllInventoryItems (token, merchantId, parameters)`
[read more](https://www.clover.com/api_docs/#!/inventory/GetItems)
`parameters: filter, expand, limit, offset`

`getAllCategories (token, merchantId, parameters)`
[read more](https://www.clover.com/api_docs/#inventory_Categories)
`parameters: filter, expand, limit, offset`

### Orders

`createAnOrder (token, merchantId, body)`
[read more](https://www.clover.com/api_docs/#!/orders/CreateOrder)

`getASingleOrder (token, merchantId, orderId, expand)`

`deleteAnOrder (token, merchantId, orderId, body)`

`getAllLineItemsForAnOrder (token, merchantId, orderId, parameters)`
`parameters: expand, limit, offset`

`createAnOrder (token, merchantId, body)`
[read more](https://www.clover.com/api_docs/#!/orders/CreateLineItem)

## License

[MIT](https://github.com/Menupedia/clover-rest-api/blob/master/LICENSE)

---
_Source: https://npm.io/package/clover-rest-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._