asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
a8293af8e1f60d77c7b4b546da692b6cfe85d323
medusa-store/docs/content/references/js-client/classes/internal.Order.md
Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994) 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
2022-08-04 17:29:52 +03:00

558 lines
6.8 KiB
Markdown
Raw Blame History

---
displayed_sidebar: jsClientSidebar
---
# Class: Order
[internal](../modules/internal.md).Order
Base abstract entity for all entities
## Hierarchy
- [`BaseEntity`](internal.BaseEntity.md)
↳ **`Order`**
## Properties
### beforeInsert
• `Private` **beforeInsert**: `any`
#### Defined in
medusa/dist/models/order.d.ts:97
___
### billing\_address
• **billing\_address**: [`Address`](internal.Address.md)
#### Defined in
medusa/dist/models/order.d.ts:59
___
### billing\_address\_id
• **billing\_address\_id**: `string`
#### Defined in
medusa/dist/models/order.d.ts:58
___
### canceled\_at
• **canceled\_at**: `Date`
#### Defined in
medusa/dist/models/order.d.ts:80
___
### cart
• **cart**: [`Cart`](internal.Cart.md)
#### Defined in
medusa/dist/models/order.d.ts:54
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
medusa/dist/models/order.d.ts:53
___
### claims
• **claims**: [`ClaimOrder`](internal.ClaimOrder.md)[]
#### Defined in
medusa/dist/models/order.d.ts:73
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:6
___
### currency
• **currency**: [`Currency`](internal.Currency.md)
#### Defined in
medusa/dist/models/order.d.ts:65
___
### currency\_code
• **currency\_code**: `string`
#### Defined in
medusa/dist/models/order.d.ts:64
___
### customer
• **customer**: [`Customer`](internal.Customer.md)
#### Defined in
medusa/dist/models/order.d.ts:56
___
### customer\_id
• **customer\_id**: `string`
#### Defined in
medusa/dist/models/order.d.ts:55
___
### discount\_total
• **discount\_total**: `number`
#### Defined in
medusa/dist/models/order.d.ts:88
___
### discounts
• **discounts**: [`Discount`](internal.Discount.md)[]
#### Defined in
medusa/dist/models/order.d.ts:67
___
### display\_id
• **display\_id**: `number`
#### Defined in
medusa/dist/models/order.d.ts:52
___
### draft\_order
• **draft\_order**: [`DraftOrder`](internal.DraftOrder.md)
#### Defined in
medusa/dist/models/order.d.ts:77
___
### draft\_order\_id
• **draft\_order\_id**: `string`
#### Defined in
medusa/dist/models/order.d.ts:76
___
### email
• **email**: `string`
#### Defined in
medusa/dist/models/order.d.ts:57
___
### external\_id
• **external\_id**: ``null`` \| `string`
#### Defined in
medusa/dist/models/order.d.ts:84
___
### fulfillment\_status
• **fulfillment\_status**: [`FulfillmentStatus`](../enums/internal.FulfillmentStatus.md)
#### Defined in
medusa/dist/models/order.d.ts:50
___
### fulfillments
• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[]
#### Defined in
medusa/dist/models/order.d.ts:71
___
### gift\_card\_tax\_total
• **gift\_card\_tax\_total**: `number`
#### Defined in
medusa/dist/models/order.d.ts:96
___
### gift\_card\_total
• **gift\_card\_total**: `number`
#### Defined in
medusa/dist/models/order.d.ts:95
___
### gift\_card\_transactions
• **gift\_card\_transactions**: [`GiftCardTransaction`](internal.GiftCardTransaction.md)[]
#### Defined in
medusa/dist/models/order.d.ts:79
___
### gift\_cards
• **gift\_cards**: [`GiftCard`](internal.GiftCard.md)[]
#### Defined in
medusa/dist/models/order.d.ts:68
___
### id
• **id**: `string`
#### Inherited from
[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:5
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
medusa/dist/models/order.d.ts:83
___
### items
• **items**: [`LineItem`](internal.LineItem.md)[]
#### Defined in
medusa/dist/models/order.d.ts:78
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/models/order.d.ts:81
___
### no\_notification
• **no\_notification**: `boolean`
#### Defined in
medusa/dist/models/order.d.ts:82
___
### object
• `Readonly` **object**: ``"order"``
#### Defined in
medusa/dist/models/order.d.ts:48
___
### paid\_total
• **paid\_total**: `number`
#### Defined in
medusa/dist/models/order.d.ts:93
___
### payment\_status
• **payment\_status**: [`PaymentStatus`](../enums/internal.PaymentStatus.md)
#### Defined in
medusa/dist/models/order.d.ts:51
___
### payments
• **payments**: [`Payment`](internal.Payment.md)[]
#### Defined in
medusa/dist/models/order.d.ts:70
___
### refundable\_amount
• **refundable\_amount**: `number`
#### Defined in
medusa/dist/models/order.d.ts:94
___
### refunded\_total
• **refunded\_total**: `number`
#### Defined in
medusa/dist/models/order.d.ts:90
___
### refunds
• **refunds**: [`Refund`](internal.Refund.md)[]
#### Defined in
medusa/dist/models/order.d.ts:74
___
### region
• **region**: [`Region`](internal.Region.md)
#### Defined in
medusa/dist/models/order.d.ts:63
___
### region\_id
• **region\_id**: `string`
#### Defined in
medusa/dist/models/order.d.ts:62
___
### returns
• **returns**: [`Return`](internal.Return.md)[]
#### Defined in
medusa/dist/models/order.d.ts:72
___
### sales\_channel
• **sales\_channel**: [`SalesChannel`](internal.SalesChannel.md)
#### Defined in
medusa/dist/models/order.d.ts:86
___
### sales\_channel\_id
• **sales\_channel\_id**: ``null`` \| `string`
#### Defined in
medusa/dist/models/order.d.ts:85
___
### shipping\_address
• **shipping\_address**: [`Address`](internal.Address.md)
#### Defined in
medusa/dist/models/order.d.ts:61
___
### shipping\_address\_id
• **shipping\_address\_id**: `string`
#### Defined in
medusa/dist/models/order.d.ts:60
___
### shipping\_methods
• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[]
#### Defined in
medusa/dist/models/order.d.ts:69
___
### shipping\_total
• **shipping\_total**: `number`
#### Defined in
medusa/dist/models/order.d.ts:87
___
### status
• **status**: [`OrderStatus`](../enums/internal.OrderStatus.md)
#### Defined in
medusa/dist/models/order.d.ts:49
___
### subtotal
• **subtotal**: `number`
#### Defined in
medusa/dist/models/order.d.ts:92
___
### swaps
• **swaps**: [`Swap`](internal.Swap.md)[]
#### Defined in
medusa/dist/models/order.d.ts:75
___
### tax\_rate
• **tax\_rate**: ``null`` \| `number`
#### Defined in
medusa/dist/models/order.d.ts:66
___
### tax\_total
• **tax\_total**: ``null`` \| `number`
#### Defined in
medusa/dist/models/order.d.ts:89
___
### total
• **total**: `number`
#### Defined in
medusa/dist/models/order.d.ts:91
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:7
Reference in New Issue View Git Blame Copy Permalink