Files
medusa-store/www/apps/docs/content/references/services/index.md
Shahed Nasser c6dff873de docs: update docusaurus to v3 (#5625)
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
2023-11-13 20:11:50 +02:00

44 KiB

displayed_sidebar
displayed_sidebar
servicesSidebar

import ParameterTypes from "@site/src/components/ParameterTypes"

Services Reference

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Enumeration Members

DEFAULT

DEFAULT: "default"


EXTERNAL

EXTERNAL: "external"


INTERNAL

INTERNAL: "internal"


ORDER_EDIT

ORDER_EDIT: "order_edit"

The payment collection is used for an order edit.

Variables

AddressRepository

Const AddressRepository: Repository<Address>


AnalyticsConfigRepository

Const AnalyticsConfigRepository: Repository<AnalyticsConfig>


BatchJobRepository

Const BatchJobRepository: Repository<BatchJob>


Buffer

Buffer: BufferConstructor


CartRepository

Const CartRepository: Repository<Cart> & { findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }


ClaimRepository

Const ClaimRepository: Repository<ClaimOrder>


CountryRepository

Const CountryRepository: Repository<Country>


CurrencyRepository

Const CurrencyRepository: Repository<Currency>


CustomShippingOptionRepository

Const CustomShippingOptionRepository: Repository<CustomShippingOption>


CustomerGroupRepository

Const CustomerGroupRepository: Repository<CustomerGroup> & { addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }


CustomerRepository

Const CustomerRepository: Repository<Customer> & { listAndCount: Method listAndCount }


DiscountConditionRepository

Const DiscountConditionRepository: Repository<DiscountCondition> & { addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }


DraftOrderRepository

Const DraftOrderRepository: Repository<DraftOrder>


FulfillmentProviderRepository

Const FulfillmentProviderRepository: Repository<FulfillmentProvider>


FulfillmentRepository

Const FulfillmentRepository: Repository<Fulfillment>


GiftCardRepository

Const GiftCardRepository: Repository<GiftCard> & { listGiftCardsAndCount: Method listGiftCardsAndCount }


GiftCardTransactionRepository

Const GiftCardTransactionRepository: Repository<GiftCardTransaction>


IdempotencyKeyRepository

Const IdempotencyKeyRepository: Repository<IdempotencyKey>


ImageRepository

Const ImageRepository: Repository<Image> & { insertBulk: Method insertBulk ; upsertImages: Method upsertImages }


LineItemAdjustmentRepository

Const LineItemAdjustmentRepository: Repository<LineItemAdjustment>


LineItemRepository

Const LineItemRepository: Repository<LineItem> & { findByReturn: Method findByReturn }


LineItemTaxLineRepository

Const LineItemTaxLineRepository: Repository<LineItemTaxLine> & { deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }


MoneyAmountRepository

Const MoneyAmountRepository: Repository<MoneyAmount> & { addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }


NoteRepository

Const NoteRepository: Repository<Note>


NotificationProviderRepository

Const NotificationProviderRepository: Repository<NotificationProvider>


NotificationRepository

Const NotificationRepository: Repository<Notification>


OauthRepository

Const OauthRepository: Repository<Oauth>


OrderEditRepository

Const OrderEditRepository: Repository<OrderEdit>


OrderItemChangeRepository

Const OrderItemChangeRepository: Repository<OrderItemChange>


OrderRepository

Const OrderRepository: Repository<Order> & { findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }


PaymentCollectionRepository

Const PaymentCollectionRepository: Repository<PaymentCollection> & { getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId }


PaymentProviderRepository

Const PaymentProviderRepository: Repository<PaymentProvider>


PaymentRepository

Const PaymentRepository: Repository<Payment>


PaymentSessionRepository

Const PaymentSessionRepository: Repository<PaymentSession>


PriceListRepository

Const PriceListRepository: Repository<PriceList> & { listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }


PriceType

PriceType: Object

Type declaration

<ParameterTypes parameters={[ { "name": "DEFAULT", "type": "DEFAULT", "description": "", "optional": false, "defaultValue": ""default"", "expandable": false, "children": [] }, { "name": "OVERRIDE", "type": "OVERRIDE", "description": "", "optional": false, "defaultValue": ""override"", "expandable": false, "children": [] }, { "name": "SALE", "type": "SALE", "description": "", "optional": false, "defaultValue": ""sale"", "expandable": false, "children": [] } ]} />


ProductCategoryRepository

Const ProductCategoryRepository: TreeRepository<ProductCategory> & { addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }


ProductCollectionRepository

Const ProductCollectionRepository: Repository<ProductCollection> & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }


ProductOptionRepository

Const ProductOptionRepository: Repository<ProductOption>


ProductRepository

Const ProductRepository: Repository<Product> & { _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }


ProductTagRepository

Const ProductTagRepository: Repository<ProductTag> & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }


ProductTypeRepository

Const ProductTypeRepository: Repository<ProductType> & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }


ProductVariantRepository

Const ProductVariantRepository: Repository<ProductVariant>


RefundRepository

Const RefundRepository: Repository<Refund>


RegionRepository

Const RegionRepository: Repository<Region>


ReturnItemRepository

Const ReturnItemRepository: Repository<ReturnItem>


ReturnReasonRepository

Const ReturnReasonRepository: Repository<ReturnReason>


ReturnRepository

Const ReturnRepository: Repository<Return>


SalesChannelRepository

Const SalesChannelRepository: Repository<SalesChannel> & { addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }


SharedArrayBuffer

SharedArrayBuffer: SharedArrayBufferConstructor


ShippingMethodRepository

Const ShippingMethodRepository: Repository<ShippingMethod>


ShippingOptionRepository

Const ShippingOptionRepository: Repository<ShippingOption> & { upsertShippingProfile: Method upsertShippingProfile }


ShippingOptionRequirementRepository

Const ShippingOptionRequirementRepository: Repository<ShippingOptionRequirement>


ShippingProfileRepository

Const ShippingProfileRepository: Repository<ShippingProfile> & { findByProducts: Method findByProducts }


StagedJobRepository

Const StagedJobRepository: Repository<StagedJob> & { insertBulk: Method insertBulk }


StoreRepository

Const StoreRepository: Repository<Store>


SwapRepository

Const SwapRepository: Repository<Swap>


TaxProviderRepository

Const TaxProviderRepository: Repository<TaxProvider>


TrackingLinkRepository

Const TrackingLinkRepository: Repository<TrackingLink>


UserRepository

Const UserRepository: Repository<User>

Functions

Boolean

**Boolean**<TypeParameter T>(value?): boolean

<ParameterTypes parameters={[ { "name": "T", "type": "object", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ]} />

Parameters

<ParameterTypes parameters={[ { "name": "value", "type": "T", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ]} />

Returns

boolean

<ParameterTypes parameters={[ { "name": "boolean", "type": "boolean", "optional": true, "defaultValue": "", "description": "", "expandable": false, "children": [] } ]} />