chore(docs): Generated References (#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions

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