medusa
Namespaces
Enumerations
- BatchJobStatus
- DefaultPriceType
- MODULE_RESOURCE_TYPE
- PostgresError
- PriceListStatus
- PriceListStatus
- PriceListType
- PriceListType
- ProductStatus
Classes
- AbstractBatchJobStrategy
- AbstractCartCompletionStrategy
- AbstractFileService
- AbstractFulfillmentService
- AbstractNotificationService
- AbstractPaymentProcessor
- AbstractPaymentService
- AbstractPriceSelectionStrategy
- AbstractTaxService
- AdditionalItem
- AdditionalItem
- AdditionalItem
- AddressCreatePayload
- AddressPayload
- AdminCreateCondition
- AdminCreateUserRequest
- AdminDeleteCustomerGroupsGroupCustomerBatchReq
- AdminDeleteDiscountsDiscountConditionsConditionBatchParams
- AdminDeleteDiscountsDiscountConditionsConditionBatchReq
- AdminDeleteDiscountsDiscountConditionsConditionParams
- AdminDeletePriceListPricesPricesReq
- AdminDeletePriceListsPriceListProductsPricesBatchReq
- AdminDeleteProductCategoriesCategoryProductsBatchParams
- AdminDeleteProductCategoriesCategoryProductsBatchReq
- AdminDeleteProductsFromCollectionReq
- AdminDeletePublishableApiKeySalesChannelsBatchReq
- AdminDeleteSalesChannelsChannelProductsBatchReq
- AdminDeleteSalesChannelsChannelStockLocationsReq
- AdminDeleteTaxRatesTaxRateProductTypesParams
- AdminDeleteTaxRatesTaxRateProductTypesReq
- AdminDeleteTaxRatesTaxRateProductsParams
- AdminDeleteTaxRatesTaxRateProductsReq
- AdminDeleteTaxRatesTaxRateShippingOptionsParams
- AdminDeleteTaxRatesTaxRateShippingOptionsReq
- AdminDeleteUploadsReq
- AdminGetBatchPaginationParams
- AdminGetBatchParams
- AdminGetCollectionsPaginationParams
- AdminGetCollectionsParams
- AdminGetCurrenciesParams
- AdminGetCustomerGroupsGroupParams
- AdminGetCustomerGroupsParams
- AdminGetCustomersParams
- AdminGetDiscountParams
- AdminGetDiscountsDiscountCodeParams
- AdminGetDiscountsDiscountConditionsConditionParams
- AdminGetDiscountsDiscountRuleParams
- AdminGetDiscountsParams
- AdminGetDraftOrdersParams
- AdminGetGiftCardsParams
- AdminGetInventoryItemsItemLocationLevelsParams
- AdminGetInventoryItemsItemParams
- AdminGetInventoryItemsParams
- AdminGetNotesParams
- AdminGetNotificationsParams
- AdminGetOrdersOrderParams
- AdminGetOrdersParams
- AdminGetPaymentCollectionsParams
- AdminGetPriceListPaginationParams
- AdminGetPriceListsPriceListProductsParams
- AdminGetProductCategoriesParams
- AdminGetProductCategoryParams
- AdminGetProductParams
- AdminGetProductTagsPaginationParams
- AdminGetProductTagsParams
- AdminGetProductTypesParams
- AdminGetProductsParams
- AdminGetProductsVariantsParams
- AdminGetRegionsParams
- AdminGetRegionsRegionFulfillmentOptionsRes
- AdminGetReservationsParams
- AdminGetReturnsParams
- AdminGetSalesChannelsParams
- AdminGetShippingOptionsParams
- AdminGetStockLocationsLocationParams
- AdminGetStockLocationsParams
- AdminGetSwapsParams
- AdminGetTaxRatesParams
- AdminGetTaxRatesTaxRateParams
- AdminGetVariantParams
- AdminGetVariantsParams
- AdminListCustomerSelector
- AdminListOrdersSelector
- AdminPostAnalyticsConfigAnalyticsConfigReq
- AdminPostAnalyticsConfigReq
- AdminPostAuthReq
- AdminPostBatchesReq
- AdminPostCollectionsCollectionReq
- AdminPostCollectionsReq
- AdminPostCurrenciesCurrencyReq
- AdminPostCustomerGroupsGroupCustomersBatchReq
- AdminPostCustomerGroupsGroupReq
- AdminPostCustomerGroupsReq
- AdminPostCustomersCustomerReq
- AdminPostCustomersReq
- AdminPostDiscountsDiscountConditions
- AdminPostDiscountsDiscountConditionsCondition
- AdminPostDiscountsDiscountConditionsConditionBatchParams
- AdminPostDiscountsDiscountConditionsConditionBatchReq
- AdminPostDiscountsDiscountConditionsConditionParams
- AdminPostDiscountsDiscountConditionsParams
- AdminPostDiscountsDiscountDynamicCodesReq
- AdminPostDiscountsDiscountParams
- AdminPostDiscountsDiscountReq
- AdminPostDiscountsDiscountRule
- AdminPostDiscountsParams
- AdminPostDiscountsReq
- AdminPostDraftOrdersDraftOrderLineItemsItemReq
- AdminPostDraftOrdersDraftOrderLineItemsReq
- AdminPostDraftOrdersDraftOrderReq
- AdminPostDraftOrdersReq
- AdminPostGiftCardsGiftCardReq
- AdminPostGiftCardsReq
- AdminPostInventoryItemsInventoryItemParams
- AdminPostInventoryItemsInventoryItemReq
- AdminPostInventoryItemsItemLocationLevelsLevelParams
- AdminPostInventoryItemsItemLocationLevelsLevelReq
- AdminPostInventoryItemsItemLocationLevelsParams
- AdminPostInventoryItemsItemLocationLevelsReq
- AdminPostInventoryItemsParams
- AdminPostInventoryItemsReq
- AdminPostInvitesInviteAcceptReq
- AdminPostInvitesInviteAcceptUserReq
- AdminPostInvitesReq
- AdminPostNotesNoteReq
- AdminPostNotesReq
- AdminPostNotificationsNotificationResendReq
- AdminPostOrderEditsEditLineItemsLineItemReq
- AdminPostOrderEditsEditLineItemsReq
- AdminPostOrderEditsOrderEditReq
- AdminPostOrderEditsReq
- AdminPostOrderEditsRequestConfirmationReq
- AdminPostOrdersClaimCancel
- AdminPostOrdersClaimFulfillmentsCancelParams
- AdminPostOrdersOrderArchiveParams
- AdminPostOrdersOrderCancel
- AdminPostOrdersOrderCaptureParams
- AdminPostOrdersOrderClaimsClaimFulfillmentsParams
- AdminPostOrdersOrderClaimsClaimFulfillmentsReq
- AdminPostOrdersOrderClaimsClaimParams
- AdminPostOrdersOrderClaimsClaimReq
- AdminPostOrdersOrderClaimsClaimShipmentsParams
- AdminPostOrdersOrderClaimsClaimShipmentsReq
- AdminPostOrdersOrderClaimsParams
- AdminPostOrdersOrderClaimsReq
- AdminPostOrdersOrderCompleteParams
- AdminPostOrdersOrderFulfillementsCancelParams
- AdminPostOrdersOrderFulfillmentsParams
- AdminPostOrdersOrderFulfillmentsReq
- AdminPostOrdersOrderParams
- AdminPostOrdersOrderRefundsParams
- AdminPostOrdersOrderRefundsReq
- AdminPostOrdersOrderReq
- AdminPostOrdersOrderReturnsParams
- AdminPostOrdersOrderReturnsReq
- AdminPostOrdersOrderShipmentParams
- AdminPostOrdersOrderShipmentReq
- AdminPostOrdersOrderShippingMethodsParams
- AdminPostOrdersOrderShippingMethodsReq
- AdminPostOrdersOrderSwapFulfillementsCancelParams
- AdminPostOrdersOrderSwapsParams
- AdminPostOrdersOrderSwapsReq
- AdminPostOrdersOrderSwapsSwapFulfillmentsParams
- AdminPostOrdersOrderSwapsSwapFulfillmentsReq
- AdminPostOrdersOrderSwapsSwapProcessPaymentParams
- AdminPostOrdersOrderSwapsSwapShipmentsParams
- AdminPostOrdersOrderSwapsSwapShipmentsReq
- AdminPostOrdersSwapCancelParams
- AdminPostPaymentRefundsReq
- AdminPostPriceListPricesPricesReq
- AdminPostPriceListsPriceListPriceListReq
- AdminPostPriceListsPriceListReq
- AdminPostProductCategoriesCategoryParams
- AdminPostProductCategoriesCategoryProductsBatchParams
- AdminPostProductCategoriesCategoryProductsBatchReq
- AdminPostProductCategoriesCategoryReq
- AdminPostProductCategoriesParams
- AdminPostProductCategoriesReq
- AdminPostProductsProductMetadataReq
- AdminPostProductsProductOptionsOption
- AdminPostProductsProductOptionsReq
- AdminPostProductsProductReq
- AdminPostProductsProductVariantsReq
- AdminPostProductsProductVariantsVariantReq
- AdminPostProductsReq
- AdminPostProductsToCollectionReq
- AdminPostPublishableApiKeySalesChannelsBatchReq
- AdminPostPublishableApiKeysPublishableApiKeyReq
- AdminPostPublishableApiKeysReq
- AdminPostRegionsRegionCountriesReq
- AdminPostRegionsRegionFulfillmentProvidersReq
- AdminPostRegionsRegionPaymentProvidersReq
- AdminPostRegionsRegionReq
- AdminPostRegionsReq
- AdminPostReservationsReq
- AdminPostReservationsReservationReq
- AdminPostReturnReasonsReasonReq
- AdminPostReturnReasonsReq
- AdminPostReturnsReturnReceiveReq
- AdminPostSalesChannelsChannelProductsBatchReq
- AdminPostSalesChannelsChannelStockLocationsReq
- AdminPostSalesChannelsReq
- AdminPostSalesChannelsSalesChannelReq
- AdminPostShippingOptionsOptionReq
- AdminPostShippingOptionsReq
- AdminPostShippingProfilesProfileReq
- AdminPostShippingProfilesReq
- AdminPostStockLocationsLocationParams
- AdminPostStockLocationsLocationReq
- AdminPostStockLocationsParams
- AdminPostStockLocationsReq
- AdminPostStoreReq
- AdminPostTaxRatesParams
- AdminPostTaxRatesReq
- AdminPostTaxRatesTaxRateParams
- AdminPostTaxRatesTaxRateProductTypesParams
- AdminPostTaxRatesTaxRateProductTypesReq
- AdminPostTaxRatesTaxRateProductsParams
- AdminPostTaxRatesTaxRateProductsReq
- AdminPostTaxRatesTaxRateReq
- AdminPostTaxRatesTaxRateShippingOptionsParams
- AdminPostTaxRatesTaxRateShippingOptionsReq
- AdminPostUploadsDownloadUrlReq
- AdminPriceListPricesCreateReq
- AdminPriceListPricesUpdateReq
- AdminPriceSelectionParams
- AdminProductCategoriesReqBase
- AdminResetPasswordRequest
- AdminResetPasswordTokenRequest
- AdminUpdateDiscountRule
- AdminUpdatePaymentCollectionsReq
- AdminUpdateUserRequest
- AdminUpsertCondition
- AdminUpsertConditionsReq
- CustomShippingOption
- CustomerGroup
- CustomerGroup
- CustomerGroupsBatchCustomer
- DateComparisonOperator
- Discount
- Discount
- Discount
- EmptyQueryParams
- FilterableBatchJobProps
- FilterableCustomerGroupProps
- FilterablePriceListProps
- FilterableProductProps
- FindPaginationParams
- FindParams
- FulfillmentOption
- GetOrderEditsOrderEditParams
- GetOrderEditsParams
- GetPaymentsParams
- GetPublishableApiKeySalesChannelsParams
- GetPublishableApiKeysParams
- GiftCard
- Group
- IAdminPostUploadsFileReq
- Image
- Item
- Item
- Item
- Item
- Item
- Item
- Item
- Item
- MedusaError
- NumericalComparisonOperator
- OptionRequirement
- OptionRequirement
- OrdersReturnItem
- PaymentMethod
- PriceSelectionParams
- ProductBatchProductCategory
- ProductBatchSalesChannel
- ProductOptionReq
- ProductProductCategoryReq
- ProductSalesChannelReq
- ProductTagReq
- ProductTypeReq
- ProductVariantOptionReq
- ProductVariantOptionReq
- ProductVariantOptionReq
- ProductVariantOptionReq
- ProductVariantPricesCreateReq
- ProductVariantPricesUpdateReq
- ProductVariantReq
- ProductVariantReq
- ReturnItem
- ReturnShipping
- ReturnShipping
- ReturnShipping
- ReturnShipping
- ShippingAddressPayload
- ShippingMethod
- ShippingMethod
- ShippingMethod
- ShippingMethod
- StockLocationAddress
- StockLocationAddress
- StoreGetCollectionsParams
- StoreGetCustomersCustomerOrdersPaginationParams
- StoreGetCustomersCustomerOrdersParams
- StoreGetOrdersParams
- StoreGetPaymentCollectionsParams
- StoreGetProductCategoriesCategoryParams
- StoreGetProductCategoriesParams
- StoreGetProductTagsParams
- StoreGetProductTypesParams
- StoreGetProductsPaginationParams
- StoreGetProductsParams
- StoreGetRegionsParams
- StoreGetRegionsRegionParams
- StoreGetShippingOptionsParams
- StoreGetVariantsParams
- StoreGetVariantsVariantParams
- StorePaymentCollectionSessionsReq
- StorePostAuthReq
- StorePostCartReq
- StorePostCartsCartLineItemsItemReq
- StorePostCartsCartLineItemsReq
- StorePostCartsCartPaymentSessionReq
- StorePostCartsCartPaymentSessionUpdateReq
- StorePostCartsCartReq
- StorePostCartsCartShippingMethodReq
- StorePostCustomersCustomerAcceptClaimReq
- StorePostCustomersCustomerAddressesAddressReq
- StorePostCustomersCustomerAddressesReq
- StorePostCustomersCustomerOrderClaimReq
- StorePostCustomersCustomerPasswordTokenReq
- StorePostCustomersCustomerReq
- StorePostCustomersReq
- StorePostCustomersResetPasswordReq
- StorePostOrderEditsOrderEditDecline
- StorePostPaymentCollectionsBatchSessionsAuthorizeReq
- StorePostPaymentCollectionsBatchSessionsReq
- StorePostPaymentCollectionsSessionsReq
- StorePostReturnsReq
- StorePostSearchReq
- StorePostSwapsReq
- StringComparisonOperator
- Tag
- TransactionBaseService
Interfaces
- CustomFindOptions
- DeleteResponse
- FindConfig
- FulfillmentService
- IBatchJobStrategy
- ICartCompletionStrategy
- IFileService
- INotificationService
- IPriceSelectionStrategy
- ITaxCalculationStrategy
- ITaxService
- ITransactionBaseService
- JoinerServiceConfig
- JoinerServiceConfigAlias
- MedusaRequest
- PaginatedResponse
- PaymentProcessor
- PaymentProcessorContext
- PaymentProcessorError
- PaymentProcessorSessionResponse
- PaymentService
- ProductCategoryDTO
- ProductCollectionDTO
- ProductDTO
- ProductImageDTO
- ProductOptionDTO
- ProductOptionValueDTO
- ProductTagDTO
- ProductTypeDTO
- ProductVariantDTO
- RequestQueryFields
- SubscriberContext
Type Aliases
- AdminAnalyticsConfigDeleteRes
- AdminAnalyticsConfigRes
- AdminAuthRes
- AdminBatchJobListRes
- AdminBatchJobRes
- AdminBearerAuthRes
- AdminCollectionsDeleteRes
- AdminCollectionsListRes
- AdminCollectionsRes
- AdminCurrenciesListRes
- AdminCurrenciesRes
- AdminCustomerGroupsDeleteRes
- AdminCustomerGroupsListRes
- AdminCustomerGroupsRes
- AdminCustomersListRes
- AdminCustomersRes
- AdminDeleteProductsFromCollectionRes
- AdminDeleteShippingProfileRes
- AdminDeleteUploadsRes
- AdminDeleteUserRes
- AdminDiscountConditionsDeleteRes
- AdminDiscountConditionsRes
- AdminDiscountsDeleteRes
- AdminDiscountsListRes
- AdminDiscountsRes
- AdminDraftOrdersDeleteRes
- AdminDraftOrdersListRes
- AdminDraftOrdersRes
- AdminExtendedStoresRes
- AdminGetVariantsVariantInventoryRes
- AdminGiftCardsDeleteRes
- AdminGiftCardsListRes
- AdminGiftCardsRes
- AdminInventoryItemsDeleteRes
- AdminInventoryItemsListRes
- AdminInventoryItemsListWithVariantsAndLocationLevelsRes
- AdminInventoryItemsLocationLevelsRes
- AdminInventoryItemsRes
- AdminInviteDeleteRes
- AdminListInvitesRes
- AdminNotesDeleteRes
- AdminNotesListRes
- AdminNotesRes
- AdminNotificationsListRes
- AdminNotificationsRes
- AdminOrderEditDeleteRes
- AdminOrderEditItemChangeDeleteRes
- AdminOrderEditsListRes
- AdminOrderEditsRes
- AdminOrdersListRes
- AdminOrdersRes
- AdminPaymentCollectionDeleteRes
- AdminPaymentCollectionsRes
- AdminPaymentProvidersList
- AdminPaymentRes
- AdminPostDraftOrdersDraftOrderRegisterPaymentRes
- AdminPriceListDeleteBatchRes
- AdminPriceListDeleteProductPricesRes
- AdminPriceListDeleteRes
- AdminPriceListDeleteVariantPricesRes
- AdminPriceListRes
- AdminPriceListsListRes
- AdminPriceListsProductsListRes
- AdminProductCategoriesCategoryDeleteRes
- AdminProductCategoriesCategoryRes
- AdminProductCategoriesListRes
- AdminProductTagsListRes
- AdminProductTypesListRes
- AdminProductsDeleteOptionRes
- AdminProductsDeleteRes
- AdminProductsDeleteVariantRes
- AdminProductsListRes
- AdminProductsListTagsRes
- AdminProductsListTypesRes
- AdminProductsListVariantsRes
- AdminProductsRes
- AdminPublishableApiKeyDeleteRes
- AdminPublishableApiKeysListRes
- AdminPublishableApiKeysListSalesChannelsRes
- AdminPublishableApiKeysRes
- AdminRefundRes
- AdminRegionsDeleteRes
- AdminRegionsListRes
- AdminRegionsRes
- AdminReservationsDeleteRes
- AdminReservationsListRes
- AdminReservationsRes
- AdminReturnReasonsDeleteRes
- AdminReturnReasonsListRes
- AdminReturnReasonsRes
- AdminReturnsCancelRes
- AdminReturnsListRes
- AdminReturnsRes
- AdminSalesChannelsDeleteLocationRes
- AdminSalesChannelsDeleteRes
- AdminSalesChannelsListRes
- AdminSalesChannelsRes
- AdminShippingOptionsDeleteRes
- AdminShippingOptionsListRes
- AdminShippingOptionsRes
- AdminShippingProfilesListRes
- AdminShippingProfilesRes
- AdminStockLocationsDeleteRes
- AdminStockLocationsListRes
- AdminStockLocationsRes
- AdminStoresRes
- AdminSwapsListRes
- AdminSwapsRes
- AdminTaxProvidersList
- AdminTaxRatesDeleteRes
- AdminTaxRatesListRes
- AdminTaxRatesRes
- AdminUploadsDownloadUrlRes
- AdminUploadsRes
- AdminUserRes
- AdminUsersListRes
- AdminVariantsListRes
- AdminVariantsRes
- BatchJobCreateProps
- BatchJobResultError
- BatchJobResultStatDescriptor
- BatchJobUpdateProps
- CartCompletionResponse
- ClassConstructor
- ConfigModule
- ConfigModule
- Constructor
- Constructor
- CreateBatchJobInput
- CreatePriceListInput
- CreateReturnType
- Data
- DecoratedInventoryItemDTO
- DeleteFileType
- DeleteResponse
- DiscountAllocation
- ExtendedFindConfig
- ExtendedRequest
- ExtendedReservationItem
- ExtendedStoreDTO
- ExternalModuleDeclaration
- FeatureFlagsResponse
- FileServiceGetUploadStreamResult
- FileServiceUploadResult
- FulfillmentProviderData
- GetUploadedFileType
- GiftCardAllocation
- HttpCompressionOptions
- InnerSelector
- InternalModuleDeclaration
- InventoryItemDTO
- InventoryLevelDTO
- ItemTaxCalculationLine
- JoinerRelationship
- LevelWithAvailability
- LineAllocationsMap
- Logger
- MedusaContainer
- MedusaContainer
- MedusaContainer
- MedusaErrorHandlerFunction
- MedusaNextFunction
- MedusaRequestHandler
- MedusaResponse
- MiddlewareFunction
- MiddlewareRoute
- MiddlewareVerb
- MiddlewaresConfig
- ModuleDefinition
- ModuleJoinerConfig
- ModuleJoinerRelationship
- ModulesResponse
- ModulesResponse
- PaginatedResponse
- ParserConfig
- PartialPick
- PaymentContext
- PaymentData
- PaymentSessionData
- PaymentSessionResponse
- PriceListLoadConfig
- PriceListPriceCreateInput
- PriceListPriceUpdateInput
- PriceSelectionContext
- PriceSelectionResult
- PriceType
- PricedProduct
- PricedShippingOption
- PricedVariant
- ProductVariantPricing
- ProjectConfigOptions
- ProviderLineItemTaxLine
- ProviderShippingMethodTaxLine
- ProviderTaxLine
- QueryConfig
- QuerySelector
- RequestContext
- ReservationItemDTO
- ResponseInventoryItem
- ReturnedData
- RouteVerb
- ScheduledJobArgs
- ScheduledJobConfig
- Selector
- SessionOptions
- ShippingMethodData
- ShippingOptionData
- ShippingOptionPricing
- ShippingTaxCalculationLine
- StockLocationAddressDTO
- StockLocationDTO
- StockLocationExpandedDTO
- StoreAuthRes
- StoreBearerAuthRes
- StoreCartShippingOptionsListRes
- StoreCartsRes
- StoreCollectionsListRes
- StoreCollectionsRes
- StoreCompleteCartRes
- StoreCustomersListOrdersRes
- StoreCustomersListPaymentMethodsRes
- StoreCustomersRes
- StoreCustomersResetPasswordRes
- StoreGetAuthEmailRes
- StoreGetProductCategoriesCategoryRes
- StoreGetProductCategoriesRes
- StoreGiftCardsRes
- StoreOrderEditsRes
- StoreOrdersRes
- StorePaymentCollectionsRes
- StorePaymentCollectionsSessionRes
- StorePostSearchRes
- StoreProductTagsListRes
- StoreProductTypesListRes
- StoreProductsListRes
- StoreProductsRes
- StoreRegionsListRes
- StoreRegionsRes
- StoreReturnReasonsListRes
- StoreReturnReasonsRes
- StoreReturnsRes
- StoreShippingOptionsListRes
- StoreSwapsRes
- StoreVariantsListRes
- StoreVariantsRes
- SubscriberArgs
- SubscriberConfig
- TaxCalculationContext
- TaxServiceRate
- TaxedPricing
- TotalField
- TreeQuerySelector
- UpdatePriceListInput
- UploadStreamDescriptorType
- VariantInventory
- WithRequiredProperty
- Writable
- handler
- payload
Enumeration Members
DEFAULT
DEFAULT: "default"
EXTERNAL
EXTERNAL: "external"
INTERNAL
INTERNAL: "internal"
Variables
AvailableOrderIncludes
Const
AvailableOrderIncludes: Object
Type declaration
RETURNABLE_ITEMS
stringRequiredDefault: "returnable_items"
HTTP_METHODS
Const
HTTP_METHODS: readonly ["GET"
, "POST"
, "PUT"
, "PATCH"
, "DELETE"
, "OPTIONS"
, "HEAD"
]
List of all the supported HTTP methods
PriceType
PriceType: Object
Type declaration
allowedAdminProductCategoryRelations
Const
allowedAdminProductCategoryRelations: string
[]
allowedFields
Const
allowedFields: string
[]
allowedOrderIncludes
Const
allowedOrderIncludes: string
[]
allowedStoreCustomersFields
Const
allowedStoreCustomersFields: string
[]
allowedStoreCustomersRelations
Const
allowedStoreCustomersRelations: string
[]
allowedStoreGiftCardFields
Const
allowedStoreGiftCardFields: string
[]
allowedStoreGiftCardRelations
Const
allowedStoreGiftCardRelations: string
[]
allowedStoreOrdersFields
Const
allowedStoreOrdersFields: string
[]
allowedStoreOrdersRelations
Const
allowedStoreOrdersRelations: string
[]
allowedStoreProductCategoryFields
Const
allowedStoreProductCategoryFields: string
[]
allowedStoreProductTagFields
Const
allowedStoreProductTagFields: string
[]
allowedStoreProductTypeFields
Const
allowedStoreProductTypeFields: string
[]
allowedStoreProductsFields
Const
allowedStoreProductsFields: string
[]
allowedStoreProductsRelations
Const
allowedStoreProductsRelations: string
[]
allowedStoreVariantRelations
Const
allowedStoreVariantRelations: string
[]
defaulPaymentCollectionRelations
Const
defaulPaymentCollectionRelations: string
[]
defaultAdminBatchFields
Const
defaultAdminBatchFields: string
[]
defaultAdminCollectionsFields
Const
defaultAdminCollectionsFields: string
[]
defaultAdminCollectionsRelations
Const
defaultAdminCollectionsRelations: string
[]
defaultAdminCustomerGroupsRelations
Const
defaultAdminCustomerGroupsRelations: never
[] = []
defaultAdminCustomersRelations
Const
defaultAdminCustomersRelations: string
[]
defaultAdminDiscountConditionFields
Const
defaultAdminDiscountConditionFields: keyof DiscountCondition[]
defaultAdminDiscountConditionRelations
Const
defaultAdminDiscountConditionRelations: string
[]
defaultAdminDiscountsFields
Const
defaultAdminDiscountsFields: keyof Discount[]
defaultAdminDiscountsRelations
Const
defaultAdminDiscountsRelations: string
[]
defaultAdminDraftOrdersCartFields
Const
defaultAdminDraftOrdersCartFields: keyof Cart[]
defaultAdminDraftOrdersCartRelations
Const
defaultAdminDraftOrdersCartRelations: string
[]
defaultAdminDraftOrdersFields
Const
defaultAdminDraftOrdersFields: keyof DraftOrder[]
defaultAdminDraftOrdersRelations
Const
defaultAdminDraftOrdersRelations: string
[]
defaultAdminGetProductsVariantsFields
Const
defaultAdminGetProductsVariantsFields: string
[]
defaultAdminGiftCardFields
Const
defaultAdminGiftCardFields: keyof GiftCard[]
defaultAdminGiftCardRelations
Const
defaultAdminGiftCardRelations: string
[]
defaultAdminInventoryItemFields
Const
defaultAdminInventoryItemFields: keyof InventoryItemDTO[]
defaultAdminInventoryItemRelations
Const
defaultAdminInventoryItemRelations: never
[] = []
defaultAdminLocationLevelFields
Const
defaultAdminLocationLevelFields: keyof InventoryLevelDTO[]
defaultAdminNotificationsFields
Const
defaultAdminNotificationsFields: string
[]
defaultAdminNotificationsRelations
Const
defaultAdminNotificationsRelations: string
[]
defaultAdminPriceListFields
Const
defaultAdminPriceListFields: string
[]
defaultAdminPriceListRelations
Const
defaultAdminPriceListRelations: string
[]
defaultAdminPriceListRemoteQueryObject
Const
defaultAdminPriceListRemoteQueryObject: Object
Type declaration
fields
string[]Requiredprice_list_rules
objectRequired
price_list_rules
objectRequiredprice_set_money_amounts
objectRequired
price_set_money_amounts
objectRequireddefaultAdminProductCategoryRelations
Const
defaultAdminProductCategoryRelations: string
[]
defaultAdminProductFields
Const
defaultAdminProductFields: keyof Product[]
defaultAdminProductRelations
Const
defaultAdminProductRelations: string
[]
defaultAdminProductRemoteQueryObject
Const
defaultAdminProductRemoteQueryObject: Object
This is temporary.
Type declaration
categories
objectRequired
categories
objectRequiredcollection
objectRequired
collection
objectRequiredDefault: defaultAdminProductFields
images
objectRequired
images
objectRequiredoptions
objectRequired
options
objectRequiredprofile
objectRequired
profile
objectRequiredsales_channels
objectRequired
sales_channels
objectRequiredtags
objectRequired
tags
objectRequiredtype
objectRequired
type
objectRequiredvariants
objectRequired
variants
objectRequireddefaultAdminProductTagsFields
Const
defaultAdminProductTagsFields: string
[]
defaultAdminProductTagsRelations
Const
defaultAdminProductTagsRelations: never
[] = []
defaultAdminProductTypeFields
Const
defaultAdminProductTypeFields: string
[]
defaultAdminProductTypeRelations
Const
defaultAdminProductTypeRelations: never
[] = []
defaultAdminRegionFields
Const
defaultAdminRegionFields: keyof Region[]
defaultAdminRegionRelations
Const
defaultAdminRegionRelations: string
[]
defaultAdminReservationRelations
Const
defaultAdminReservationRelations: never
[] = []
defaultAdminReturnReasonsFields
Const
defaultAdminReturnReasonsFields: keyof ReturnReason[]
defaultAdminReturnReasonsRelations
Const
defaultAdminReturnReasonsRelations: keyof ReturnReason[]
defaultAdminShippingProfilesFields
Const
defaultAdminShippingProfilesFields: keyof ShippingProfile[]
defaultAdminShippingProfilesRelations
Const
defaultAdminShippingProfilesRelations: string
[]
defaultAdminStockLocationFields
Const
defaultAdminStockLocationFields: keyof StockLocationDTO[]
defaultAdminStockLocationRelations
Const
defaultAdminStockLocationRelations: never
[] = []
defaultAdminSwapFields
Const
defaultAdminSwapFields: string
[]
defaultAdminSwapRelations
Const
defaultAdminSwapRelations: string
[]
defaultAdminTaxRatesFields
Const
defaultAdminTaxRatesFields: keyof TaxRate[]
defaultAdminTaxRatesRelations
Const
defaultAdminTaxRatesRelations: never
[] = []
defaultAdminVariantFields
Const
defaultAdminVariantFields: keyof ProductVariant[]
defaultAdminVariantRelations
Const
defaultAdminVariantRelations: string
[]
defaultFields
Const
defaultFields: keyof ShippingOption[]
defaultPaymentCollectionFields
Const
defaultPaymentCollectionFields: string
[]
defaultPaymentCollectionRelations
Const
defaultPaymentCollectionRelations: string
[]
defaultPaymentFields
Const
defaultPaymentFields: string
[]
defaultProductCategoryFields
Const
defaultProductCategoryFields: string
[]
defaultRelations
Const
defaultRelations: string
[]
defaultRelationsExtended
Const
defaultRelationsExtended: string
[]
defaultRelationsList
Const
defaultRelationsList: string
[]
defaultReservationFields
Const
defaultReservationFields: string
[]
defaultReturnCancelFields
Const
defaultReturnCancelFields: keyof Order[]
defaultReturnCancelRelations
Const
defaultReturnCancelRelations: string
[]
defaultStoreCartFields
Const
defaultStoreCartFields: keyof Cart[] = []
defaultStoreCartRelations
Const
defaultStoreCartRelations: string
[]
defaultStoreCategoryScope
Const
defaultStoreCategoryScope: Object
Type declaration
is_active
booleanRequiredDefault: true
is_internal
booleanRequiredDefault: false
defaultStoreCollectionRelations
Const
defaultStoreCollectionRelations: never
[] = []
defaultStoreCustomersFields
Const
defaultStoreCustomersFields: keyof Customer[]
defaultStoreCustomersRelations
Const
defaultStoreCustomersRelations: string
[]
defaultStoreGiftCardFields
Const
defaultStoreGiftCardFields: keyof GiftCard[]
defaultStoreGiftCardRelations
Const
defaultStoreGiftCardRelations: string
[]
defaultStoreOrdersFields
Const
defaultStoreOrdersFields: keyof Order[]
defaultStoreOrdersRelations
Const
defaultStoreOrdersRelations: string
[]
defaultStoreProductCategoryFields
Const
defaultStoreProductCategoryFields: string
[]
defaultStoreProductCategoryRelations
Const
defaultStoreProductCategoryRelations: string
[]
defaultStoreProductRemoteQueryObject
Const
defaultStoreProductRemoteQueryObject: Object
This is temporary.
Type declaration
collection
objectRequired
collection
objectRequiredDefault: defaultStoreProductsFields
images
objectRequired
images
objectRequiredoptions
objectRequired
options
objectRequiredprofile
objectRequired
profile
objectRequiredsales_channels
objectRequired
sales_channels
objectRequiredtags
objectRequired
tags
objectRequiredtype
objectRequired
type
objectRequiredvariants
objectRequired
variants
objectRequireddefaultStoreProductTagFields
Const
defaultStoreProductTagFields: string
[]
defaultStoreProductTagRelations
Const
defaultStoreProductTagRelations: never
[] = []
defaultStoreProductTypeFields
Const
defaultStoreProductTypeFields: string
[]
defaultStoreProductTypeRelations
Const
defaultStoreProductTypeRelations: never
[] = []
defaultStoreProductsFields
Const
defaultStoreProductsFields: keyof Product[]
defaultStoreProductsRelations
Const
defaultStoreProductsRelations: string
[]
defaultStoreRegionFields
Const
defaultStoreRegionFields: string
[]
defaultStoreRegionRelations
Const
defaultStoreRegionRelations: string
[]
defaultStoreReturnReasonFields
Const
defaultStoreReturnReasonFields: keyof ReturnReason[]
defaultStoreReturnReasonRelations
Const
defaultStoreReturnReasonRelations: keyof ReturnReason[]
defaultStoreSwapFields
Const
defaultStoreSwapFields: FindConfig<Swap>["select"
]
defaultStoreSwapRelations
Const
defaultStoreSwapRelations: string
[]
defaultStoreVariantRelations
Const
defaultStoreVariantRelations: string
[]
filterableAdminOrdersFields
Const
filterableAdminOrdersFields: string
[]
joinerConfig
Const
joinerConfig: ModuleJoinerConfig[]
Functions
DbAwareColumn
Parameters
columnOptions
ColumnOptionsRequiredReturns
PropertyDecorator
PropertyDecoratorRequiredIsType
Parameters
types
any[]RequiredvalidationOptions
ValidationOptionsReturns
(object: Object, propertyName: string) => void
(object: Object, propertyName: string) => voidRequiredParameters
object
ObjectRequiredpropertyName
stringRequiredReturns
void
voidRequiredaddOrderToSelect
Type Parameters
TEntity
objectRequiredParameters
order
FindOptionsOrder<TEntity>Requiredselect
FindOptionsSelect<TEntity>RequiredReturns
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>Requiredauthenticate
Returns
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Required
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>RequiredauthenticateCustomer
Returns
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Required
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>RequiredbuildLegacyFieldsListFrom
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[]Required
keyof TEntity[]
keyof TEntity[]RequiredDeprecated
in favor of import { objectToStringPath } from "@medusajs/utils"
buildQuery
Used to build TypeORM queries.
Type Parameters
TWhereKeys
objectRequiredTEntity
objectRequiredParameters
selector
TWhereKeysRequiredThe configDefault: {}
{}
Returns
The QueryBuilderConfig
calculatePriceTaxAmount
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
numberRequiredcanAccessBatchJob
Parameters
req
anyRequiredres
anyRequirednext
anyRequiredReturns
Promise
Promise<any>Required
Promise
Promise<any>RequiredcategoryMatchesScope
Parameters
A product category can be used to categorize products into a hierarchy of categories.
Returns
boolean
booleanRequiredcleanResponseData
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>RequiredcsvCellContentFormatter
Parameters
str
stringRequiredReturns
string
stringRequiredcsvRevertCellContentFormatter
Parameters
str
stringRequiredReturns
string
stringRequireddoesConditionBelongToDiscount
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
voidRequiredextendedFindParamsMixin
Parameters
__namedParameters
objectRequiredDefault: {}
__namedParameters
objectRequired{}
__namedParameters.limit
number__namedParameters.offset
numberReturns
fetchCategoryDescendantsIds
Parameters
A product category can be used to categorize products into a hierarchy of categories.
Returns
string[]
string[]Required
string[]
string[]RequiredformatException
Parameters
err
anyRequiredReturns
date
DateRequiredmessage
stringRequiredtype
stringRequiredCodes
objectRequired
Codes
objectRequiredTypes
objectRequired
Types
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
stringRequiredgetRequestedBatchJob
Parameters
req
anyRequiredres
anyRequirednext
anyRequiredReturns
Promise
Promise<any>Required
Promise
Promise<any>RequiredgetVariantsFromPriceList
Parameters
priceListId
stringRequiredReturns
hasChanges
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
booleanRequiredisBatchJobStrategy
Parameters
object
unknownRequiredReturns
object
object is IBatchJobStrategyRequiredisCartCompletionStrategy
Parameters
obj
unknownRequiredReturns
boolean
booleanRequiredisDate
Parameters
value
anyRequiredReturns
value
value is DateRequiredisFileService
Parameters
object
unknownRequiredReturns
boolean
booleanRequiredisNotificationService
Parameters
obj
unknownRequiredReturns
boolean
booleanRequiredisObject
Parameters
obj
anyRequiredReturns
obj
obj is objectRequiredisPaymentProcessor
Return if the input object is AbstractPaymentProcessor
Parameters
obj
unknownRequiredReturns
boolean
booleanRequiredisPaymentProcessorError
Utility function to determine if an object is a processor error
Parameters
obj
anyRequiredReturns
obj
obj is PaymentProcessorErrorRequiredisPaymentService
Return if the input object is one of AbstractPaymentService or PaymentService or AbstractPaymentPluginService
Parameters
obj
unknownRequiredReturns
boolean
booleanRequiredisPriceSelectionStrategy
Parameters
object
anyRequiredReturns
object
object is IPriceSelectionStrategyRequiredisString
Parameters
val
anyRequiredReturns
val
val is stringRequiredisTaxCalculationStrategy
Parameters
object
anyRequiredReturns
object
object is ITaxCalculationStrategyRequiredlistProducts
Parameters
Returns
Promise
Promise<any[]>Required
Promise
Promise<any[]>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
voidRequirednullableValue
Parameters
value
anyRequiredReturns
FindOperator
FindOperator<any>Required
FindOperator
FindOperator<any>RequiredomitDeep
Type Parameters
T
objectRequiredParameters
input
objectRequiredexcludes
(string | number)[]RequiredReturns
T
TRequiredregisterOverriddenValidators
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
voidRequiredremoteQueryFetchData
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
TRequiredrequireCustomerAuthentication
Returns
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>Required
RequestHandler
RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>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>RequiredresolveDbGenerationStrategy
Parameters
pgSqlType
"uuid" | "rowid" | "increment"RequiredReturns
"increment" | "uuid" | "rowid"
"increment" | "uuid" | "rowid"RequiredresolveDbType
Parameters
pgSqlType
ColumnTypeRequiredReturns
ColumnType
ColumnTypeRequiredretrieveProduct
Parameters
container
anyRequiredid
anyRequiredremoteQueryObject
objectRequiredDefault: {}
Returns
Promise
Promise<any>Required
Promise
Promise<any>RequiredsetMetadata
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>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>RequiredunauthenticatedInviteRoutes
Parameters
app
anyRequiredReturns
void
voidRequiredunauthenticatedUserRoutes
Parameters
app
anyRequiredReturns
void
voidRequiredupdateInventoryAndReservations
Parameters
context
objectRequired
context
objectRequiredcontext.locationId
stringRequiredReturns
Promise
Promise<void>RequiredvalidateId
Parameters
rawId
stringRequiredconfig
objectRequiredDefault: {}
config
objectRequired{}
config.length
numberconfig.prefix
stringReturns
string
stringRequiredvalidator
Type Parameters
T
objectRequiredV
objectRequiredParameters
Returns
Promise
Promise<T>Required
Promise
Promise<T>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"