asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated Services Reference (automated) (#2663)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-28 11:02:51 +02:00
committed by GitHub
parent d9f9d7ac28
commit 6aee2e2265
54 changed files with 2320 additions and 1474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

230
docs/content/references/services/classes/CartService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L121)
[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L129)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:98](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L98)
[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L105)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:97](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L97)
[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L104)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L116)
[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L124)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L109)
[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L116)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L111)
[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L118)
___
@@ -112,7 +112,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L101)
[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L108)
___
@@ -122,7 +122,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L119)
[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L127)
___
@@ -132,7 +132,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L112)
[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L119)
___
@@ -142,7 +142,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L115)
[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L123)
___
@@ -152,7 +152,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L118)
[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L126)
___
@@ -162,7 +162,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L100)
[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L107)
___
@@ -172,7 +172,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L107)
[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L114)
___
@@ -186,7 +186,17 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/cart.ts:93](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L93)
[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L100)
___
### newTotalsService\_
• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](NewTotalsService.md)
#### Defined in
[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L122)
___
@@ -196,7 +206,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L108)
[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L115)
___
@@ -206,7 +216,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:99](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L99)
[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L106)
___
@@ -216,7 +226,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L117)
[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L125)
___
@@ -226,7 +236,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L103)
[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L110)
___
@@ -236,7 +246,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L102)
[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L109)
___
@@ -246,7 +256,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L106)
[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L113)
___
@@ -256,7 +266,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L105)
[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L112)
___
@@ -266,7 +276,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:96](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L96)
[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L103)
___
@@ -276,7 +286,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L110)
[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L117)
___
@@ -286,7 +296,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L104)
[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L111)
___
@@ -296,7 +306,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L113)
[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L120)
___
@@ -306,7 +316,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L114)
[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L121)
___
@@ -320,7 +330,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/cart.ts:94](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L94)
[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L101)
___
@@ -338,13 +348,13 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:87](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L87)
[packages/medusa/src/services/cart.ts:94](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L94)
## Methods
### addLineItem
▸ **addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`Cart`\>
▸ **addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`void`\>
Adds a line item to the cart.
@@ -359,13 +369,13 @@ Adds a line item to the cart.
#### Returns
`Promise`<`Cart`\>
`Promise`<`void`\>
the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:682](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L682)
[packages/medusa/src/services/cart.ts:587](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L587)
___
@@ -395,7 +405,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1743](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1743)
[packages/medusa/src/services/cart.ts:1642](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1642)
___
@@ -423,7 +433,7 @@ void
#### Defined in
[packages/medusa/src/services/cart.ts:849](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L849)
[packages/medusa/src/services/cart.ts:749](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L749)
___
@@ -451,7 +461,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1268](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1268)
[packages/medusa/src/services/cart.ts:1170](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1170)
___
@@ -472,7 +482,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:1232](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1232)
[packages/medusa/src/services/cart.ts:1134](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1134)
___
@@ -511,7 +521,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
___
@@ -530,7 +540,7 @@ set the payment on the cart.
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to authorize payment for |
| `context` | `Record`<`string`, `unknown`\> | object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling. |
| `context` | `Record`<`string`, `unknown`\> & { `cart_id`: `string` } | object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling. |
#### Returns
@@ -540,7 +550,7 @@ the resulting cart
#### Defined in
[packages/medusa/src/services/cart.ts:1414](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1414)
[packages/medusa/src/services/cart.ts:1316](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1316)
___
@@ -564,7 +574,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/cart.ts:400](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L400)
[packages/medusa/src/services/cart.ts:305](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L305)
___
@@ -588,48 +598,48 @@ the resultign customer object
#### Defined in
[packages/medusa/src/services/cart.ts:1117](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1117)
[packages/medusa/src/services/cart.ts:1019](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1019)
___
### createTaxLines
▸ **createTaxLines**(`id`): `Promise`<`Cart`\>
▸ **createTaxLines**(`cartOrId`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `cartOrId` | `string` \| `Cart` |
#### Returns
`Promise`<`Cart`\>
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/cart.ts:2150](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L2150)
[packages/medusa/src/services/cart.ts:2049](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2049)
___
### decorateTotals
▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<`Cart`\>
▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<`WithRequiredProperty`<`Cart`, ``"total"``\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `cart` | `Cart` |
| `totalsConfig?` | `TotalsConfig` |
| `totalsConfig` | `TotalsConfig` |
#### Returns
`Promise`<`Cart`\>
`Promise`<`WithRequiredProperty`<`Cart`, ``"total"``\>\>
#### Defined in
[packages/medusa/src/services/cart.ts:2200](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L2200)
[packages/medusa/src/services/cart.ts:2099](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2099)
___
@@ -637,6 +647,10 @@ ___
▸ `Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<`Cart`\>
**`Deprecated`**
Use decorateTotals instead
#### Parameters
| Name | Type |
@@ -651,7 +665,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:247](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L247)
[packages/medusa/src/services/cart.ts:2271](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2271)
___
@@ -675,7 +689,7 @@ the deleted cart or undefined if the cart was not found.
#### Defined in
[packages/medusa/src/services/cart.ts:2065](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L2065)
[packages/medusa/src/services/cart.ts:1964](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1964)
___
@@ -700,7 +714,7 @@ the resulting cart.
#### Defined in
[packages/medusa/src/services/cart.ts:1651](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1651)
[packages/medusa/src/services/cart.ts:1550](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1550)
___
@@ -720,7 +734,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:2181](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L2181)
[packages/medusa/src/services/cart.ts:2080](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2080)
___
@@ -746,7 +760,7 @@ custom shipping option
#### Defined in
[packages/medusa/src/services/cart.ts:1851](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1851)
[packages/medusa/src/services/cart.ts:1750](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1750)
___
@@ -766,7 +780,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:178](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L178)
[packages/medusa/src/services/cart.ts:2322](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2322)
___
@@ -786,7 +800,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:522](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L522)
[packages/medusa/src/services/cart.ts:427](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L427)
___
@@ -809,7 +823,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/cart.ts:303](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L303)
[packages/medusa/src/services/cart.ts:193](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L193)
___
@@ -834,7 +848,7 @@ void
#### Defined in
[packages/medusa/src/services/cart.ts:1063](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1063)
[packages/medusa/src/services/cart.ts:965](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L965)
___
@@ -854,7 +868,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:2271](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L2271)
[packages/medusa/src/services/cart.ts:2193](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2193)
___
@@ -879,7 +893,7 @@ the resulting cart.
#### Defined in
[packages/medusa/src/services/cart.ts:1699](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1699)
[packages/medusa/src/services/cart.ts:1598](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1598)
___
@@ -904,7 +918,7 @@ the resulting cart
#### Defined in
[packages/medusa/src/services/cart.ts:1328](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1328)
[packages/medusa/src/services/cart.ts:1230](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1230)
___
@@ -929,7 +943,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:554](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L554)
[packages/medusa/src/services/cart.ts:459](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L459)
___
@@ -945,7 +959,7 @@ Gets a cart by id.
| :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to get. |
| `options` | `FindConfig`<`Cart`\> | the options to get a cart |
| `totalsConfig` | `TotalsConfig` | - |
| `totalsConfig` | `TotalsConfig` | |
#### Returns
@@ -955,34 +969,15 @@ the cart document.
#### Defined in
[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L320)
[packages/medusa/src/services/cart.ts:211](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L211)
___
### retrieveNew
### retrieveLegacy
▸ `Private` **retrieveNew**(`cartId`, `options?`): `Promise`<`Cart`\>
▸ `Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`Cart`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `cartId` | `string` |
| `options` | `FindConfig`<`Cart`\> |
#### Returns
`Promise`<`Cart`\>
#### Defined in
[packages/medusa/src/services/cart.ts:352](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L352)
___
### retrieveWithTotals
▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`Cart`\>
**`Deprecated`**
#### Parameters
@@ -998,7 +993,29 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:380](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L380)
[packages/medusa/src/services/cart.ts:253](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L253)
___
### retrieveWithTotals
▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`WithRequiredProperty`<`Cart`, ``"total"``\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `cartId` | `string` |
| `options` | `FindConfig`<`Cart`\> |
| `totalsConfig` | `TotalsConfig` |
#### Returns
`Promise`<`WithRequiredProperty`<`Cart`, ``"total"``\>\>
#### Defined in
[packages/medusa/src/services/cart.ts:285](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L285)
___
@@ -1026,7 +1043,7 @@ resolves to the updated result.
#### Defined in
[packages/medusa/src/services/cart.ts:2108](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L2108)
[packages/medusa/src/services/cart.ts:2007](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2007)
___
@@ -1051,7 +1068,7 @@ result of update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1485](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1485)
[packages/medusa/src/services/cart.ts:1391](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1391)
___
@@ -1079,7 +1096,7 @@ the result of the update operation.
#### Defined in
[packages/medusa/src/services/cart.ts:1551](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1551)
[packages/medusa/src/services/cart.ts:1457](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1457)
___
@@ -1105,7 +1122,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1931](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1931)
[packages/medusa/src/services/cart.ts:1830](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1830)
___
@@ -1129,7 +1146,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
___
@@ -1149,7 +1166,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:196](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L196)
[packages/medusa/src/services/cart.ts:2213](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2213)
___
@@ -1170,7 +1187,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:892](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L892)
[packages/medusa/src/services/cart.ts:792](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L792)
___
@@ -1196,7 +1213,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1143](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1143)
[packages/medusa/src/services/cart.ts:1045](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1045)
___
@@ -1221,7 +1238,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1099](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1099)
[packages/medusa/src/services/cart.ts:1001](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1001)
___
@@ -1247,7 +1264,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:784](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L784)
[packages/medusa/src/services/cart.ts:684](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L684)
___
@@ -1272,7 +1289,7 @@ the resulting cart
#### Defined in
[packages/medusa/src/services/cart.ts:1376](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1376)
[packages/medusa/src/services/cart.ts:1278](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1278)
___
@@ -1298,7 +1315,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1183](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1183)
[packages/medusa/src/services/cart.ts:1085](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1085)
___
@@ -1320,13 +1337,13 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:1870](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L1870)
[packages/medusa/src/services/cart.ts:1769](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1769)
___
### validateLineItem
▸ `Protected` **validateLineItem**(`cart`, `lineItem`): `Promise`<`boolean`\>
▸ `Protected` **validateLineItem**(`sales_channel_id`, `lineItem`): `Promise`<`boolean`\>
Check if line item's variant belongs to the cart's sales channel.
@@ -1334,7 +1351,8 @@ Check if line item's variant belongs to the cart's sales channel.
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart` | `Cart` | the cart for the line item |
| `sales_channel_id` | `Object` | the cart for the line item |
| `sales_channel_id.sales_channel_id` | ``null`` \| `string` | - |
| `lineItem` | `LineItem` | the line item being added |
#### Returns
@@ -1345,7 +1363,7 @@ a boolean indicating validation result
#### Defined in
[packages/medusa/src/services/cart.ts:651](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L651)
[packages/medusa/src/services/cart.ts:556](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L556)
___
@@ -1372,7 +1390,7 @@ boolean representing whether shipping method is validated
#### Defined in
[packages/medusa/src/services/cart.ts:620](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/cart.ts#L620)
[packages/medusa/src/services/cart.ts:525](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L525)
___
@@ -1396,4 +1414,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)