3.2.0 • Published 4 years ago
@twec/mongoose-models v3.2.0
mongoose-models
Installation
npm i @twec/mongoose-models
Usage
const models = require('@twec/mongoose-models`);
const instance = new models.OrderFeedback({...})
or
const { OrderFeedback } = require('@twec/mongoose-models`);
const instance = new OrderFeedback({...})
Available Models
OrderFeedback
Field | Type | Required | Default |
---|---|---|---|
reference | string | ✓ | |
purchaseOrderId | string | ✓ | |
sentToOMS | boolean | ||
sentToCustomer | boolean | ||
errorCode | string | ||
errorMessage | string |
OrderCancel
inherits fields from OrderFeedback
Field | Type | Required | Default |
---|---|---|---|
cancelledAt | date | ||
reference | string | ✓ | |
purchaseOrderId | string | ✓ | |
sentToOMS | boolean | ||
sentToCustomer | boolean | ||
errorCode | string | ||
errorMessage | string |
ItemShipment
inherits fields from OrderFeedback
Field | Type | Required | Default |
---|---|---|---|
shippedAt | date | ✓ | Date.now |
items | [schema] | ||
carrier | string | ||
trackingNumber | string | ✓ | |
expenses | [schema] |
Items Schema
Field | Type | Required | Min | Max | Default |
---|---|---|---|---|---|
itemId | string | ✓ | |||
quantity | number | ✓ | 0 | 9999 | |
cost | number | ||||
isUsed | boolean | false |
Expense Schema
Field | Type | Required | Enum | Min |
---|---|---|---|---|
type | string | ✓ | handling ,freight | |
amount | number | ✓ | 0 |
ItemConfirmation
inherits fields from OrderFeedback
Field | Type | Required | Default | Min | Max |
---|---|---|---|---|---|
confirmedAt | date | ✓ | Date.now | ||
itemId | string | ✓ | |||
quantity | number | ✓ | 0 | 9999 |
ItemCancel
inherits fields from OrderFeedback
Field | Type | Required | Default | Min | Max |
---|---|---|---|---|---|
cancelledAt | date | ✓ | Date.now | ||
itemId | string | ✓ | |||
quantity | number | ✓ | 0 | 9999 |
ItemBackorder
inherits fields from OrderFeedback
Field | Type | Required | Default | Min | Max |
---|---|---|---|---|---|
backorderedAt | date | ✓ | Date.now | ||
itemId | string | ✓ | |||
quantity | number | ✓ | 0 | 9999 |
3.3.0-dev0.6
4 years ago
3.3.0-dev0.5
4 years ago
3.3.0-dev0.4
4 years ago
3.3.0-dev0.3
4 years ago
3.3.0-dev0.2
4 years ago
3.3.0-dev0.1
4 years ago
3.2.0
4 years ago
3.1.0
4 years ago
3.0.1
4 years ago
3.0.0
4 years ago
2.1.0
4 years ago
2.0.0
5 years ago
1.5.0
5 years ago
1.4.0
5 years ago
1.3.0
5 years ago
1.2.0
5 years ago
1.0.2
5 years ago
1.0.1
5 years ago
1.0.0
5 years ago