api-ref: custom API reference (#4770)
* 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
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,567 @@
|
||||
---
|
||||
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:99
|
||||
|
||||
___
|
||||
|
||||
### billing\_address
|
||||
|
||||
• **billing\_address**: [`Address`](internal.Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:60
|
||||
|
||||
___
|
||||
|
||||
### billing\_address\_id
|
||||
|
||||
• **billing\_address\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:59
|
||||
|
||||
___
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](internal.Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:55
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:54
|
||||
|
||||
___
|
||||
|
||||
### claims
|
||||
|
||||
• **claims**: [`ClaimOrder`](internal.ClaimOrder.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:74
|
||||
|
||||
___
|
||||
|
||||
### 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:66
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• **currency\_code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:65
|
||||
|
||||
___
|
||||
|
||||
### customer
|
||||
|
||||
• **customer**: [`Customer`](internal.Customer.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:57
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• **customer\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:56
|
||||
|
||||
___
|
||||
|
||||
### discount\_total
|
||||
|
||||
• **discount\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### discounts
|
||||
|
||||
• **discounts**: [`Discount`](internal.Discount.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:68
|
||||
|
||||
___
|
||||
|
||||
### display\_id
|
||||
|
||||
• **display\_id**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:53
|
||||
|
||||
___
|
||||
|
||||
### draft\_order
|
||||
|
||||
• **draft\_order**: [`DraftOrder`](internal.DraftOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:78
|
||||
|
||||
___
|
||||
|
||||
### draft\_order\_id
|
||||
|
||||
• **draft\_order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:77
|
||||
|
||||
___
|
||||
|
||||
### edits
|
||||
|
||||
• **edits**: [`OrderEdit`](internal.OrderEdit.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:79
|
||||
|
||||
___
|
||||
|
||||
### email
|
||||
|
||||
• **email**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:58
|
||||
|
||||
___
|
||||
|
||||
### external\_id
|
||||
|
||||
• **external\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### fulfillment\_status
|
||||
|
||||
• **fulfillment\_status**: [`FulfillmentStatus`](../enums/internal.FulfillmentStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:51
|
||||
|
||||
___
|
||||
|
||||
### fulfillments
|
||||
|
||||
• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:72
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_tax\_total
|
||||
|
||||
• **gift\_card\_tax\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:98
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_total
|
||||
|
||||
• **gift\_card\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:97
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_transactions
|
||||
|
||||
• **gift\_card\_transactions**: [`GiftCardTransaction`](internal.GiftCardTransaction.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:81
|
||||
|
||||
___
|
||||
|
||||
### gift\_cards
|
||||
|
||||
• **gift\_cards**: [`GiftCard`](internal.GiftCard.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### 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:85
|
||||
|
||||
___
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`LineItem`](internal.LineItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:80
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### object
|
||||
|
||||
• `Readonly` **object**: ``"order"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:49
|
||||
|
||||
___
|
||||
|
||||
### paid\_total
|
||||
|
||||
• **paid\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:95
|
||||
|
||||
___
|
||||
|
||||
### payment\_status
|
||||
|
||||
• **payment\_status**: [`PaymentStatus`](../enums/internal.PaymentStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:52
|
||||
|
||||
___
|
||||
|
||||
### payments
|
||||
|
||||
• **payments**: [`Payment`](internal.Payment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:71
|
||||
|
||||
___
|
||||
|
||||
### refundable\_amount
|
||||
|
||||
• **refundable\_amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:96
|
||||
|
||||
___
|
||||
|
||||
### refunded\_total
|
||||
|
||||
• **refunded\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
### refunds
|
||||
|
||||
• **refunds**: [`Refund`](internal.Refund.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:75
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• **region**: [`Region`](internal.Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:64
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:63
|
||||
|
||||
___
|
||||
|
||||
### returns
|
||||
|
||||
• **returns**: [`Return`](internal.Return.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:73
|
||||
|
||||
___
|
||||
|
||||
### sales\_channel
|
||||
|
||||
• **sales\_channel**: [`SalesChannel`](internal.SalesChannel.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:88
|
||||
|
||||
___
|
||||
|
||||
### sales\_channel\_id
|
||||
|
||||
• **sales\_channel\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address
|
||||
|
||||
• **shipping\_address**: [`Address`](internal.Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:62
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address\_id
|
||||
|
||||
• **shipping\_address\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:61
|
||||
|
||||
___
|
||||
|
||||
### shipping\_methods
|
||||
|
||||
• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:70
|
||||
|
||||
___
|
||||
|
||||
### shipping\_total
|
||||
|
||||
• **shipping\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: [`OrderStatus`](../enums/internal.OrderStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:50
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• **subtotal**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
### swaps
|
||||
|
||||
• **swaps**: [`Swap`](internal.Swap.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:76
|
||||
|
||||
___
|
||||
|
||||
### tax\_rate
|
||||
|
||||
• **tax\_rate**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:67
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• **tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• **total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/order.d.ts:93
|
||||
|
||||
___
|
||||
|
||||
### 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
Block a user