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

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
@@ -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={[
{