# sanity-plugin-snipcart-orders

> A dashboard widget for displaying recent orders from Snipcart

Latest version **3.0.0** (published 2021-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install sanity-plugin-snipcart-orders
pnpm add sanity-plugin-snipcart-orders
yarn add sanity-plugin-snipcart-orders
bun add sanity-plugin-snipcart-orders
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-02-08 |
| First published | 2021-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Jacob Størdahl |
| Maintainers | stordahl_ |
| Keywords | sanity, sanity-plugin |

## Links

- npm: https://www.npmjs.com/package/sanity-plugin-snipcart-orders
- Repository: https://github.com/stordahl/sanity-plugin-snipcart-orders
- Homepage: https://github.com/stordahl/sanity-plugin-snipcart-orders#readme
- Issues: https://github.com/stordahl/sanity-plugin-snipcart-orders/issues
- npm.io page: https://npm.io/package/sanity-plugin-snipcart-orders

## Dependencies (1)

- [prop-types](https://npm.io/package/prop-types.md) 15.7.2

## Recent versions

- 3.0.0 (latest) — 2021-02-08

## README

# sanity-plugin-snipcart-orders

A dashboard widget for displaying recent orders from Snipcart.

This plugin is a part of the Steel headless commerce sudo framework.

## Installation

Be sure to have dashboard installed in your studio by running...

```shell
sanity install @sanity/dashboard
```

Then install the widget...

```shell
sanity install snipcart-orders
```

## Configuration

The plugin can be configured by creating a file called `dashboardConfig.js` in the root of your studio. You'll then need to add the following object to the `parts` array in your projects `sanity.json`...

```json
{ 
  "implements": "part:@sanity/dashboard/config", 
  "path": "./dashboardConfig.js" 
}
```

You'll then need to add some boilerplate to `dashboardConfig.js` along with options for the plugin...

```javascript
export default {
  widgets: [
    {
      name: 'snipcart-orders',
      options: 
      {
        apiKey: string, // SNIPCART SECRET API KEY
        limit: number, //DEFAULTS TO FIVE
      }
    }
  ]
}
```

### Options

| Option | Type   | Description |
|--------|--------|-------------|
| apiKey | string | a secret api key from Snipcart. Check the [docs](https://docs.snipcart.com/v3/api-reference/authentication). |
| limit  | number | the number of orders to be returned |

## License

MIT © Jacob Størdahl
See LICENSE

---
_Source: https://npm.io/package/sanity-plugin-snipcart-orders · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._