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