asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
dae8da1099bbe5fd3c59adc7fd2c28b41c0f71bc
medusa-store/docs/content/references/services/classes/ShippingOptionService.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

17 KiB
Raw Blame History

Class: ShippingOptionService

Provides layer to manipulate profiles.

Hierarchy

  • TransactionBaseService

    ↳ ShippingOptionService

Constructors

constructor

• new ShippingOptionService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/shipping-option.ts:55

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

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/src/services/shipping-option.ts:50

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/shipping-option.ts:52

methodRepository_

• Protected Readonly methodRepository_: typeof ShippingMethodRepository

Defined in

packages/medusa/src/services/shipping-option.ts:49

optionRepository_

• Protected Readonly optionRepository_: typeof ShippingOptionRepository

Defined in

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

providerService_

• Protected Readonly providerService_: FulfillmentProviderService

Defined in

packages/medusa/src/services/shipping-option.ts:44

regionService_

• Protected Readonly regionService_: RegionService

Defined in

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

requirementRepository_

• Protected Readonly requirementRepository_: typeof ShippingOptionRequirementRepository

Defined in

packages/medusa/src/services/shipping-option.ts:47

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/shipping-option.ts:53

Methods

addRequirement

▸ addRequirement(optionId, requirement): Promise<ShippingOption>

Adds a requirement to a shipping option. Only 1 requirement of each type is allowed.

Parameters

Name Type Description
optionId string the option to add the requirement to.
requirement ShippingOptionRequirement the requirement for the option.

Returns

Promise<ShippingOption>

the result of update

Defined in

packages/medusa/src/services/shipping-option.ts:713

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(data): Promise<ShippingOption>

Creates a new shipping option. Used both for outbound and inbound shipping options. The difference is registered by the is_return field which defaults to false.

Parameters

Name Type Description
data CreateShippingOptionInput the data to create shipping options

Returns

Promise<ShippingOption>

the result of the create operation

Defined in

packages/medusa/src/services/shipping-option.ts:451

createShippingMethod

▸ createShippingMethod(optionId, data, config): Promise<ShippingMethod>

Creates a shipping method for a given cart.

Parameters

Name Type Description
optionId string the id of the option to use for the method.
data Record<string, unknown> the optional provider data to use.
config CreateShippingMethodDto the cart to create the shipping method for.

Returns

Promise<ShippingMethod>

the resulting shipping method.

Defined in

packages/medusa/src/services/shipping-option.ts:278

delete

▸ delete(optionId): Promise<void | ShippingOption>

Deletes a profile with a given profile id.

Parameters

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

Returns

Promise<void | ShippingOption>

the result of the delete operation.

Defined in

packages/medusa/src/services/shipping-option.ts:691

deleteShippingMethods

▸ deleteShippingMethods(shippingMethods): Promise<ShippingMethod[]>

Removes a given shipping method

Parameters

Name Type Description
shippingMethods ShippingMethod | ShippingMethod[] the shipping method to remove

Returns

Promise<ShippingMethod[]>

removed shipping methods

Defined in

packages/medusa/src/services/shipping-option.ts:258

getPrice_

▸ getPrice_(option, data, cart): Promise<number>

Returns the amount to be paid for a shipping method. Will ask the fulfillment provider to calculate the price if the shipping option has the price type "calculated".

Parameters

Name Type Description
option ShippingOption the shipping option to retrieve the price for.
data Record<string, unknown> the shipping data to retrieve the price.
cart undefined | Cart | Order the context in which the price should be retrieved.

Returns

Promise<number>

the price of the shipping option.

Defined in

packages/medusa/src/services/shipping-option.ts:791

list

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

Parameters

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

Returns

Promise<ShippingOption[]>

the result of the find operation

Defined in

packages/medusa/src/services/shipping-option.ts:148

listAndCount

▸ listAndCount(selector, config?): Promise<[ShippingOption[], number]>

Parameters

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

Returns

Promise<[ShippingOption[], number]>

