# @nuskin/order-model

> Order Model and conversion utility functions based on cart object and SalesOrder

Latest version **3.1.3** (published 2024-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nuskin/order-model
pnpm add @nuskin/order-model
yarn add @nuskin/order-model
bun add @nuskin/order-model
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.3 |
| Published | 2024-08-01 |
| First published | 2021-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 161.9 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| Author | Dan Arnold |
| Maintainers | nkranendonk, emoore, nuskin-cws, klau, rellenberger |

## Links

- npm: https://www.npmjs.com/package/@nuskin/order-model
- Repository: git@code.tls.nuskin.io:ns-am/order/node/order-model
- Homepage: https://code.tls.nuskin.io/ns-am/order/node/order-model/blob/master/README.md
- npm.io page: https://npm.io/package/@nuskin/order-model

## Dependencies (2)

- [ajv](https://npm.io/package/ajv.md) 7.0.3
- [lodash](https://npm.io/package/lodash.md) 4.17.21

## Recent versions

- 3.1.3 (latest) — 2024-08-01
- 3.1.2-cx16-11155.1 (prerelease) — 2024-07-12
- 3.1.2 — 2024-07-12
- 3.1.1 — 2024-07-09
- 3.1.1-cx16-11155.1 — 2024-07-03
- 3.1.0 — 2024-05-30
- 3.1.0-cx16-11089.5 — 2024-05-22
- 3.1.0-cx16-11089.4 — 2024-05-22
- 3.1.0-cx16-11089.3 — 2024-05-21
- 3.1.0-cx16-11089.2 — 2024-05-17
- 3.1.0-cx16-11089.1 — 2024-05-17
- 3.0.24-cx16-11089.3 — 2024-05-16
- 3.0.24-cx16-11089.2 — 2024-05-16
- 3.0.24-cx16-11089.1 — 2024-05-16
- 3.0.23 — 2024-05-14
- … 39 more at https://npm.io/package/@nuskin/order-model/versions

## README

# @nuskin/order-model

This module defines the order model for the web commerce platform. It consists of fields from
the commercetools cart object, as well as fields from the SAP SalesOrder object.
It also has functions to convert between this model and SAP SalesOrder objects.

## Installing

Using npm:

```bash
npm add @nuskin/order-model
```

Using yarn:

```bash
yarn add @nuskin/order-model
```

## Example usage

```js
const { order: { Order } } = require('@nuskin/order-model');

// Create a new Order object from scratch
const myOrder1 = new Order({...});
// Create a new Order object from a SalesOrderRequest
const myOrder2 = Order.fromSalesOrderRequest(mySalesOrderRequest);
// Create a new Order object from a SalesOrderResponse
const myOrder3 = Order.fromSalesOrderResponse(mySalesOrderResponse);
// Convert an order to a SalesOrderRequest
const mySalesOrderRequest = myOrder2.toSalesOrderRequest();
// Convert an order to a SalesOrderResponse
const mySalesOrderResponse = myOrder3.toSalesOrderResponse();
```

<br>

## Updating the Order Model

When adding or removing properties from the order model. Kindly also update the type definition, which you can find in `@types/index.d.ts`

<br>

## Resources

* Commercetools cart object: https://docs.commercetools.com/api/projects/carts

---
_Source: https://npm.io/package/@nuskin/order-model · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._