Services Reference
Namespaces
Enumerations
- AllocationType
- BatchJobStatus
- CartType
- ClaimFulfillmentStatus
- ClaimPaymentStatus
- ClaimReason
- ClaimType
- DefaultPriceType
- DiscountConditionJoinTableForeignKey
- DiscountConditionOperator
- DiscountConditionType
- DiscountRuleType
- DraftOrderStatus
- FulfillmentStatus
- FulfillmentStatus
- MODULE_RESOURCE_TYPE
- OrderEditItemChangeType
- OrderEditStatus
- OrderStatus
- OrderStatus
- PaymentCollectionStatus
- PaymentCollectionType
- PaymentSessionStatus
- PaymentStatus
- PaymentStatus
- PriceListStatus
- PriceListType
- ProductStatus
- RequirementType
- ReturnStatus
- ShippingOptionPriceType
- ShippingProfileType
- SwapFulfillmentStatus
- SwapPaymentStatus
- UserRoles
Classes
- AbstractBatchJobStrategy
- AbstractEventBusModuleService
- AbstractNotificationService
- AbstractPaymentProcessor
- AbstractPaymentService
- AbstractSearchService
- Address
- AddressCreatePayload
- AddressPayload
- AdminGetDiscountsDiscountRuleParams
- AdminPriceListPricesCreateReq
- AdminPriceListPricesUpdateReq
- AnalyticsConfig
- AnalyticsConfigService
- AuthService
- BaseEntity
- BatchJob
- BatchJobService
- Cart
- CartService
- ClaimImage
- ClaimItem
- ClaimItemService
- ClaimOrder
- ClaimService
- ClaimTag
- Country
- Currency
- CurrencyService
- CustomShippingOption
- CustomShippingOptionService
- Customer
- CustomerGroup
- CustomerGroupService
- CustomerGroupUpdate
- CustomerService
- DateComparisonOperator
- Discount
- Discount
- DiscountCondition
- DiscountConditionCustomerGroup
- DiscountConditionProduct
- DiscountConditionProductCollection
- DiscountConditionProductTag
- DiscountConditionProductType
- DiscountConditionService
- DiscountRule
- DiscountService
- DraftOrder
- DraftOrderService
- EventBusService
- FilterableBatchJobProps
- FilterableCartProps
- FilterableDiscountProps
- FilterableLineItemAdjustmentProps
- FilterablePriceListProps
- FilterableProductProps
- FilterableProductVariantProps
- FlagRouter
- Fulfillment
- FulfillmentItem
- FulfillmentProvider
- FulfillmentProviderService
- FulfillmentService
- GiftCard
- GiftCard
- GiftCardService
- GiftCardTransaction
- IdempotencyKey
- IdempotencyKeyService
- Image
- LineItem
- LineItemAdjustment
- LineItemAdjustmentService
- LineItemService
- LineItemTaxLine
- MiddlewareService
- MoneyAmount
- NewTotalsService
- Note
- NoteService
- Notification
- NotificationProvider
- NotificationService
- NumericalComparisonOperator
- Oauth
- OauthService
- Order
- OrderEdit
- OrderEditItemChangeService
- OrderEditService
- OrderItemChange
- OrderService
- OrdersReturnItem
- Payment
- PaymentCollection
- PaymentCollectionService
- PaymentProvider
- PaymentProviderService
- PaymentService
- PaymentSession
- PriceList
- PriceListService
- PricingService
- Product
- ProductCategory
- ProductCategoryService
- ProductCollection
- ProductCollectionService
- ProductOption
- ProductOptionValue
- ProductService
- ProductTag
- ProductTaxRate
- ProductType
- ProductTypeService
- ProductTypeTaxRate
- ProductVariant
- ProductVariantInventoryItem
- ProductVariantInventoryService
- ProductVariantService
- Refund
- Region
- RegionService
- Return
- ReturnItem
- ReturnReason
- ReturnReasonService
- ReturnService
- SalesChannel
- SalesChannelInventoryService
- SalesChannelLocation
- SalesChannelLocationService
- SalesChannelService
- SearchService
- ShippingMethod
- ShippingMethodTaxLine
- ShippingOption
- ShippingOptionRequirement
- ShippingOptionService
- ShippingProfile
- ShippingProfileService
- ShippingTaxRate
- SoftDeletableEntity
- StagedJob
- StagedJobService
- Store
- StorePostCustomersCustomerAddressesAddressReq
- StoreService
- StrategyResolverService
- StringComparisonOperator
- Swap
- SwapService
- SystemPaymentProviderService
- TaxLine
- TaxProvider
- TaxProviderService
- TaxRate
- TaxRateService
- TokenService
- TotalsService
- TrackingLink
- TransactionBaseService
- User
- UserService
Interfaces
- AddPricesDTO
- AddRulesDTO
- ArrayLike
- BaseFilterable
- Boolean
- Buffer
- BufferConstructor
- CalculatedPriceSetDTO
- Context
- CreateCurrencyDTO
- CreateMoneyAmountDTO
- CreateNoteInput
- CreatePriceRuleDTO
- CreatePriceSetDTO
- CreatePriceSetMoneyAmountRulesDTO
- CreatePricesDTO
- CreateRuleTypeDTO
- CreateUserInput
- CurrencyDTO
- FilterableCurrencyProps
- FilterableMoneyAmountProps
- FilterablePriceRuleProps
- FilterablePriceSetMoneyAmountProps
- FilterablePriceSetMoneyAmountRulesProps
- FilterablePriceSetProps
- FilterableRuleTypeProps
- FindConfig
- FindConfig
- IBatchJobStrategy
- ICacheService
- IEventBusModuleService
- IEventBusService
- IFlagRouter
- IInventoryService
- INotificationService
- IPriceSelectionStrategy
- IPricingModuleService
- ISearchService
- IStockLocationService
- ITaxCalculationStrategy
- ITaxService
- ITransactionBaseService
- IterableIterator
- Iterator
- IteratorReturnResult
- IteratorYieldResult
- JoinerArgument
- JoinerDirective
- JoinerServiceConfig
- JoinerServiceConfigAlias
- Logger
- MoneyAmountDTO
- NumericalComparisonOperator
- PaymentProcessor
- PaymentProcessorError
- PriceRuleDTO
- PriceSetDTO
- PriceSetMoneyAmountDTO
- PriceSetMoneyAmountRulesDTO
- PricingContext
- PricingFilters
- RemoteJoinerQuery
- RemovePriceSetRulesDTO
- RuleTypeDTO
- SharedArrayBuffer
- SharedArrayBufferConstructor
- StringComparisonOperator
- UpdateCurrencyDTO
- UpdateMoneyAmountDTO
- UpdatePriceRuleDTO
- UpdatePriceSetDTO
- UpdatePriceSetMoneyAmountRulesDTO
- UpdateRuleTypeDTO
- UpdateUserInput
Type Aliases
- AddOrderEditLineItemInput
- AdjustmentContext
- AllocationMapOptions
- ArrayBufferLike
- ArrayBufferView
- AuthenticateResult
- AvailabilityContext
- BatchJobCreateProps
- BatchJobResultError
- BatchJobResultStatDescriptor
- BufferEncoding
- CalculateOptionPriceInput
- CalculationContextData
- CalculationContextOptions
- CartCreateProps
- CartUpdateProps
- CategoryQueryParams
- ClaimTypeValue
- ConfigModule
- ConfigModule
- CreateAnalyticsConfig
- CreateBatchJobInput
- CreateClaimInput
- CreateClaimItemAdditionalItemInput
- CreateClaimItemInput
- CreateClaimReturnShippingInput
- CreateClaimShippingMethodInput
- CreateCustomShippingOptionInput
- CreateCustomerInput
- CreateDiscountInput
- CreateDiscountRuleInput
- CreateDynamicDiscountInput
- CreateFulfillmentOrder
- CreateGiftCardInput
- CreateGiftCardTransactionInput
- CreateIdempotencyKeyInput
- CreateInventoryItemInput
- CreateInventoryLevelInput
- CreateOauthInput
- CreateOrderEditInput
- CreateOrderEditItemChangeInput
- CreatePaymentCollectionInput
- CreatePaymentInput
- CreatePriceListInput
- CreateProductCategoryInput
- CreateProductCollection
- CreateProductInput
- CreateProductProductCategoryInput
- CreateProductProductOption
- CreateProductProductSalesChannelInput
- CreateProductProductTagInput
- CreateProductProductTypeInput
- CreateProductProductVariantInput
- CreateProductProductVariantPriceInput
- CreateProductVariantInput
- CreateRegionInput
- CreateReservationItemInput
- CreateReturnInput
- CreateReturnReason
- CreateReturnType
- CreateSalesChannelInput
- CreateShipmentConfig
- CreateShippingMethod
- CreateShippingMethodDto
- CreateShippingOptionInput
- CreateShippingProfile
- CreateStockLocationInput
- CreateTaxRateInput
- CustomerGroupConstructorProps
- Data
- DefaultWithoutRelations
- DefaultWithoutRelations
- Discount
- DiscountAllocation
- DiscountConditionInput
- DiscountConditionResourceType
- DraftOrderCreateProps
- EmitData
- Exclude
- ExtendedFindConfig
- ExtendedFindConfig
- ExternalModuleDeclaration
- FeatureFlagsResponse
- FilterableInventoryItemProps
- FilterableInventoryLevelProps
- FilterableReservationItemProps
- FilterableStockLocationProps
- FilterableTaxRateProps
- FilterableUserProps
- FindProductConfig
- FindWithRelationsOptions
- FindWithoutRelationsOptions
- FindWithoutRelationsOptions
- FulFillmentItemType
- FulfillmentItemPartition
- FulfillmentOptions
- FulfillmentProviderContainer
- FulfillmentProviderKey
- GenerateInputData
- GenerateLineItemContext
- GeneratedAdjustment
- GetLineItemTotalOptions
- GetRegionPriceContext
- GetShippingMethodTotalsOptions
- GetTotalsOptions
- GiftCardAllocation
- GiftCardTransaction
- HttpCompressionOptions
- IdempotencyCallbackResult
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedDependencies
- InjectedProps
- InternalModuleDeclaration
- InventoryItemDTO
- InventoryLevelDTO
- Item
- ItemTaxCalculationLine
- IteratorResult
- JoinerRelationship
- LineAllocationsMap
- LineDiscount
- LineDiscountAmount
- LineItemAdjustmentServiceProps
- LineItemTotals
- LineItemTotals
- LineItemTotalsOptions
- LineItemUpdate
- LineItemValidateData
- ListAndCountSelector
- Logger
- MedusaContainer
- MedusaContainer
- ModuleDefinition
- ModuleJoinerConfig
- ModuleJoinerRelationship
- Omit
- OrdersReturnItem
- Partial
- PartialPick
- PaymentCollectionsSessionsBatchInput
- PaymentCollectionsSessionsInput
- PaymentContext
- PaymentDataInput
- PaymentProcessorContext
- PaymentProcessorSessionResponse
- PaymentProviderKey
- PaymentSessionInput
- PaymentSessionResponse
- Pick
- Price
- PriceListConstructorProps
- PriceListLoadConfig
- PriceListPriceCreateInput
- PriceListPriceUpdateInput
- PriceSelectionContext
- PriceSelectionResult
- PriceType
- PricedProduct
- PricedShippingOption
- PricedVariant
- PricingContext
- ProductCategoryInput
- ProductOptionInput
- ProductSelector
- ProductVariantOption
- ProductVariantPrice
- ProductVariantPricing
- ProjectConfigOptions
- ProviderLineItemTaxLine
- ProviderShippingMethodTaxLine
- ProviderTaxLine
- QuerySelector
- Record
- RegionDetails
- RemoteQueryFunction
- ReorderConditions
- Required
- ReservationItemDTO
- ReserveQuantityContext
- ReturnedData
- Selector
- SessionOptions
- SharedContext
- ShippingMethod
- ShippingMethodTotals
- ShippingMethodTotals
- ShippingMethodUpdate
- ShippingOptionPricing
- ShippingTaxCalculationLine
- StagedJobServiceProps
- StockLocationAddressDTO
- StockLocationAddressInput
- StockLocationDTO
- Subscriber
- SubscriberContext
- SubscriberDescriptor
- SubtotalOptions
- TaxCalculationContext
- TaxLinesMaps
- TaxRateListByConfig
- TaxServiceRate
- TaxedPricing
- TotalField
- TotalsConfig
- TotalsContext
- TotalsServiceProps
- Transformer
- TreeQuerySelector
- TypedArray
- UpdateAnalyticsConfig
- UpdateClaimInput
- UpdateClaimItemImageInput
- UpdateClaimItemInput
- UpdateClaimItemTagInput
- UpdateClaimShippingMethodInput
- UpdateCurrencyInput
- UpdateCustomerInput
- UpdateDiscountInput
- UpdateDiscountRuleInput
- UpdateGiftCardInput
- UpdateInventoryLevelInput
- UpdateOauthInput
- UpdateOrderInput
- UpdatePriceListInput
- UpdateProductCategoryInput
- UpdateProductCollection
- UpdateProductInput
- UpdateProductProductVariantDTO
- UpdateProductVariantData
- UpdateProductVariantInput
- UpdateRegionInput
- UpdateReservationItemInput
- UpdateReturnInput
- UpdateReturnReason
- UpdateShippingOptionInput
- UpdateShippingProfile
- UpdateStockLocationInput
- UpdateStoreInput
- UpdateTaxRateInput
- UpdateVariantPricesData
- UpdateVariantRegionPriceData
- UpsertTagsInput
- UpsertTypeInput
- UserServiceProps
- ValidatePriceTypeAndAmountInput
- WithImplicitCoercion
- WithRequiredProperty
- middlewareHandlerType
- middlewareType
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
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<T
>(value?
): boolean
T
objectRequiredParameters
value
TReturns
boolean
boolean
boolean