the result of the find operation

Defined in

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

removeRequirement

▸ removeRequirement(requirementId): Promise<void | ShippingOptionRequirement>

Removes a requirement from a shipping option

Parameters

Name Type Description
requirementId any the id of the requirement to remove

Returns

Promise<void | ShippingOptionRequirement>

the result of update

Defined in

packages/medusa/src/services/shipping-option.ts:742

retrieve

▸ retrieve(optionId, options?): Promise<ShippingOption>

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

Parameters

Name Type Description
optionId any the id of the profile to get.
options Object the options to get a profile
options.relations? string[] -
options.select? keyof ShippingOption[] -

Returns

Promise<ShippingOption>

the profile document.

Defined in

packages/medusa/src/services/shipping-option.ts:182

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(optionId, update): Promise<ShippingOption>

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

Parameters

Name Type Description
optionId string the id of the option. Must be a string that can be casted to an ObjectId
update UpdateShippingOptionInput an object with the update values.

Returns

Promise<ShippingOption>

resolves to the update result.

Defined in

packages/medusa/src/services/shipping-option.ts:579

updateShippingMethod

▸ updateShippingMethod(id, update): Promise<undefined | ShippingMethod>

Updates a shipping method's associations. Useful when a cart is completed and its methods should be copied to an order/swap entity.

Parameters

Name Type Description
id string the id of the shipping method to update
update ShippingMethodUpdate the values to update the method with

Returns

Promise<undefined | ShippingMethod>

the resulting shipping method

Defined in

packages/medusa/src/services/shipping-option.ts:229

updateShippingProfile

▸ updateShippingProfile(optionIds, profileId): Promise<ShippingOption[]>

Parameters

Name Type Description
optionIds string | string[] ID or IDs of the shipping options to update
profileId string Shipping profile ID to update the shipping options with

Returns

Promise<ShippingOption[]>

updated shipping options

Defined in

packages/medusa/src/services/shipping-option.ts:767

validateAndMutatePrice

▸ Private validateAndMutatePrice(option, priceInput): Promise<CreateShippingOptionInput | Omit<ShippingOption, "beforeInsert">>

Parameters

Name Type
option ShippingOption | CreateShippingOptionInput
priceInput ValidatePriceTypeAndAmountInput

Returns

Promise<CreateShippingOptionInput | Omit<ShippingOption, "beforeInsert">>

Defined in

packages/medusa/src/services/shipping-option.ts:408

validateCartOption

▸ validateCartOption(option, cart): Promise<null | ShippingOption>

Checks if a given option id is a valid option for a cart. If it is the option is returned with the correct price. Throws when region_ids do not match, or when the shipping option requirements are not satisfied.

Parameters

Name Type Description
option ShippingOption the option object to check
cart Cart the cart object to check against

Returns

Promise<null | ShippingOption>

the validated shipping option

Defined in

packages/medusa/src/services/shipping-option.ts:366

validatePriceType_

▸ validatePriceType_(priceType, option): Promise<ShippingOptionPriceType>

Validates a shipping option price

Parameters

Name Type Description
priceType ShippingOptionPriceType the price to validate
option ShippingOption the option to validate against

Returns

Promise<ShippingOptionPriceType>

the validated price

Defined in

packages/medusa/src/services/shipping-option.ts:539

validateRequirement_

▸ validateRequirement_(requirement, optionId?): Promise<ShippingOptionRequirement>

Validates a requirement

Parameters

Name Type Default value Description
requirement ShippingOptionRequirement undefined the requirement to validate
optionId undefined | string undefined the id to validate the requirement

Returns

Promise<ShippingOptionRequirement>

a validated shipping requirement

Defined in

packages/medusa/src/services/shipping-option.ts:82

withTransaction

▸ withTransaction(transactionManager?): ShippingOptionService

Parameters

Name Type
transactionManager? EntityManager

Returns

ShippingOptionService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

Reference in New Issue View Git Blame Copy Permalink