asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/classes/AddressesResource.mdx
+12 -12
View File
@@ -14,11 +14,11 @@ All methods in this class require [customer authentication](AuthResource.mdx#aut
## Methods
#### addAddress
### addAddress
Add an address to the logged-in customer's saved addresses.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -43,7 +43,7 @@ medusa.customers.addresses
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -176,7 +176,7 @@ medusa.customers.addresses
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -348,11 +348,11 @@ medusa.customers.addresses
___
#### deleteAddress
### deleteAddress
Delete an address of the logged-in customer.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -363,7 +363,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -386,7 +386,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -558,11 +558,11 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => {
___
#### updateAddress
### updateAddress
Update an address of the logged-in customer.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -577,7 +577,7 @@ medusa.customers.addresses
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -709,7 +709,7 @@ medusa.customers.addresses
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminAuthResource.mdx
+16 -16
View File
@@ -19,11 +19,11 @@ Related Guide: [How to implement user profiles](https://docs.medusajs.com/module
## Methods
#### createSession
### createSession
Log a User in using their credentials. If the user is authenticated successfully, the cookie is automatically attached to subsequent requests sent with the JS Client.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -36,7 +36,7 @@ medusa.admin.AdminAuthResource.createSession({
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -78,7 +78,7 @@ medusa.admin.AdminAuthResource.createSession({
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -205,12 +205,12 @@ medusa.admin.AdminAuthResource.createSession({
___
#### deleteSession
### deleteSession
Log out the user and remove their authentication session. This will only work if you're using Cookie session for authentication. If the API token is still passed in the header,
the user is still authorized to perform admin functionalities in other API Routes.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -219,7 +219,7 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.admin.auth.deleteSession()
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -233,7 +233,7 @@ medusa.admin.auth.deleteSession()
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -249,11 +249,11 @@ medusa.admin.auth.deleteSession()
___
#### getSession
### getSession
Get the currently logged in user's details. Can also be used to check if there is an authenticated user.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -264,7 +264,7 @@ medusa.admin.auth.getSession().then(({ user }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -278,7 +278,7 @@ medusa.admin.auth.getSession().then(({ user }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -405,11 +405,11 @@ medusa.admin.auth.getSession().then(({ user }) => {
___
#### getToken
### getToken
Authenticate the user and retrieve a JWT token to use for subsequent authenticated requests.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -424,7 +424,7 @@ medusa.admin.auth
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -466,7 +466,7 @@ medusa.admin.auth
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.mdx
+20 -20
View File
@@ -19,11 +19,11 @@ Related Guide: [How to import products](https://docs.medusajs.com/modules/produc
## Methods
#### cancel
### cancel
Mark a batch job as canceled. When a batch job is canceled, the processing of the batch job doesn’t automatically stop.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -34,7 +34,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -57,7 +57,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -247,11 +247,11 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => {
___
#### confirm
### confirm
When a batch job is created, it's not executed automatically if `dry_run` is set to `true`. This method confirms that the batch job should be executed.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -262,7 +262,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -285,7 +285,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -475,12 +475,12 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => {
___
#### create
### create
Create a Batch Job to be executed asynchronously in the Medusa backend. If `dry_run` is set to `true`, the batch job will not be executed until the it is confirmed,
which can be done using the [confirm](AdminBatchJobsResource.mdx#confirm) method.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -495,7 +495,7 @@ medusa.admin.batchJobs.create({
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -546,7 +546,7 @@ medusa.admin.batchJobs.create({
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -736,11 +736,11 @@ medusa.admin.batchJobs.create({
___
#### list
### list
Retrieve a list of Batch Jobs. The batch jobs can be filtered by fields such as `type` or `confirmed_at`. The batch jobs can also be sorted or paginated.
##### Example
#### Example
To list batch jobs:
@@ -785,7 +785,7 @@ medusa.admin.batchJobs
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1009,7 +1009,7 @@ medusa.admin.batchJobs
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1226,11 +1226,11 @@ medusa.admin.batchJobs
___
#### retrieve
### retrieve
Retrieve the details of a batch job.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1241,7 +1241,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1264,7 +1264,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.mdx
+28 -28
View File
@@ -16,11 +16,11 @@ A product collection is used to organize products for different purposes such as
## Methods
#### addProducts
### addProducts
Add products to collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -35,7 +35,7 @@ medusa.admin.collections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -77,7 +77,7 @@ medusa.admin.collections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -186,11 +186,11 @@ medusa.admin.collections
___
#### create
### create
Create a product collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -205,7 +205,7 @@ medusa.admin.collections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -256,7 +256,7 @@ medusa.admin.collections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -365,11 +365,11 @@ medusa.admin.collections
___
#### delete
### delete
Delete a product collection. This does not delete associated products.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -382,7 +382,7 @@ medusa.admin.collections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -405,7 +405,7 @@ medusa.admin.collections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -449,11 +449,11 @@ medusa.admin.collections
___
#### list
### list
Retrieve a list of product collections. The product collections can be filtered by fields such as `handle` or `title`. The collections can also be sorted or paginated.
##### Example
#### Example
To list product collections:
@@ -484,7 +484,7 @@ medusa.admin.collections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -700,7 +700,7 @@ medusa.admin.collections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -836,11 +836,11 @@ medusa.admin.collections
___
#### removeProducts
### removeProducts
Remove a list of products from a collection. This would not delete the product, only the association between the product and the collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -855,7 +855,7 @@ medusa.admin.collections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -897,7 +897,7 @@ medusa.admin.collections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -951,11 +951,11 @@ medusa.admin.collections
___
#### retrieve
### retrieve
Retrieve a product collection by its ID. The products associated with it are expanded and returned as well.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -966,7 +966,7 @@ medusa.admin.collections.retrieve(collectionId).then(({ collection }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -989,7 +989,7 @@ medusa.admin.collections.retrieve(collectionId).then(({ collection }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1098,11 +1098,11 @@ medusa.admin.collections.retrieve(collectionId).then(({ collection }) => {
___
#### update
### update
Update a product collection's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1117,7 +1117,7 @@ medusa.admin.collections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1177,7 +1177,7 @@ medusa.admin.collections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.mdx
+8 -8
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage currencies](https://docs.medusajs.com/modules/regi
## Methods
#### list
### list
Retrieve a list of currencies. The currencies can be filtered by fields such as `code`. The currencies can also be sorted or paginated.
##### Example
#### Example
To list currencies:
@@ -52,7 +52,7 @@ medusa.admin.currencies
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -122,7 +122,7 @@ medusa.admin.currencies
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -232,11 +232,11 @@ medusa.admin.currencies
___
#### update
### update
Update a Currency's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -251,7 +251,7 @@ medusa.admin.currencies
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -294,7 +294,7 @@ medusa.admin.currencies
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminCustomResource.mdx
+12 -12
View File
@@ -12,11 +12,11 @@ are available in the JS Client under the `medusa.admin.custom` property.
## Methods
#### delete
### delete
Send a `DELETE` request to a custom API Route. The method accepts a type parameters `TResponse` indicating the type of response, which defaults to `any`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -27,7 +27,7 @@ medusa.admin.custom.delete(`/blog/posts/${postId}`).then(() => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -78,7 +78,7 @@ medusa.admin.custom.delete(`/blog/posts/${postId}`).then(() => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -104,12 +104,12 @@ medusa.admin.custom.delete(`/blog/posts/${postId}`).then(() => {
___
#### get
### get
Send a `GET` request to a custom API Route. The method accepts a tuple of type parameters: the first `TQuery` is the type of accepted query parameters,
which defaults to `Record<string, any>`; the second `TResponse` is the type of response, which defaults to `any`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -126,7 +126,7 @@ medusa.admin.custom.get<Record<string, any>, PostsResponse>(
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -186,7 +186,7 @@ medusa.admin.custom.get<Record<string, any>, PostsResponse>(
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -212,12 +212,12 @@ medusa.admin.custom.get<Record<string, any>, PostsResponse>(
___
#### post
### post
Send a `POST` request to a custom API Route. The method accepts a tuple of type parameters: the first `TPayload` is the type of accepted body parameters,
which defaults to `Record<string, any>`; the second `TResponse` is the type of response, which defaults to `any`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -240,7 +240,7 @@ medusa.admin.custom.post<PostRequest, PostResponse>(
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -300,7 +300,7 @@ medusa.admin.custom.post<PostRequest, PostResponse>(
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx
+30 -30
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage customer groups](https://docs.medusajs.com/modules
## Methods
#### addCustomers
### addCustomers
Add a list of customers to a customer group.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -75,7 +75,7 @@ Add a list of customers to a customer group.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -184,11 +184,11 @@ Add a list of customers to a customer group.
___
#### create
### create
Create a customer group.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -203,7 +203,7 @@ medusa.admin.customerGroups
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -245,7 +245,7 @@ medusa.admin.customerGroups
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -354,11 +354,11 @@ medusa.admin.customerGroups
___
#### delete
### delete
Delete a customer group. This doesn't delete the customers associated with the customer group.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -371,7 +371,7 @@ medusa.admin.customerGroups
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -394,7 +394,7 @@ medusa.admin.customerGroups
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -438,11 +438,11 @@ medusa.admin.customerGroups
___
#### list
### list
Retrieve a list of customer groups. The customer groups can be filtered by fields such as `name` or `id`. The customer groups can also be sorted or paginated.
##### Example
#### Example
To list customer groups:
@@ -489,7 +489,7 @@ medusa.admin.customerGroups
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -677,7 +677,7 @@ medusa.admin.customerGroups
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -813,11 +813,11 @@ medusa.admin.customerGroups
___
#### listCustomers
### listCustomers
Retrieve a list of customers in a customer group. The customers can be filtered by the `q` field. The customers can also be paginated.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -830,7 +830,7 @@ medusa.admin.customerGroups
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -917,7 +917,7 @@ medusa.admin.customerGroups
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1116,11 +1116,11 @@ medusa.admin.customerGroups
___
#### removeCustomers
### removeCustomers
Remove a list of customers from a customer group. This doesn't delete the customer, only the association between the customer and the customer group.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1139,7 +1139,7 @@ medusa.admin.customerGroups
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1191,7 +1191,7 @@ medusa.admin.customerGroups
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1300,11 +1300,11 @@ medusa.admin.customerGroups
___
#### retrieve
### retrieve
Retrieve a customer group by its ID. You can expand the customer group's relations or select the fields that should be returned.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1317,7 +1317,7 @@ medusa.admin.customerGroups
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1368,7 +1368,7 @@ medusa.admin.customerGroups
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1477,11 +1477,11 @@ medusa.admin.customerGroups
___
#### update
### update
Update a customer group's details.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1532,7 +1532,7 @@ Update a customer group's details.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminCustomersResource.mdx
+16 -16
View File
@@ -18,11 +18,11 @@ Related Guide: [How to manage customers](https://docs.medusajs.com/modules/custo
## Methods
#### create
### create
Create a customer as an admin.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -40,7 +40,7 @@ medusa.admin.customers
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -118,7 +118,7 @@ medusa.admin.customers
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -290,11 +290,11 @@ medusa.admin.customers
___
#### list
### list
Retrieve a list of Customers. The customers can be filtered by fields such as `q` or `groups`. The customers can also be paginated.
##### Example
#### Example
To list customers:
@@ -339,7 +339,7 @@ medusa.admin.customers
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -417,7 +417,7 @@ medusa.admin.customers
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -616,11 +616,11 @@ medusa.admin.customers
___
#### retrieve
### retrieve
Retrieve the details of a customer.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -631,7 +631,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -654,7 +654,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -826,11 +826,11 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
___
#### update
### update
Update a customer's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -845,7 +845,7 @@ medusa.admin.customers
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -951,7 +951,7 @@ medusa.admin.customers
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.mdx
+64 -64
View File
@@ -19,12 +19,12 @@ Related Guide: [How to manage discounts](https://docs.medusajs.com/modules/disco
## Methods
#### addConditionResourceBatch
### addConditionResourceBatch
Add a batch of resources to a discount condition. The type of resource depends on the type of discount condition. For example, if the discount condition's type is `products`,
the resources being added should be products.
##### Example
#### Example
To add resources to a discount condition:
@@ -63,7 +63,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -152,7 +152,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -351,11 +351,11 @@ medusa.admin.discounts
___
#### addRegion
### addRegion
Add a Region to the list of Regions a Discount can be used in.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -366,7 +366,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -398,7 +398,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -597,11 +597,11 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => {
___
#### create
### create
Create a discount with a given set of rules that defines how the discount is applied.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -625,7 +625,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -887,7 +887,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1086,12 +1086,12 @@ medusa.admin.discounts
___
#### createCondition
### createCondition
Create a discount condition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided in the `payload` parameter,
based on the type of discount condition. For example, if the discount condition's type is `products`, the `products` field should be provided in the `payload` parameter.
##### Example
#### Example
To create a condition in a discount:
@@ -1133,7 +1133,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1267,7 +1267,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1466,11 +1466,11 @@ medusa.admin.discounts
___
#### createDynamicCode
### createDynamicCode
Create a dynamic unique code that can map to a parent discount. This is useful if you want to automatically generate codes with the same rules and conditions.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1486,7 +1486,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1546,7 +1546,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1745,11 +1745,11 @@ medusa.admin.discounts
___
#### delete
### delete
Delete a discount. Deleting the discount will make it unavailable for customers to use.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1760,7 +1760,7 @@ medusa.admin.discounts.delete(discountId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1783,7 +1783,7 @@ medusa.admin.discounts.delete(discountId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1827,11 +1827,11 @@ medusa.admin.discounts.delete(discountId).then(({ id, object, deleted }) => {
___
#### deleteCondition
### deleteCondition
Delete a discount condition. This doesn't delete resources associated to the discount condition.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1844,7 +1844,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1876,7 +1876,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1920,11 +1920,11 @@ medusa.admin.discounts
___
#### deleteConditionResourceBatch
### deleteConditionResourceBatch
Remove a batch of resources from a discount condition. This will only remove the association between the resource and the discount condition, not the resource itself.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1939,7 +1939,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2000,7 +2000,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2199,11 +2199,11 @@ medusa.admin.discounts
___
#### deleteDynamicCode
### deleteDynamicCode
Delete a dynamic code from a discount.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2216,7 +2216,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2248,7 +2248,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2447,11 +2447,11 @@ medusa.admin.discounts
___
#### getCondition
### getCondition
Retrieve a Discount Condition's details.
##### Example
#### Example
A simple example that retrieves a discount condition by its ID:
@@ -2481,7 +2481,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2541,7 +2541,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2704,11 +2704,11 @@ medusa.admin.discounts
___
#### list
### list
Retrieve a list of Discounts. The discounts can be filtered by fields such as `rule` or `is_dynamic`. The discounts can also be paginated.
##### Example
#### Example
To list discounts:
@@ -2753,7 +2753,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2915,7 +2915,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3141,11 +3141,11 @@ medusa.admin.discounts
___
#### removeRegion
### removeRegion
Remove a Region from the list of Regions that a Discount can be used in. This does not delete a region, only the association between it and the discount.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3158,7 +3158,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3190,7 +3190,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3389,11 +3389,11 @@ medusa.admin.discounts
___
#### retrieve
### retrieve
Retrieve a discount.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3404,7 +3404,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3427,7 +3427,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3626,11 +3626,11 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => {
___
#### retrieveByCode
### retrieveByCode
Retrieve a discount's details by its discount code.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3641,7 +3641,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3664,7 +3664,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3863,11 +3863,11 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => {
___
#### update
### update
Update a discount with a given set of rules that define how the discount is applied.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3882,7 +3882,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -4125,7 +4125,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -4324,12 +4324,12 @@ medusa.admin.discounts
___
#### updateCondition
### updateCondition
Update a discount condition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided in the `payload` parameter,
based on the type of discount condition. For example, if the discount condition's type is `products`, the `products` field should be provided in the `payload` parameter.
##### Example
#### Example
To update a condition in a discount:
@@ -4368,7 +4368,7 @@ medusa.admin.discounts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -4483,7 +4483,7 @@ medusa.admin.discounts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.mdx
+36 -36
View File
@@ -18,11 +18,11 @@ Related Guide: [How to manage draft orders](https://docs.medusajs.com/modules/or
## Methods
#### addLineItem
### addLineItem
Create a Line Item in the Draft Order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -37,7 +37,7 @@ medusa.admin.draftOrders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -115,7 +115,7 @@ medusa.admin.draftOrders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -278,11 +278,11 @@ medusa.admin.draftOrders
___
#### create
### create
Create a Draft Order. A draft order is not transformed into an order until payment is captured.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -308,7 +308,7 @@ medusa.admin.draftOrders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -515,7 +515,7 @@ medusa.admin.draftOrders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -678,11 +678,11 @@ medusa.admin.draftOrders
___
#### delete
### delete
Delete a Draft Order
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -695,7 +695,7 @@ medusa.admin.draftOrders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -718,7 +718,7 @@ medusa.admin.draftOrders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -762,11 +762,11 @@ medusa.admin.draftOrders
___
#### list
### list
Retrieve an list of Draft Orders. The draft orders can be filtered by parameters such as `query`. The draft orders can also paginated.
##### Example
#### Example
To list draft orders:
@@ -797,7 +797,7 @@ medusa.admin.draftOrders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -848,7 +848,7 @@ medusa.admin.draftOrders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1038,12 +1038,12 @@ medusa.admin.draftOrders
___
#### markPaid
### markPaid
Capture the draft order's payment. This will also set the draft order's status to `completed` and create an order from the draft order. The payment is captured through Medusa's system payment,
which is manual payment that isn't integrated with any third-party payment provider. It is assumed that the payment capturing is handled manually by the admin.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1054,7 +1054,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1077,7 +1077,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1618,11 +1618,11 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
___
#### removeLineItem
### removeLineItem
Delete a Line Item from a Draft Order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1635,7 +1635,7 @@ medusa.admin.draftOrders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1667,7 +1667,7 @@ medusa.admin.draftOrders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1830,11 +1830,11 @@ medusa.admin.draftOrders
___
#### retrieve
### retrieve
Retrieve a Draft Order's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1845,7 +1845,7 @@ medusa.admin.draftOrders.retrieve(draftOrderId).then(({ draft_order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1868,7 +1868,7 @@ medusa.admin.draftOrders.retrieve(draftOrderId).then(({ draft_order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2031,11 +2031,11 @@ medusa.admin.draftOrders.retrieve(draftOrderId).then(({ draft_order }) => {
___
#### update
### update
Update a Draft Order's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2050,7 +2050,7 @@ medusa.admin.draftOrders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2165,7 +2165,7 @@ medusa.admin.draftOrders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2328,11 +2328,11 @@ medusa.admin.draftOrders
___
#### updateLineItem
### updateLineItem
Update a Line Item in a Draft Order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2347,7 +2347,7 @@ medusa.admin.draftOrders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2425,7 +2425,7 @@ medusa.admin.draftOrders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.mdx
+20 -20
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage gift cards](https://docs.medusajs.com/modules/gift
## Methods
#### create
### create
Create a gift card that can redeemed by its unique code. The Gift Card is only valid within `1` region.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -38,7 +38,7 @@ medusa.admin.giftCards
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -107,7 +107,7 @@ medusa.admin.giftCards
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -279,11 +279,11 @@ medusa.admin.giftCards
___
#### delete
### delete
Delete a gift card. Once deleted, it can't be used by customers.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -294,7 +294,7 @@ medusa.admin.giftCards.delete(giftCardId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -317,7 +317,7 @@ medusa.admin.giftCards.delete(giftCardId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -361,11 +361,11 @@ medusa.admin.giftCards.delete(giftCardId).then(({ id, object, deleted }) => {
___
#### list
### list
Retrieve a list of gift cards. The gift cards can be filtered by fields such as `q` passed in the `query` parameter. The gift cards can also paginated.
##### Example
#### Example
To list gift cards:
@@ -394,7 +394,7 @@ medusa.admin.giftCards
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -445,7 +445,7 @@ medusa.admin.giftCards
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -644,11 +644,11 @@ medusa.admin.giftCards
___
#### retrieve
### retrieve
Retrieve a gift card's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -659,7 +659,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -682,7 +682,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -854,11 +854,11 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
___
#### update
### update
Update a gift card's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -873,7 +873,7 @@ medusa.admin.giftCards
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -951,7 +951,7 @@ medusa.admin.giftCards
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.mdx
+36 -36
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage inventory items](https://docs.medusajs.com/modules
## Methods
#### create
### create
Create an Inventory Item for a product variant.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -38,7 +38,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -216,7 +216,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -415,11 +415,11 @@ medusa.admin.inventoryItems
___
#### createLocationLevel
### createLocationLevel
Create a Location Level for a given Inventory Item.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -435,7 +435,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -523,7 +523,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -722,11 +722,11 @@ medusa.admin.inventoryItems
___
#### delete
### delete
Delete an Inventory Item. This does not delete the associated product variant.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -739,7 +739,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -762,7 +762,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -806,11 +806,11 @@ medusa.admin.inventoryItems
___
#### deleteLocationLevel
### deleteLocationLevel
Delete a location level of an Inventory Item.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -823,7 +823,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1018,7 +1018,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1217,12 +1217,12 @@ medusa.admin.inventoryItems
___
#### list
### list
Retrieve a list of inventory items. The inventory items can be filtered by fields such as `q` or `location_id` passed in the `query` parameter.
The inventory items can also be paginated.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1235,7 +1235,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1412,7 +1412,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1674,11 +1674,11 @@ medusa.admin.inventoryItems
___
#### listLocationLevels
### listLocationLevels
Retrieve a list of inventory levels of an inventory item. The inventory levels can be filtered by fields such as `location_id` passed in the `query` parameter.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1691,7 +1691,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1751,7 +1751,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1806,11 +1806,11 @@ medusa.admin.inventoryItems
___
#### retrieve
### retrieve
Retrieve an Inventory Item's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1823,7 +1823,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1874,7 +1874,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2073,11 +2073,11 @@ medusa.admin.inventoryItems
___
#### update
### update
Update an Inventory Item's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2092,7 +2092,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2270,7 +2270,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2469,11 +2469,11 @@ medusa.admin.inventoryItems
___
#### updateLocationLevel
### updateLocationLevel
Update a location level's details for a given inventory item.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2488,7 +2488,7 @@ medusa.admin.inventoryItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2576,7 +2576,7 @@ medusa.admin.inventoryItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminInvitesResource.mdx
+20 -20
View File
@@ -18,12 +18,12 @@ Related Guide: [How to manage invites](https://docs.medusajs.com/modules/users/a
## Methods
#### accept
### accept
Accept an Invite. This will also delete the invite and create a new user that can log in and perform admin functionalities.
The user will have the email associated with the invite, and the password provided in the `payload` parameter.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -46,7 +46,7 @@ medusa.admin.invites
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -116,7 +116,7 @@ medusa.admin.invites
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -132,12 +132,12 @@ medusa.admin.invites
___
#### create
### create
Create an invite. This will generate a token associated with the invite and trigger an `invite.created` event. If you have a Notification Provider installed that handles this
event, a notification should be sent to the email associated with the invite to allow them to accept the invite.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -156,7 +156,7 @@ medusa.admin.invites
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -198,7 +198,7 @@ medusa.admin.invites
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -214,11 +214,11 @@ medusa.admin.invites
___
#### delete
### delete
Delete an invite. Only invites that weren't accepted can be deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -229,7 +229,7 @@ medusa.admin.invites.delete(inviteId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -252,7 +252,7 @@ medusa.admin.invites.delete(inviteId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -296,11 +296,11 @@ medusa.admin.invites.delete(inviteId).then(({ id, object, deleted }) => {
___
#### list
### list
Retrieve a list of invites.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -311,7 +311,7 @@ medusa.admin.invites.list().then(({ invites }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -325,7 +325,7 @@ medusa.admin.invites.list().then(({ invites }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -452,13 +452,13 @@ medusa.admin.invites.list().then(({ invites }) => {
___
#### resend
### resend
Resend an invite. This renews the expiry date by seven days and generates a new token for the invite. It also triggers the `invite.created` event,
so if you have a Notification Provider installed that handles this event, a notification should be sent to the email associated with the
invite to allow them to accept the invite.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -474,7 +474,7 @@ medusa.admin.invites
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -497,7 +497,7 @@ medusa.admin.invites
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx
+20 -20
View File
@@ -16,11 +16,11 @@ Notes are created by admins and can be associated with any resource. For example
## Methods
#### create
### create
Create a Note which can be associated with any resource.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -37,7 +37,7 @@ medusa.admin.notes
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -88,7 +88,7 @@ medusa.admin.notes
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -215,11 +215,11 @@ medusa.admin.notes
___
#### delete
### delete
Delete a Note.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -230,7 +230,7 @@ medusa.admin.notes.delete(noteId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -253,7 +253,7 @@ medusa.admin.notes.delete(noteId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -297,11 +297,11 @@ medusa.admin.notes.delete(noteId).then(({ id, object, deleted }) => {
___
#### list
### list
Retrieve a list of notes. The notes can be filtered by fields such as `resource_id` passed in the `query` parameter. The notes can also be paginated.
##### Example
#### Example
To list notes:
@@ -330,7 +330,7 @@ medusa.admin.notes
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -381,7 +381,7 @@ medusa.admin.notes
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -535,11 +535,11 @@ medusa.admin.notes
___
#### retrieve
### retrieve
Retrieve a note's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -550,7 +550,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -573,7 +573,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -700,11 +700,11 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
___
#### update
### update
Update a Note's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -719,7 +719,7 @@ medusa.admin.notes
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -761,7 +761,7 @@ medusa.admin.notes
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.mdx
+8 -8
View File
@@ -17,12 +17,12 @@ The notification's type, such as an email or SMS, is determined by the notificat
## Methods
#### list
### list
Retrieve a list of notifications. The notifications can be filtered by fields such as `event_name` or `resource_type` passed in the `query` parameter.
The notifications can also be paginated.
##### Example
#### Example
To list notifications:
@@ -67,7 +67,7 @@ medusa.admin.notifications
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -172,7 +172,7 @@ medusa.admin.notifications
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -371,11 +371,11 @@ medusa.admin.notifications
___
#### resend
### resend
Resend a previously sent notifications, with the same data but optionally to a different address.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -386,7 +386,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -428,7 +428,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.mdx
+48 -48
View File
@@ -18,12 +18,12 @@ Related Guide: [How to edit an order](https://docs.medusajs.com/modules/orders/a
## Methods
#### addLineItem
### addLineItem
Create a line item change in the order edit that indicates adding an item in the original order. The item will not be added to the original order until the order edit is
confirmed.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -39,7 +39,7 @@ medusa.admin.orderEdits
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -99,7 +99,7 @@ medusa.admin.orderEdits
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -397,11 +397,11 @@ medusa.admin.orderEdits
___
#### cancel
### cancel
Cancel an order edit.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -412,7 +412,7 @@ medusa.admin.orderEdits.cancel(orderEditId).then(({ order_edit }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -435,7 +435,7 @@ medusa.admin.orderEdits.cancel(orderEditId).then(({ order_edit }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -733,11 +733,11 @@ medusa.admin.orderEdits.cancel(orderEditId).then(({ order_edit }) => {
___
#### confirm
### confirm
Confirm an order edit. This will reflect the changes in the order edit on the associated order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -748,7 +748,7 @@ medusa.admin.orderEdits.confirm(orderEditId).then(({ order_edit }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -771,7 +771,7 @@ medusa.admin.orderEdits.confirm(orderEditId).then(({ order_edit }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1069,11 +1069,11 @@ medusa.admin.orderEdits.confirm(orderEditId).then(({ order_edit }) => {
___
#### create
### create
Create an order edit.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1084,7 +1084,7 @@ medusa.admin.orderEdits.create({ orderId }).then(({ order_edit }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1135,7 +1135,7 @@ medusa.admin.orderEdits.create({ orderId }).then(({ order_edit }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1433,11 +1433,11 @@ medusa.admin.orderEdits.create({ orderId }).then(({ order_edit }) => {
___
#### delete
### delete
Delete an order edit. Only order edits that have the status `created` can be deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1448,7 +1448,7 @@ medusa.admin.orderEdits.delete(orderEditId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1471,7 +1471,7 @@ medusa.admin.orderEdits.delete(orderEditId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1515,11 +1515,11 @@ medusa.admin.orderEdits.delete(orderEditId).then(({ id, object, deleted }) => {
___
#### deleteItemChange
### deleteItemChange
Delete a line item change that indicates the addition, deletion, or update of a line item in the original order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1532,7 +1532,7 @@ medusa.admin.orderEdits
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1564,7 +1564,7 @@ medusa.admin.orderEdits
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1618,11 +1618,11 @@ medusa.admin.orderEdits
___
#### list
### list
Retrieve a list of order edits. The order edits can be filtered by fields such as `q` or `order_id` passed to the `query` parameter. The order edits can also be paginated.
##### Example
#### Example
To list order edits:
@@ -1667,7 +1667,7 @@ medusa.admin.orderEdits
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1745,7 +1745,7 @@ medusa.admin.orderEdits
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2070,12 +2070,12 @@ medusa.admin.orderEdits
___
#### removeLineItem
### removeLineItem
Create a line item change in the order edit that indicates deleting an item in the original order. The item in the original order will not be deleted until the order edit is
confirmed.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2088,7 +2088,7 @@ medusa.admin.orderEdits
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2120,7 +2120,7 @@ medusa.admin.orderEdits
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2418,12 +2418,12 @@ medusa.admin.orderEdits
___
#### requestConfirmation
### requestConfirmation
Request customer confirmation of an order edit. This would emit the event `order-edit.requested` which Notification Providers listen to and send
a notification to the customer about the order edit.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2435,7 +2435,7 @@ medusa.admin.orderEdits.requestConfirmation(orderEditId)
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2458,7 +2458,7 @@ medusa.admin.orderEdits.requestConfirmation(orderEditId)
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2756,11 +2756,11 @@ medusa.admin.orderEdits.requestConfirmation(orderEditId)
___
#### retrieve
### retrieve
Retrieve an order edit's details.
##### Example
#### Example
A simple example that retrieves an order edit by its ID:
@@ -2788,7 +2788,7 @@ medusa.admin.orderEdits
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2839,7 +2839,7 @@ medusa.admin.orderEdits
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3137,11 +3137,11 @@ medusa.admin.orderEdits
___
#### update
### update
Update an Order Edit's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3156,7 +3156,7 @@ medusa.admin.orderEdits
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3198,7 +3198,7 @@ medusa.admin.orderEdits
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3496,12 +3496,12 @@ medusa.admin.orderEdits
___
#### updateLineItem
### updateLineItem
Create or update a line item change in the order edit that indicates addition, deletion, or update of a line item into an original order. Line item changes
are only reflected on the original order after the order edit is confirmed.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3516,7 +3516,7 @@ medusa.admin.orderEdits
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3567,7 +3567,7 @@ medusa.admin.orderEdits
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminOrdersResource.mdx
+100 -100
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage orders](https://docs.medusajs.com/modules/orders/a
## Methods
#### addShippingMethod
### addShippingMethod
Add a shipping method to an order. If another shipping method exists with the same shipping profile, the previous shipping method will be replaced.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -39,7 +39,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -99,7 +99,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -125,11 +125,11 @@ medusa.admin.orders
___
#### archive
### archive
Archive an order and change its status.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -140,7 +140,7 @@ medusa.admin.orders.archive(orderId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -163,7 +163,7 @@ medusa.admin.orders.archive(orderId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -189,12 +189,12 @@ medusa.admin.orders.archive(orderId).then(({ order }) => {
___
#### cancel
### cancel
Cancel an order and change its status. This will also cancel any associated fulfillments and payments, and it may fail if the payment or fulfillment Provider
is unable to cancel the payment/fulfillment.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -205,7 +205,7 @@ medusa.admin.orders.cancel(orderId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -228,7 +228,7 @@ medusa.admin.orders.cancel(orderId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -254,11 +254,11 @@ medusa.admin.orders.cancel(orderId).then(({ order }) => {
___
#### cancelClaim
### cancelClaim
Cancel a claim and change its status. A claim can't be canceled if it has a refund, if its fulfillments haven't been canceled, of if its associated return hasn't been canceled.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -269,7 +269,7 @@ medusa.admin.orders.cancelClaim(orderId, claimId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -301,7 +301,7 @@ medusa.admin.orders.cancelClaim(orderId, claimId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -327,11 +327,11 @@ medusa.admin.orders.cancelClaim(orderId, claimId).then(({ order }) => {
___
#### cancelClaimFulfillment
### cancelClaimFulfillment
Cancel a claim's fulfillment and change its fulfillment status to `canceled`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -344,7 +344,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -385,7 +385,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -411,11 +411,11 @@ medusa.admin.orders
___
#### cancelFulfillment
### cancelFulfillment
Cancel an order's fulfillment and change its fulfillment status to `canceled`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -428,7 +428,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -460,7 +460,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -486,11 +486,11 @@ medusa.admin.orders
___
#### cancelSwap
### cancelSwap
Cancel a swap and change its status.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -501,7 +501,7 @@ medusa.admin.orders.cancelSwap(orderId, swapId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -533,7 +533,7 @@ medusa.admin.orders.cancelSwap(orderId, swapId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -559,11 +559,11 @@ medusa.admin.orders.cancelSwap(orderId, swapId).then(({ order }) => {
___
#### cancelSwapFulfillment
### cancelSwapFulfillment
Cancel a swap's fulfillment and change its fulfillment status to `canceled`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -576,7 +576,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -617,7 +617,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -643,11 +643,11 @@ medusa.admin.orders
___
#### capturePayment
### capturePayment
Capture all the payments associated with an order. The payment of canceled orders can't be captured.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -658,7 +658,7 @@ medusa.admin.orders.capturePayment(orderId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -681,7 +681,7 @@ medusa.admin.orders.capturePayment(orderId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -707,11 +707,11 @@ medusa.admin.orders.capturePayment(orderId).then(({ order }) => {
___
#### complete
### complete
Complete an order and change its status. A canceled order can't be completed.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -722,7 +722,7 @@ medusa.admin.orders.complete(orderId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -745,7 +745,7 @@ medusa.admin.orders.complete(orderId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -771,12 +771,12 @@ medusa.admin.orders.complete(orderId).then(({ order }) => {
___
#### createClaim
### createClaim
Create a claim for an order. If a return shipping method is specified, a return will also be created and associated with the claim. If the claim's type is `refund`,
the refund is processed as well.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -797,7 +797,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -920,7 +920,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -946,12 +946,12 @@ medusa.admin.orders
___
#### createClaimShipment
### createClaimShipment
Create a shipment for the claim and mark its fulfillment as shipped. If the shipment is created successfully, this changes the claim's fulfillment status
to either `partially_shipped` or `shipped`, depending on whether all the items were shipped.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -966,7 +966,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1026,7 +1026,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1052,12 +1052,12 @@ medusa.admin.orders
___
#### createFulfillment
### createFulfillment
Create a Fulfillment of an Order using the fulfillment provider, and change the order's fulfillment status to either `partially_fulfilled` or `fulfilled`, depending on
whether all the items were fulfilled.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1077,7 +1077,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1146,7 +1146,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1172,12 +1172,12 @@ medusa.admin.orders
___
#### createShipment
### createShipment
Create a shipment and mark a fulfillment as shipped. This changes the order's fulfillment status to either `partially_shipped` or `shipped`, depending on
whether all the items were shipped.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1192,7 +1192,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1252,7 +1252,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1278,11 +1278,11 @@ medusa.admin.orders
___
#### createSwap
### createSwap
Create a swap for an order. This includes creating a return that is associated with the swap.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1302,7 +1302,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1407,7 +1407,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1433,12 +1433,12 @@ medusa.admin.orders
___
#### createSwapShipment
### createSwapShipment
Create a shipment for a swap and mark its fulfillment as shipped. This changes the swap's fulfillment status to either `shipped` or `partially_shipped`, depending on
whether all the items were shipped.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1453,7 +1453,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1522,7 +1522,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1548,12 +1548,12 @@ medusa.admin.orders
___
#### fulfillClaim
### fulfillClaim
Create a Fulfillment for a Claim, and change its fulfillment status to `partially_fulfilled` or `fulfilled` depending on whether all the items were fulfilled.
It may also change the status to `requires_action` if any actions are required.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1564,7 +1564,7 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {}).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1633,7 +1633,7 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {}).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1659,12 +1659,12 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {}).then(({ order }) => {
___
#### fulfillSwap
### fulfillSwap
Create a Fulfillment for a Swap and change its fulfillment status to `fulfilled`. If it requires any additional actions,
its fulfillment status may change to `requires_action`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1679,7 +1679,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1748,7 +1748,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1774,11 +1774,11 @@ medusa.admin.orders
___
#### list
### list
Retrieve a list of orders. The orders can be filtered by fields such as `status` or `display_id` passed in the `query` parameter. The order can also be paginated.
##### Example
#### Example
To list orders:
@@ -1823,7 +1823,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2027,7 +2027,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2053,12 +2053,12 @@ medusa.admin.orders
___
#### processSwapPayment
### processSwapPayment
Process a swap's payment either by refunding or issuing a payment. This depends on the `difference_due` of the swap. If `difference_due` is negative, the amount is refunded.
If `difference_due` is positive, the amount is captured.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2069,7 +2069,7 @@ medusa.admin.orders.processSwapPayment(orderId, swapId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2101,7 +2101,7 @@ medusa.admin.orders.processSwapPayment(orderId, swapId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2127,11 +2127,11 @@ medusa.admin.orders.processSwapPayment(orderId, swapId).then(({ order }) => {
___
#### refundPayment
### refundPayment
Refund an amount for an order. The amount must be less than or equal the `refundable_amount` of the order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2147,7 +2147,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2216,7 +2216,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2242,11 +2242,11 @@ medusa.admin.orders
___
#### requestReturn
### requestReturn
Request and create a return for items in an order. If the return shipping method is specified, it will be automatically fulfilled.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2266,7 +2266,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2362,7 +2362,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2388,11 +2388,11 @@ medusa.admin.orders
___
#### retrieve
### retrieve
Retrieve an order's details.
##### Example
#### Example
A simple example that retrieves an order by its ID:
@@ -2420,7 +2420,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2471,7 +2471,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2497,11 +2497,11 @@ medusa.admin.orders
___
#### update
### update
Update and order's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2516,7 +2516,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2639,7 +2639,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2665,11 +2665,11 @@ medusa.admin.orders
___
#### updateClaim
### updateClaim
Update a claim's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2684,7 +2684,7 @@ medusa.admin.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2762,7 +2762,7 @@ medusa.admin.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.mdx
+16 -16
View File
@@ -16,11 +16,11 @@ A payment collection is useful for managing additional payments, such as for Ord
## Methods
#### delete
### delete
Delete a payment collection. Only payment collections with the statuses `canceled` or `not_paid` can be deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -33,7 +33,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -110,11 +110,11 @@ medusa.admin.paymentCollections
___
#### markAsAuthorized
### markAsAuthorized
Set the status of a payment collection as `authorized`. This will also change the `authorized_amount` of the payment collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -127,7 +127,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -150,7 +150,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -340,11 +340,11 @@ medusa.admin.paymentCollections
___
#### retrieve
### retrieve
Retrieve a Payment Collection's details.
##### Example
#### Example
A simple example that retrieves a payment collection by its ID:
@@ -374,7 +374,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -425,7 +425,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -615,11 +615,11 @@ medusa.admin.paymentCollections
___
#### update
### update
Update a payment collection's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -634,7 +634,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -685,7 +685,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.mdx
+12 -12
View File
@@ -16,11 +16,11 @@ A payment can be related to an order, swap, return, or more. It can be captured
## Methods
#### capturePayment
### capturePayment
Capture a payment.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -31,7 +31,7 @@ medusa.admin.payments.capturePayment(paymentId).then(({ payment }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -54,7 +54,7 @@ medusa.admin.payments.capturePayment(paymentId).then(({ payment }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -262,11 +262,11 @@ medusa.admin.payments.capturePayment(paymentId).then(({ payment }) => {
___
#### refundPayment
### refundPayment
Refund a payment. The payment must be captured first.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -283,7 +283,7 @@ medusa.admin.payments
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -389,7 +389,7 @@ medusa.admin.payments
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -534,11 +534,11 @@ medusa.admin.payments
___
#### retrieve
### retrieve
Retrieve a payment's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -549,7 +549,7 @@ medusa.admin.payments.retrieve(paymentId).then(({ payment }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -600,7 +600,7 @@ medusa.admin.payments.retrieve(paymentId).then(({ payment }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminPriceListResource.mdx
+44 -44
View File
@@ -18,11 +18,11 @@ Related Guide: [How to manage price lists](https://docs.medusajs.com/modules/pri
## Methods
#### addPrices
### addPrices
Add or update a list of prices in a price list.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -43,7 +43,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -158,7 +158,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -313,11 +313,11 @@ medusa.admin.priceLists
___
#### create
### create
Create a price list.
##### Example
#### Example
```ts
medusa.admin.priceLists
@@ -338,7 +338,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -547,7 +547,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -702,11 +702,11 @@ medusa.admin.priceLists
___
#### delete
### delete
Delete a price list and its associated prices.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -717,7 +717,7 @@ medusa.admin.priceLists.delete(priceListId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -740,7 +740,7 @@ medusa.admin.priceLists.delete(priceListId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -784,11 +784,11 @@ medusa.admin.priceLists.delete(priceListId).then(({ id, object, deleted }) => {
___
#### deletePrices
### deletePrices
Delete a list of prices in a price list
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -803,7 +803,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -845,7 +845,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -899,11 +899,11 @@ medusa.admin.priceLists
___
#### deleteProductPrices
### deleteProductPrices
Delete all the prices related to a specific product in a price list.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -916,7 +916,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -948,7 +948,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1002,11 +1002,11 @@ medusa.admin.priceLists
___
#### deleteProductsPrices
### deleteProductsPrices
Delete all the prices associated with multiple products in a price list.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1021,7 +1021,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1063,7 +1063,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1117,11 +1117,11 @@ medusa.admin.priceLists
___
#### deleteVariantPrices
### deleteVariantPrices
Delete all the prices related to a specific product variant in a price list.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1134,7 +1134,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1166,7 +1166,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1220,11 +1220,11 @@ medusa.admin.priceLists
___
#### list
### list
Retrieve a list of price lists. The price lists can be filtered by fields such as `q` or `status` passed in the `query` parameter. The price lists can also be sorted or paginated.
##### Example
#### Example
To list price lists:
@@ -1269,7 +1269,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1568,7 +1568,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1750,11 +1750,11 @@ medusa.admin.priceLists
___
#### listProducts
### listProducts
Retrieve a price list's products. The products can be filtered by fields such as `q` or `status` passed in the `query` parameter. The products can also be sorted or paginated.
##### Example
#### Example
To list products in a price list:
@@ -1801,7 +1801,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2144,7 +2144,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2524,11 +2524,11 @@ medusa.admin.priceLists
___
#### retrieve
### retrieve
Retrieve a price list's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2539,7 +2539,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2562,7 +2562,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2717,11 +2717,11 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => {
___
#### update
### update
Update a price list's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2736,7 +2736,7 @@ medusa.admin.priceLists
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2963,7 +2963,7 @@ medusa.admin.priceLists
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.mdx
+28 -28
View File
@@ -24,11 +24,11 @@ Related Guide: [How to manage product categories](https://docs.medusajs.com/modu
## Methods
#### addProducts
### addProducts
Add a list of products to a product category.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -47,7 +47,7 @@ medusa.admin.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -99,7 +99,7 @@ medusa.admin.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -262,11 +262,11 @@ medusa.admin.productCategories
___
#### create
### create
Create a product category.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -281,7 +281,7 @@ medusa.admin.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -368,7 +368,7 @@ medusa.admin.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -531,11 +531,11 @@ medusa.admin.productCategories
___
#### delete
### delete
Delete a product category. This does not delete associated products.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -548,7 +548,7 @@ medusa.admin.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -571,7 +571,7 @@ medusa.admin.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -615,12 +615,12 @@ medusa.admin.productCategories
___
#### list
### list
Retrieve a list of product categories. The product categories can be filtered by fields such as `q` or `handle` passed in the `query` parameter.
The product categories can also be paginated.
##### Example
#### Example
To list product categories:
@@ -667,7 +667,7 @@ medusa.admin.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -781,7 +781,7 @@ medusa.admin.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -971,11 +971,11 @@ medusa.admin.productCategories
___
#### removeProducts
### removeProducts
Remove a list of products from a product category.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -994,7 +994,7 @@ medusa.admin.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1046,7 +1046,7 @@ medusa.admin.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1209,11 +1209,11 @@ medusa.admin.productCategories
___
#### retrieve
### retrieve
Retrieve a product category's details.
##### Example
#### Example
A simple example that retrieves an order by its ID:
@@ -1243,7 +1243,7 @@ medusa.admin.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1294,7 +1294,7 @@ medusa.admin.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1457,11 +1457,11 @@ medusa.admin.productCategories
___
#### update
### update
Updates a product category.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1476,7 +1476,7 @@ medusa.admin.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1581,7 +1581,7 @@ medusa.admin.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.mdx
+4 -4
View File
@@ -17,11 +17,11 @@ Products can have more than one tag, and products can share tags. This allows ad
## Methods
#### list
### list
Retrieve a list of product tags. The product tags can be filtered by fields such as `q` or `value` passed in the `query` parameter. The product tags can also be sorted or paginated.
##### Example
#### Example
To list product tags:
@@ -50,7 +50,7 @@ medusa.admin.productTags
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -220,7 +220,7 @@ medusa.admin.productTags
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.mdx
+4 -4
View File
@@ -17,12 +17,12 @@ Products can have one type, and products can share types. This allows admins to
## Methods
#### list
### list
Retrieve a list of product types. The product types can be filtered by fields such as `q` or `value` passed in the `query` parameter.
The product types can also be sorted or paginated.
##### Example
#### Example
To list product types:
@@ -51,7 +51,7 @@ medusa.admin.productTypes
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -230,7 +230,7 @@ medusa.admin.productTypes
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminProductsResource.mdx
+51 -51
View File
@@ -18,11 +18,11 @@ Related Guide: [How to manage products](https://docs.medusajs.com/modules/produc
## Methods
#### addOption
### addOption
Add a product option to a product.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -37,7 +37,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -79,7 +79,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -432,11 +432,11 @@ medusa.admin.products
___
#### create
### create
Create a new Product. This API Route can also be used to create a gift card if the `is_giftcard` field is set to `true`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -453,7 +453,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1036,7 +1036,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1389,11 +1389,11 @@ medusa.admin.products
___
#### createVariant
### createVariant
Create a product variant associated with a product. Each product variant must have a unique combination of product option values.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1421,7 +1421,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1690,7 +1690,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2043,11 +2043,11 @@ medusa.admin.products
___
#### delete
### delete
Delete a product and its associated product variants and options.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2058,7 +2058,7 @@ medusa.admin.products.delete(productId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2081,7 +2081,7 @@ medusa.admin.products.delete(productId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2135,11 +2135,11 @@ medusa.admin.products.delete(productId).then(({ id, object, deleted }) => {
___
#### deleteOption
### deleteOption
Delete a product option. If there are product variants that use this product option, they must be deleted before deleting the product option.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2171,7 +2171,7 @@ Delete a product option. If there are product variants that use this product opt
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2551,11 +2551,11 @@ Delete a product option. If there are product variants that use this product opt
___
#### deleteVariant
### deleteVariant
Delete a product variant.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2568,7 +2568,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2600,7 +2600,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2980,11 +2980,11 @@ medusa.admin.products
___
#### list
### list
Retrieve a list of products. The products can be filtered by fields such as `q` or `status` passed in the `query` parameter. The products can also be sorted or paginated.
##### Example
#### Example
To list products:
@@ -3029,7 +3029,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3409,7 +3409,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3472,11 +3472,11 @@ medusa.admin.products
___
#### listTags
### listTags
Retrieve a list of Product Tags with how many times each is used in products.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3487,7 +3487,7 @@ medusa.admin.products.listTags().then(({ tags }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3501,7 +3501,7 @@ medusa.admin.products.listTags().then(({ tags }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3601,11 +3601,11 @@ medusa.admin.products.listTags().then(({ tags }) => {
___
#### retrieve
### retrieve
Retrieve a product's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3616,7 +3616,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3639,7 +3639,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3992,12 +3992,12 @@ medusa.admin.products.retrieve(productId).then(({ product }) => {
___
#### setMetadata
### setMetadata
Set the metadata of a product. It can be any key-value pair, which allows adding custom data to a product. Learn about how you can update and delete the metadata attribute
[here](https://docs.medusajs.com/development/entities/overview#metadata-attribute).
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -4013,7 +4013,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -4064,7 +4064,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -4417,11 +4417,11 @@ medusa.admin.products
___
#### update
### update
Update a Product's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -4436,7 +4436,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -5017,7 +5017,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -5370,11 +5370,11 @@ medusa.admin.products
___
#### updateOption
### updateOption
Update a product option's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -5389,7 +5389,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -5440,7 +5440,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -5793,11 +5793,11 @@ medusa.admin.products
___
#### updateVariant
### updateVariant
Update a product variant's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -5825,7 +5825,7 @@ medusa.admin.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -6112,7 +6112,7 @@ medusa.admin.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.mdx
+36 -36
View File
@@ -21,11 +21,11 @@ Related Guide: [How to manage publishable API keys](https://docs.medusajs.com/de
## Methods
#### addSalesChannelsBatch
### addSalesChannelsBatch
Add a list of sales channels to a publishable API key.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -44,7 +44,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -96,7 +96,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -196,11 +196,11 @@ medusa.admin.publishableApiKeys
___
#### create
### create
Create a publishable API key.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -215,7 +215,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -248,7 +248,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -348,11 +348,11 @@ medusa.admin.publishableApiKeys
___
#### delete
### delete
Delete a publishable API key. Associated resources, such as sales channels, are not deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -365,7 +365,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -388,7 +388,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -432,11 +432,11 @@ medusa.admin.publishableApiKeys
___
#### deleteSalesChannelsBatch
### deleteSalesChannelsBatch
Remove a list of sales channels from a publishable API key. This doesn't delete the sales channels and only removes the association between them and the publishable API key.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -455,7 +455,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -507,7 +507,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -607,11 +607,11 @@ medusa.admin.publishableApiKeys
___
#### list
### list
Retrieve a list of publishable API keys. The publishable API keys can be filtered by fields such as `q` passed in `query`. The publishable API keys can also be paginated.
##### Example
#### Example
To list publishable API keys:
@@ -642,7 +642,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -711,7 +711,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -838,11 +838,11 @@ medusa.admin.publishableApiKeys
___
#### listSalesChannels
### listSalesChannels
List the sales channels associated with a publishable API key. The sales channels can be filtered by fields such as `q` passed in the `query` parameter.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -855,7 +855,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -933,7 +933,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1051,11 +1051,11 @@ medusa.admin.publishableApiKeys
___
#### retrieve
### retrieve
Retrieve a publishable API key's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1068,7 +1068,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1100,7 +1100,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1200,11 +1200,11 @@ medusa.admin.publishableApiKeys
___
#### revoke
### revoke
Revoke a publishable API key. Revoking the publishable API Key can't be undone, and the key can't be used in future requests.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1217,7 +1217,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1240,7 +1240,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1340,11 +1340,11 @@ medusa.admin.publishableApiKeys
___
#### update
### update
Update a publishable API key's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1359,7 +1359,7 @@ medusa.admin.publishableApiKeys
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1401,7 +1401,7 @@ medusa.admin.publishableApiKeys
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminRegionsResource.mdx
+48 -48
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage regions](https://docs.medusajs.com/modules/regions
## Methods
#### addCountry
### addCountry
Add a country to the list of countries in a region.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -38,7 +38,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -80,7 +80,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -289,11 +289,11 @@ medusa.admin.regions
___
#### addFulfillmentProvider
### addFulfillmentProvider
Add a fulfillment provider to the list of fulfullment providers in a region.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -308,7 +308,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -350,7 +350,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -559,11 +559,11 @@ medusa.admin.regions
___
#### addPaymentProvider
### addPaymentProvider
Add a payment provider to the list of payment providers in a region.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -578,7 +578,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -620,7 +620,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -829,11 +829,11 @@ medusa.admin.regions
___
#### create
### create
Create a region.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -853,7 +853,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -959,7 +959,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1168,11 +1168,11 @@ medusa.admin.regions
___
#### delete
### delete
Delete a region. Associated resources, such as providers or currencies are not deleted. Associated tax rates are deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1183,7 +1183,7 @@ medusa.admin.regions.delete(regionId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1206,7 +1206,7 @@ medusa.admin.regions.delete(regionId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1250,11 +1250,11 @@ medusa.admin.regions.delete(regionId).then(({ id, object, deleted }) => {
___
#### deleteCountry
### deleteCountry
Delete a country from the list of countries in a region. The country will still be available in the system, and it can be used in other regions.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1265,7 +1265,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1297,7 +1297,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1506,11 +1506,11 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => {
___
#### deleteFulfillmentProvider
### deleteFulfillmentProvider
Delete a fulfillment provider from a region. The fulfillment provider will still be available for usage in other regions.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1523,7 +1523,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1555,7 +1555,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1764,11 +1764,11 @@ medusa.admin.regions
___
#### deletePaymentProvider
### deletePaymentProvider
Delete a payment provider from a region. The payment provider will still be available for usage in other regions.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1781,7 +1781,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1813,7 +1813,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2022,11 +2022,11 @@ medusa.admin.regions
___
#### list
### list
Retrieve a list of Regions. The regions can be filtered by fields such as `created_at` passed in the `query` parameter. The regions can also be paginated.
##### Example
#### Example
To list regions:
@@ -2055,7 +2055,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2235,7 +2235,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2471,11 +2471,11 @@ medusa.admin.regions
___
#### retrieve
### retrieve
Retrieve a region's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2486,7 +2486,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2509,7 +2509,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2718,11 +2718,11 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => {
___
#### retrieveFulfillmentOptions
### retrieveFulfillmentOptions
Retrieve a list of fulfillment options available in a region.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2735,7 +2735,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2758,7 +2758,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2784,11 +2784,11 @@ medusa.admin.regions
___
#### update
### update
Update a region's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2803,7 +2803,7 @@ medusa.admin.regions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2945,7 +2945,7 @@ medusa.admin.regions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminReservationsResource.mdx
+20 -20
View File
@@ -20,11 +20,11 @@ Related Guide: [How to manage item allocations in orders](https://docs.medusajs.
## Methods
#### create
### create
Create a reservation which can be associated with any resource, such as an order's line item.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -42,7 +42,7 @@ medusa.admin.reservations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -120,7 +120,7 @@ medusa.admin.reservations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -256,11 +256,11 @@ medusa.admin.reservations
___
#### delete
### delete
Delete a reservation. Associated resources, such as the line item, will not be deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -273,7 +273,7 @@ medusa.admin.reservations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -296,7 +296,7 @@ medusa.admin.reservations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -340,11 +340,11 @@ medusa.admin.reservations
___
#### list
### list
Retrieve a list of reservations. The reservations can be filtered by fields such as `location_id` or `quantity` passed in the `query` parameter. The reservations can also be paginated.
##### Example
#### Example
To list reservations:
@@ -391,7 +391,7 @@ medusa.admin.reservations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -588,7 +588,7 @@ medusa.admin.reservations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -751,11 +751,11 @@ medusa.admin.reservations
___
#### retrieve
### retrieve
Retrieve a reservation's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -766,7 +766,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -789,7 +789,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -925,11 +925,11 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
___
#### update
### update
Update a reservation's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -944,7 +944,7 @@ medusa.admin.reservations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1013,7 +1013,7 @@ medusa.admin.reservations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.mdx
+20 -20
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage return reasons](https://docs.medusajs.com/modules/
## Methods
#### create
### create
Create a return reason.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -39,7 +39,7 @@ medusa.admin.returnReasons
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -108,7 +108,7 @@ medusa.admin.returnReasons
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -244,11 +244,11 @@ medusa.admin.returnReasons
___
#### delete
### delete
Delete a return reason.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -261,7 +261,7 @@ medusa.admin.returnReasons
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -284,7 +284,7 @@ medusa.admin.returnReasons
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -328,11 +328,11 @@ medusa.admin.returnReasons
___
#### list
### list
Retrieve a list of return reasons.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -343,7 +343,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -357,7 +357,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -493,11 +493,11 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => {
___
#### retrieve
### retrieve
Retrieve a return reason's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -510,7 +510,7 @@ medusa.admin.returnReasons
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -533,7 +533,7 @@ medusa.admin.returnReasons
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -669,11 +669,11 @@ medusa.admin.returnReasons
___
#### update
### update
Update a return reason's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -688,7 +688,7 @@ medusa.admin.returnReasons
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -757,7 +757,7 @@ medusa.admin.returnReasons
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminReturnsResource.mdx
+12 -12
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage returns](https://docs.medusajs.com/modules/orders/
## Methods
#### cancel
### cancel
Registers a return as canceled. The return can be associated with an order, claim, or swap.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -34,7 +34,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -57,7 +57,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -598,11 +598,11 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
___
#### list
### list
Retrieve a list of Returns. The returns can be paginated.
##### Example
#### Example
To list returns:
@@ -631,7 +631,7 @@ medusa.admin.returns
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -673,7 +673,7 @@ medusa.admin.returns
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -908,11 +908,11 @@ medusa.admin.returns
___
#### receive
### receive
Mark a return as received. This also updates the status of associated order, claim, or swap accordingly.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -932,7 +932,7 @@ medusa.admin.returns
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1011,7 +1011,7 @@ medusa.admin.returns
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.mdx
+36 -36
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage sales channels](https://docs.medusajs.com/modules/
## Methods
#### addLocation
### addLocation
Associate a stock location with a sales channel.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -38,7 +38,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -80,7 +80,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -198,11 +198,11 @@ medusa.admin.salesChannels
___
#### addProducts
### addProducts
Add a list of products to a sales channel.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -221,7 +221,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -273,7 +273,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -391,11 +391,11 @@ medusa.admin.salesChannels
___
#### create
### create
Create a sales channel.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -411,7 +411,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -462,7 +462,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -580,11 +580,11 @@ medusa.admin.salesChannels
___
#### delete
### delete
Delete a sales channel. Associated products, stock locations, and other resources are not deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -597,7 +597,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -620,7 +620,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -664,11 +664,11 @@ medusa.admin.salesChannels
___
#### list
### list
Retrieve a list of sales channels. The sales channels can be filtered by fields such as `q` or `name` passed in the `query` parameter. The sales channels can also be sorted or paginated.
##### Example
#### Example
To list sales channels:
@@ -715,7 +715,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -958,7 +958,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1103,11 +1103,11 @@ medusa.admin.salesChannels
___
#### removeLocation
### removeLocation
Remove a stock location from a sales channel. This only removes the association between the stock location and the sales channel. It does not delete the stock location.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1122,7 +1122,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1164,7 +1164,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1282,11 +1282,11 @@ medusa.admin.salesChannels
___
#### removeProducts
### removeProducts
Remove a list of products from a sales channel. This doesn't delete the product. It only removes the association between the product and the sales channel.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1305,7 +1305,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1357,7 +1357,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1475,11 +1475,11 @@ medusa.admin.salesChannels
___
#### retrieve
### retrieve
Retrieve a sales channel's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1492,7 +1492,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1515,7 +1515,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1633,11 +1633,11 @@ medusa.admin.salesChannels
___
#### update
### update
Update a sales channel's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1652,7 +1652,7 @@ medusa.admin.salesChannels
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1712,7 +1712,7 @@ medusa.admin.salesChannels
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.mdx
+20 -20
View File
@@ -19,11 +19,11 @@ Related Guide: [Shipping Option architecture](https://docs.medusajs.com/modules/
## Methods
#### create
### create
Create a shipping option.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -42,7 +42,7 @@ medusa.admin.shippingOptions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -194,7 +194,7 @@ medusa.admin.shippingOptions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -403,11 +403,11 @@ medusa.admin.shippingOptions
___
#### delete
### delete
Delete a shipping option. Once deleted, it can't be used when creating orders or returns.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -420,7 +420,7 @@ medusa.admin.shippingOptions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -443,7 +443,7 @@ medusa.admin.shippingOptions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -487,11 +487,11 @@ medusa.admin.shippingOptions
___
#### list
### list
Retrieve a list of shipping options. The shipping options can be filtered by fields such as `region_id` or `is_return` passed in the `query` parameter.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -502,7 +502,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -553,7 +553,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -789,11 +789,11 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => {
___
#### retrieve
### retrieve
Retrieve a shipping option's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -804,7 +804,7 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -827,7 +827,7 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1036,11 +1036,11 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => {
___
#### update
### update
Update a shipping option's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1062,7 +1062,7 @@ medusa.admin.shippingOptions
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1178,7 +1178,7 @@ medusa.admin.shippingOptions
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.mdx
+20 -20
View File
@@ -19,11 +19,11 @@ Related Guide: [Shipping Profile architecture](https://docs.medusajs.com/modules
## Methods
#### create
### create
Create a shipping profile.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -38,7 +38,7 @@ medusa.admin.shippingProfiles
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -117,7 +117,7 @@ medusa.admin.shippingProfiles
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -235,11 +235,11 @@ medusa.admin.shippingProfiles
___
#### delete
### delete
Delete a shipping profile. Associated shipping options are deleted as well.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -252,7 +252,7 @@ medusa.admin.shippingProfiles
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -275,7 +275,7 @@ medusa.admin.shippingProfiles
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -319,11 +319,11 @@ medusa.admin.shippingProfiles
___
#### list
### list
Retrieve a list of shipping profiles.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -334,7 +334,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -348,7 +348,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -466,11 +466,11 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
___
#### retrieve
### retrieve
Retrieve a shipping profile's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -483,7 +483,7 @@ medusa.admin.shippingProfiles
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -506,7 +506,7 @@ medusa.admin.shippingProfiles
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -624,11 +624,11 @@ medusa.admin.shippingProfiles
___
#### update
### update
Update a shipping profile's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -643,7 +643,7 @@ medusa.admin.shippingProfiles
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -749,7 +749,7 @@ medusa.admin.shippingProfiles
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.mdx
+20 -20
View File
@@ -20,11 +20,11 @@ Related Guide: [How to manage stock locations](https://docs.medusajs.com/modules
## Methods
#### create
### create
Create a stock location.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -39,7 +39,7 @@ medusa.admin.stockLocations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -172,7 +172,7 @@ medusa.admin.stockLocations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -290,11 +290,11 @@ medusa.admin.stockLocations
___
#### delete
### delete
Delete a stock location.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -307,7 +307,7 @@ medusa.admin.stockLocations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -330,7 +330,7 @@ medusa.admin.stockLocations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -384,12 +384,12 @@ medusa.admin.stockLocations
___
#### list
### list
Retrieve a list of stock locations. The stock locations can be filtered by fields such as `name` or `created_at` passed in the `query` parameter.
The stock locations can also be sorted or paginated.
##### Example
#### Example
To list stock locations:
@@ -436,7 +436,7 @@ medusa.admin.stockLocations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -532,7 +532,7 @@ medusa.admin.stockLocations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -677,11 +677,11 @@ medusa.admin.stockLocations
___
#### retrieve
### retrieve
Retrieve a stock location's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -694,7 +694,7 @@ medusa.admin.stockLocations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -717,7 +717,7 @@ medusa.admin.stockLocations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -835,11 +835,11 @@ medusa.admin.stockLocations
___
#### update
### update
Update a stock location's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -854,7 +854,7 @@ medusa.admin.stockLocations
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -996,7 +996,7 @@ medusa.admin.stockLocations
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminStoresResource.mdx
+24 -24
View File
@@ -17,12 +17,12 @@ Admins can manage the store and its details or configurations.
## Methods
#### addCurrency
### addCurrency
Add a currency code to the available currencies in a store. This doesn't create new currencies, as currencies are defined within the Medusa backend.
To create a currency, you can [create a migration](https://docs.medusajs.com/development/entities/migrations/create) that inserts the currency into the database.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -33,7 +33,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -219,11 +219,11 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
___
#### deleteCurrency
### deleteCurrency
Delete a currency code from the available currencies in a store. This doesn't completely delete the currency and it can be added again later to the store.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -234,7 +234,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -257,7 +257,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -420,11 +420,11 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
___
#### listPaymentProviders
### listPaymentProviders
Retrieve a list of available payment providers in a store.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -435,7 +435,7 @@ medusa.admin.store.listPaymentProviders().then(({ payment_providers }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -449,7 +449,7 @@ medusa.admin.store.listPaymentProviders().then(({ payment_providers }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -504,11 +504,11 @@ medusa.admin.store.listPaymentProviders().then(({ payment_providers }) => {
___
#### listTaxProviders
### listTaxProviders
Retrieve a list of available tax providers in a store.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -519,7 +519,7 @@ medusa.admin.store.listTaxProviders().then(({ tax_providers }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -533,7 +533,7 @@ medusa.admin.store.listTaxProviders().then(({ tax_providers }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -588,11 +588,11 @@ medusa.admin.store.listTaxProviders().then(({ tax_providers }) => {
___
#### retrieve
### retrieve
Retrieve the store's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -603,7 +603,7 @@ medusa.admin.store.retrieve().then(({ store }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -617,7 +617,7 @@ medusa.admin.store.retrieve().then(({ store }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -816,11 +816,11 @@ medusa.admin.store.retrieve().then(({ store }) => {
___
#### update
### update
Update the store's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -835,7 +835,7 @@ medusa.admin.store
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -922,7 +922,7 @@ medusa.admin.store
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminSwapsResource.mdx
+8 -8
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage swaps](https://docs.medusajs.com/modules/orders/ad
## Methods
#### list
### list
Retrieve a list of swaps. The swaps can be paginated.
##### Example
#### Example
To list swaps:
@@ -52,7 +52,7 @@ medusa.admin.swaps
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -94,7 +94,7 @@ medusa.admin.swaps
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -374,11 +374,11 @@ medusa.admin.swaps
___
#### retrieve
### retrieve
Retrieve a swap's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -389,7 +389,7 @@ medusa.admin.swaps.retrieve(swapId).then(({ swap }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -412,7 +412,7 @@ medusa.admin.swaps.retrieve(swapId).then(({ swap }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.mdx
+44 -44
View File
@@ -18,11 +18,11 @@ Related Guide: [How to manage tax rates](https://docs.medusajs.com/modules/taxes
## Methods
#### addProductTypes
### addProductTypes
Add product types to a tax rate.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -37,7 +37,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -107,7 +107,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -279,11 +279,11 @@ medusa.admin.taxRates
___
#### addProducts
### addProducts
Add products to a tax rate.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -298,7 +298,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -368,7 +368,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -540,11 +540,11 @@ medusa.admin.taxRates
___
#### addShippingOptions
### addShippingOptions
Add shipping options to a tax rate.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -559,7 +559,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -629,7 +629,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -801,11 +801,11 @@ medusa.admin.taxRates
___
#### create
### create
Create a tax rate.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -822,7 +822,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -937,7 +937,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1109,11 +1109,11 @@ medusa.admin.taxRates
___
#### delete
### delete
Delete a tax rate. Resources associated with the tax rate, such as products or product types, are not deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1124,7 +1124,7 @@ medusa.admin.taxRates.delete(taxRateId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1147,7 +1147,7 @@ medusa.admin.taxRates.delete(taxRateId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1191,11 +1191,11 @@ medusa.admin.taxRates.delete(taxRateId).then(({ id, object, deleted }) => {
___
#### list
### list
Retrieve a list of tax rates. The tax rates can be filtered by fields such as `name` or `rate` passed in the `query` parameter. The tax rates can also be paginated.
##### Example
#### Example
To list tax rates:
@@ -1240,7 +1240,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1336,7 +1336,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1535,11 +1535,11 @@ medusa.admin.taxRates
___
#### removeProductTypes
### removeProductTypes
Remove product types from a tax rate. This only removes the association between the product types and the tax rate. It does not delete the product types.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1554,7 +1554,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1624,7 +1624,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1796,11 +1796,11 @@ medusa.admin.taxRates
___
#### removeProducts
### removeProducts
Remove products from a tax rate. This only removes the association between the products and the tax rate. It does not delete the products.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1815,7 +1815,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1885,7 +1885,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2057,11 +2057,11 @@ medusa.admin.taxRates
___
#### removeShippingOptions
### removeShippingOptions
Remove shipping options from a tax rate. This only removes the association between the shipping options and the tax rate. It does not delete the shipping options.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2076,7 +2076,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2146,7 +2146,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2318,11 +2318,11 @@ medusa.admin.taxRates
___
#### retrieve
### retrieve
Retrieve a tax rate's details.
##### Example
#### Example
A simple example that retrieves a tax rate by its ID:
@@ -2350,7 +2350,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2401,7 +2401,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2573,11 +2573,11 @@ medusa.admin.taxRates
___
#### update
### update
Update a tax rate's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2592,7 +2592,7 @@ medusa.admin.taxRates
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2716,7 +2716,7 @@ medusa.admin.taxRates
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminUploadsResource.mdx
+19 -19
View File
@@ -18,9 +18,9 @@ Related Guide: [How to upload CSV file when importing a product](https://docs.me
## Methods
#### \_createPayload
### \_createPayload
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -34,7 +34,7 @@ Related Guide: [How to upload CSV file when importing a product](https://docs.me
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -50,11 +50,11 @@ Related Guide: [How to upload CSV file when importing a product](https://docs.me
___
#### create
### create
Upload a file to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -65,7 +65,7 @@ medusa.admin.uploads.create(file).then(({ uploads }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -79,7 +79,7 @@ medusa.admin.uploads.create(file).then(({ uploads }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -134,11 +134,11 @@ medusa.admin.uploads.create(file).then(({ uploads }) => {
___
#### createProtected
### createProtected
Upload a file to an ACL or a non-public bucket. The file upload is handled by the file service installed on the Medusa backend.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -149,7 +149,7 @@ medusa.admin.uploads.createProtected(file).then(({ uploads }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -163,7 +163,7 @@ medusa.admin.uploads.createProtected(file).then(({ uploads }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -218,11 +218,11 @@ medusa.admin.uploads.createProtected(file).then(({ uploads }) => {
___
#### delete
### delete
Delete an uploaded file from storage. The file is deleted using the installed file service on the Medusa backend.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -237,7 +237,7 @@ medusa.admin.uploads
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -270,7 +270,7 @@ medusa.admin.uploads
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -314,11 +314,11 @@ medusa.admin.uploads
___
#### getPresignedDownloadUrl
### getPresignedDownloadUrl
Create and retrieve a presigned or public download URL for a file. The URL creation is handled by the file service installed on the Medusa backend.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -333,7 +333,7 @@ medusa.admin.uploads
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -366,7 +366,7 @@ medusa.admin.uploads
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminUsersResource.mdx
+28 -28
View File
@@ -18,11 +18,11 @@ Related Guide: [How to manage users](https://docs.medusajs.com/modules/users/adm
## Methods
#### create
### create
Create an admin user. The user has the same privileges as all admin users, and will be able to authenticate and perform admin functionalities right after creation.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -38,7 +38,7 @@ medusa.admin.users
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -61,7 +61,7 @@ medusa.admin.users
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -188,11 +188,11 @@ medusa.admin.users
___
#### delete
### delete
Delete a user. Once deleted, the user will not be able to authenticate or perform admin functionalities.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -203,7 +203,7 @@ medusa.admin.users.delete(userId).then(({ id, object, deleted }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -226,7 +226,7 @@ medusa.admin.users.delete(userId).then(({ id, object, deleted }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -270,11 +270,11 @@ medusa.admin.users.delete(userId).then(({ id, object, deleted }) => {
___
#### list
### list
Retrieve all admin users.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -285,7 +285,7 @@ medusa.admin.users.list().then(({ users }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -299,7 +299,7 @@ medusa.admin.users.list().then(({ users }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -426,12 +426,12 @@ medusa.admin.users.list().then(({ users }) => {
___
#### resetPassword
### resetPassword
Reset the password of an admin user using their reset password token. You must generate a reset password token first for the user using the [sendResetPasswordToken](AdminUsersResource.mdx#sendresetpasswordtoken) method,
then use that token to reset the password in this method.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -447,7 +447,7 @@ medusa.admin.users
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -498,7 +498,7 @@ medusa.admin.users
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -625,11 +625,11 @@ medusa.admin.users
___
#### retrieve
### retrieve
Retrieve an admin user's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -640,7 +640,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -663,7 +663,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -790,13 +790,13 @@ medusa.admin.users.retrieve(userId).then(({ user }) => {
___
#### sendResetPasswordToken
### sendResetPasswordToken
Generate a password token for an admin user with a given email. This also triggers the `user.password_reset` event. So, if you have a Notification Service installed
that can handle this event, a notification, such as an email, will be sent to the user. The token is triggered as part of the `user.password_reset` event's payload.
That token must be used later to reset the password using the [resetPassword](AdminUsersResource.mdx#resetpassword) method.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -814,7 +814,7 @@ medusa.admin.users
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -847,7 +847,7 @@ medusa.admin.users
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -863,11 +863,11 @@ medusa.admin.users
___
#### update
### update
Update an admin user's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -882,7 +882,7 @@ medusa.admin.users
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -960,7 +960,7 @@ medusa.admin.users
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx
+12 -12
View File
@@ -19,11 +19,11 @@ Related Guide: [How to manage product variants](https://docs.medusajs.com/module
## Methods
#### getInventory
### getInventory
Retrieve the available inventory of a product variant.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -34,7 +34,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -57,7 +57,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -121,11 +121,11 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
___
#### list
### list
Retrieve a list of product variants. The product variant can be filtered by fields such as `id` or `title` passed in the `query` parameter. The product variant can also be paginated.
##### Example
#### Example
To list product variants:
@@ -170,7 +170,7 @@ medusa.admin.variants
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -302,7 +302,7 @@ medusa.admin.variants
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -719,11 +719,11 @@ medusa.admin.variants
___
#### retrieve
### retrieve
Retrieve a product variant's details.
##### Example
#### Example
A simple example that retrieves a product variant by its ID:
@@ -751,7 +751,7 @@ medusa.admin.variants
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -802,7 +802,7 @@ medusa.admin.variants
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/AuthResource.mdx
+20 -20
View File
@@ -19,11 +19,11 @@ Related Guide: [How to implement customer profiles in your storefront](https://d
## Methods
#### authenticate
### authenticate
Authenticate a customer using their email and password. If the customer is authenticated successfully, the cookie is automatically attached to subsequent requests sent with the JS Client.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -38,7 +38,7 @@ medusa.auth
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -80,7 +80,7 @@ medusa.auth
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -252,11 +252,11 @@ medusa.auth
___
#### deleteSession
### deleteSession
Log out the customer and remove their authentication session. This method requires [customer authentication](AuthResource.mdx#authenticate).
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -266,7 +266,7 @@ medusa.auth.deleteSession().then(() => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -280,7 +280,7 @@ medusa.auth.deleteSession().then(() => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -296,11 +296,11 @@ medusa.auth.deleteSession().then(() => {
___
#### exists
### exists
Check if the email is already used by another registered customer. Can be used to validate a new customer's email.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -308,7 +308,7 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.auth.exists("user@example.com")
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -331,7 +331,7 @@ medusa.auth.exists("user@example.com")
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -367,12 +367,12 @@ medusa.auth.exists("user@example.com")
___
#### getSession
### getSession
Retrieve the details of the logged-in customer. Can also be used to check if there is an authenticated customer.
This method requires [customer authentication](AuthResource.mdx#authenticate).
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -383,7 +383,7 @@ medusa.auth.getSession().then(({ customer }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -397,7 +397,7 @@ medusa.auth.getSession().then(({ customer }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -569,11 +569,11 @@ medusa.auth.getSession().then(({ customer }) => {
___
#### getToken
### getToken
Authenticate the customer and retrieve a JWT token to use for subsequent authenticated requests.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -588,7 +588,7 @@ medusa.auth
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -630,7 +630,7 @@ medusa.auth
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/CartsResource.mdx
+46 -44
View File
@@ -29,13 +29,15 @@ Related Guide: [How to implement cart functionality in your storefront](https://
}
]} />
___
## Methods
#### addShippingMethod
### addShippingMethod
Add a shipping method to the cart. The validation of the `data` field is handled by the fulfillment provider of the chosen shipping option.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -49,7 +51,7 @@ medusa.carts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -100,7 +102,7 @@ medusa.carts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -488,7 +490,7 @@ medusa.carts
___
#### complete
### complete
Complete a cart and place an order or create a swap, based on the cart's type. This includes attempting to authorize the cart's payment.
If authorizing the payment requires more action, the cart will not be completed and the order will not be placed or the swap will not be created.
@@ -496,7 +498,7 @@ An idempotency key will be generated if none is provided in the header `Idempote
the response. If an error occurs during cart completion or the request is interrupted for any reason, the cart completion can be retried by passing the idempotency
key in the `Idempotency-Key` header.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -506,7 +508,7 @@ medusa.carts.complete(cartId).then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -529,7 +531,7 @@ medusa.carts.complete(cartId).then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -555,13 +557,13 @@ medusa.carts.complete(cartId).then(({ cart }) => {
___
#### create
### create
Create a Cart. Although optional, specifying the cart's region and sales channel can affect the cart's pricing and
the products that can be added to the cart respectively. So, make sure to set those early on and change them if necessary, such as when the customer changes their region.
If a customer is logged in, make sure to pass its ID or email within the cart's details so that the cart is attached to the customer.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -571,7 +573,7 @@ medusa.carts.create().then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -659,7 +661,7 @@ medusa.carts.create().then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1047,12 +1049,12 @@ medusa.carts.create().then(({ cart }) => {
___
#### createPaymentSessions
### createPaymentSessions
Create Payment Sessions for each of the available Payment Providers in the Cart's Region. If there's only one payment session created,
it will be selected by default. The creation of the payment session uses the payment provider and may require sending requests to third-party services.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1062,7 +1064,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1085,7 +1087,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1473,12 +1475,12 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
___
#### deleteDiscount
### deleteDiscount
Remove a Discount from a Cart. This only removes the application of the discount, and not completely deletes it. The totals will be re-calculated and the payment sessions
will be refreshed after the removal.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1488,7 +1490,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1520,7 +1522,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1908,11 +1910,11 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
___
#### deletePaymentSession
### deletePaymentSession
Delete a Payment Session in a Cart. May be useful if a payment has failed. The totals will be recalculated.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1922,7 +1924,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1954,7 +1956,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2342,11 +2344,11 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
___
#### refreshPaymentSession
### refreshPaymentSession
Refresh a Payment Session to ensure that it is in sync with the Cart. This is usually not necessary, but is provided for edge cases.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2356,7 +2358,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2388,7 +2390,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -2776,11 +2778,11 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
___
#### retrieve
### retrieve
Retrieve a Cart's details. This includes recalculating its totals.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -2790,7 +2792,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -2813,7 +2815,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3201,12 +3203,12 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
___
#### setPaymentSession
### setPaymentSession
Select the Payment Session that will be used to complete the cart. This is typically used when the customer chooses their preferred payment method during checkout.
The totals of the cart will be recalculated.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3220,7 +3222,7 @@ medusa.carts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3262,7 +3264,7 @@ medusa.carts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -3650,11 +3652,11 @@ medusa.carts
___
#### update
### update
Update a Cart's details. If the cart has payment sessions and the region was not changed, the payment sessions are updated. The cart's totals are also recalculated.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -3668,7 +3670,7 @@ medusa.carts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -3811,7 +3813,7 @@ medusa.carts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -4199,12 +4201,12 @@ medusa.carts
___
#### updatePaymentSession
### updatePaymentSession
Update a Payment Session with additional data. This can be useful depending on the payment provider used.
All payment sessions are updated and cart totals are recalculated afterwards.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -4219,7 +4221,7 @@ medusa.carts
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -4270,7 +4272,7 @@ medusa.carts
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/CollectionsResource.mdx
+8 -8
View File
@@ -15,12 +15,12 @@ Using the methods in this class, you can list or retrieve a collection's details
## Methods
#### list
### list
Retrieve a list of product collections. The product collections can be filtered by fields such as `handle` or `created_at` passed in the `query` parameter.
The product collections can also be paginated.
##### Example
#### Example
To list product collections:
@@ -47,7 +47,7 @@ medusa.collections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -190,7 +190,7 @@ medusa.collections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -326,11 +326,11 @@ medusa.collections
___
#### retrieve
### retrieve
Retrieve a product collection's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -340,7 +340,7 @@ medusa.collections.retrieve(collectionId).then(({ collection }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -363,7 +363,7 @@ medusa.collections.retrieve(collectionId).then(({ collection }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/CustomersResource.mdx
+26 -24
View File
@@ -37,14 +37,16 @@ Related Guide: [How to implement customer profiles in your storefront](https://d
}
]} />
___
## Methods
#### create
### create
Register a new customer. This will also automatically authenticate the customer and set their login session in the response Cookie header.
Subsequent requests sent with the JS client are sent with the Cookie session automatically.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -61,7 +63,7 @@ medusa.customers
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -130,7 +132,7 @@ medusa.customers
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -302,12 +304,12 @@ medusa.customers
___
#### generatePasswordToken
### generatePasswordToken
Create a reset password token to be used when sending a request with the [resetPassword](CustomersResource.mdx#resetpassword) method. This emits the event `customer.password_reset`. If a notification provider is
installed in the Medusa backend and is configured to handle this event, a notification to the customer, such as an email, may be sent with reset instructions.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -324,7 +326,7 @@ medusa.customers
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -357,7 +359,7 @@ medusa.customers
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -373,12 +375,12 @@ medusa.customers
___
#### listOrders
### listOrders
Retrieve a list of the logged-in customer's orders. The orders can be filtered by fields such as `status` or `fulfillment_status`. The orders can also be paginated.
This method requires [customer authentication](AuthResource.mdx#authenticate).
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -389,7 +391,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -878,7 +880,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1446,12 +1448,12 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
___
#### resetPassword
### resetPassword
Reset a customer's password using a password token created by a previous request using the [generatePasswordToken](CustomersResource.mdx#generatepasswordtoken) method. If the password token expired,
you must create a new one.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1467,7 +1469,7 @@ medusa.customers
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1518,7 +1520,7 @@ medusa.customers
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1690,11 +1692,11 @@ medusa.customers
___
#### retrieve
### retrieve
Retrieve the logged-in customer's details. This method requires [customer authentication](AuthResource.mdx#authenticate).
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1705,7 +1707,7 @@ medusa.customers.retrieve().then(({ customer }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1719,7 +1721,7 @@ medusa.customers.retrieve().then(({ customer }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1891,11 +1893,11 @@ medusa.customers.retrieve().then(({ customer }) => {
___
#### update
### update
Update the logged-in customer's details. This method requires [customer authentication](AuthResource.mdx#authenticate).
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1910,7 +1912,7 @@ medusa.customers
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1997,7 +1999,7 @@ medusa.customers
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/GiftCardsResource.mdx
+4 -4
View File
@@ -17,11 +17,11 @@ Related Guide: [How to use gift cards in a storefront](https://docs.medusajs.com
## Methods
#### retrieve
### retrieve
Retrieve a Gift Card's details by its associated unique code.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -31,7 +31,7 @@ medusa.giftCards.retrieve(code).then(({ gift_card }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -54,7 +54,7 @@ medusa.giftCards.retrieve(code).then(({ gift_card }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/LineItemsResource.mdx
+12 -12
View File
@@ -12,11 +12,11 @@ are available in the JS Client under the `medusa.carts.lineItems` property.
## Methods
#### create
### create
Generates a Line Item with a given Product Variant and adds it to the Cart
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -31,7 +31,7 @@ medusa.carts.lineItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -91,7 +91,7 @@ medusa.carts.lineItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -479,11 +479,11 @@ medusa.carts.lineItems
___
#### delete
### delete
Delete a line item from a cart. The payment sessions will be updated and the totals will be recalculated.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -493,7 +493,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -525,7 +525,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -913,11 +913,11 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
___
#### update
### update
Update a line item's data.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -931,7 +931,7 @@ medusa.carts.lineItems
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -991,7 +991,7 @@ medusa.carts.lineItems
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/OrderEditsResource.mdx
+12 -12
View File
@@ -17,11 +17,11 @@ Related Guide: [How to handle order edits in a storefront](https://docs.medusajs
## Methods
#### complete
### complete
Complete an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the [PaymentCollectionsResource](PaymentCollectionsResource.mdx) routes.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -31,7 +31,7 @@ medusa.orderEdits.complete(orderEditId).then(({ order_edit }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -54,7 +54,7 @@ medusa.orderEdits.complete(orderEditId).then(({ order_edit }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -316,11 +316,11 @@ medusa.orderEdits.complete(orderEditId).then(({ order_edit }) => {
___
#### decline
### decline
Decline an Order Edit. The changes are not reflected on the original order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -330,7 +330,7 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -372,7 +372,7 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -634,11 +634,11 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => {
___
#### retrieve
### retrieve
Retrieve an Order Edit's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -648,7 +648,7 @@ medusa.orderEdits.retrieve(orderEditId).then(({ order_edit }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -671,7 +671,7 @@ medusa.orderEdits.retrieve(orderEditId).then(({ order_edit }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/OrdersResource.mdx
+20 -20
View File
@@ -17,11 +17,11 @@ Related Guide: [How to retrieve order details in a storefront](https://docs.medu
## Methods
#### confirmRequest
### confirmRequest
Verify the claim order token provided to the customer when they request ownership of an order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -37,7 +37,7 @@ medusa.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -70,7 +70,7 @@ medusa.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -86,11 +86,11 @@ medusa.orders
___
#### lookupOrder
### lookupOrder
Look up an order using filters. If the filters don't narrow down the results to a single order, a `404` response is returned with no orders.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -105,7 +105,7 @@ medusa.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -184,7 +184,7 @@ medusa.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -725,13 +725,13 @@ medusa.orders
___
#### requestCustomerOrders
### requestCustomerOrders
Allow the logged-in customer to claim ownership of one or more orders. This generates a token that can be used later on to verify the claim using the [confirmRequest](OrdersResource.mdx#confirmrequest) method.
This also emits the event `order-update-token.created`. So, if you have a notification provider installed that handles this event and sends the customer a notification, such as an email,
the customer should receive instructions on how to finalize their claim ownership.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -749,7 +749,7 @@ medusa.orders
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -782,7 +782,7 @@ medusa.orders
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -798,11 +798,11 @@ medusa.orders
___
#### retrieve
### retrieve
Retrieve an Order's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -812,7 +812,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -835,7 +835,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1376,11 +1376,11 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
___
#### retrieveByCartId
### retrieveByCartId
Retrieve an order's details by the ID of the cart that was used to create the order.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1390,7 +1390,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1413,7 +1413,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.mdx
+24 -24
View File
@@ -14,11 +14,11 @@ A payment collection is useful for managing additional payments, such as for Ord
## Methods
#### authorizePaymentSession
### authorizePaymentSession
Authorize a Payment Session of a Payment Collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -31,7 +31,7 @@ medusa.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -63,7 +63,7 @@ medusa.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -253,11 +253,11 @@ medusa.paymentCollections
___
#### authorizePaymentSessionsBatch
### authorizePaymentSessionsBatch
Authorize the Payment Sessions of a Payment Collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -270,7 +270,7 @@ medusa.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -312,7 +312,7 @@ medusa.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -502,11 +502,11 @@ medusa.paymentCollections
___
#### managePaymentSession
### managePaymentSession
Create a Payment Session for a payment provider in a Payment Collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -519,7 +519,7 @@ medusa.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -561,7 +561,7 @@ medusa.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -751,11 +751,11 @@ medusa.paymentCollections
___
#### managePaymentSessionsBatch
### managePaymentSessionsBatch
Create, update, or delete a list of payment sessions of a Payment Collections. If a payment session is not provided in the `sessions` array, it's deleted.
##### Example
#### Example
To add two new payment sessions:
@@ -801,7 +801,7 @@ medusa.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -871,7 +871,7 @@ medusa.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1061,11 +1061,11 @@ medusa.paymentCollections
___
#### refreshPaymentSession
### refreshPaymentSession
Refresh a Payment Session's data to ensure that it is in sync with the Payment Collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1077,7 +1077,7 @@ medusa.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1109,7 +1109,7 @@ medusa.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1263,11 +1263,11 @@ medusa.paymentCollections
___
#### retrieve
### retrieve
Retrieve a Payment Collection's details.
##### Example
#### Example
A simple example that retrieves a payment collection by its ID:
@@ -1297,7 +1297,7 @@ medusa.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1348,7 +1348,7 @@ medusa.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.mdx
+4 -4
View File
@@ -14,12 +14,12 @@ All methods in this class require [customer authentication](AuthResource.mdx#aut
## Methods
#### list
### list
Retrieve the logged-in customer's saved payment methods. This method only works with payment providers created with the deprecated Payment Service interface.
The payment methods are saved using the Payment Service's third-party service, and not on the Medusa backend. So, they're retrieved from the third-party service.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -30,7 +30,7 @@ medusa.customers.paymentMethods.list().then(({ payment_methods }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -44,7 +44,7 @@ medusa.customers.paymentMethods.list().then(({ payment_methods }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx
+8 -8
View File
@@ -23,12 +23,12 @@ Related Guide: [How to use product categories in a storefront](https://docs.medu
## Methods
#### list
### list
Retrieve a list of product categories. The product categories can be filtered by fields such as `handle` or `q` passed in the `query` parameter.
The product categories can also be paginated. This method can also be used to retrieve a product category by its handle.
##### Example
#### Example
To list product categories:
@@ -89,7 +89,7 @@ medusa.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -185,7 +185,7 @@ medusa.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -375,11 +375,11 @@ medusa.productCategories
___
#### retrieve
### retrieve
Retrieve a Product Category's details.
##### Example
#### Example
A simple example that retrieves a product category by its ID:
@@ -409,7 +409,7 @@ medusa.productCategories
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -460,7 +460,7 @@ medusa.productCategories
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ProductTagsResource.mdx
+4 -4
View File
@@ -15,11 +15,11 @@ Products can have more than one tag, and products can share tags.
## Methods
#### list
### list
Retrieve a list of product tags. The product tags can be filtered by fields such as `id` or `q` passed in the `query` parameter. The product tags can also be sorted or paginated.
##### Example
#### Example
To list product tags:
@@ -46,7 +46,7 @@ medusa.productTags
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -225,7 +225,7 @@ medusa.productTags
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ProductTypesResource.mdx
+4 -4
View File
@@ -15,11 +15,11 @@ Products can have more than one tag, and products can share types.
## Methods
#### list
### list
Retrieve a list of product types. The product types can be filtered by fields such as `value` or `q` passed in the `query` parameter. The product types can also be sorted or paginated.
##### Example
#### Example
To list product types:
@@ -48,7 +48,7 @@ medusa.productTypes
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -227,7 +227,7 @@ medusa.productTypes
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ProductVariantsResource.mdx
+8 -8
View File
@@ -14,7 +14,7 @@ Product variants are the actual salable item in your store. Each variant is a co
## Methods
#### list
### list
Retrieves a list of product variants. The product variants can be filtered by fields such as `id` or `title` passed in the `query` parameter. The product variants can also be paginated.
@@ -24,7 +24,7 @@ For accurate and correct pricing of the product variants based on the customer's
Passing `sales_channel_id` ensures retrieving only variants of products available in the specified sales channel.
You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`.
##### Example
#### Example
To list product variants:
@@ -69,7 +69,7 @@ medusa.product.variants
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -201,7 +201,7 @@ medusa.product.variants
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -591,7 +591,7 @@ medusa.product.variants
___
#### retrieve
### retrieve
Retrieve a Product Variant's details. For accurate and correct pricing of the product variant based on the customer's context, it's highly recommended to pass fields such as
`region_id`, `currency_code`, and `cart_id` when available.
@@ -599,7 +599,7 @@ Retrieve a Product Variant's details. For accurate and correct pricing of the pr
Passing `sales_channel_id` ensures retrieving only variants of products available in the current sales channel.
You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -610,7 +610,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -633,7 +633,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ProductsResource.mdx
+14 -12
View File
@@ -29,9 +29,11 @@ Related Guide: [How to show products in a storefront](https://docs.medusajs.com/
}
]} />
___
## Methods
#### list
### list
Retrieves a list of products. The products can be filtered by fields such as `id` or `q` passed in the `query` parameter. The products can also be sorted or paginated.
This method can also be used to retrieve a product by its handle.
@@ -42,7 +44,7 @@ For accurate and correct pricing of the products based on the customer's context
Passing `sales_channel_id` ensures retrieving only products available in the specified sales channel.
You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`.
##### Example
#### Example
To list products:
@@ -84,7 +86,7 @@ medusa.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -381,7 +383,7 @@ medusa.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -761,7 +763,7 @@ medusa.products
___
#### retrieve
### retrieve
Retrieve a Product's details. For accurate and correct pricing of the product based on the customer's context, it's highly recommended to pass fields such as
`region_id`, `currency_code`, and `cart_id` when available.
@@ -769,7 +771,7 @@ Retrieve a Product's details. For accurate and correct pricing of the product ba
Passing `sales_channel_id` ensures retrieving only products available in the current sales channel.
You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -779,7 +781,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -802,7 +804,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -1155,12 +1157,12 @@ medusa.products.retrieve(productId).then(({ product }) => {
___
#### search
### search
Run a search query on products using the search service installed on the Medusa backend. The searching is handled through the search service, so the returned data's
format depends on the search service you're using.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -1174,7 +1176,7 @@ medusa.products
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1234,7 +1236,7 @@ medusa.products
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/RegionsResource.mdx
+8 -8
View File
@@ -17,11 +17,11 @@ Related Guide: [How to use regions in a storefront](https://docs.medusajs.com/mo
## Methods
#### list
### list
Retrieve a list of regions. This method is useful to show the customer all available regions to choose from.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -31,7 +31,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -45,7 +45,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -281,11 +281,11 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => {
___
#### retrieve
### retrieve
Retrieve a Region's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -295,7 +295,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -318,7 +318,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.mdx
+8 -8
View File
@@ -14,11 +14,11 @@ Return reasons are key-value pairs that are used to specify why an order return
## Methods
#### list
### list
Retrieve a list of Return Reasons. This is useful when implementing a Create Return flow in the storefront.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -28,7 +28,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -42,7 +42,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -178,11 +178,11 @@ medusa.returnReasons.list().then(({ return_reasons }) => {
___
#### retrieve
### retrieve
Retrieve a Return Reason's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -192,7 +192,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -215,7 +215,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ReturnsResource.mdx
+4 -4
View File
@@ -16,11 +16,11 @@ Related Guide: [How to create a return in a storefront](https://docs.medusajs.co
## Methods
#### create
### create
Create a return for an order. If a return shipping method is specified, the return is automatically fulfilled.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -40,7 +40,7 @@ medusa.returns
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -138,7 +138,7 @@ medusa.returns
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.mdx
+8 -8
View File
@@ -16,11 +16,11 @@ Related Guide: [Shipping Option architecture](https://docs.medusajs.com/modules/
## Methods
#### list
### list
Retrieve a list of shipping options. The shipping options can be filtered using the `query` parameter.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -30,7 +30,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -81,7 +81,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -317,11 +317,11 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
___
#### listCartOptions
### listCartOptions
Retrieve a list of shipping options available for a cart.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -331,7 +331,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -354,7 +354,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/classes/SwapsResource.mdx
+8 -8
View File
@@ -17,7 +17,7 @@ Related Guide: [How to create a swap in a storefront](https://docs.medusajs.com/
## Methods
#### create
### create
Create a Swap for an Order. This will also create a return and associate it with the swap. If a return shipping option is specified, the return will automatically be fulfilled.
To complete the swap, you must use the [CartsResource.complete](CartsResource.mdx#complete) method passing it the ID of the swap's cart.
@@ -26,7 +26,7 @@ An idempotency key will be generated if none is provided in the header `Idempote
the response. If an error occurs during swap creation or the request is interrupted for any reason, the swap creation can be retried by passing the idempotency
key in the `Idempotency-Key` header.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -52,7 +52,7 @@ medusa.swaps
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -168,7 +168,7 @@ medusa.swaps
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -421,11 +421,11 @@ medusa.swaps
___
#### retrieveByCartId
### retrieveByCartId
Retrieve a Swap's details by the ID of its cart.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -435,7 +435,7 @@ medusa.swaps.retrieveByCartId(cartId).then(({ swap }) => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -458,7 +458,7 @@ medusa.swaps.retrieveByCartId(cartId).then(({ swap }) => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{