asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
7a9740bad70893f5fb33e426c334e50d43b60a4e
medusa-store/docs/content/references/services/classes/ShippingProfileService.md
Shahed Nasser 6f1b49af03 chore: merge docs from master to develop (#3650) 
* Fix issue on fixed total amount discount when using includes tax (#3472)

The calculation of the fixed discount amount breaks when having includes_tax setting active, due to the line item totals are incorrect and returning everything as 0, thus the totalItemPercentage will be Infinitiy due to the division by a subtotal of 0

* chore: Add missing changeset for @medusajs/medusa

* feat(medusa): Improve performance of Products domain (#3417)

* feat(medusa): Improve product update performances

* fix tests and update

* update mock repo

* improve repo

* cleanup

* fix

* cleanup + bulk emit + unit test fix

* improvements

* improve

* fix unit tests

* fix export

* fix product update handler

* enhance mock repo

* fix import integration

* fix end point tests

* revert mock repo product variant

* fix unit

* cleanup

* cleanup

* address feedback

* fix quotes in tests

* address feedback

* Create new-tips-mate.md

* use types

* chore: Remove integration-tests from changeset

* chore(release): v1.7.14

* chore(docs): Generated Docs Announcement Bar (automated) (#3489)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* fix(medusa): EventBusService.emit using Redis mock (#3491)

* Fix eventBusService.emit using redis mock

* revert gitignore

* enqueuer

* unit test add redis_url

* fix test

* chore(docs): Generated Services Reference (automated) (#3490)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* docs: publish restructure (#3496)

* docs: added features and guides overview page

* added image

* added version 2

* added version 3

* added version 4

* docs: implemented new color scheme

* docs: redesigned sidebar (#3193)

* docs: redesigned navbar for restructure (#3199)

* docs: redesigned footer (#3209)

* docs: redesigned cards (#3230)

* docs: redesigned admonitions (#3231)

* docs: redesign announcement bar (#3236)

* docs: redesigned large cards (#3239)

* docs: redesigned code blocks (#3253)

* docs: redesigned search modal and page (#3264)

* docs: redesigned doc footer (#3268)

* docs: added new sidebars + refactored css and assets (#3279)

* docs: redesigned api reference sidebar

* docs: refactored css

* docs: added code tabs transition

* docs: added new sidebars

* removed unused assets

* remove unusued assets

* Fix deploy errors

* fix incorrect link

* docs: fixed code responsivity + missing icons (#3283)

* docs: changed icons (#3296)

* docs: design fixes to the sidebar (#3297)

* redesign fixes

* docs: small design fixes

* docs: several design fixes after restructure (#3299)

* docs: bordered icon fixes

* docs: desgin fixes

* fixes to code blocks and sidebar scroll

* design adjustments

* docs: restructured homepage (#3305)

* docs: restructured homepage

* design fixes

* fixed core concepts icon

* docs: added core concepts page (#3318)

* docs: restructured homepage

* design fixes

* docs: added core concepts page

* changed text of different components

* docs: added architecture link

* added missing prop for user guide

* docs: added regions overview page (#3327)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page (#3331)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page

* fix link

* resolve link issues

* docs: updated regions architecture image

* docs: second-iteration fixes (#3347)

* docs: redesigned document

* design fixes

* docs: added products overview page (#3354)

* docs: added carts overview page (#3363)

* docs: added orders overview (#3364)

* docs: added orders overview

* added links in overview

* docs: added vercel redirects

* docs: added soon badge for cards (#3389)

* docs: resolved feedback changes + organized troubleshooting pages (#3409)

* docs: resolved feedback changes

* added extra line

* docs: changed icons for restructure (#3421)

* docs: added taxes overview page (#3422)

* docs: added taxes overview page

* docs: fix sidebar label

* added link to taxes overview page

* fixed link

* docs: fixed sidebar scroll (#3429)

* docs: added discounts overview (#3432)

* docs: added discounts overview

* fixed links

* docs: added gift cards overview (#3433)

* docs: added price lists overview page (#3440)

* docs: added price lists overview page

* fixed links

* docs: added sales channels overview page (#3441)

* docs: added sales overview page

* fixed links

* docs: added users overview (#3443)

* docs: fixed sidebar border height (#3444)

* docs: fixed sidebar border height

* fixed svg markup

* docs: added possible solutions to feedback component (#3449)

* docs: added several overview pages + restructured files (#3463)

* docs: added several overview pages

* fixed links

* docs: added feature flags + PAK overview pages (#3464)

* docs: added feature flags + PAK overview pages

* fixed links

* fix link

* fix link

* fixed links colors

* docs: added strategies overview page (#3468)

* docs: automated upgrade guide (#3470)

* docs: automated upgrade guide

* fixed vercel redirect

* docs: restructured files in docs codebase (#3475)

* docs: restructured files

* docs: fixed eslint exception

* docs: finished restructure loose-ends (#3493)

* fixed uses of backend

* docs: finished loose ends

* eslint fixes

* fixed links

* merged master

* added update instructions for v1.7.12

* docs: fixed discount details (#3499)

* docs: fix trailing slash causing 404 (#3508)

* docs: fix error during navigation (#3509)

* docs: removed the gatsby storefront guide (#3527)

* docs: removed the gatsby storefront guide

* docs: fixed query value

* chore(docs): Removed Docs Announcement Bar (automated) (#3536)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity (#3539)

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity

* fix unit tests

* Create brave-seahorses-film.md

* docs: fix admin redirects (#3548)

* chore(release): v1.7.15

* chore(docs): Generated Docs Announcement Bar (automated) (#3550)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* chore(docs): Generated Services Reference (automated) (#3551)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore: updated READMEs of plugins (#3546)

* chore: updated READMEs of plugins

* added notice to plugins

* docs: added a deploy guide for next.js storefront (#3558)

* docs: added a deploy next.js guide

* docs: fix image zoom

* docs: fixes to next.js deployment guide to vercel (#3562)

* chore(workflows): Enable manual workflow in pre-release mode (#3566)

* chore(docs): Removed Docs Announcement Bar (automated) (#3598)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Rounding issues on line item adjustments (#3446)

* chores(medusa): Attempt to fix discount rounding issues

* add migration

* update entities

* apply multipler factor properly

* fix discount service

* WIP

* fix rounding issues in discounts

* fix some tests

* Exclude raw_discount_total from responses

* fix adjustments

* cleanup response

* fix

* fix draft order integration

* fix order integration

* fix order integration

* address feedback

* fix test

* Create .changeset/polite-llamas-sit.md

* remove comment

---------

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore(workflows): Add release notification (#3629)

---------

Co-authored-by: pepijn-vanvlaanderen <pepijn@webbers.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
Co-authored-by: Adrien de Peretti <adrien.deperetti@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-03-31 09:34:38 +02:00

14 KiB
Raw Blame History

Class: ShippingProfileService

Provides layer to manipulate profiles.

Implements

Hierarchy

  • TransactionBaseService

    ↳ ShippingProfileService

Constructors

constructor

• new ShippingProfileService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/shipping-profile.ts:48

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11

customShippingOptionService_

• Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

packages/medusa/src/services/shipping-profile.ts:40

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/shipping-profile.ts:45

productRepository_

• Protected Readonly productRepository_: typeof ProductRepository

Defined in

packages/medusa/src/services/shipping-profile.ts:43

productService_

• Protected Readonly productService_: ProductService

Defined in

packages/medusa/src/services/shipping-profile.ts:38

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

packages/medusa/src/services/shipping-profile.ts:39

shippingProfileRepository_

• Protected Readonly shippingProfileRepository_: typeof ShippingProfileRepository

Defined in

packages/medusa/src/services/shipping-profile.ts:42

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/shipping-profile.ts:46

Methods

addProduct

▸ addProduct(profileId, productId): Promise<ShippingProfile>

Adds a product of an array of products to the profile.

Parameters

Name Type Description
profileId string the profile to add the products to.
productId string | string[] the ID of the product or multiple products to add.

Returns

Promise<ShippingProfile>

the result of update

Defined in

packages/medusa/src/services/shipping-profile.ts:356

addShippingOption

▸ addShippingOption(profileId, optionId): Promise<ShippingProfile>

Adds a shipping option to the profile. The shipping option can be used to fulfill the products in the products field.

Parameters

Name Type Description
profileId string the profile to apply the shipping option to
optionId string | string[] the ID of the option or multiple options to add to the profile

Returns

Promise<ShippingProfile>

the result of the model update operation

Defined in

packages/medusa/src/services/shipping-profile.ts:386

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult> the transactional work to be done
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult> the isolation level to be used for the work.
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult> Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50

create

▸ create(profile): Promise<ShippingProfile>

Creates a new shipping profile.

Parameters

Name Type Description
profile CreateShippingProfile the shipping profile to create from

Returns

Promise<ShippingProfile>

the result of the create operation

Defined in

packages/medusa/src/services/shipping-profile.ts:250

createDefault

▸ createDefault(): Promise<ShippingProfile>

Creates a default shipping profile, if this does not already exist.

Returns

Promise<ShippingProfile>

the shipping profile

Defined in

packages/medusa/src/services/shipping-profile.ts:180

createGiftCardDefault

▸ createGiftCardDefault(): Promise<ShippingProfile>

Creates a default shipping profile, for gift cards if unless it already exists.

Returns

Promise<ShippingProfile>

the shipping profile

Defined in

packages/medusa/src/services/shipping-profile.ts:224

delete

▸ delete(profileId): Promise<void>

Deletes a profile with a given profile id.

Parameters

Name Type Description
profileId string the id of the profile to delete. Must be castable as an ObjectId

Returns

Promise<void>

the result of the delete operation.

Defined in

packages/medusa/src/services/shipping-profile.ts:331

fetchCartOptions

▸ fetchCartOptions(cart): Promise<ShippingOption[]>

Finds all the shipping profiles that cover the products in a cart, and validates all options that are available for the cart.

Parameters

Name Type Description
cart any the cart object to find shipping options for

Returns

Promise<ShippingOption[]>

a list of the available shipping options

Defined in

packages/medusa/src/services/shipping-profile.ts:416

fetchOptionsByProductIds

▸ fetchOptionsByProductIds(productIds, filter): Promise<ShippingOption[]>

Parameters

Name Type
productIds string[]
filter Selector<ShippingOption>

Returns

Promise<ShippingOption[]>

Defined in

packages/medusa/src/services/shipping-profile.ts:83

getProfilesInCart

▸ Protected getProfilesInCart(cart): string[]

Returns a list of all the productIds in the cart.

Parameters

Name Type Description
cart Cart the cart to extract products from

Returns

string[]

a list of product ids

Defined in

packages/medusa/src/services/shipping-profile.ts:482

list

▸ list(selector?, config?): Promise<ShippingProfile[]>

Parameters

Name Type Description
selector Selector<ShippingProfile> the query object for find
config FindConfig<ShippingProfile> the config object for find

Returns

Promise<ShippingProfile[]>

the result of the find operation

Defined in

packages/medusa/src/services/shipping-profile.ts:71

retrieve

▸ retrieve(profileId, options?): Promise<ShippingProfile>

Gets a profile by id. Throws in case of DB Error and if profile was not found.

Parameters

Name Type Description
profileId string the id of the profile to get.
options FindConfig<ShippingProfile> options opf the query.

Returns

Promise<ShippingProfile>

the profile document.

Defined in

packages/medusa/src/services/shipping-profile.ts:135

retrieveDefault

▸ retrieveDefault(): Promise<undefined | ShippingProfile>

Returns

Promise<undefined | ShippingProfile>

Defined in

packages/medusa/src/services/shipping-profile.ts:164

retrieveGiftCardDefault

▸ retrieveGiftCardDefault(): Promise<undefined | ShippingProfile>

Retrieves the default gift card profile

Returns

Promise<undefined | ShippingProfile>

the shipping profile for gift cards

Defined in

packages/medusa/src/services/shipping-profile.ts:207

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

update

▸ update(profileId, update): Promise<ShippingProfile>

Updates a profile. Metadata updates and product updates should use dedicated methods, e.g. setMetadata, addProduct, etc. The function will throw errors if metadata or product updates are attempted.

Parameters

Name Type Description
profileId string the id of the profile. Must be a string that can be casted to an ObjectId
update UpdateShippingProfile an object with the update values.

Returns

Promise<ShippingProfile>

resolves to the update result.

Defined in

packages/medusa/src/services/shipping-profile.ts:285

withTransaction

▸ withTransaction(transactionManager?): ShippingProfileService

Parameters

Name Type
transactionManager? EntityManager

Returns

ShippingProfileService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14

Reference in New Issue View Git Blame Copy Permalink