* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
11 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| entitiesSidebar |
Class: Order
Hierarchy
-
BaseEntity↳
Order
Constructors
constructor
• new Order()
Inherited from
BaseEntity.constructor
Properties
billing_address
• billing_address: Address
Defined in
billing_address_id
• billing_address_id: string
Defined in
canceled_at
• canceled_at: Date
Defined in
cart
• cart: Cart
Defined in
cart_id
• cart_id: string
Defined in
claims
• claims: ClaimOrder[]
Defined in
created_at
• created_at: Date
Inherited from
BaseEntity.created_at
Defined in
interfaces/models/base-entity.ts:16
currency
• currency: Currency
Defined in
currency_code
• currency_code: string
Defined in
customer
• customer: Customer
Defined in
customer_id
• customer_id: string
Defined in
discount_total
• discount_total: number
Defined in
discounts
• discounts: Discount[]
Defined in
display_id
• display_id: number
Defined in
draft_order
• draft_order: DraftOrder
Defined in
draft_order_id
• draft_order_id: string
Defined in
edits
• edits: OrderEdit[]
Defined in
• email: string
Defined in
external_id
• external_id: null | string
Defined in
fulfillment_status
• fulfillment_status: FulfillmentStatus
Defined in
fulfillments
• fulfillments: Fulfillment[]
Defined in
gift_card_tax_total
• gift_card_tax_total: number
Defined in
gift_card_total
• gift_card_total: number
Defined in
gift_card_transactions
• gift_card_transactions: GiftCardTransaction[]
Defined in
gift_cards
• gift_cards: GiftCard[]
Defined in
id
• id: string
Inherited from
BaseEntity.id
Defined in
interfaces/models/base-entity.ts:13
idempotency_key
• idempotency_key: string
Defined in
items
• items: LineItem[]
Defined in
metadata
• metadata: Record<string, unknown>
Defined in
no_notification
• no_notification: boolean
Defined in
object
• Readonly object: "order"
Defined in
paid_total
• paid_total: number
Defined in
payment_status
• payment_status: PaymentStatus
Defined in
payments
• payments: Payment[]
Defined in
refundable_amount
• refundable_amount: number
Defined in
refunded_total
• refunded_total: number
Defined in
refunds
• refunds: Refund[]
Defined in
region
• region: Region
Defined in
region_id
• region_id: string
Defined in
returns
• returns: Return[]
Defined in
sales_channel
• sales_channel: SalesChannel
Defined in
sales_channel_id
• sales_channel_id: null | string
Defined in
shipping_address
• shipping_address: Address
Defined in
shipping_address_id
• shipping_address_id: string
Defined in
shipping_methods
• shipping_methods: ShippingMethod[]
Defined in
shipping_total
• shipping_total: number
Defined in
status
• status: OrderStatus
Defined in
subtotal
• subtotal: number
Defined in
swaps
• swaps: Swap[]
Defined in
tax_rate
• tax_rate: null | number
Defined in
tax_total
• tax_total: null | number
Defined in
total
• total: number
Defined in
updated_at
• updated_at: Date
Inherited from
BaseEntity.updated_at
Defined in
interfaces/models/base-entity.ts:19
Methods
beforeInsert
▸ Private beforeInsert(): Promise<void>
Returns
Promise<void>