medusa
Namespaces
Enumerations
- DefaultPriceType
- BatchJobStatus
- PriceListType
- PriceListStatus
- UserRole
- PostgresError
- MODULE_RESOURCE_TYPE
- ProductStatus
- PriceListStatus
- PriceListType
Classes
- MedusaError
- AdminPostAnalyticsConfigReq
- AdminPostAnalyticsConfigAnalyticsConfigReq
- AdminPostAuthReq
- AdminPostBatchesReq
- AdminGetBatchPaginationParams
- AdminGetBatchParams
- AdminPostProductsToCollectionReq
- AdminPostCollectionsReq
- AdminGetCollectionsPaginationParams
- AdminGetCollectionsParams
- AdminDeleteProductsFromCollectionReq
- AdminPostCollectionsCollectionReq
- AdminGetCurrenciesParams
- AdminPostCurrenciesCurrencyReq
- AdminPostCustomerGroupsGroupCustomersBatchReq
- AdminPostCustomerGroupsReq
- AdminDeleteCustomerGroupsGroupCustomerBatchReq
- AdminGetCustomerGroupsGroupParams
- AdminGetCustomerGroupsParams
- AdminPostCustomerGroupsGroupReq
- AdminPostCustomersReq
- AdminGetCustomersParams
- Group
- AdminPostCustomersCustomerReq
- AdminPostDiscountsDiscountConditionsConditionBatchReq
- AdminPostDiscountsDiscountConditionsConditionBatchParams
- AdminPostDiscountsDiscountConditions
- AdminPostDiscountsDiscountConditionsParams
- AdminPostDiscountsReq
- AdminPostDiscountsDiscountRule
- AdminCreateCondition
- AdminPostDiscountsParams
- AdminPostDiscountsDiscountDynamicCodesReq
- AdminDeleteDiscountsDiscountConditionsConditionParams
- AdminDeleteDiscountsDiscountConditionsConditionBatchParams
- AdminDeleteDiscountsDiscountConditionsConditionBatchReq
- AdminGetDiscountsDiscountConditionsConditionParams
- AdminGetDiscountsDiscountCodeParams
- AdminGetDiscountParams
- AdminGetDiscountsParams
- AdminPostDiscountsDiscountConditionsCondition
- AdminPostDiscountsDiscountConditionsConditionParams
- AdminPostDiscountsDiscountReq
- AdminUpdateDiscountRule
- AdminUpsertCondition
- AdminPostDiscountsDiscountParams
- AdminPostDraftOrdersReq
- ShippingMethod
- Discount
- Item
- AdminPostDraftOrdersDraftOrderLineItemsReq
- AdminGetDraftOrdersParams
- AdminPostDraftOrdersDraftOrderReq
- Discount
- AdminPostDraftOrdersDraftOrderLineItemsItemReq
- AdminPostGiftCardsReq
- AdminGetGiftCardsParams
- AdminPostGiftCardsGiftCardReq
- AdminPostInventoryItemsReq
- AdminPostInventoryItemsParams
- AdminPostInventoryItemsItemLocationLevelsReq
- AdminPostInventoryItemsItemLocationLevelsParams
- AdminGetInventoryItemsItemParams
- AdminGetInventoryItemsParams
- AdminGetInventoryItemsItemLocationLevelsParams
- AdminPostInventoryItemsInventoryItemReq
- AdminPostInventoryItemsInventoryItemParams
- AdminPostInventoryItemsItemLocationLevelsLevelReq
- AdminPostInventoryItemsItemLocationLevelsLevelParams
- AdminPostInvitesInviteAcceptUserReq
- AdminPostInvitesInviteAcceptReq
- AdminPostInvitesReq
- AdminPostNotesReq
- AdminGetNotesParams
- AdminPostNotesNoteReq
- AdminGetNotificationsParams
- AdminPostNotificationsNotificationResendReq
- AdminPostOrderEditsEditLineItemsReq
- AdminPostOrderEditsReq
- GetOrderEditsOrderEditParams
- GetOrderEditsParams
- AdminPostOrderEditsRequestConfirmationReq
- AdminPostOrderEditsEditLineItemsLineItemReq
- AdminPostOrderEditsOrderEditReq
- AdminPostOrdersOrderShippingMethodsReq
- AdminPostOrdersOrderShippingMethodsParams
- AdminPostOrdersOrderArchiveParams
- AdminPostOrdersClaimCancel
- AdminPostOrdersClaimFulfillmentsCancelParams
- AdminPostOrdersOrderSwapFulfillementsCancelParams
- AdminPostOrdersOrderFulfillementsCancelParams
- AdminPostOrdersOrderCancel
- AdminPostOrdersSwapCancelParams
- AdminPostOrdersOrderCaptureParams
- AdminPostOrdersOrderCompleteParams
- AdminPostOrdersOrderClaimsClaimShipmentsReq
- AdminPostOrdersOrderClaimsClaimShipmentsParams
- AdminPostOrdersOrderClaimsReq
- ReturnShipping
- ShippingMethod
- Item
- AdditionalItem
- AdminPostOrdersOrderClaimsParams
- AdminPostOrdersOrderFulfillmentsReq
- Item
- AdminPostOrdersOrderFulfillmentsParams
- AdminPostOrdersOrderShipmentReq
- AdminPostOrdersOrderShipmentParams
- AdminPostOrdersOrderSwapsSwapShipmentsReq
- AdminPostOrdersOrderSwapsSwapShipmentsParams
- AdminPostOrdersOrderSwapsReq
- ReturnItem
- ReturnShipping
- CustomShippingOption
- AdditionalItem
- AdminPostOrdersOrderSwapsParams
- AdminPostOrdersOrderClaimsClaimFulfillmentsReq
- AdminPostOrdersOrderClaimsClaimFulfillmentsParams
- AdminPostOrdersOrderSwapsSwapFulfillmentsReq
- AdminPostOrdersOrderSwapsSwapFulfillmentsParams
- AdminGetOrdersOrderParams
- AdminGetOrdersParams
- AdminPostOrdersOrderSwapsSwapProcessPaymentParams
- AdminPostOrdersOrderRefundsReq
- AdminPostOrdersOrderRefundsParams
- AdminPostOrdersOrderReturnsReq
- ReturnShipping
- AdminPostOrdersOrderReturnsParams
- AdminPostOrdersOrderClaimsClaimReq
- ShippingMethod
- Item
- Image
- Tag
- AdminPostOrdersOrderClaimsClaimParams
- AdminPostOrdersOrderReq
- PaymentMethod
- ShippingMethod
- AdminPostOrdersOrderParams
- AdminGetPaymentCollectionsParams
- AdminUpdatePaymentCollectionsReq
- GetPaymentsParams
- AdminPostPaymentRefundsReq
- AdminPostPriceListPricesPricesReq
- CustomerGroup
- AdminPostPriceListsPriceListReq
- AdminDeletePriceListPricesPricesReq
- AdminDeletePriceListsPriceListProductsPricesBatchReq
- AdminGetPriceListsPriceListProductsParams
- AdminGetPriceListPaginationParams
- CustomerGroup
- AdminPostPriceListsPriceListPriceListReq
- AdminPostProductCategoriesCategoryProductsBatchReq
- AdminPostProductCategoriesCategoryProductsBatchParams
- AdminPostProductCategoriesReq
- AdminPostProductCategoriesParams
- AdminDeleteProductCategoriesCategoryProductsBatchReq
- AdminDeleteProductCategoriesCategoryProductsBatchParams
- AdminGetProductCategoryParams
- AdminGetProductCategoriesParams
- AdminPostProductCategoriesCategoryReq
- AdminPostProductCategoriesCategoryParams
- AdminGetProductTagsPaginationParams
- AdminGetProductTagsParams
- AdminGetProductTypesParams
- AdminPostProductsProductOptionsReq
- ProductVariantOptionReq
- ProductOptionReq
- ProductVariantReq
- AdminPostProductsReq
- ProductVariantOptionReq
- AdminPostProductsProductVariantsReq
- AdminGetProductParams
- AdminGetProductsParams
- AdminGetProductsVariantsParams
- AdminPostProductsProductMetadataReq
- AdminPostProductsProductOptionsOption
- ProductVariantOptionReq
- ProductVariantReq
- AdminPostProductsProductReq
- ProductVariantOptionReq
- AdminPostProductsProductVariantsVariantReq
- AdminPostPublishableApiKeySalesChannelsBatchReq
- AdminPostPublishableApiKeysReq
- AdminDeletePublishableApiKeySalesChannelsBatchReq
- GetPublishableApiKeySalesChannelsParams
- GetPublishableApiKeysParams
- AdminPostPublishableApiKeysPublishableApiKeyReq
- AdminPostRegionsRegionCountriesReq
- AdminPostRegionsRegionFulfillmentProvidersReq
- AdminPostRegionsRegionPaymentProvidersReq
- AdminPostRegionsReq
- FulfillmentOption
- AdminGetRegionsRegionFulfillmentOptionsRes
- AdminGetRegionsParams
- AdminPostRegionsRegionReq
- AdminPostReservationsReq
- AdminGetReservationsParams
- AdminPostReservationsReservationReq
- AdminPostReturnReasonsReq
- AdminPostReturnReasonsReasonReq
- AdminGetReturnsParams
- Item
- AdminPostReturnsReturnReceiveReq
- AdminPostSalesChannelsChannelProductsBatchReq
- AdminPostSalesChannelsChannelStockLocationsReq
- AdminPostSalesChannelsReq
- AdminDeleteSalesChannelsChannelProductsBatchReq
- AdminGetSalesChannelsParams
- AdminDeleteSalesChannelsChannelStockLocationsReq
- AdminPostSalesChannelsSalesChannelReq
- OptionRequirement
- AdminPostShippingOptionsReq
- AdminGetShippingOptionsParams
- OptionRequirement
- AdminPostShippingOptionsOptionReq
- AdminPostShippingProfilesReq
- AdminPostShippingProfilesProfileReq
- StockLocationAddress
- AdminPostStockLocationsReq
- AdminPostStockLocationsParams
- AdminGetStockLocationsLocationParams
- AdminGetStockLocationsParams
- StockLocationAddress
- AdminPostStockLocationsLocationReq
- AdminPostStockLocationsLocationParams
- AdminPostStoreReq
- AdminGetSwapsParams
- AdminPostTaxRatesTaxRateProductTypesReq
- AdminPostTaxRatesTaxRateProductTypesParams
- AdminPostTaxRatesTaxRateProductsReq
- AdminPostTaxRatesTaxRateProductsParams
- AdminPostTaxRatesTaxRateShippingOptionsReq
- AdminPostTaxRatesTaxRateShippingOptionsParams
- AdminPostTaxRatesReq
- AdminPostTaxRatesParams
- AdminGetTaxRatesTaxRateParams
- AdminGetTaxRatesParams
- AdminDeleteTaxRatesTaxRateProductTypesReq
- AdminDeleteTaxRatesTaxRateProductTypesParams
- AdminDeleteTaxRatesTaxRateProductsReq
- AdminDeleteTaxRatesTaxRateProductsParams
- AdminDeleteTaxRatesTaxRateShippingOptionsReq
- AdminDeleteTaxRatesTaxRateShippingOptionsParams
- AdminPostTaxRatesTaxRateReq
- AdminPostTaxRatesTaxRateParams
- IAdminPostUploadsFileReq
- AdminDeleteUploadsReq
- AdminPostUploadsDownloadUrlReq
- AdminCreateUserRequest
- AdminGetUsersParams
- AdminResetPasswordTokenRequest
- AdminResetPasswordRequest
- AdminUpdateUserRequest
- AdminGetVariantParams
- AdminGetVariantsParams
- StorePostAuthReq
- StorePostCartsCartShippingMethodReq
- Item
- StorePostCartReq
- StorePostCartsCartLineItemsReq
- StorePostCartsCartPaymentSessionReq
- GiftCard
- Discount
- StorePostCartsCartReq
- StorePostCartsCartLineItemsItemReq
- StorePostCartsCartPaymentSessionUpdateReq
- StoreGetCollectionsParams
- StorePostCustomersCustomerAddressesReq
- StorePostCustomersReq
- StoreGetCustomersCustomerOrdersPaginationParams
- StoreGetCustomersCustomerOrdersParams
- StorePostCustomersCustomerPasswordTokenReq
- StorePostCustomersResetPasswordReq
- StorePostCustomersCustomerAddressesAddressReq
- StorePostCustomersCustomerReq
- StorePostOrderEditsOrderEditDecline
- StorePostCustomersCustomerAcceptClaimReq
- ShippingAddressPayload
- StoreGetOrdersParams
- StorePostCustomersCustomerOrderClaimReq
- StorePostPaymentCollectionsBatchSessionsAuthorizeReq
- StoreGetPaymentCollectionsParams
- StorePostPaymentCollectionsSessionsReq
- StorePostPaymentCollectionsBatchSessionsReq
- StorePaymentCollectionSessionsReq
- StoreGetProductCategoriesCategoryParams
- StoreGetProductCategoriesParams
- StoreGetProductTagsParams
- StoreGetProductTypesParams
- StoreGetProductsPaginationParams
- StoreGetProductsParams
- StorePostSearchReq
- StoreGetRegionsRegionParams
- StoreGetRegionsParams
- ReturnShipping
- Item
- StorePostReturnsReq
- StoreGetShippingOptionsParams
- Item
- AdditionalItem
- StorePostSwapsReq
- StoreGetVariantsVariantParams
- StoreGetVariantsParams
- AbstractBatchJobStrategy
- AbstractCartCompletionStrategy
- AbstractFileService
- AbstractFulfillmentService
- AbstractNotificationService
- AbstractPaymentProcessor
- AbstractPaymentService
- AbstractPriceSelectionStrategy
- AbstractTaxCalculationStrategy
- AbstractTaxService
- TransactionBaseService
- FilterableBatchJobProps
- EmptyQueryParams
- DateComparisonOperator
- StringComparisonOperator
- NumericalComparisonOperator
- AddressPayload
- AddressCreatePayload
- FindParams
- FindPaginationParams
- FilterableCustomerGroupProps
- CustomerGroupsBatchCustomer
- AdminListCustomerSelector
- AdminGetDiscountsDiscountRuleParams
- AdminUpsertConditionsReq
- AdminListOrdersSelector
- OrdersReturnItem
- FilterablePriceListProps
- AdminPriceListPricesUpdateReq
- AdminPriceListPricesCreateReq
- PriceSelectionParams
- AdminPriceSelectionParams
- AdminProductCategoriesReqBase
- ProductBatchProductCategory
- ProductVariantPricesUpdateReq
- ProductVariantPricesCreateReq
- FilterableProductProps
- ProductSalesChannelReq
- ProductProductCategoryReq
- ProductTagReq
- ProductTypeReq
- ProductBatchSalesChannel
Interfaces
- IBatchJobStrategy
- ICartCompletionStrategy
- IFileService
- FulfillmentService
- ReturnedData
- INotificationService
- PaymentProcessorContext
- PaymentProcessorSessionResponse
- PaymentProcessorError
- PaymentProcessor
- PaymentService
- IPriceSelectionStrategy
- PriceSelectionContext
- PriceSelectionResult
- ITaxCalculationStrategy
- ITaxService
- FindConfig
- CustomFindOptions
- RequestQueryFields
- PaginatedResponse
- DeleteResponse
- MedusaRequest
- SubscriberContext
- SessionOptions
- HttpCompressionOptions
- ProjectConfigOptions
- ConfigModule
- FileServiceUploadResult
- FileServiceGetUploadStreamResult
- GetUploadedFileType
- DeleteFileType
- UploadStreamDescriptorType
- JoinerServiceConfigAlias
- JoinerServiceConfig
- Logger
- ProductDTO
- ProductVariantDTO
- ProductCategoryDTO
- ProductTagDTO
- ProductCollectionDTO
- ProductTypeDTO
- ProductOptionDTO
- ProductImageDTO
- ProductOptionValueDTO
- ITransactionBaseService
Type Aliases
- MedusaContainer
- handler
- AdminAnalyticsConfigRes
- AdminAnalyticsConfigDeleteRes
- AdminAuthRes
- AdminBearerAuthRes
- AdminBatchJobRes
- AdminBatchJobListRes
- AdminCollectionsListRes
- AdminCollectionsDeleteRes
- AdminDeleteProductsFromCollectionRes
- AdminCollectionsRes
- AdminCurrenciesListRes
- AdminCurrenciesRes
- AdminCustomerGroupsRes
- AdminCustomerGroupsDeleteRes
- AdminCustomerGroupsListRes
- AdminCustomersRes
- AdminCustomersListRes
- AdminDiscountsRes
- AdminDiscountConditionsRes
- AdminDiscountsDeleteRes
- AdminDiscountConditionsDeleteRes
- AdminDiscountsListRes
- AdminPostDraftOrdersDraftOrderRegisterPaymentRes
- AdminDraftOrdersRes
- AdminDraftOrdersDeleteRes
- AdminDraftOrdersListRes
- AdminGiftCardsRes
- AdminGiftCardsDeleteRes
- AdminGiftCardsListRes
- AdminInventoryItemsRes
- AdminInventoryItemsDeleteRes
- AdminInventoryItemsListRes
- DecoratedInventoryItemDTO
- AdminInventoryItemsListWithVariantsAndLocationLevelsRes
- AdminInventoryItemsLocationLevelsRes
- AdminInviteDeleteRes
- AdminListInvitesRes
- AdminNotesRes
- AdminNotesDeleteRes
- AdminNotesListRes
- AdminNotificationsListRes
- AdminNotificationsRes
- AdminOrderEditsRes
- AdminOrderEditsListRes
- AdminOrderEditDeleteRes
- AdminOrderEditItemChangeDeleteRes
- AdminOrdersRes
- AdminOrdersListRes
- AdminPaymentCollectionsRes
- AdminPaymentCollectionDeleteRes
- AdminPaymentRes
- AdminRefundRes
- AdminPriceListRes
- AdminPriceListDeleteBatchRes
- AdminPriceListDeleteProductPricesRes
- AdminPriceListDeleteVariantPricesRes
- AdminPriceListDeleteRes
- AdminPriceListsListRes
- AdminPriceListsProductsListRes
- AdminProductCategoriesCategoryRes
- AdminProductCategoriesCategoryDeleteRes
- AdminProductCategoriesListRes
- AdminProductTagsListRes
- AdminProductTypesListRes
- AdminProductsDeleteOptionRes
- AdminProductsDeleteVariantRes
- AdminProductsDeleteRes
- AdminProductsListRes
- AdminProductsListVariantsRes
- AdminProductsListTypesRes
- AdminProductsListTagsRes
- AdminProductsRes
- AdminPublishableApiKeysRes
- AdminPublishableApiKeysListRes
- AdminPublishableApiKeyDeleteRes
- AdminPublishableApiKeysListSalesChannelsRes
- AdminRegionsRes
- AdminRegionsListRes
- AdminRegionsDeleteRes
- AdminReservationsRes
- ExtendedReservationItem
- AdminReservationsListRes
- AdminReservationsDeleteRes
- AdminReturnReasonsRes
- AdminReturnReasonsListRes
- AdminReturnReasonsDeleteRes
- AdminReturnsCancelRes
- AdminReturnsListRes
- AdminReturnsRes
- AdminSalesChannelsRes
- AdminSalesChannelsDeleteRes
- AdminSalesChannelsDeleteLocationRes
- AdminSalesChannelsListRes
- AdminShippingOptionsListRes
- AdminShippingOptionsRes
- AdminShippingOptionsDeleteRes
- AdminDeleteShippingProfileRes
- AdminShippingProfilesRes
- AdminShippingProfilesListRes
- AdminStockLocationsDeleteRes
- AdminStockLocationsRes
- AdminStockLocationsListRes
- AdminExtendedStoresRes
- AdminStoresRes
- AdminTaxProvidersList
- AdminPaymentProvidersList
- AdminSwapsListRes
- AdminSwapsRes
- AdminTaxRatesDeleteRes
- AdminTaxRatesListRes
- AdminTaxRatesRes
- AdminUploadsRes
- AdminDeleteUploadsRes
- AdminUploadsDownloadUrlRes
- AdminUserRes
- AdminUsersListRes
- AdminDeleteUserRes
- payload
- LevelWithAvailability
- ResponseInventoryItem
- VariantInventory
- AdminGetVariantsVariantInventoryRes
- AdminVariantsListRes
- AdminVariantsRes
- StoreAuthRes
- StoreBearerAuthRes
- StoreGetAuthEmailRes
- StoreCartsRes
- StoreCompleteCartRes
- StoreCollectionsListRes
- StoreCollectionsRes
- StoreCustomersRes
- StoreCustomersResetPasswordRes
- StoreCustomersListOrdersRes
- StoreCustomersListPaymentMethodsRes
- StoreGiftCardsRes
- StoreOrderEditsRes
- StoreOrdersRes
- StorePaymentCollectionsRes
- StorePaymentCollectionsSessionRes
- StoreGetProductCategoriesCategoryRes
- StoreGetProductCategoriesRes
- StoreProductTagsListRes
- StoreProductTypesListRes
- StoreProductsRes
- StorePostSearchRes
- StoreProductsListRes
- StoreRegionsListRes
- StoreRegionsRes
- StoreReturnReasonsListRes
- StoreReturnReasonsRes
- StoreReturnsRes
- StoreShippingOptionsListRes
- StoreCartShippingOptionsListRes
- StoreSwapsRes
- StoreVariantsRes
- StoreVariantsListRes
- CartCompletionResponse
- FulfillmentProviderData
- ShippingOptionData
- ShippingMethodData
- Data
- PaymentData
- PaymentSessionData
- PaymentContext
- PaymentSessionResponse
- PriceType
- ShippingTaxCalculationLine
- ItemTaxCalculationLine
- TaxCalculationContext
- RouteVerb
- MiddlewareVerb
- MiddlewareFunction
- MedusaErrorHandlerFunction
- ParserConfig
- MiddlewareRoute
- MiddlewaresConfig
- BatchJobUpdateProps
- CreateBatchJobInput
- BatchJobResultError
- BatchJobResultStatDescriptor
- BatchJobCreateProps
- WithRequiredProperty
- PartialPick
- Writable
- ExtendedFindConfig
- QuerySelector
- TreeQuerySelector
- InnerSelector
- Selector
- TotalField
- QueryConfig
- FeatureFlagsResponse
- CreateReturnType
- ExtendedRequest
- ClassConstructor
- MedusaContainer
- Logger
- Constructor
- ConfigModule
- CreatePriceListInput
- UpdatePriceListInput
- PriceListPriceUpdateInput
- PriceListPriceCreateInput
- PriceListLoadConfig
- ProductVariantPricing
- TaxedPricing
- ShippingOptionPricing
- PricedShippingOption
- PricedVariant
- PricedProduct
- RequestContext
- MedusaResponse
- MedusaNextFunction
- MedusaRequestHandler
- ScheduledJobConfig
- ScheduledJobArgs
- ModulesResponse
- ExtendedStoreDTO
- SubscriberConfig
- SubscriberArgs
- TaxServiceRate
- ProviderShippingMethodTaxLine
- ProviderLineItemTaxLine
- ProviderTaxLine
- GiftCardAllocation
- DiscountAllocation
- LineAllocationsMap
- PaginatedResponse
- DeleteResponse
- MedusaContainer
- InventoryItemDTO
- ReservationItemDTO
- InventoryLevelDTO
- JoinerRelationship
- Constructor
- InternalModuleDeclaration
- ExternalModuleDeclaration
- ModuleDefinition
- LoaderOptions
- ModuleLoaderFunction
- ModulesResponse
- ModuleJoinerConfig
- ModuleJoinerRelationship
- ModuleExports
- StockLocationAddressDTO
- StockLocationDTO
- StockLocationExpandedDTO
Enumeration Members
DEFAULT
DEFAULT: "default"
The calculatedPrice
is the original price.
INTERNAL
INTERNAL: "internal"
EXTERNAL
EXTERNAL: "external"
Variables
defaultAdminBatchFields
Const
defaultAdminBatchFields: string
[]
defaultAdminCollectionsFields
Const
defaultAdminCollectionsFields: string
[]
defaultAdminCollectionsRelations
Const
defaultAdminCollectionsRelations: string
[]
defaultAdminCustomerGroupsRelations
Const
defaultAdminCustomerGroupsRelations: never
[] = []
defaultAdminCustomersRelations
Const
defaultAdminCustomersRelations: string
[]
defaultAdminDiscountsFields
Const
defaultAdminDiscountsFields: keyof Discount[]
defaultAdminDiscountsRelations
Const
defaultAdminDiscountsRelations: string
[]
defaultAdminDiscountConditionFields
Const
defaultAdminDiscountConditionFields: keyof DiscountCondition[]
defaultAdminDiscountConditionRelations
Const
defaultAdminDiscountConditionRelations: string
[]
defaultAdminDraftOrdersRelations
Const
defaultAdminDraftOrdersRelations: string
[]
defaultAdminDraftOrdersCartRelations
Const
defaultAdminDraftOrdersCartRelations: string
[]
defaultAdminDraftOrdersCartFields
Const
defaultAdminDraftOrdersCartFields: keyof Cart[]
defaultAdminDraftOrdersFields
Const
defaultAdminDraftOrdersFields: keyof DraftOrder[]
defaultAdminGiftCardFields
Const
defaultAdminGiftCardFields: keyof GiftCard[]
defaultAdminGiftCardRelations
Const
defaultAdminGiftCardRelations: string
[]
defaultAdminInventoryItemFields
Const
defaultAdminInventoryItemFields: keyof InventoryItemDTO[]
defaultAdminLocationLevelFields
Const
defaultAdminLocationLevelFields: keyof InventoryLevelDTO[]
defaultAdminInventoryItemRelations
Const
defaultAdminInventoryItemRelations: never
[] = []
defaultAdminNotificationsRelations
Const
defaultAdminNotificationsRelations: string
[]
defaultAdminNotificationsFields
Const
defaultAdminNotificationsFields: string
[]
filterableAdminOrdersFields
Const
filterableAdminOrdersFields: string
[]
AvailableOrderIncludes
Const
AvailableOrderIncludes: Object
Properties
RETURNABLE_ITEMS
stringRequiredDefault: "returnable_items"
allowedOrderIncludes
Const
allowedOrderIncludes: string
[]
defaultPaymentCollectionFields
Const
defaultPaymentCollectionFields: string
[]
defaulPaymentCollectionRelations
Const
defaulPaymentCollectionRelations: string
[]
defaultPaymentFields
Const
defaultPaymentFields: string
[]
defaultAdminPriceListRemoteQueryObject
Const
defaultAdminPriceListRemoteQueryObject: Object
Properties
fields
string[]Requiredprice_list_rules
objectRequired
price_list_rules
objectRequiredprice_set_money_amounts
objectRequired
price_set_money_amounts
objectRequireddefaultAdminPriceListFields
Const
defaultAdminPriceListFields: string
[]
defaultAdminPriceListRelations
Const
defaultAdminPriceListRelations: string
[]
defaultAdminProductCategoryRelations
Const
defaultAdminProductCategoryRelations: string
[]
allowedAdminProductCategoryRelations
Const
allowedAdminProductCategoryRelations: string
[]
defaultProductCategoryFields
Const
defaultProductCategoryFields: string
[]
defaultAdminProductTagsFields
Const
defaultAdminProductTagsFields: string
[]
defaultAdminProductTagsRelations
Const
defaultAdminProductTagsRelations: never
[] = []
defaultAdminProductTypeFields
Const
defaultAdminProductTypeFields: string
[]
defaultAdminProductTypeRelations
Const
defaultAdminProductTypeRelations: never
[] = []
defaultAdminProductRelations
Const
defaultAdminProductRelations: string
[]
defaultAdminProductFields
Const
defaultAdminProductFields: keyof Product[]
defaultAdminGetProductsVariantsFields
Const
defaultAdminGetProductsVariantsFields: string
[]
defaultAdminProductRemoteQueryObject
Const
defaultAdminProductRemoteQueryObject: Object
This is temporary.
Properties
Default: defaultAdminProductFields
images
objectRequired
images
objectRequiredtags
objectRequired
tags
objectRequiredtype
objectRequired
type
objectRequiredcollection
objectRequired
collection
objectRequiredcategories
objectRequired
categories
objectRequiredoptions
objectRequired
options
objectRequiredvariants
objectRequired
variants
objectRequiredprofile
objectRequired
profile
objectRequiredsales_channels
objectRequired
sales_channels
objectRequireddefaultAdminRegionFields
Const
defaultAdminRegionFields: keyof Region[]
defaultAdminRegionRelations
Const
defaultAdminRegionRelations: string
[]
defaultAdminReservationRelations
Const
defaultAdminReservationRelations: never
[] = []
defaultReservationFields
Const
defaultReservationFields: string
[]
defaultAdminReturnReasonsFields
Const
defaultAdminReturnReasonsFields: keyof ReturnReason[]
defaultAdminReturnReasonsRelations
Const
defaultAdminReturnReasonsRelations: keyof ReturnReason[]
defaultRelations
Const
defaultRelations: string
[]
defaultRelationsList
Const
defaultRelationsList: string
[]
defaultReturnCancelRelations
Const
defaultReturnCancelRelations: string
[]
defaultReturnCancelFields
Const
defaultReturnCancelFields: keyof Order[]
shippingOptionsDefaultFields
Const
shippingOptionsDefaultFields: keyof ShippingOption[]
shippingOptionsDefaultRelations
Const
shippingOptionsDefaultRelations: string
[]
defaultAdminShippingProfilesFields
Const
defaultAdminShippingProfilesFields: keyof ShippingProfile[]
defaultAdminShippingProfilesRelations
Const
defaultAdminShippingProfilesRelations: string
[]
defaultAdminStockLocationFields
Const
defaultAdminStockLocationFields: keyof StockLocationDTO[]
defaultAdminStockLocationRelations
Const
defaultAdminStockLocationRelations: never
[] = []
defaultRelationsExtended
Const
defaultRelationsExtended: string
[]
defaultAdminSwapRelations
Const
defaultAdminSwapRelations: string
[]
defaultAdminSwapFields
Const
defaultAdminSwapFields: string
[]
defaultAdminTaxRatesRelations
Const
defaultAdminTaxRatesRelations: never
[] = []
defaultAdminTaxRatesFields
Const
defaultAdminTaxRatesFields: keyof TaxRate[]
defaultAdminUserFields
Const
defaultAdminUserFields: keyof User[]
defaultAdminVariantRelations
Const
defaultAdminVariantRelations: string
[]
defaultAdminVariantFields
Const
defaultAdminVariantFields: keyof ProductVariant[]
defaultStoreCartFields
Const
defaultStoreCartFields: keyof Cart[] = []
defaultStoreCartRelations
Const
defaultStoreCartRelations: string
[]
defaultStoreCollectionRelations
Const
defaultStoreCollectionRelations: never
[] = []
allowedFields
Const
allowedFields: string
[]
defaultStoreCustomersRelations
Const
defaultStoreCustomersRelations: string
[]
defaultStoreCustomersFields
Const
defaultStoreCustomersFields: keyof Customer[]
allowedStoreCustomersRelations
Const
allowedStoreCustomersRelations: string
[]
allowedStoreCustomersFields
Const
allowedStoreCustomersFields: string
[]
defaultStoreGiftCardRelations
Const
defaultStoreGiftCardRelations: string
[]
defaultStoreGiftCardFields
Const
defaultStoreGiftCardFields: keyof GiftCard[]
allowedStoreGiftCardRelations
Const
allowedStoreGiftCardRelations: string
[]
allowedStoreGiftCardFields
Const
allowedStoreGiftCardFields: string
[]
defaultStoreOrdersRelations
Const
defaultStoreOrdersRelations: string
[]
allowedStoreOrdersRelations
Const
allowedStoreOrdersRelations: string
[]
defaultStoreOrdersFields
Const
defaultStoreOrdersFields: keyof Order[]
allowedStoreOrdersFields
Const
allowedStoreOrdersFields: string
[]
defaultPaymentCollectionRelations
Const
defaultPaymentCollectionRelations: string
[]
defaultStoreProductCategoryRelations
Const
defaultStoreProductCategoryRelations: string
[]
defaultStoreCategoryScope
Const
defaultStoreCategoryScope: Object
Properties
is_internal
booleanRequiredDefault: false
is_active
booleanRequiredDefault: true
defaultStoreProductCategoryFields
Const
defaultStoreProductCategoryFields: string
[]
allowedStoreProductCategoryFields
Const
allowedStoreProductCategoryFields: string
[]
defaultStoreProductTagFields
Const
defaultStoreProductTagFields: string
[]
allowedStoreProductTagFields
Const
allowedStoreProductTagFields: string
[]
defaultStoreProductTagRelations
Const
defaultStoreProductTagRelations: never
[] = []
allowedStoreProductTypeFields
Const
allowedStoreProductTypeFields: string
[]
defaultStoreProductTypeFields
Const
defaultStoreProductTypeFields: string
[]
defaultStoreProductTypeRelations
Const
defaultStoreProductTypeRelations: never
[] = []
defaultStoreProductsRelations
Const
defaultStoreProductsRelations: string
[]
defaultStoreProductsFields
Const
defaultStoreProductsFields: keyof Product[]
allowedStoreProductsFields
Const
allowedStoreProductsFields: string
[]
allowedStoreProductsRelations
Const
allowedStoreProductsRelations: string
[]
defaultStoreProductRemoteQueryObject
Const
defaultStoreProductRemoteQueryObject: Object
This is temporary.
Properties
Default: defaultStoreProductsFields
images
objectRequired
images
objectRequiredtags
objectRequired
tags
objectRequiredtype
objectRequired
type
objectRequiredcollection
objectRequired
collection
objectRequiredoptions
objectRequired
options
objectRequiredvariants
objectRequired
variants
objectRequiredprofile
objectRequired
profile
objectRequiredsales_channels
objectRequired
sales_channels
objectRequireddefaultStoreRegionRelations
Const
defaultStoreRegionRelations: string
[]
defaultStoreRegionFields
Const
defaultStoreRegionFields: string
[]
defaultStoreReturnReasonFields
Const
defaultStoreReturnReasonFields: keyof ReturnReason[]
defaultStoreReturnReasonRelations
Const
defaultStoreReturnReasonRelations: keyof ReturnReason[]
defaultStoreSwapRelations
Const
defaultStoreSwapRelations: string
[]
defaultStoreSwapFields
Const
defaultStoreSwapFields: FindConfig<Swap>["select"
]
defaultStoreVariantRelations
Const
defaultStoreVariantRelations: string
[]
allowedStoreVariantRelations
Const
allowedStoreVariantRelations: string
[]
PriceType
PriceType: Object
Properties
joinerConfig
Const
joinerConfig: ModuleJoinerConfig[]
HTTP_METHODS
Const
HTTP_METHODS: readonly ["GET"
, "POST"
, "PUT"
, "PATCH"
, "DELETE"
, "OPTIONS"
, "HEAD"
]
List of all the supported HTTP methods
Functions
authenticateCustomer
Returns
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Required
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Requiredauthenticate
Returns
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Required
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>RequiredwrapHandler
Parameters
Returns
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Required
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>RequiredDeprecated
use import { wrapHandler } from "@medusajs/utils"
canAccessBatchJob
Parameters
req
anyRequiredres
anyRequirednext
anyRequiredReturns
Promise
Promise<any>Required
Promise
Promise<any>RequiredgetRequestedBatchJob
Parameters
req
anyRequiredres
anyRequirednext
anyRequiredReturns
Promise
Promise<any>Required
Promise
Promise<any>RequireddoesConditionBelongToDiscount
Parameters
req
anyRequiredres
anyRequirednext
anyRequiredReturns
Promise
Promise<any>Required
Promise
Promise<any>RequirederrorHandler
Returns
(err: MedusaError, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
(err: MedusaError, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => voidRequiredParameters
req
Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Requiredres
Response<any, Record<string, any>>Requirednext
NextFunctionRequiredReturns
void
voidRequiredisFeatureFlagEnabled
Parameters
flagKey
stringRequiredReturns
(req: Request, res: Response, next: NextFunction) => Promise<void>
(req: Request, res: Response, next: NextFunction) => Promise<void>RequiredParameters
req
RequestRequiredres
ResponseRequirednext
NextFunctionRequiredReturns
Promise
Promise<void>RequirednormalizeQuery
Normalize an input query, especially from array like query params to an array type e.g: /admin/orders/?fields[]=id,status,cart_id becomes { fields: ["id", "status", "cart_id"] }
Returns
(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => voidRequiredParameters
req
Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Requiredres
Response<any, Record<string, any>>Requirednext
NextFunctionRequiredReturns
void
voidRequiredrequireCustomerAuthentication
Returns
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Required
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>RequiredtransformBody
Type Parameters
T
objectRequiredParameters
config
ValidatorOptionsRequiredReturns
(req: Request, res: Response, next: NextFunction) => Promise<void>
(req: Request, res: Response, next: NextFunction) => Promise<void>RequiredParameters
req
RequestRequiredres
ResponseRequirednext
NextFunctionRequiredReturns
Promise
Promise<void>RequiredtransformIncludesOptions
Retrieve the includes options from the fields query param. If the include option is present then assigned it to includes on req
Parameters
allowedIncludes
string[]RequiredDefault: []
expectedIncludes
string[]RequiredallowedIncludes
Default: []
Returns
(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void
(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => voidRequiredParameters
req
Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Requiredres
Response<any, Record<string, any>>Requirednext
NextFunctionRequiredReturns
void
voidRequiredtransformQuery
Middleware that transform the query input for the admin end points
Type Parameters
TEntity
BaseEntityRequiredParameters
config
ValidatorOptionsRequiredDefault: {}
queryConfig
Omit<QueryConfig<TEntity>, "allowedFields" | "allowedRelations">
queryConfig
Omit<QueryConfig<TEntity>, "allowedFields" | "allowedRelations">Returns
(req: Request, res: Response, next: NextFunction) => Promise<void>
(req: Request, res: Response, next: NextFunction) => Promise<void>RequiredParameters
req
RequestRequiredres
ResponseRequirednext
NextFunctionRequiredReturns
Promise
Promise<void>RequiredtransformStoreQuery
Middleware that transform the query input for the store endpoints
Type Parameters
TEntity
BaseEntityRequiredParameters
Returns
(req: Request, res: Response, next: NextFunction) => Promise<void>
(req: Request, res: Response, next: NextFunction) => Promise<void>RequiredParameters
req
RequestRequiredres
ResponseRequirednext
NextFunctionRequiredReturns
Promise
Promise<void>RequiredreserveQuantityForDraftOrder
Parameters
An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user.
context
objectRequired
context
objectRequiredcontext.locationId
stringReturns
Promise
Promise<void>RequiredunauthenticatedInviteRoutes
Parameters
app
anyRequiredReturns
void
voidRequiredadjustInventoryForCancelledFulfillment
Parameters
A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.
context
objectRequired
context
objectRequiredReturns
Promise
Promise<void>RequiredupdateInventoryAndReservations
Parameters
context
objectRequired
context
objectRequiredcontext.locationId
stringRequiredReturns
Promise
Promise<void>RequiredunauthenticatedUserRoutes
Parameters
app
anyRequiredReturns
void
voidRequiredisPaymentProcessorError
Parameters
obj
anyRequiredReturns
obj
obj is PaymentProcessorErrorRequiredextendedFindParamsMixin
Parameters
__namedParameters
objectRequiredDefault: {}
__namedParameters
objectRequired{}
__namedParameters.limit
number__namedParameters.offset
numberReturns
buildQuery
Used to build TypeORM queries.
Type Parameters
TWhereKeys
objectRequiredTEntity
objectRequiredParameters
selector
TWhereKeysRequiredThe configDefault: {}
{}
Returns
The QueryBuilderConfig
buildLegacyFieldsListFrom
Revert new object structure of find options to the legacy structure of previous version
Example
Type Parameters
TEntity
objectRequiredParameters
input
FindOptionsWhere<TEntity> | FindOptionsSelect<TEntity> | FindOptionsOrder<TEntity> | FindOptionsRelations<TEntity>RequiredDefault: {}
Returns
keyof TEntity[]
keyof TEntity[]RequiredRevert new object structure of find options to the legacy structure of previous version
keyof TEntity[]
keyof TEntity[]RequiredDeprecated
in favor of import { objectToStringPath } from "@medusajs/utils"
addOrderToSelect
Type Parameters
TEntity
objectRequiredParameters
order
FindOptionsOrder<TEntity>Requiredselect
FindOptionsSelect<TEntity>RequiredReturns
void
voidRequirednullableValue
Parameters
value
anyRequiredReturns
FindOperator
FindOperator<any>Required
FindOperator
FindOperator<any>RequiredcalculatePriceTaxAmount
Return the tax amount that
- is includes in the price if it is tax inclusive
- will be applied on to the price if it is tax exclusive
Parameters
__namedParameters
objectRequired
__namedParameters
objectRequired__namedParameters.price
numberRequired__namedParameters.taxRate
numberRequired__namedParameters.includesTax
booleanReturns
number
numberRequired- is includes in the price if it is tax inclusive
- will be applied on to the price if it is tax exclusive
cleanResponseData
Filter response data to contain props specified in the allowedProperties
.
You can read more in the transformQuery middleware utility methods.
Type Parameters
T
unknownRequiredParameters
data
TRequiredfields
string[]RequiredReturns
T extends [] ? Partial<T>[] : Partial<T>
T extends [] ? Partial<T>[] : Partial<T>RequiredallowedProperties
.
You can read more in the transformQuery middleware utility methods.csvCellContentFormatter
Parameters
str
stringRequiredReturns
string
stringRequiredcsvRevertCellContentFormatter
Parameters
str
stringRequiredReturns
string
stringRequiredresolveDbType
Parameters
pgSqlType
ColumnTypeRequiredReturns
ColumnType
ColumnTypeRequiredresolveDbGenerationStrategy
Parameters
pgSqlType
"uuid" | "rowid" | "increment"RequiredReturns
"increment" | "uuid" | "rowid"
"increment" | "uuid" | "rowid"RequiredDbAwareColumn
Parameters
columnOptions
ColumnOptionsRequiredReturns
PropertyDecorator
PropertyDecoratorRequiredformatException
Parameters
err
anyRequiredReturns
type
stringRequiredmessage
stringRequireddate
DateRequiredTypes
objectRequired
Types
objectRequiredCodes
objectRequired
Codes
objectRequiredcode
stringgenerateEntityId
Generate a composed id based on the input parameters and return either the is if it exists or the generated one.
Parameters
idProperty
stringprefix
stringReturns
string
stringRequiredhasChanges
Compare two objects and return true if there is changes detected from obj2 compared to obj1
Type Parameters
T1
ObjectRequiredT2
ObjectRequiredParameters
obj1
T1Requiredobj2
T2RequiredReturns
boolean
booleanRequiredisDate
Parameters
value
anyRequiredReturns
value
value is DateRequiredisObject
Parameters
obj
anyRequiredReturns
obj
obj is objectRequiredisString
Parameters
val
anyRequiredReturns
val
val is stringRequiredomitDeep
Type Parameters
T
objectRequiredParameters
input
objectRequiredexcludes
(string | number)[]RequiredReturns
T
TRequiredcategoryMatchesScope
Parameters
A product category can be used to categorize products into a hierarchy of categories.
Returns
boolean
booleanRequiredfetchCategoryDescendantsIds
Parameters
A product category can be used to categorize products into a hierarchy of categories.
Returns
string[]
string[]Required
string[]
string[]RequiredgetVariantsFromPriceList
Parameters
priceListId
stringRequiredReturns
listProducts
Parameters
Returns
Promise
Promise<any[]>Required
Promise
Promise<any[]>RequiredretrieveProduct
Parameters
container
anyRequiredid
anyRequiredremoteQueryObject
objectRequiredDefault: {}
Returns
Promise
Promise<any>Required
Promise
Promise<any>RequiredremoteQueryFetchData
Parameters
Returns
(expand: any, keyField: any, ids: any, relationship: any) => Promise<any>
(expand: any, keyField: any, ids: any, relationship: any) => Promise<any>RequiredParameters
expand
anyRequiredkeyField
anyRequiredids
anyRequiredrelationship
anyRequiredReturns
Promise
Promise<any>Required
Promise
Promise<any>RequiredremoveUndefinedProperties
Type Parameters
T
objectRequiredParameters
inputObj
TRequiredReturns
T
TRequiredsetMetadata
Dedicated method to set metadata.
Parameters
obj
undefined | null | objectRequiredmetadata
Record<string, unknown>RequiredReturns
Record
Record<string, unknown>Requiredresolves to the updated result.
Record
Record<string, unknown>RequiredvalidateId
Parameters
rawId
stringRequiredconfig
objectRequiredDefault: {}
config
objectRequired{}
config.prefix
stringconfig.length
numberReturns
string
stringRequiredregisterOverriddenValidators
When overriding a validator, you can register it to be used instead of the original one. For example, the place where you are overriding the core validator, you can call this function
Example
// /src/api/routes/admin/products/create-product.ts
import { registerOverriddenValidators } from "@medusajs/medusa"
import { AdminPostProductsReq as MedusaAdminPostProductsReq } from "@medusajs/medusa/dist/api/routes/admin/products/create-product"
import { IsString } from "class-validator"
class AdminPostProductsReq extends MedusaAdminPostProductsReq {
@IsString()
test: string
}
registerOverriddenValidators(AdminPostProductsReq)
Parameters
Returns
void
voidRequiredvalidator
Type Parameters
T
objectRequiredV
objectRequiredParameters
Returns
Promise
Promise<T>Required
Promise
Promise<T>RequiredIsType
Parameters
types
any[]RequiredvalidationOptions
ValidationOptionsReturns
(object: Object, propertyName: string) => void
(object: Object, propertyName: string) => voidRequiredParameters
object
ObjectRequiredpropertyName
stringRequiredReturns
void
voidRequired