docs: added reference for JS Client (#1629)
* added reference for JS Client * added reference for JS Client * added reference for JS Client
This commit is contained in:
@@ -0,0 +1,263 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminGetOrdersParams
|
||||
|
||||
[internal](../modules/internal.md).AdminGetOrdersParams
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`AdminListOrdersSelector`](internal.AdminListOrdersSelector.md)
|
||||
|
||||
↳ **`AdminGetOrdersParams`**
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[canceled_at](internal.AdminListOrdersSelector.md#canceled_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• `Optional` **cart\_id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[cart_id](internal.AdminListOrdersSelector.md#cart_id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[created_at](internal.AdminListOrdersSelector.md#created_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• `Optional` **currency\_code**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[currency_code](internal.AdminListOrdersSelector.md#currency_code)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• `Optional` **customer\_id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[customer_id](internal.AdminListOrdersSelector.md#customer_id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### display\_id
|
||||
|
||||
• `Optional` **display\_id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[display_id](internal.AdminListOrdersSelector.md#display_id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### email
|
||||
|
||||
• `Optional` **email**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[email](internal.AdminListOrdersSelector.md#email)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### expand
|
||||
|
||||
• `Optional` **expand**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:47
|
||||
|
||||
___
|
||||
|
||||
### fields
|
||||
|
||||
• `Optional` **fields**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:48
|
||||
|
||||
___
|
||||
|
||||
### fulfillment\_status
|
||||
|
||||
• `Optional` **fulfillment\_status**: `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[fulfillment_status](internal.AdminListOrdersSelector.md#fulfillment_status)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[id](internal.AdminListOrdersSelector.md#id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### limit
|
||||
|
||||
• **limit**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:46
|
||||
|
||||
___
|
||||
|
||||
### offset
|
||||
|
||||
• **offset**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:45
|
||||
|
||||
___
|
||||
|
||||
### payment\_status
|
||||
|
||||
• `Optional` **payment\_status**: `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[payment_status](internal.AdminListOrdersSelector.md#payment_status)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### q
|
||||
|
||||
• `Optional` **q**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[q](internal.AdminListOrdersSelector.md#q)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• `Optional` **region\_id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[region_id](internal.AdminListOrdersSelector.md#region_id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• `Optional` **status**: `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[status](internal.AdminListOrdersSelector.md#status)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
### tax\_rate
|
||||
|
||||
• `Optional` **tax\_rate**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[tax_rate](internal.AdminListOrdersSelector.md#tax_rate)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[updated_at](internal.AdminListOrdersSelector.md#updated_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:19
|
||||
Reference in New Issue
Block a user