Files
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

6.8 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: Order

internal.Order

Base abstract entity for all entities

Hierarchy

Properties

beforeInsert

Private beforeInsert: any

Defined in

medusa/dist/models/order.d.ts:97


billing_address

billing_address: Address

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

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[]

Defined in

medusa/dist/models/order.d.ts:73


created_at

created_at: Date

Inherited from

BaseEntity.created_at

Defined in

medusa/dist/interfaces/models/base-entity.d.ts:6


currency

currency: Currency

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

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[]

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

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

Defined in

medusa/dist/models/order.d.ts:50


fulfillments

fulfillments: Fulfillment[]

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[]

Defined in

medusa/dist/models/order.d.ts:79


gift_cards

gift_cards: GiftCard[]

Defined in

medusa/dist/models/order.d.ts:68


id

id: string

Inherited from

BaseEntity.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[]

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

Defined in

medusa/dist/models/order.d.ts:51


payments

payments: Payment[]

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[]

Defined in

medusa/dist/models/order.d.ts:74


region

region: Region

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[]

Defined in

medusa/dist/models/order.d.ts:72


sales_channel

sales_channel: SalesChannel

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

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[]

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

Defined in

medusa/dist/models/order.d.ts:49


subtotal

subtotal: number

Defined in

medusa/dist/models/order.d.ts:92


swaps

swaps: Swap[]

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.updated_at

Defined in

medusa/dist/interfaces/models/base-entity.d.ts:7