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

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