chore(docs): Generated Services Reference (automated) (#2993)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
olivermrbl
olivermrbl
parent
6dafb51547
commit
f521260a8f
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L47)
|
||||
[packages/medusa/src/services/fulfillment.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L50)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L42)
|
||||
[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L43)
|
||||
[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L45)
|
||||
[packages/medusa/src/services/fulfillment.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L40)
|
||||
[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,17 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L36)
|
||||
[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### productVariantInventoryService\_
|
||||
|
||||
• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](ProductVariantInventoryService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L41)
|
||||
[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +138,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L39)
|
||||
[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -138,7 +148,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L44)
|
||||
[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +162,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L37)
|
||||
[packages/medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L38)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -191,7 +201,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -217,13 +227,13 @@ the result of the save operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:260](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L260)
|
||||
[packages/medusa/src/services/fulfillment.ts:269](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L269)
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<`Fulfillment`[]\>
|
||||
▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`, `context?`): `Promise`<`Fulfillment`[]\>
|
||||
|
||||
Creates an order fulfillment
|
||||
If items needs to be fulfilled by different provider, we make
|
||||
@@ -237,6 +247,8 @@ those partitions.
|
||||
| `order` | `CreateFulfillmentOrder` | order to create fulfillment for |
|
||||
| `itemsToFulfill` | `FulFillmentItemType`[] | the items in the order to fulfill |
|
||||
| `custom` | `Partial`<`Fulfillment`\> | potential custom values to add |
|
||||
| `context` | `Object` | - |
|
||||
| `context.locationId?` | `string` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -246,7 +258,7 @@ the created fulfillments
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:205](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L205)
|
||||
[packages/medusa/src/services/fulfillment.ts:211](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L211)
|
||||
|
||||
___
|
||||
|
||||
@@ -273,7 +285,7 @@ the shipped fulfillment
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:310](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L310)
|
||||
[packages/medusa/src/services/fulfillment.ts:321](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L321)
|
||||
|
||||
___
|
||||
|
||||
@@ -298,7 +310,7 @@ the line items generated by the transformer.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L109)
|
||||
[packages/medusa/src/services/fulfillment.ts:115](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
@@ -319,7 +331,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L71)
|
||||
[packages/medusa/src/services/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -344,7 +356,7 @@ the fulfillment
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L166)
|
||||
[packages/medusa/src/services/fulfillment.ts:172](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L172)
|
||||
|
||||
___
|
||||
|
||||
@@ -368,7 +380,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -397,7 +409,7 @@ a line item that has the requested fulfillment quantity
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L134)
|
||||
[packages/medusa/src/services/fulfillment.ts:140](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/fulfillment.ts#L140)
|
||||
|
||||
___
|
||||
|
||||
@@ -421,4 +433,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
Reference in New Issue
Block a user