chore(docs): Generated References (#5881)
Generated the following references: - `EventBusTypes` - `IPricingModuleService` - `ModulesSdkTypes` - `PriceListWorkflow` - `fulfillment` - `js_client` - `medusa` - `modules` - `pricing` - `services` - `types` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
co-authored by
Shahed Nasser
parent
fde1e23995
commit
2d127a4c67
+8
-8
@@ -13,11 +13,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
This documentation provides a reference to the `addPrices` method. This belongs to the Pricing Module.
|
||||
|
||||
`**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>`
|
||||
## addPrices(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>
|
||||
|
||||
This method adds prices to a price set.
|
||||
|
||||
## Example
|
||||
### Example
|
||||
|
||||
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
|
||||
|
||||
@@ -88,7 +88,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -240,7 +240,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -383,11 +383,11 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
]} />
|
||||
|
||||
`**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>`
|
||||
## addPrices(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>
|
||||
|
||||
This method adds prices to multiple price sets.
|
||||
|
||||
## Example
|
||||
### Example
|
||||
|
||||
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
|
||||
|
||||
@@ -458,7 +458,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -610,7 +610,7 @@ async function addPricesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
+8
-8
@@ -13,11 +13,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
This documentation provides a reference to the `addRules` method. This belongs to the Pricing Module.
|
||||
|
||||
`**addRules**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>`
|
||||
## addRules(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>
|
||||
|
||||
This method adds rules to a price set.
|
||||
|
||||
## Example
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
@@ -38,7 +38,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -136,7 +136,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -279,11 +279,11 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
]} />
|
||||
|
||||
`**addRules**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>`
|
||||
## addRules(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>
|
||||
|
||||
This method adds rules to multiple price sets.
|
||||
|
||||
## Example
|
||||
### Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
@@ -304,7 +304,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -402,7 +402,7 @@ async function addRulesToPriceSet (priceSetId: string) {
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
+8
-8
@@ -13,11 +13,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
This documentation provides a reference to the `create` method. This belongs to the Pricing Module.
|
||||
|
||||
`**create**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>`
|
||||
## create(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>
|
||||
|
||||
This method is used to create a new price set.
|
||||
|
||||
## Example
|
||||
### Example
|
||||
|
||||
To create a default price set, don't pass any rules. For example:
|
||||
|
||||
@@ -99,7 +99,7 @@ async function createPriceSet () {
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -261,7 +261,7 @@ async function createPriceSet () {
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -404,11 +404,11 @@ async function createPriceSet () {
|
||||
}
|
||||
]} />
|
||||
|
||||
`**create**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>`
|
||||
## create(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>
|
||||
|
||||
This method is used to create multiple price sets.
|
||||
|
||||
## Example
|
||||
### Example
|
||||
|
||||
To create price sets with a default price, don't pass any rules and make sure to pass the `currency_code` of the price. For example:
|
||||
|
||||
@@ -483,7 +483,7 @@ async function createPriceSets () {
|
||||
}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -645,7 +645,7 @@ async function createPriceSets () {
|
||||
}
|
||||
]} />
|
||||
|
||||
## Returns
|
||||
### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Details of the discount condition to create.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminCreateUserRequest
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteCustomerGroupsGroupCustomerBatchReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-6
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The resources to remove.
|
||||
|
||||
## constructor
|
||||
|
||||
The resources to remove.
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeletePriceListPricesPricesReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeletePriceListsPriceListProductsPricesBatchReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteProductCategoriesCategoryProductsBatchReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteProductsFromCollectionReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeletePublishableApiKeySalesChannelsBatchReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteSalesChannelsChannelProductsBatchReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteSalesChannelsChannelStockLocationsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-6
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Product types to remove from the tax rates.
|
||||
|
||||
## constructor
|
||||
|
||||
Product types to remove from the tax rates.
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteTaxRatesTaxRateProductsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteTaxRatesTaxRateShippingOptionsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminDeleteUploadsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Request parameters used to configure and paginate retrieved batch jobs.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure pagination of the retrieved batch jobs.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to configure the pagination of the retrieved product collections.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved product collections.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved currencies.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved customer groups.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved customers.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on discounts' rules.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved discounts.
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved draft orders.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved gift cards.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-18
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved inventory items.
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved notes.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved notifications.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved orders.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved price lists.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-18
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved products associated with a price list.
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-18
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved product categories.
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how a list of data is paginated.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved product tags.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved product types.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved products.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminGetProductsVariantsParams
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how a list of data is paginated.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved regions.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-6
@@ -8,12 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The list of fulfillment options in a region.
|
||||
|
||||
## constructor
|
||||
|
||||
The list of fulfillment options in a region.
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved reservations.
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how a list of data is paginated.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-18
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved sales channels.
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter the retrieved shipping options.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-18
@@ -8,24 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved stock locations.
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how a list of data is paginated.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved tax rates.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters used to filter and configure the pagination of the retrieved product variants.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters used to filter retrieved customers.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on the retrieved orders.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostAnalyticsConfigAnalyticsConfigReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostAnalyticsConfigReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostAuthReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostBatchesReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCollectionsCollectionReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCollectionsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCurrenciesCurrencyReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCustomerGroupsGroupCustomersBatchReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCustomerGroupsGroupReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCustomerGroupsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCustomersCustomerReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostCustomersReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Fields to create or update a discount condition.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Fields to create or update a discount condition.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostDiscountsDiscountConditionsConditionBatchReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostDiscountsDiscountDynamicCodesReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostDiscountsDiscountReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Details of the discount rule to create.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -8,10 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Parameters that can be used to configure how data is retrieved.
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostDiscountsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostDraftOrdersDraftOrderLineItemsItemReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostDraftOrdersDraftOrderLineItemsReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
-4
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminPostDraftOrdersDraftOrderReq
|
||||
|
||||
## constructor
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user