1351 lines
122 KiB
Plaintext
1351 lines
122 KiB
Plaintext
import { TypeList } from "docs-ui"
|
|
|
|
# medusa
|
|
|
|
## Enumerations
|
|
|
|
- [BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus/page.mdx)
|
|
- [PriceListType](../../medusa/enums/medusa.PriceListType/page.mdx)
|
|
- [PriceListStatus](../../medusa/enums/medusa.PriceListStatus/page.mdx)
|
|
- [UserRole](../../medusa/enums/medusa.UserRole/page.mdx)
|
|
- [MODULE\_RESOURCE\_TYPE](../../medusa/enums/medusa.MODULE_RESOURCE_TYPE/page.mdx)
|
|
- [TransactionHandlerType](../../medusa/enums/medusa.TransactionHandlerType/page.mdx)
|
|
- [PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1/page.mdx)
|
|
- [PriceListType](../../medusa/enums/medusa.PriceListType-1/page.mdx)
|
|
|
|
## Classes
|
|
|
|
- [MedusaError](../../medusa/classes/medusa.MedusaError/page.mdx)
|
|
- [AdminPostAnalyticsConfigReq](../../medusa/classes/medusa.AdminPostAnalyticsConfigReq/page.mdx)
|
|
- [AdminPostAnalyticsConfigAnalyticsConfigReq](../../medusa/classes/medusa.AdminPostAnalyticsConfigAnalyticsConfigReq/page.mdx)
|
|
- [AdminPostAuthReq](../../medusa/classes/medusa.AdminPostAuthReq/page.mdx)
|
|
- [AdminPostBatchesReq](../../medusa/classes/medusa.AdminPostBatchesReq/page.mdx)
|
|
- [AdminGetBatchPaginationParams](../../medusa/classes/medusa.AdminGetBatchPaginationParams/page.mdx)
|
|
- [AdminGetBatchParams](../../medusa/classes/medusa.AdminGetBatchParams/page.mdx)
|
|
- [AdminPostProductsToCollectionReq](../../medusa/classes/medusa.AdminPostProductsToCollectionReq/page.mdx)
|
|
- [AdminPostCollectionsReq](../../medusa/classes/medusa.AdminPostCollectionsReq/page.mdx)
|
|
- [AdminGetCollectionsPaginationParams](../../medusa/classes/medusa.AdminGetCollectionsPaginationParams/page.mdx)
|
|
- [AdminGetCollectionsParams](../../medusa/classes/medusa.AdminGetCollectionsParams/page.mdx)
|
|
- [AdminDeleteProductsFromCollectionReq](../../medusa/classes/medusa.AdminDeleteProductsFromCollectionReq/page.mdx)
|
|
- [AdminPostCollectionsCollectionReq](../../medusa/classes/medusa.AdminPostCollectionsCollectionReq/page.mdx)
|
|
- [AdminGetCurrenciesParams](../../medusa/classes/medusa.AdminGetCurrenciesParams/page.mdx)
|
|
- [AdminPostCurrenciesCurrencyReq](../../medusa/classes/medusa.AdminPostCurrenciesCurrencyReq/page.mdx)
|
|
- [AdminPostCustomerGroupsGroupCustomersBatchReq](../../medusa/classes/medusa.AdminPostCustomerGroupsGroupCustomersBatchReq/page.mdx)
|
|
- [AdminPostCustomerGroupsReq](../../medusa/classes/medusa.AdminPostCustomerGroupsReq/page.mdx)
|
|
- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../../medusa/classes/medusa.AdminDeleteCustomerGroupsGroupCustomerBatchReq/page.mdx)
|
|
- [AdminGetCustomerGroupsGroupParams](../../medusa/classes/medusa.AdminGetCustomerGroupsGroupParams/page.mdx)
|
|
- [AdminGetCustomerGroupsParams](../../medusa/classes/medusa.AdminGetCustomerGroupsParams/page.mdx)
|
|
- [AdminPostCustomerGroupsGroupReq](../../medusa/classes/medusa.AdminPostCustomerGroupsGroupReq/page.mdx)
|
|
- [AdminPostCustomersReq](../../medusa/classes/medusa.AdminPostCustomersReq/page.mdx)
|
|
- [AdminGetCustomersParams](../../medusa/classes/medusa.AdminGetCustomersParams/page.mdx)
|
|
- [Group](../../medusa/classes/medusa.Group/page.mdx)
|
|
- [AdminPostCustomersCustomerReq](../../medusa/classes/medusa.AdminPostCustomersCustomerReq/page.mdx)
|
|
- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionBatchReq/page.mdx)
|
|
- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionBatchParams/page.mdx)
|
|
- [AdminPostDiscountsDiscountConditions](../../medusa/classes/medusa.AdminPostDiscountsDiscountConditions/page.mdx)
|
|
- [AdminPostDiscountsDiscountConditionsParams](../../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsParams/page.mdx)
|
|
- [AdminPostDiscountsDiscountRule](../../medusa/classes/medusa.AdminPostDiscountsDiscountRule/page.mdx)
|
|
- [AdminPostDiscountsReq](../../medusa/classes/medusa.AdminPostDiscountsReq/page.mdx)
|
|
- [AdminCreateCondition](../../medusa/classes/medusa.AdminCreateCondition/page.mdx)
|
|
- [AdminPostDiscountsParams](../../medusa/classes/medusa.AdminPostDiscountsParams/page.mdx)
|
|
- [AdminPostDiscountsDiscountDynamicCodesReq](../../medusa/classes/medusa.AdminPostDiscountsDiscountDynamicCodesReq/page.mdx)
|
|
- [AdminDeleteDiscountsDiscountConditionsConditionParams](../../medusa/classes/medusa.AdminDeleteDiscountsDiscountConditionsConditionParams/page.mdx)
|
|
- [AdminDeleteDiscountsDiscountConditionsConditionBatchParams](../../medusa/classes/medusa.AdminDeleteDiscountsDiscountConditionsConditionBatchParams/page.mdx)
|
|
- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../../medusa/classes/medusa.AdminDeleteDiscountsDiscountConditionsConditionBatchReq/page.mdx)
|
|
- [AdminGetDiscountsDiscountConditionsConditionParams](../../medusa/classes/medusa.AdminGetDiscountsDiscountConditionsConditionParams/page.mdx)
|
|
- [AdminGetDiscountsDiscountCodeParams](../../medusa/classes/medusa.AdminGetDiscountsDiscountCodeParams/page.mdx)
|
|
- [AdminGetDiscountParams](../../medusa/classes/medusa.AdminGetDiscountParams/page.mdx)
|
|
- [AdminGetDiscountsParams](../../medusa/classes/medusa.AdminGetDiscountsParams/page.mdx)
|
|
- [AdminPostDiscountsDiscountConditionsCondition](../../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsCondition/page.mdx)
|
|
- [AdminPostDiscountsDiscountConditionsConditionParams](../../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionParams/page.mdx)
|
|
- [AdminUpdateDiscountRule](../../medusa/classes/medusa.AdminUpdateDiscountRule/page.mdx)
|
|
- [AdminPostDiscountsDiscountReq](../../medusa/classes/medusa.AdminPostDiscountsDiscountReq/page.mdx)
|
|
- [AdminUpsertCondition](../../medusa/classes/medusa.AdminUpsertCondition/page.mdx)
|
|
- [AdminPostDiscountsDiscountParams](../../medusa/classes/medusa.AdminPostDiscountsDiscountParams/page.mdx)
|
|
- [AdminPostDraftOrdersReq](../../medusa/classes/medusa.AdminPostDraftOrdersReq/page.mdx)
|
|
- [ShippingMethod](../../medusa/classes/medusa.ShippingMethod/page.mdx)
|
|
- [Discount](../../medusa/classes/medusa.Discount/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item/page.mdx)
|
|
- [AdminPostDraftOrdersDraftOrderLineItemsReq](../../medusa/classes/medusa.AdminPostDraftOrdersDraftOrderLineItemsReq/page.mdx)
|
|
- [AdminGetDraftOrdersParams](../../medusa/classes/medusa.AdminGetDraftOrdersParams/page.mdx)
|
|
- [AdminPostDraftOrdersDraftOrderReq](../../medusa/classes/medusa.AdminPostDraftOrdersDraftOrderReq/page.mdx)
|
|
- [Discount](../../medusa/classes/medusa.Discount-1/page.mdx)
|
|
- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../../medusa/classes/medusa.AdminPostDraftOrdersDraftOrderLineItemsItemReq/page.mdx)
|
|
- [AdminPostGiftCardsReq](../../medusa/classes/medusa.AdminPostGiftCardsReq/page.mdx)
|
|
- [AdminGetGiftCardsParams](../../medusa/classes/medusa.AdminGetGiftCardsParams/page.mdx)
|
|
- [AdminPostGiftCardsGiftCardReq](../../medusa/classes/medusa.AdminPostGiftCardsGiftCardReq/page.mdx)
|
|
- [AdminPostInventoryItemsReq](../../medusa/classes/medusa.AdminPostInventoryItemsReq/page.mdx)
|
|
- [AdminPostInventoryItemsParams](../../medusa/classes/medusa.AdminPostInventoryItemsParams/page.mdx)
|
|
- [AdminPostInventoryItemsItemLocationLevelsReq](../../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsReq/page.mdx)
|
|
- [AdminPostInventoryItemsItemLocationLevelsParams](../../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsParams/page.mdx)
|
|
- [AdminGetInventoryItemsItemParams](../../medusa/classes/medusa.AdminGetInventoryItemsItemParams/page.mdx)
|
|
- [AdminGetInventoryItemsParams](../../medusa/classes/medusa.AdminGetInventoryItemsParams/page.mdx)
|
|
- [AdminGetInventoryItemsItemLocationLevelsParams](../../medusa/classes/medusa.AdminGetInventoryItemsItemLocationLevelsParams/page.mdx)
|
|
- [AdminPostInventoryItemsInventoryItemReq](../../medusa/classes/medusa.AdminPostInventoryItemsInventoryItemReq/page.mdx)
|
|
- [AdminPostInventoryItemsInventoryItemParams](../../medusa/classes/medusa.AdminPostInventoryItemsInventoryItemParams/page.mdx)
|
|
- [AdminPostInventoryItemsItemLocationLevelsLevelReq](../../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsLevelReq/page.mdx)
|
|
- [AdminPostInventoryItemsItemLocationLevelsLevelParams](../../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsLevelParams/page.mdx)
|
|
- [AdminPostInvitesInviteAcceptUserReq](../../medusa/classes/medusa.AdminPostInvitesInviteAcceptUserReq/page.mdx)
|
|
- [AdminPostInvitesInviteAcceptReq](../../medusa/classes/medusa.AdminPostInvitesInviteAcceptReq/page.mdx)
|
|
- [AdminPostInvitesReq](../../medusa/classes/medusa.AdminPostInvitesReq/page.mdx)
|
|
- [AdminPostNotesReq](../../medusa/classes/medusa.AdminPostNotesReq/page.mdx)
|
|
- [AdminGetNotesParams](../../medusa/classes/medusa.AdminGetNotesParams/page.mdx)
|
|
- [AdminPostNotesNoteReq](../../medusa/classes/medusa.AdminPostNotesNoteReq/page.mdx)
|
|
- [AdminGetNotificationsParams](../../medusa/classes/medusa.AdminGetNotificationsParams/page.mdx)
|
|
- [AdminPostNotificationsNotificationResendReq](../../medusa/classes/medusa.AdminPostNotificationsNotificationResendReq/page.mdx)
|
|
- [AdminPostOrderEditsEditLineItemsReq](../../medusa/classes/medusa.AdminPostOrderEditsEditLineItemsReq/page.mdx)
|
|
- [AdminPostOrderEditsReq](../../medusa/classes/medusa.AdminPostOrderEditsReq/page.mdx)
|
|
- [GetOrderEditsOrderEditParams](../../medusa/classes/medusa.GetOrderEditsOrderEditParams/page.mdx)
|
|
- [GetOrderEditsParams](../../medusa/classes/medusa.GetOrderEditsParams/page.mdx)
|
|
- [AdminPostOrderEditsRequestConfirmationReq](../../medusa/classes/medusa.AdminPostOrderEditsRequestConfirmationReq/page.mdx)
|
|
- [AdminPostOrderEditsEditLineItemsLineItemReq](../../medusa/classes/medusa.AdminPostOrderEditsEditLineItemsLineItemReq/page.mdx)
|
|
- [AdminPostOrderEditsOrderEditReq](../../medusa/classes/medusa.AdminPostOrderEditsOrderEditReq/page.mdx)
|
|
- [AdminPostOrdersOrderShippingMethodsReq](../../medusa/classes/medusa.AdminPostOrdersOrderShippingMethodsReq/page.mdx)
|
|
- [AdminPostOrdersOrderShippingMethodsParams](../../medusa/classes/medusa.AdminPostOrdersOrderShippingMethodsParams/page.mdx)
|
|
- [AdminPostOrdersOrderArchiveParams](../../medusa/classes/medusa.AdminPostOrdersOrderArchiveParams/page.mdx)
|
|
- [AdminPostOrdersClaimCancel](../../medusa/classes/medusa.AdminPostOrdersClaimCancel/page.mdx)
|
|
- [AdminPostOrdersClaimFulfillmentsCancelParams](../../medusa/classes/medusa.AdminPostOrdersClaimFulfillmentsCancelParams/page.mdx)
|
|
- [AdminPostOrdersOrderSwapFulfillementsCancelParams](../../medusa/classes/medusa.AdminPostOrdersOrderSwapFulfillementsCancelParams/page.mdx)
|
|
- [AdminPostOrdersOrderFulfillementsCancelParams](../../medusa/classes/medusa.AdminPostOrdersOrderFulfillementsCancelParams/page.mdx)
|
|
- [AdminPostOrdersOrderCancel](../../medusa/classes/medusa.AdminPostOrdersOrderCancel/page.mdx)
|
|
- [AdminPostOrdersSwapCancelParams](../../medusa/classes/medusa.AdminPostOrdersSwapCancelParams/page.mdx)
|
|
- [AdminPostOrdersOrderCaptureParams](../../medusa/classes/medusa.AdminPostOrdersOrderCaptureParams/page.mdx)
|
|
- [AdminPostOrdersOrderCompleteParams](../../medusa/classes/medusa.AdminPostOrdersOrderCompleteParams/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsReq/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsClaimShipmentsParams](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsParams/page.mdx)
|
|
- [ReturnShipping](../../medusa/classes/medusa.ReturnShipping/page.mdx)
|
|
- [ShippingMethod](../../medusa/classes/medusa.ShippingMethod-1/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item-1/page.mdx)
|
|
- [AdditionalItem](../../medusa/classes/medusa.AdditionalItem/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsReq/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsParams](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsParams/page.mdx)
|
|
- [AdminPostOrdersOrderFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderFulfillmentsReq/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item-2/page.mdx)
|
|
- [AdminPostOrdersOrderFulfillmentsParams](../../medusa/classes/medusa.AdminPostOrdersOrderFulfillmentsParams/page.mdx)
|
|
- [AdminPostOrdersOrderShipmentReq](../../medusa/classes/medusa.AdminPostOrdersOrderShipmentReq/page.mdx)
|
|
- [AdminPostOrdersOrderShipmentParams](../../medusa/classes/medusa.AdminPostOrdersOrderShipmentParams/page.mdx)
|
|
- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsReq/page.mdx)
|
|
- [AdminPostOrdersOrderSwapsSwapShipmentsParams](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsParams/page.mdx)
|
|
- [ReturnItem](../../medusa/classes/medusa.ReturnItem/page.mdx)
|
|
- [ReturnShipping](../../medusa/classes/medusa.ReturnShipping-1/page.mdx)
|
|
- [CustomShippingOption](../../medusa/classes/medusa.CustomShippingOption/page.mdx)
|
|
- [AdditionalItem](../../medusa/classes/medusa.AdditionalItem-1/page.mdx)
|
|
- [AdminPostOrdersOrderSwapsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsReq/page.mdx)
|
|
- [AdminPostOrdersOrderSwapsParams](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsParams/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsReq/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsClaimFulfillmentsParams](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsParams/page.mdx)
|
|
- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapFulfillmentsReq/page.mdx)
|
|
- [AdminPostOrdersOrderSwapsSwapFulfillmentsParams](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapFulfillmentsParams/page.mdx)
|
|
- [AdminGetOrdersOrderParams](../../medusa/classes/medusa.AdminGetOrdersOrderParams/page.mdx)
|
|
- [AdminGetOrdersParams](../../medusa/classes/medusa.AdminGetOrdersParams/page.mdx)
|
|
- [AdminPostOrdersOrderSwapsSwapProcessPaymentParams](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapProcessPaymentParams/page.mdx)
|
|
- [AdminPostOrdersOrderRefundsReq](../../medusa/classes/medusa.AdminPostOrdersOrderRefundsReq/page.mdx)
|
|
- [AdminPostOrdersOrderRefundsParams](../../medusa/classes/medusa.AdminPostOrdersOrderRefundsParams/page.mdx)
|
|
- [ReturnShipping](../../medusa/classes/medusa.ReturnShipping-2/page.mdx)
|
|
- [AdminPostOrdersOrderReturnsReq](../../medusa/classes/medusa.AdminPostOrdersOrderReturnsReq/page.mdx)
|
|
- [AdminPostOrdersOrderReturnsParams](../../medusa/classes/medusa.AdminPostOrdersOrderReturnsParams/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsClaimReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimReq/page.mdx)
|
|
- [ShippingMethod](../../medusa/classes/medusa.ShippingMethod-2/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item-3/page.mdx)
|
|
- [Image](../../medusa/classes/medusa.Image/page.mdx)
|
|
- [Tag](../../medusa/classes/medusa.Tag/page.mdx)
|
|
- [AdminPostOrdersOrderClaimsClaimParams](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimParams/page.mdx)
|
|
- [PaymentMethod](../../medusa/classes/medusa.PaymentMethod/page.mdx)
|
|
- [ShippingMethod](../../medusa/classes/medusa.ShippingMethod-3/page.mdx)
|
|
- [AdminPostOrdersOrderReq](../../medusa/classes/medusa.AdminPostOrdersOrderReq/page.mdx)
|
|
- [AdminPostOrdersOrderParams](../../medusa/classes/medusa.AdminPostOrdersOrderParams/page.mdx)
|
|
- [AdminGetPaymentCollectionsParams](../../medusa/classes/medusa.AdminGetPaymentCollectionsParams/page.mdx)
|
|
- [AdminUpdatePaymentCollectionsReq](../../medusa/classes/medusa.AdminUpdatePaymentCollectionsReq/page.mdx)
|
|
- [GetPaymentsParams](../../medusa/classes/medusa.GetPaymentsParams/page.mdx)
|
|
- [AdminPostPaymentRefundsReq](../../medusa/classes/medusa.AdminPostPaymentRefundsReq/page.mdx)
|
|
- [AdminPostPriceListPricesPricesReq](../../medusa/classes/medusa.AdminPostPriceListPricesPricesReq/page.mdx)
|
|
- [CustomerGroup](../../medusa/classes/medusa.CustomerGroup/page.mdx)
|
|
- [AdminPostPriceListsPriceListReq](../../medusa/classes/medusa.AdminPostPriceListsPriceListReq/page.mdx)
|
|
- [AdminDeletePriceListPricesPricesReq](../../medusa/classes/medusa.AdminDeletePriceListPricesPricesReq/page.mdx)
|
|
- [AdminDeletePriceListsPriceListProductsPricesBatchReq](../../medusa/classes/medusa.AdminDeletePriceListsPriceListProductsPricesBatchReq/page.mdx)
|
|
- [AdminGetPriceListsPriceListProductsParams](../../medusa/classes/medusa.AdminGetPriceListsPriceListProductsParams/page.mdx)
|
|
- [AdminGetPriceListPaginationParams](../../medusa/classes/medusa.AdminGetPriceListPaginationParams/page.mdx)
|
|
- [CustomerGroup](../../medusa/classes/medusa.CustomerGroup-1/page.mdx)
|
|
- [AdminPostPriceListsPriceListPriceListReq](../../medusa/classes/medusa.AdminPostPriceListsPriceListPriceListReq/page.mdx)
|
|
- [AdminPostProductCategoriesCategoryProductsBatchReq](../../medusa/classes/medusa.AdminPostProductCategoriesCategoryProductsBatchReq/page.mdx)
|
|
- [AdminPostProductCategoriesCategoryProductsBatchParams](../../medusa/classes/medusa.AdminPostProductCategoriesCategoryProductsBatchParams/page.mdx)
|
|
- [AdminPostProductCategoriesReq](../../medusa/classes/medusa.AdminPostProductCategoriesReq/page.mdx)
|
|
- [AdminPostProductCategoriesParams](../../medusa/classes/medusa.AdminPostProductCategoriesParams/page.mdx)
|
|
- [AdminDeleteProductCategoriesCategoryProductsBatchReq](../../medusa/classes/medusa.AdminDeleteProductCategoriesCategoryProductsBatchReq/page.mdx)
|
|
- [AdminDeleteProductCategoriesCategoryProductsBatchParams](../../medusa/classes/medusa.AdminDeleteProductCategoriesCategoryProductsBatchParams/page.mdx)
|
|
- [AdminGetProductCategoryParams](../../medusa/classes/medusa.AdminGetProductCategoryParams/page.mdx)
|
|
- [AdminGetProductCategoriesParams](../../medusa/classes/medusa.AdminGetProductCategoriesParams/page.mdx)
|
|
- [AdminPostProductCategoriesCategoryReq](../../medusa/classes/medusa.AdminPostProductCategoriesCategoryReq/page.mdx)
|
|
- [AdminPostProductCategoriesCategoryParams](../../medusa/classes/medusa.AdminPostProductCategoriesCategoryParams/page.mdx)
|
|
- [AdminGetProductTagsPaginationParams](../../medusa/classes/medusa.AdminGetProductTagsPaginationParams/page.mdx)
|
|
- [AdminGetProductTagsParams](../../medusa/classes/medusa.AdminGetProductTagsParams/page.mdx)
|
|
- [AdminGetProductTypesParams](../../medusa/classes/medusa.AdminGetProductTypesParams/page.mdx)
|
|
- [AdminPostProductsProductOptionsReq](../../medusa/classes/medusa.AdminPostProductsProductOptionsReq/page.mdx)
|
|
- [ProductVariantOptionReq](../../medusa/classes/medusa.ProductVariantOptionReq/page.mdx)
|
|
- [ProductOptionReq](../../medusa/classes/medusa.ProductOptionReq/page.mdx)
|
|
- [ProductVariantReq](../../medusa/classes/medusa.ProductVariantReq/page.mdx)
|
|
- [AdminPostProductsReq](../../medusa/classes/medusa.AdminPostProductsReq/page.mdx)
|
|
- [ProductVariantOptionReq](../../medusa/classes/medusa.ProductVariantOptionReq-1/page.mdx)
|
|
- [AdminPostProductsProductVariantsReq](../../medusa/classes/medusa.AdminPostProductsProductVariantsReq/page.mdx)
|
|
- [AdminGetProductParams](../../medusa/classes/medusa.AdminGetProductParams/page.mdx)
|
|
- [AdminGetProductsParams](../../medusa/classes/medusa.AdminGetProductsParams/page.mdx)
|
|
- [AdminGetProductsVariantsParams](../../medusa/classes/medusa.AdminGetProductsVariantsParams/page.mdx)
|
|
- [AdminPostProductsProductMetadataReq](../../medusa/classes/medusa.AdminPostProductsProductMetadataReq/page.mdx)
|
|
- [AdminPostProductsProductOptionsOption](../../medusa/classes/medusa.AdminPostProductsProductOptionsOption/page.mdx)
|
|
- [ProductVariantOptionReq](../../medusa/classes/medusa.ProductVariantOptionReq-2/page.mdx)
|
|
- [ProductVariantReq](../../medusa/classes/medusa.ProductVariantReq-1/page.mdx)
|
|
- [AdminPostProductsProductReq](../../medusa/classes/medusa.AdminPostProductsProductReq/page.mdx)
|
|
- [ProductVariantOptionReq](../../medusa/classes/medusa.ProductVariantOptionReq-3/page.mdx)
|
|
- [AdminPostProductsProductVariantsVariantReq](../../medusa/classes/medusa.AdminPostProductsProductVariantsVariantReq/page.mdx)
|
|
- [AdminPostPublishableApiKeySalesChannelsBatchReq](../../medusa/classes/medusa.AdminPostPublishableApiKeySalesChannelsBatchReq/page.mdx)
|
|
- [AdminPostPublishableApiKeysReq](../../medusa/classes/medusa.AdminPostPublishableApiKeysReq/page.mdx)
|
|
- [AdminDeletePublishableApiKeySalesChannelsBatchReq](../../medusa/classes/medusa.AdminDeletePublishableApiKeySalesChannelsBatchReq/page.mdx)
|
|
- [GetPublishableApiKeySalesChannelsParams](../../medusa/classes/medusa.GetPublishableApiKeySalesChannelsParams/page.mdx)
|
|
- [GetPublishableApiKeysParams](../../medusa/classes/medusa.GetPublishableApiKeysParams/page.mdx)
|
|
- [AdminPostPublishableApiKeysPublishableApiKeyReq](../../medusa/classes/medusa.AdminPostPublishableApiKeysPublishableApiKeyReq/page.mdx)
|
|
- [AdminPostRegionsRegionCountriesReq](../../medusa/classes/medusa.AdminPostRegionsRegionCountriesReq/page.mdx)
|
|
- [AdminPostRegionsRegionFulfillmentProvidersReq](../../medusa/classes/medusa.AdminPostRegionsRegionFulfillmentProvidersReq/page.mdx)
|
|
- [AdminPostRegionsRegionPaymentProvidersReq](../../medusa/classes/medusa.AdminPostRegionsRegionPaymentProvidersReq/page.mdx)
|
|
- [AdminPostRegionsReq](../../medusa/classes/medusa.AdminPostRegionsReq/page.mdx)
|
|
- [AdminGetRegionsRegionParams](../../medusa/classes/medusa.AdminGetRegionsRegionParams/page.mdx)
|
|
- [FulfillmentOption](../../medusa/classes/medusa.FulfillmentOption/page.mdx)
|
|
- [AdminGetRegionsRegionFulfillmentOptionsRes](../../medusa/classes/medusa.AdminGetRegionsRegionFulfillmentOptionsRes/page.mdx)
|
|
- [AdminGetRegionsParams](../../medusa/classes/medusa.AdminGetRegionsParams/page.mdx)
|
|
- [AdminPostRegionsRegionReq](../../medusa/classes/medusa.AdminPostRegionsRegionReq/page.mdx)
|
|
- [AdminPostReservationsReq](../../medusa/classes/medusa.AdminPostReservationsReq/page.mdx)
|
|
- [AdminGetReservationsParams](../../medusa/classes/medusa.AdminGetReservationsParams/page.mdx)
|
|
- [AdminPostReservationsReservationReq](../../medusa/classes/medusa.AdminPostReservationsReservationReq/page.mdx)
|
|
- [AdminPostReturnReasonsReq](../../medusa/classes/medusa.AdminPostReturnReasonsReq/page.mdx)
|
|
- [AdminPostReturnReasonsReasonReq](../../medusa/classes/medusa.AdminPostReturnReasonsReasonReq/page.mdx)
|
|
- [AdminGetReturnsParams](../../medusa/classes/medusa.AdminGetReturnsParams/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item-4/page.mdx)
|
|
- [AdminPostReturnsReturnReceiveReq](../../medusa/classes/medusa.AdminPostReturnsReturnReceiveReq/page.mdx)
|
|
- [AdminPostSalesChannelsChannelProductsBatchReq](../../medusa/classes/medusa.AdminPostSalesChannelsChannelProductsBatchReq/page.mdx)
|
|
- [AdminPostSalesChannelsChannelStockLocationsReq](../../medusa/classes/medusa.AdminPostSalesChannelsChannelStockLocationsReq/page.mdx)
|
|
- [AdminPostSalesChannelsReq](../../medusa/classes/medusa.AdminPostSalesChannelsReq/page.mdx)
|
|
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../../medusa/classes/medusa.AdminDeleteSalesChannelsChannelProductsBatchReq/page.mdx)
|
|
- [AdminGetSalesChannelsParams](../../medusa/classes/medusa.AdminGetSalesChannelsParams/page.mdx)
|
|
- [AdminDeleteSalesChannelsChannelStockLocationsReq](../../medusa/classes/medusa.AdminDeleteSalesChannelsChannelStockLocationsReq/page.mdx)
|
|
- [AdminPostSalesChannelsSalesChannelReq](../../medusa/classes/medusa.AdminPostSalesChannelsSalesChannelReq/page.mdx)
|
|
- [OptionRequirement](../../medusa/classes/medusa.OptionRequirement/page.mdx)
|
|
- [AdminPostShippingOptionsReq](../../medusa/classes/medusa.AdminPostShippingOptionsReq/page.mdx)
|
|
- [AdminGetShippingOptionsParams](../../medusa/classes/medusa.AdminGetShippingOptionsParams/page.mdx)
|
|
- [OptionRequirement](../../medusa/classes/medusa.OptionRequirement-1/page.mdx)
|
|
- [AdminPostShippingOptionsOptionReq](../../medusa/classes/medusa.AdminPostShippingOptionsOptionReq/page.mdx)
|
|
- [AdminPostShippingProfilesReq](../../medusa/classes/medusa.AdminPostShippingProfilesReq/page.mdx)
|
|
- [AdminPostShippingProfilesProfileReq](../../medusa/classes/medusa.AdminPostShippingProfilesProfileReq/page.mdx)
|
|
- [StockLocationAddress](../../medusa/classes/medusa.StockLocationAddress/page.mdx)
|
|
- [AdminPostStockLocationsReq](../../medusa/classes/medusa.AdminPostStockLocationsReq/page.mdx)
|
|
- [AdminPostStockLocationsParams](../../medusa/classes/medusa.AdminPostStockLocationsParams/page.mdx)
|
|
- [AdminGetStockLocationsLocationParams](../../medusa/classes/medusa.AdminGetStockLocationsLocationParams/page.mdx)
|
|
- [AdminGetStockLocationsParams](../../medusa/classes/medusa.AdminGetStockLocationsParams/page.mdx)
|
|
- [StockLocationAddress](../../medusa/classes/medusa.StockLocationAddress-1/page.mdx)
|
|
- [AdminPostStockLocationsLocationReq](../../medusa/classes/medusa.AdminPostStockLocationsLocationReq/page.mdx)
|
|
- [AdminPostStockLocationsLocationParams](../../medusa/classes/medusa.AdminPostStockLocationsLocationParams/page.mdx)
|
|
- [AdminPostStoreReq](../../medusa/classes/medusa.AdminPostStoreReq/page.mdx)
|
|
- [AdminGetSwapsParams](../../medusa/classes/medusa.AdminGetSwapsParams/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateProductTypesReq](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductTypesReq/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateProductTypesParams](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductTypesParams/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateProductsReq](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductsReq/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateProductsParams](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductsParams/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateShippingOptionsReq/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateShippingOptionsParams](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateShippingOptionsParams/page.mdx)
|
|
- [AdminPostTaxRatesReq](../../medusa/classes/medusa.AdminPostTaxRatesReq/page.mdx)
|
|
- [AdminPostTaxRatesParams](../../medusa/classes/medusa.AdminPostTaxRatesParams/page.mdx)
|
|
- [AdminGetTaxRatesTaxRateParams](../../medusa/classes/medusa.AdminGetTaxRatesTaxRateParams/page.mdx)
|
|
- [AdminGetTaxRatesParams](../../medusa/classes/medusa.AdminGetTaxRatesParams/page.mdx)
|
|
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductTypesReq/page.mdx)
|
|
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductTypesParams/page.mdx)
|
|
- [AdminDeleteTaxRatesTaxRateProductsReq](../../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductsReq/page.mdx)
|
|
- [AdminDeleteTaxRatesTaxRateProductsParams](../../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductsParams/page.mdx)
|
|
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateShippingOptionsReq/page.mdx)
|
|
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateShippingOptionsParams/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateReq](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateReq/page.mdx)
|
|
- [AdminPostTaxRatesTaxRateParams](../../medusa/classes/medusa.AdminPostTaxRatesTaxRateParams/page.mdx)
|
|
- [IAdminPostUploadsFileReq](../../medusa/classes/medusa.IAdminPostUploadsFileReq/page.mdx)
|
|
- [AdminDeleteUploadsReq](../../medusa/classes/medusa.AdminDeleteUploadsReq/page.mdx)
|
|
- [AdminPostUploadsDownloadUrlReq](../../medusa/classes/medusa.AdminPostUploadsDownloadUrlReq/page.mdx)
|
|
- [AdminCreateUserRequest](../../medusa/classes/medusa.AdminCreateUserRequest/page.mdx)
|
|
- [AdminGetUsersParams](../../medusa/classes/medusa.AdminGetUsersParams/page.mdx)
|
|
- [AdminResetPasswordTokenRequest](../../medusa/classes/medusa.AdminResetPasswordTokenRequest/page.mdx)
|
|
- [AdminResetPasswordRequest](../../medusa/classes/medusa.AdminResetPasswordRequest/page.mdx)
|
|
- [AdminUpdateUserRequest](../../medusa/classes/medusa.AdminUpdateUserRequest/page.mdx)
|
|
- [AdminGetVariantParams](../../medusa/classes/medusa.AdminGetVariantParams/page.mdx)
|
|
- [AdminGetVariantsParams](../../medusa/classes/medusa.AdminGetVariantsParams/page.mdx)
|
|
- [AdminGetWorkflowExecutionDetailsParams](../../medusa/classes/medusa.AdminGetWorkflowExecutionDetailsParams/page.mdx)
|
|
- [AdminGetWorkflowExecutionsParams](../../medusa/classes/medusa.AdminGetWorkflowExecutionsParams/page.mdx)
|
|
- [AdminPostWorkflowsRunReq](../../medusa/classes/medusa.AdminPostWorkflowsRunReq/page.mdx)
|
|
- [AdminPostWorkflowsAsyncResponseReq](../../medusa/classes/medusa.AdminPostWorkflowsAsyncResponseReq/page.mdx)
|
|
- [StorePostAuthReq](../../medusa/classes/medusa.StorePostAuthReq/page.mdx)
|
|
- [StorePostCartsCartShippingMethodReq](../../medusa/classes/medusa.StorePostCartsCartShippingMethodReq/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item-5/page.mdx)
|
|
- [StorePostCartReq](../../medusa/classes/medusa.StorePostCartReq/page.mdx)
|
|
- [StorePostCartsCartLineItemsReq](../../medusa/classes/medusa.StorePostCartsCartLineItemsReq/page.mdx)
|
|
- [StorePostCartsCartPaymentSessionReq](../../medusa/classes/medusa.StorePostCartsCartPaymentSessionReq/page.mdx)
|
|
- [GiftCard](../../medusa/classes/medusa.GiftCard/page.mdx)
|
|
- [Discount](../../medusa/classes/medusa.Discount-2/page.mdx)
|
|
- [StorePostCartsCartReq](../../medusa/classes/medusa.StorePostCartsCartReq/page.mdx)
|
|
- [StorePostCartsCartLineItemsItemReq](../../medusa/classes/medusa.StorePostCartsCartLineItemsItemReq/page.mdx)
|
|
- [StorePostCartsCartPaymentSessionUpdateReq](../../medusa/classes/medusa.StorePostCartsCartPaymentSessionUpdateReq/page.mdx)
|
|
- [StoreGetCollectionsParams](../../medusa/classes/medusa.StoreGetCollectionsParams/page.mdx)
|
|
- [StorePostCustomersCustomerAddressesReq](../../medusa/classes/medusa.StorePostCustomersCustomerAddressesReq/page.mdx)
|
|
- [StorePostCustomersReq](../../medusa/classes/medusa.StorePostCustomersReq/page.mdx)
|
|
- [StoreGetCustomersCustomerOrdersPaginationParams](../../medusa/classes/medusa.StoreGetCustomersCustomerOrdersPaginationParams/page.mdx)
|
|
- [StoreGetCustomersCustomerOrdersParams](../../medusa/classes/medusa.StoreGetCustomersCustomerOrdersParams/page.mdx)
|
|
- [StorePostCustomersCustomerPasswordTokenReq](../../medusa/classes/medusa.StorePostCustomersCustomerPasswordTokenReq/page.mdx)
|
|
- [StorePostCustomersResetPasswordReq](../../medusa/classes/medusa.StorePostCustomersResetPasswordReq/page.mdx)
|
|
- [StorePostCustomersCustomerAddressesAddressReq](../../medusa/classes/medusa.StorePostCustomersCustomerAddressesAddressReq/page.mdx)
|
|
- [StorePostCustomersCustomerReq](../../medusa/classes/medusa.StorePostCustomersCustomerReq/page.mdx)
|
|
- [StorePostOrderEditsOrderEditDecline](../../medusa/classes/medusa.StorePostOrderEditsOrderEditDecline/page.mdx)
|
|
- [StorePostCustomersCustomerAcceptClaimReq](../../medusa/classes/medusa.StorePostCustomersCustomerAcceptClaimReq/page.mdx)
|
|
- [ShippingAddressPayload](../../medusa/classes/medusa.ShippingAddressPayload/page.mdx)
|
|
- [StoreGetOrdersParams](../../medusa/classes/medusa.StoreGetOrdersParams/page.mdx)
|
|
- [StorePostCustomersCustomerOrderClaimReq](../../medusa/classes/medusa.StorePostCustomersCustomerOrderClaimReq/page.mdx)
|
|
- [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../../medusa/classes/medusa.StorePostPaymentCollectionsBatchSessionsAuthorizeReq/page.mdx)
|
|
- [StoreGetPaymentCollectionsParams](../../medusa/classes/medusa.StoreGetPaymentCollectionsParams/page.mdx)
|
|
- [StorePostPaymentCollectionsSessionsReq](../../medusa/classes/medusa.StorePostPaymentCollectionsSessionsReq/page.mdx)
|
|
- [StorePostPaymentCollectionsBatchSessionsReq](../../medusa/classes/medusa.StorePostPaymentCollectionsBatchSessionsReq/page.mdx)
|
|
- [StorePaymentCollectionSessionsReq](../../medusa/classes/medusa.StorePaymentCollectionSessionsReq/page.mdx)
|
|
- [StoreGetProductCategoriesCategoryParams](../../medusa/classes/medusa.StoreGetProductCategoriesCategoryParams/page.mdx)
|
|
- [StoreGetProductCategoriesParams](../../medusa/classes/medusa.StoreGetProductCategoriesParams/page.mdx)
|
|
- [StoreGetProductTagsParams](../../medusa/classes/medusa.StoreGetProductTagsParams/page.mdx)
|
|
- [StoreGetProductTypesParams](../../medusa/classes/medusa.StoreGetProductTypesParams/page.mdx)
|
|
- [StoreGetProductsPaginationParams](../../medusa/classes/medusa.StoreGetProductsPaginationParams/page.mdx)
|
|
- [StoreGetProductsParams](../../medusa/classes/medusa.StoreGetProductsParams/page.mdx)
|
|
- [StorePostSearchReq](../../medusa/classes/medusa.StorePostSearchReq/page.mdx)
|
|
- [StoreGetRegionsRegionParams](../../medusa/classes/medusa.StoreGetRegionsRegionParams/page.mdx)
|
|
- [StoreGetRegionsParams](../../medusa/classes/medusa.StoreGetRegionsParams/page.mdx)
|
|
- [ReturnShipping](../../medusa/classes/medusa.ReturnShipping-3/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item-6/page.mdx)
|
|
- [StorePostReturnsReq](../../medusa/classes/medusa.StorePostReturnsReq/page.mdx)
|
|
- [StoreGetShippingOptionsParams](../../medusa/classes/medusa.StoreGetShippingOptionsParams/page.mdx)
|
|
- [Item](../../medusa/classes/medusa.Item-7/page.mdx)
|
|
- [AdditionalItem](../../medusa/classes/medusa.AdditionalItem-2/page.mdx)
|
|
- [StorePostSwapsReq](../../medusa/classes/medusa.StorePostSwapsReq/page.mdx)
|
|
- [StoreGetVariantsVariantParams](../../medusa/classes/medusa.StoreGetVariantsVariantParams/page.mdx)
|
|
- [StoreGetVariantsParams](../../medusa/classes/medusa.StoreGetVariantsParams/page.mdx)
|
|
- [FilterableBatchJobProps](../../medusa/classes/medusa.FilterableBatchJobProps/page.mdx)
|
|
- [EmptyQueryParams](../../medusa/classes/medusa.EmptyQueryParams/page.mdx)
|
|
- [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator/page.mdx)
|
|
- [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator/page.mdx)
|
|
- [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator/page.mdx)
|
|
- [AddressPayload](../../medusa/classes/medusa.AddressPayload/page.mdx)
|
|
- [AddressCreatePayload](../../medusa/classes/medusa.AddressCreatePayload/page.mdx)
|
|
- [FindParams](../../medusa/classes/medusa.FindParams/page.mdx)
|
|
- [FindPaginationParams](../../medusa/classes/medusa.FindPaginationParams/page.mdx)
|
|
- [FilterableCustomerGroupProps](../../medusa/classes/medusa.FilterableCustomerGroupProps/page.mdx)
|
|
- [CustomerGroupsBatchCustomer](../../medusa/classes/medusa.CustomerGroupsBatchCustomer/page.mdx)
|
|
- [AdminListCustomerSelector](../../medusa/classes/medusa.AdminListCustomerSelector/page.mdx)
|
|
- [AdminGetDiscountsDiscountRuleParams](../../medusa/classes/medusa.AdminGetDiscountsDiscountRuleParams/page.mdx)
|
|
- [AdminUpsertConditionsReq](../../medusa/classes/medusa.AdminUpsertConditionsReq/page.mdx)
|
|
- [AdminListOrdersSelector](../../medusa/classes/medusa.AdminListOrdersSelector/page.mdx)
|
|
- [OrdersReturnItem](../../medusa/classes/medusa.OrdersReturnItem/page.mdx)
|
|
- [FilterablePriceListProps](../../medusa/classes/medusa.FilterablePriceListProps/page.mdx)
|
|
- [AdminPriceListPricesUpdateReq](../../medusa/classes/medusa.AdminPriceListPricesUpdateReq/page.mdx)
|
|
- [AdminPriceListPricesCreateReq](../../medusa/classes/medusa.AdminPriceListPricesCreateReq/page.mdx)
|
|
- [PriceSelectionParams](../../medusa/classes/medusa.PriceSelectionParams/page.mdx)
|
|
- [AdminPriceSelectionParams](../../medusa/classes/medusa.AdminPriceSelectionParams/page.mdx)
|
|
- [AdminProductCategoriesReqBase](../../medusa/classes/medusa.AdminProductCategoriesReqBase/page.mdx)
|
|
- [ProductBatchProductCategory](../../medusa/classes/medusa.ProductBatchProductCategory/page.mdx)
|
|
- [ProductVariantPricesUpdateReq](../../medusa/classes/medusa.ProductVariantPricesUpdateReq/page.mdx)
|
|
- [ProductVariantPricesCreateReq](../../medusa/classes/medusa.ProductVariantPricesCreateReq/page.mdx)
|
|
- [FilterableProductProps](../../medusa/classes/medusa.FilterableProductProps/page.mdx)
|
|
- [ProductSalesChannelReq](../../medusa/classes/medusa.ProductSalesChannelReq/page.mdx)
|
|
- [ProductProductCategoryReq](../../medusa/classes/medusa.ProductProductCategoryReq/page.mdx)
|
|
- [ProductTagReq](../../medusa/classes/medusa.ProductTagReq/page.mdx)
|
|
- [ProductTypeReq](../../medusa/classes/medusa.ProductTypeReq/page.mdx)
|
|
- [ProductBatchSalesChannel](../../medusa/classes/medusa.ProductBatchSalesChannel/page.mdx)
|
|
|
|
## Interfaces
|
|
|
|
- [FindConfig](../../medusa/interfaces/medusa.FindConfig/page.mdx)
|
|
- [CustomFindOptions](../../medusa/interfaces/medusa.CustomFindOptions/page.mdx)
|
|
- [RequestQueryFields](../../medusa/interfaces/medusa.RequestQueryFields/page.mdx)
|
|
- [PaginatedResponse](../../medusa/interfaces/medusa.PaginatedResponse/page.mdx)
|
|
- [DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse/page.mdx)
|
|
- [MedusaRequest](../../medusa/interfaces/medusa.MedusaRequest/page.mdx)
|
|
- [AuthenticatedMedusaRequest](../../medusa/interfaces/medusa.AuthenticatedMedusaRequest/page.mdx)
|
|
- [SubscriberContext](../../medusa/interfaces/medusa.SubscriberContext/page.mdx)
|
|
- [RequestQueryFields](../../medusa/interfaces/medusa.RequestQueryFields-1/page.mdx)
|
|
- [PaginatedResponse](../../medusa/interfaces/medusa.PaginatedResponse-1/page.mdx)
|
|
- [SessionOptions](../../medusa/interfaces/medusa.SessionOptions/page.mdx)
|
|
- [HttpCompressionOptions](../../medusa/interfaces/medusa.HttpCompressionOptions/page.mdx)
|
|
- [ProjectConfigOptions](../../medusa/interfaces/medusa.ProjectConfigOptions/page.mdx)
|
|
- [ConfigModule](../../medusa/interfaces/medusa.ConfigModule-1/page.mdx)
|
|
- [FileServiceUploadResult](../../medusa/interfaces/medusa.FileServiceUploadResult/page.mdx)
|
|
- [FulfillmentAddressDTO](../../medusa/interfaces/medusa.FulfillmentAddressDTO/page.mdx)
|
|
- [FulfillmentItemDTO](../../medusa/interfaces/medusa.FulfillmentItemDTO/page.mdx)
|
|
- [FulfillmentLabelDTO](../../medusa/interfaces/medusa.FulfillmentLabelDTO/page.mdx)
|
|
- [FulfillmentProviderDTO](../../medusa/interfaces/medusa.FulfillmentProviderDTO/page.mdx)
|
|
- [FulfillmentSetDTO](../../medusa/interfaces/medusa.FulfillmentSetDTO/page.mdx)
|
|
- [FulfillmentDTO](../../medusa/interfaces/medusa.FulfillmentDTO/page.mdx)
|
|
- [GeoZoneDTO](../../medusa/interfaces/medusa.GeoZoneDTO/page.mdx)
|
|
- [ServiceZoneDTO](../../medusa/interfaces/medusa.ServiceZoneDTO/page.mdx)
|
|
- [ShippingOptionRuleDTO](../../medusa/interfaces/medusa.ShippingOptionRuleDTO/page.mdx)
|
|
- [ShippingOptionTypeDTO](../../medusa/interfaces/medusa.ShippingOptionTypeDTO/page.mdx)
|
|
- [ShippingOptionDTO](../../medusa/interfaces/medusa.ShippingOptionDTO/page.mdx)
|
|
- [ShippingProfileDTO](../../medusa/interfaces/medusa.ShippingProfileDTO/page.mdx)
|
|
- [Logger](../../medusa/interfaces/medusa.Logger-1/page.mdx)
|
|
|
|
## Type Aliases
|
|
|
|
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)
|
|
- [handler](../../medusa/types/medusa.handler/page.mdx)
|
|
- [AdminAnalyticsConfigRes](../../medusa/types/medusa.AdminAnalyticsConfigRes/page.mdx)
|
|
- [AdminAnalyticsConfigDeleteRes](../../medusa/types/medusa.AdminAnalyticsConfigDeleteRes/page.mdx)
|
|
- [AdminAuthRes](../../medusa/types/medusa.AdminAuthRes/page.mdx)
|
|
- [AdminBearerAuthRes](../../medusa/types/medusa.AdminBearerAuthRes/page.mdx)
|
|
- [AdminBatchJobRes](../../medusa/types/medusa.AdminBatchJobRes/page.mdx)
|
|
- [AdminBatchJobListRes](../../medusa/types/medusa.AdminBatchJobListRes/page.mdx)
|
|
- [AdminCollectionsListRes](../../medusa/types/medusa.AdminCollectionsListRes/page.mdx)
|
|
- [AdminCollectionsDeleteRes](../../medusa/types/medusa.AdminCollectionsDeleteRes/page.mdx)
|
|
- [AdminDeleteProductsFromCollectionRes](../../medusa/types/medusa.AdminDeleteProductsFromCollectionRes/page.mdx)
|
|
- [AdminCollectionsRes](../../medusa/types/medusa.AdminCollectionsRes/page.mdx)
|
|
- [AdminCurrenciesListRes](../../medusa/types/medusa.AdminCurrenciesListRes/page.mdx)
|
|
- [AdminCurrenciesRes](../../medusa/types/medusa.AdminCurrenciesRes/page.mdx)
|
|
- [AdminCustomerGroupsRes](../../medusa/types/medusa.AdminCustomerGroupsRes/page.mdx)
|
|
- [AdminCustomerGroupsDeleteRes](../../medusa/types/medusa.AdminCustomerGroupsDeleteRes/page.mdx)
|
|
- [AdminCustomerGroupsListRes](../../medusa/types/medusa.AdminCustomerGroupsListRes/page.mdx)
|
|
- [AdminCustomersRes](../../medusa/types/medusa.AdminCustomersRes/page.mdx)
|
|
- [AdminCustomersListRes](../../medusa/types/medusa.AdminCustomersListRes/page.mdx)
|
|
- [AdminDiscountsRes](../../medusa/types/medusa.AdminDiscountsRes/page.mdx)
|
|
- [AdminDiscountConditionsRes](../../medusa/types/medusa.AdminDiscountConditionsRes/page.mdx)
|
|
- [AdminDiscountsDeleteRes](../../medusa/types/medusa.AdminDiscountsDeleteRes/page.mdx)
|
|
- [AdminDiscountConditionsDeleteRes](../../medusa/types/medusa.AdminDiscountConditionsDeleteRes/page.mdx)
|
|
- [AdminDiscountsListRes](../../medusa/types/medusa.AdminDiscountsListRes/page.mdx)
|
|
- [AdminPostDraftOrdersDraftOrderRegisterPaymentRes](../../medusa/types/medusa.AdminPostDraftOrdersDraftOrderRegisterPaymentRes/page.mdx)
|
|
- [AdminDraftOrdersRes](../../medusa/types/medusa.AdminDraftOrdersRes/page.mdx)
|
|
- [AdminDraftOrdersDeleteRes](../../medusa/types/medusa.AdminDraftOrdersDeleteRes/page.mdx)
|
|
- [AdminDraftOrdersListRes](../../medusa/types/medusa.AdminDraftOrdersListRes/page.mdx)
|
|
- [AdminGiftCardsRes](../../medusa/types/medusa.AdminGiftCardsRes/page.mdx)
|
|
- [AdminGiftCardsDeleteRes](../../medusa/types/medusa.AdminGiftCardsDeleteRes/page.mdx)
|
|
- [AdminGiftCardsListRes](../../medusa/types/medusa.AdminGiftCardsListRes/page.mdx)
|
|
- [AdminInventoryItemsRes](../../medusa/types/medusa.AdminInventoryItemsRes/page.mdx)
|
|
- [AdminInventoryItemsDeleteRes](../../medusa/types/medusa.AdminInventoryItemsDeleteRes/page.mdx)
|
|
- [AdminInventoryItemsListRes](../../medusa/types/medusa.AdminInventoryItemsListRes/page.mdx)
|
|
- [DecoratedInventoryItemDTO](../../medusa/types/medusa.DecoratedInventoryItemDTO/page.mdx)
|
|
- [AdminInventoryItemsListWithVariantsAndLocationLevelsRes](../../medusa/types/medusa.AdminInventoryItemsListWithVariantsAndLocationLevelsRes/page.mdx)
|
|
- [AdminInventoryItemsLocationLevelsRes](../../medusa/types/medusa.AdminInventoryItemsLocationLevelsRes/page.mdx)
|
|
- [AdminInviteDeleteRes](../../medusa/types/medusa.AdminInviteDeleteRes/page.mdx)
|
|
- [AdminListInvitesRes](../../medusa/types/medusa.AdminListInvitesRes/page.mdx)
|
|
- [AdminNotesRes](../../medusa/types/medusa.AdminNotesRes/page.mdx)
|
|
- [AdminNotesDeleteRes](../../medusa/types/medusa.AdminNotesDeleteRes/page.mdx)
|
|
- [AdminNotesListRes](../../medusa/types/medusa.AdminNotesListRes/page.mdx)
|
|
- [AdminNotificationsListRes](../../medusa/types/medusa.AdminNotificationsListRes/page.mdx)
|
|
- [AdminNotificationsRes](../../medusa/types/medusa.AdminNotificationsRes/page.mdx)
|
|
- [AdminOrderEditsRes](../../medusa/types/medusa.AdminOrderEditsRes/page.mdx)
|
|
- [AdminOrderEditsListRes](../../medusa/types/medusa.AdminOrderEditsListRes/page.mdx)
|
|
- [AdminOrderEditDeleteRes](../../medusa/types/medusa.AdminOrderEditDeleteRes/page.mdx)
|
|
- [AdminOrderEditItemChangeDeleteRes](../../medusa/types/medusa.AdminOrderEditItemChangeDeleteRes/page.mdx)
|
|
- [AdminOrdersRes](../../medusa/types/medusa.AdminOrdersRes/page.mdx)
|
|
- [AdminOrdersListRes](../../medusa/types/medusa.AdminOrdersListRes/page.mdx)
|
|
- [AdminPaymentCollectionsRes](../../medusa/types/medusa.AdminPaymentCollectionsRes/page.mdx)
|
|
- [AdminPaymentCollectionDeleteRes](../../medusa/types/medusa.AdminPaymentCollectionDeleteRes/page.mdx)
|
|
- [AdminPaymentRes](../../medusa/types/medusa.AdminPaymentRes/page.mdx)
|
|
- [AdminRefundRes](../../medusa/types/medusa.AdminRefundRes/page.mdx)
|
|
- [AdminPriceListRes](../../medusa/types/medusa.AdminPriceListRes/page.mdx)
|
|
- [AdminPriceListDeleteBatchRes](../../medusa/types/medusa.AdminPriceListDeleteBatchRes/page.mdx)
|
|
- [AdminPriceListDeleteProductPricesRes](../../medusa/types/medusa.AdminPriceListDeleteProductPricesRes/page.mdx)
|
|
- [AdminPriceListDeleteVariantPricesRes](../../medusa/types/medusa.AdminPriceListDeleteVariantPricesRes/page.mdx)
|
|
- [AdminPriceListDeleteRes](../../medusa/types/medusa.AdminPriceListDeleteRes/page.mdx)
|
|
- [AdminPriceListsListRes](../../medusa/types/medusa.AdminPriceListsListRes/page.mdx)
|
|
- [AdminPriceListsProductsListRes](../../medusa/types/medusa.AdminPriceListsProductsListRes/page.mdx)
|
|
- [AdminProductCategoriesCategoryRes](../../medusa/types/medusa.AdminProductCategoriesCategoryRes/page.mdx)
|
|
- [AdminProductCategoriesCategoryDeleteRes](../../medusa/types/medusa.AdminProductCategoriesCategoryDeleteRes/page.mdx)
|
|
- [AdminProductCategoriesListRes](../../medusa/types/medusa.AdminProductCategoriesListRes/page.mdx)
|
|
- [AdminProductTagsListRes](../../medusa/types/medusa.AdminProductTagsListRes/page.mdx)
|
|
- [AdminProductTypesListRes](../../medusa/types/medusa.AdminProductTypesListRes/page.mdx)
|
|
- [AdminProductsDeleteOptionRes](../../medusa/types/medusa.AdminProductsDeleteOptionRes/page.mdx)
|
|
- [AdminProductsDeleteVariantRes](../../medusa/types/medusa.AdminProductsDeleteVariantRes/page.mdx)
|
|
- [AdminProductsDeleteRes](../../medusa/types/medusa.AdminProductsDeleteRes/page.mdx)
|
|
- [AdminProductsListRes](../../medusa/types/medusa.AdminProductsListRes/page.mdx)
|
|
- [AdminProductsListVariantsRes](../../medusa/types/medusa.AdminProductsListVariantsRes/page.mdx)
|
|
- [AdminProductsListTypesRes](../../medusa/types/medusa.AdminProductsListTypesRes/page.mdx)
|
|
- [AdminProductsListTagsRes](../../medusa/types/medusa.AdminProductsListTagsRes/page.mdx)
|
|
- [AdminProductsRes](../../medusa/types/medusa.AdminProductsRes/page.mdx)
|
|
- [AdminPublishableApiKeysRes](../../medusa/types/medusa.AdminPublishableApiKeysRes/page.mdx)
|
|
- [AdminPublishableApiKeysListRes](../../medusa/types/medusa.AdminPublishableApiKeysListRes/page.mdx)
|
|
- [AdminPublishableApiKeyDeleteRes](../../medusa/types/medusa.AdminPublishableApiKeyDeleteRes/page.mdx)
|
|
- [AdminPublishableApiKeysListSalesChannelsRes](../../medusa/types/medusa.AdminPublishableApiKeysListSalesChannelsRes/page.mdx)
|
|
- [AdminRegionsRes](../../medusa/types/medusa.AdminRegionsRes/page.mdx)
|
|
- [AdminRegionsListRes](../../medusa/types/medusa.AdminRegionsListRes/page.mdx)
|
|
- [AdminRegionsDeleteRes](../../medusa/types/medusa.AdminRegionsDeleteRes/page.mdx)
|
|
- [AdminReservationsRes](../../medusa/types/medusa.AdminReservationsRes/page.mdx)
|
|
- [ExtendedReservationItem](../../medusa/types/medusa.ExtendedReservationItem/page.mdx)
|
|
- [AdminReservationsListRes](../../medusa/types/medusa.AdminReservationsListRes/page.mdx)
|
|
- [AdminReservationsDeleteRes](../../medusa/types/medusa.AdminReservationsDeleteRes/page.mdx)
|
|
- [AdminReturnReasonsRes](../../medusa/types/medusa.AdminReturnReasonsRes/page.mdx)
|
|
- [AdminReturnReasonsListRes](../../medusa/types/medusa.AdminReturnReasonsListRes/page.mdx)
|
|
- [AdminReturnReasonsDeleteRes](../../medusa/types/medusa.AdminReturnReasonsDeleteRes/page.mdx)
|
|
- [AdminReturnsCancelRes](../../medusa/types/medusa.AdminReturnsCancelRes/page.mdx)
|
|
- [AdminReturnsListRes](../../medusa/types/medusa.AdminReturnsListRes/page.mdx)
|
|
- [AdminReturnsRes](../../medusa/types/medusa.AdminReturnsRes/page.mdx)
|
|
- [AdminSalesChannelsRes](../../medusa/types/medusa.AdminSalesChannelsRes/page.mdx)
|
|
- [AdminSalesChannelsDeleteRes](../../medusa/types/medusa.AdminSalesChannelsDeleteRes/page.mdx)
|
|
- [AdminSalesChannelsDeleteLocationRes](../../medusa/types/medusa.AdminSalesChannelsDeleteLocationRes/page.mdx)
|
|
- [AdminSalesChannelsListRes](../../medusa/types/medusa.AdminSalesChannelsListRes/page.mdx)
|
|
- [AdminShippingOptionsListRes](../../medusa/types/medusa.AdminShippingOptionsListRes/page.mdx)
|
|
- [AdminShippingOptionsRes](../../medusa/types/medusa.AdminShippingOptionsRes/page.mdx)
|
|
- [AdminShippingOptionsDeleteRes](../../medusa/types/medusa.AdminShippingOptionsDeleteRes/page.mdx)
|
|
- [AdminDeleteShippingProfileRes](../../medusa/types/medusa.AdminDeleteShippingProfileRes/page.mdx)
|
|
- [AdminShippingProfilesRes](../../medusa/types/medusa.AdminShippingProfilesRes/page.mdx)
|
|
- [AdminShippingProfilesListRes](../../medusa/types/medusa.AdminShippingProfilesListRes/page.mdx)
|
|
- [AdminStockLocationsDeleteRes](../../medusa/types/medusa.AdminStockLocationsDeleteRes/page.mdx)
|
|
- [AdminStockLocationsRes](../../medusa/types/medusa.AdminStockLocationsRes/page.mdx)
|
|
- [AdminStockLocationsListRes](../../medusa/types/medusa.AdminStockLocationsListRes/page.mdx)
|
|
- [AdminExtendedStoresRes](../../medusa/types/medusa.AdminExtendedStoresRes/page.mdx)
|
|
- [AdminStoresRes](../../medusa/types/medusa.AdminStoresRes/page.mdx)
|
|
- [AdminTaxProvidersList](../../medusa/types/medusa.AdminTaxProvidersList/page.mdx)
|
|
- [AdminPaymentProvidersList](../../medusa/types/medusa.AdminPaymentProvidersList/page.mdx)
|
|
- [AdminSwapsListRes](../../medusa/types/medusa.AdminSwapsListRes/page.mdx)
|
|
- [AdminSwapsRes](../../medusa/types/medusa.AdminSwapsRes/page.mdx)
|
|
- [AdminTaxRatesDeleteRes](../../medusa/types/medusa.AdminTaxRatesDeleteRes/page.mdx)
|
|
- [AdminTaxRatesListRes](../../medusa/types/medusa.AdminTaxRatesListRes/page.mdx)
|
|
- [AdminTaxRatesRes](../../medusa/types/medusa.AdminTaxRatesRes/page.mdx)
|
|
- [AdminUploadsRes](../../medusa/types/medusa.AdminUploadsRes/page.mdx)
|
|
- [AdminDeleteUploadsRes](../../medusa/types/medusa.AdminDeleteUploadsRes/page.mdx)
|
|
- [AdminUploadsDownloadUrlRes](../../medusa/types/medusa.AdminUploadsDownloadUrlRes/page.mdx)
|
|
- [AdminUserRes](../../medusa/types/medusa.AdminUserRes/page.mdx)
|
|
- [AdminUsersListRes](../../medusa/types/medusa.AdminUsersListRes/page.mdx)
|
|
- [AdminDeleteUserRes](../../medusa/types/medusa.AdminDeleteUserRes/page.mdx)
|
|
- [payload](../../medusa/types/medusa.payload/page.mdx)
|
|
- [LevelWithAvailability](../../medusa/types/medusa.LevelWithAvailability/page.mdx)
|
|
- [ResponseInventoryItem](../../medusa/types/medusa.ResponseInventoryItem/page.mdx)
|
|
- [VariantInventory](../../medusa/types/medusa.VariantInventory/page.mdx)
|
|
- [AdminGetVariantsVariantInventoryRes](../../medusa/types/medusa.AdminGetVariantsVariantInventoryRes/page.mdx)
|
|
- [AdminVariantsListRes](../../medusa/types/medusa.AdminVariantsListRes/page.mdx)
|
|
- [AdminVariantsRes](../../medusa/types/medusa.AdminVariantsRes/page.mdx)
|
|
- [StoreAuthRes](../../medusa/types/medusa.StoreAuthRes/page.mdx)
|
|
- [StoreBearerAuthRes](../../medusa/types/medusa.StoreBearerAuthRes/page.mdx)
|
|
- [StoreGetAuthEmailRes](../../medusa/types/medusa.StoreGetAuthEmailRes/page.mdx)
|
|
- [StoreCartsRes](../../medusa/types/medusa.StoreCartsRes/page.mdx)
|
|
- [StoreCompleteCartRes](../../medusa/types/medusa.StoreCompleteCartRes/page.mdx)
|
|
- [StoreCollectionsListRes](../../medusa/types/medusa.StoreCollectionsListRes/page.mdx)
|
|
- [StoreCollectionsRes](../../medusa/types/medusa.StoreCollectionsRes/page.mdx)
|
|
- [StoreCustomersRes](../../medusa/types/medusa.StoreCustomersRes/page.mdx)
|
|
- [StoreCustomersResetPasswordRes](../../medusa/types/medusa.StoreCustomersResetPasswordRes/page.mdx)
|
|
- [StoreCustomersListOrdersRes](../../medusa/types/medusa.StoreCustomersListOrdersRes/page.mdx)
|
|
- [StoreCustomersListPaymentMethodsRes](../../medusa/types/medusa.StoreCustomersListPaymentMethodsRes/page.mdx)
|
|
- [StoreGiftCardsRes](../../medusa/types/medusa.StoreGiftCardsRes/page.mdx)
|
|
- [StoreOrderEditsRes](../../medusa/types/medusa.StoreOrderEditsRes/page.mdx)
|
|
- [StoreOrdersRes](../../medusa/types/medusa.StoreOrdersRes/page.mdx)
|
|
- [StorePaymentCollectionsRes](../../medusa/types/medusa.StorePaymentCollectionsRes/page.mdx)
|
|
- [StorePaymentCollectionsSessionRes](../../medusa/types/medusa.StorePaymentCollectionsSessionRes/page.mdx)
|
|
- [StoreGetProductCategoriesCategoryRes](../../medusa/types/medusa.StoreGetProductCategoriesCategoryRes/page.mdx)
|
|
- [StoreGetProductCategoriesRes](../../medusa/types/medusa.StoreGetProductCategoriesRes/page.mdx)
|
|
- [StoreProductTagsListRes](../../medusa/types/medusa.StoreProductTagsListRes/page.mdx)
|
|
- [StoreProductTypesListRes](../../medusa/types/medusa.StoreProductTypesListRes/page.mdx)
|
|
- [StoreProductsRes](../../medusa/types/medusa.StoreProductsRes/page.mdx)
|
|
- [StorePostSearchRes](../../medusa/types/medusa.StorePostSearchRes/page.mdx)
|
|
- [StoreProductsListRes](../../medusa/types/medusa.StoreProductsListRes/page.mdx)
|
|
- [StoreRegionsListRes](../../medusa/types/medusa.StoreRegionsListRes/page.mdx)
|
|
- [StoreRegionsRes](../../medusa/types/medusa.StoreRegionsRes/page.mdx)
|
|
- [StoreReturnReasonsListRes](../../medusa/types/medusa.StoreReturnReasonsListRes/page.mdx)
|
|
- [StoreReturnReasonsRes](../../medusa/types/medusa.StoreReturnReasonsRes/page.mdx)
|
|
- [StoreReturnsRes](../../medusa/types/medusa.StoreReturnsRes/page.mdx)
|
|
- [StoreShippingOptionsListRes](../../medusa/types/medusa.StoreShippingOptionsListRes/page.mdx)
|
|
- [StoreCartShippingOptionsListRes](../../medusa/types/medusa.StoreCartShippingOptionsListRes/page.mdx)
|
|
- [StoreSwapsRes](../../medusa/types/medusa.StoreSwapsRes/page.mdx)
|
|
- [StoreVariantsRes](../../medusa/types/medusa.StoreVariantsRes/page.mdx)
|
|
- [StoreVariantsListRes](../../medusa/types/medusa.StoreVariantsListRes/page.mdx)
|
|
- [BatchJobUpdateProps](../../medusa/types/medusa.BatchJobUpdateProps/page.mdx)
|
|
- [CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput/page.mdx)
|
|
- [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError/page.mdx)
|
|
- [BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor/page.mdx)
|
|
- [BatchJobCreateProps](../../medusa/types/medusa.BatchJobCreateProps/page.mdx)
|
|
- [WithRequiredProperty](../../medusa/types/medusa.WithRequiredProperty/page.mdx)
|
|
- [PartialPick](../../medusa/types/medusa.PartialPick/page.mdx)
|
|
- [Writable](../../medusa/types/medusa.Writable/page.mdx)
|
|
- [ExtendedFindConfig](../../medusa/types/medusa.ExtendedFindConfig/page.mdx)
|
|
- [QuerySelector](../../medusa/types/medusa.QuerySelector/page.mdx)
|
|
- [TreeQuerySelector](../../medusa/types/medusa.TreeQuerySelector/page.mdx)
|
|
- [InnerSelector](../../medusa/types/medusa.InnerSelector/page.mdx)
|
|
- [Selector](../../medusa/types/medusa.Selector/page.mdx)
|
|
- [TotalField](../../medusa/types/medusa.TotalField/page.mdx)
|
|
- [QueryConfig](../../medusa/types/medusa.QueryConfig/page.mdx)
|
|
- [DraftOrderStatusValue](../../medusa/types/medusa.DraftOrderStatusValue/page.mdx)
|
|
- [FeatureFlagsResponse](../../medusa/types/medusa.FeatureFlagsResponse/page.mdx)
|
|
- [ExtendedRequest](../../medusa/types/medusa.ExtendedRequest/page.mdx)
|
|
- [ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx)
|
|
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)
|
|
- [Logger](../../medusa/types/medusa.Logger/page.mdx)
|
|
- [Constructor](../../medusa/types/medusa.Constructor/page.mdx)
|
|
- [ConfigModule](../../medusa/types/medusa.ConfigModule/page.mdx)
|
|
- [CreatePriceListInput](../../medusa/types/medusa.CreatePriceListInput/page.mdx)
|
|
- [UpdatePriceListInput](../../medusa/types/medusa.UpdatePriceListInput/page.mdx)
|
|
- [PriceListPriceUpdateInput](../../medusa/types/medusa.PriceListPriceUpdateInput/page.mdx)
|
|
- [PriceListPriceCreateInput](../../medusa/types/medusa.PriceListPriceCreateInput/page.mdx)
|
|
- [PriceListLoadConfig](../../medusa/types/medusa.PriceListLoadConfig/page.mdx)
|
|
- [ProductVariantPricing](../../medusa/types/medusa.ProductVariantPricing/page.mdx)
|
|
- [TaxedPricing](../../medusa/types/medusa.TaxedPricing/page.mdx)
|
|
- [ShippingOptionPricing](../../medusa/types/medusa.ShippingOptionPricing/page.mdx)
|
|
- [PricedShippingOption](../../medusa/types/medusa.PricedShippingOption/page.mdx)
|
|
- [PricedVariant](../../medusa/types/medusa.PricedVariant/page.mdx)
|
|
- [PricedProduct](../../medusa/types/medusa.PricedProduct/page.mdx)
|
|
- [MedusaResponse](../../medusa/types/medusa.MedusaResponse/page.mdx)
|
|
- [MedusaNextFunction](../../medusa/types/medusa.MedusaNextFunction/page.mdx)
|
|
- [MedusaRequestHandler](../../medusa/types/medusa.MedusaRequestHandler/page.mdx)
|
|
- [ScheduledJobConfig](../../medusa/types/medusa.ScheduledJobConfig/page.mdx)
|
|
- [ScheduledJobArgs](../../medusa/types/medusa.ScheduledJobArgs/page.mdx)
|
|
- [ModulesResponse](../../medusa/types/medusa.ModulesResponse/page.mdx)
|
|
- [ExtendedStoreDTO](../../medusa/types/medusa.ExtendedStoreDTO/page.mdx)
|
|
- [SubscriberConfig](../../medusa/types/medusa.SubscriberConfig/page.mdx)
|
|
- [SubscriberArgs](../../medusa/types/medusa.SubscriberArgs/page.mdx)
|
|
- [TaxServiceRate](../../medusa/types/medusa.TaxServiceRate/page.mdx)
|
|
- [DeleteResponse](../../medusa/types/medusa.DeleteResponse-1/page.mdx)
|
|
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer-2/page.mdx)
|
|
- [GeoZoneType](../../medusa/types/medusa.GeoZoneType/page.mdx)
|
|
- [ShippingOptionPriceType](../../medusa/types/medusa.ShippingOptionPriceType/page.mdx)
|
|
- [InventoryItemDTO](../../medusa/types/medusa.InventoryItemDTO/page.mdx)
|
|
- [ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO/page.mdx)
|
|
- [InventoryLevelDTO](../../medusa/types/medusa.InventoryLevelDTO/page.mdx)
|
|
- [Constructor](../../medusa/types/medusa.Constructor-1/page.mdx)
|
|
- [InternalModuleDeclaration](../../medusa/types/medusa.InternalModuleDeclaration/page.mdx)
|
|
- [ExternalModuleDeclaration](../../medusa/types/medusa.ExternalModuleDeclaration/page.mdx)
|
|
- [ModuleDefinition](../../medusa/types/medusa.ModuleDefinition/page.mdx)
|
|
- [LoaderOptions](../../medusa/types/medusa.LoaderOptions/page.mdx)
|
|
- [ModuleLoaderFunction](../../medusa/types/medusa.ModuleLoaderFunction/page.mdx)
|
|
- [ModulesResponse](../../medusa/types/medusa.ModulesResponse-1/page.mdx)
|
|
- [ModuleExports](../../medusa/types/medusa.ModuleExports/page.mdx)
|
|
- [StockLocationAddressDTO](../../medusa/types/medusa.StockLocationAddressDTO/page.mdx)
|
|
- [StockLocationDTO](../../medusa/types/medusa.StockLocationDTO/page.mdx)
|
|
- [StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO/page.mdx)
|
|
|
|
___
|
|
|
|
## Enumeration Members
|
|
|
|
### 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](../../medusa/types/medusa.InventoryItemDTO/page.mdx)[]
|
|
|
|
### defaultAdminLocationLevelFields
|
|
|
|
`Const` **defaultAdminLocationLevelFields**: keyof [InventoryLevelDTO](../../medusa/types/medusa.InventoryLevelDTO/page.mdx)[]
|
|
|
|
### defaultAdminInventoryItemRelations
|
|
|
|
`Const` **defaultAdminInventoryItemRelations**: `never`[] = `[]`
|
|
|
|
### defaultAdminNotificationsRelations
|
|
|
|
`Const` **defaultAdminNotificationsRelations**: `string`[]
|
|
|
|
### defaultAdminNotificationsFields
|
|
|
|
`Const` **defaultAdminNotificationsFields**: `string`[]
|
|
|
|
### filterableAdminOrdersFields
|
|
|
|
`Const` **filterableAdminOrdersFields**: `string`[]
|
|
|
|
### AvailableOrderIncludes
|
|
|
|
`Const` **AvailableOrderIncludes**: `Object`
|
|
|
|
#### Properties
|
|
|
|
<TypeList types={[{"name":"RETURNABLE_ITEMS","type":"`string`","description":"","optional":false,"defaultValue":"\"returnable_items\"","expandable":false,"children":[]}]} sectionTitle="AvailableOrderIncludes"/>
|
|
|
|
### allowedOrderIncludes
|
|
|
|
`Const` **allowedOrderIncludes**: `string`[]
|
|
|
|
### defaultPaymentCollectionFields
|
|
|
|
`Const` **defaultPaymentCollectionFields**: `string`[]
|
|
|
|
### defaulPaymentCollectionRelations
|
|
|
|
`Const` **defaulPaymentCollectionRelations**: `string`[]
|
|
|
|
### defaultPaymentFields
|
|
|
|
`Const` **defaultPaymentFields**: `string`[]
|
|
|
|
### defaultAdminPriceListFields
|
|
|
|
`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`[]
|
|
|
|
### defaultAdminGetProductsVariantsRelations
|
|
|
|
`Const` **defaultAdminGetProductsVariantsRelations**: `string`[]
|
|
|
|
### defaultAdminProductRemoteQueryObject
|
|
|
|
`Const` **defaultAdminProductRemoteQueryObject**: `Object`
|
|
|
|
This is temporary.
|
|
|
|
#### Properties
|
|
|
|
<TypeList types={[{"name":"fields","type":"keyof [Product](../../product_models/classes/product_models.Product/page.mdx)[]","description":"","optional":false,"defaultValue":"defaultAdminProductFields","expandable":false,"children":[]},{"name":"images","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tags","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"collection","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"categories","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"variants","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"profile","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="defaultAdminProductRemoteQueryObject"/>
|
|
|
|
### defaultAdminRegionFields
|
|
|
|
`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](../../medusa/types/medusa.StockLocationDTO/page.mdx)[]
|
|
|
|
### 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`[]
|
|
|
|
### defaultAdminWorkflowExecutionsRelations
|
|
|
|
`Const` **defaultAdminWorkflowExecutionsRelations**: `never`[] = `[]`
|
|
|
|
### allowedAdminWorkflowExecutionsRelations
|
|
|
|
`Const` **allowedAdminWorkflowExecutionsRelations**: `never`[] = `[]`
|
|
|
|
### defaultAdminWorkflowExecutionsFields
|
|
|
|
`Const` **defaultAdminWorkflowExecutionsFields**: `string`[]
|
|
|
|
### defaultAdminWorkflowExecutionDetailFields
|
|
|
|
`Const` **defaultAdminWorkflowExecutionDetailFields**: `string`[]
|
|
|
|
### 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
|
|
|
|
<TypeList types={[{"name":"is_internal","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_active","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} sectionTitle="defaultStoreCategoryScope"/>
|
|
|
|
### 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
|
|
|
|
<TypeList types={[{"name":"fields","type":"keyof [Product](../../product_models/classes/product_models.Product/page.mdx)[]","description":"","optional":false,"defaultValue":"defaultStoreProductsFields","expandable":false,"children":[]},{"name":"images","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tags","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"collection","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"variants","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"profile","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="defaultStoreProductRemoteQueryObject"/>
|
|
|
|
### defaultStoreRegionRelations
|
|
|
|
`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](../../medusa/interfaces/medusa.FindConfig/page.mdx)<Swap>[`"select"`]
|
|
|
|
### defaultStoreVariantRelations
|
|
|
|
`Const` **defaultStoreVariantRelations**: `string`[]
|
|
|
|
### allowedStoreVariantRelations
|
|
|
|
`Const` **allowedStoreVariantRelations**: `string`[]
|
|
|
|
___
|
|
|
|
## Functions
|
|
|
|
### authenticateCustomer
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"RequestHandler","type":"RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ParamsDictionary","type":"`ParamsDictionary`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"ParsedQs","type":"`ParsedQs`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, any>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="authenticateCustomer"/>
|
|
|
|
### authenticate
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"RequestHandler","type":"RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ParamsDictionary","type":"`ParamsDictionary`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"ParsedQs","type":"`ParsedQs`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, any>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="authenticate"/>
|
|
|
|
### wrapHandler
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"fn","type":"[handler](../../medusa/types/medusa.handler/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="wrapHandler"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"RequestHandler","type":"RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ParamsDictionary","type":"`ParamsDictionary`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"ParsedQs","type":"`ParsedQs`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, any>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="wrapHandler"/>
|
|
|
|
#### Deprecated
|
|
|
|
use `import { wrapHandler } from "@medusajs/utils"`
|
|
|
|
### canAccessBatchJob
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="canAccessBatchJob"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<any>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="canAccessBatchJob"/>
|
|
|
|
### getRequestedBatchJob
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="getRequestedBatchJob"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<any>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="getRequestedBatchJob"/>
|
|
|
|
### doesConditionBelongToDiscount
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="doesConditionBelongToDiscount"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<any>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="doesConditionBelongToDiscount"/>
|
|
|
|
### errorHandler
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"(err: MedusaError, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void","type":"(`err`: [MedusaError](../../medusa/classes/medusa.MedusaError/page.mdx), `req`: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, `res`: Response<any, Record<string, any>>, `next`: `NextFunction`) => `void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="errorHandler"/>
|
|
|
|
##### Parameters
|
|
|
|
<TypeList types={[{"name":"err","type":"[MedusaError](../../medusa/classes/medusa.MedusaError/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"message","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"date","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Types","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DB_ERROR","type":"`string`","description":"Errors stemming from the database","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"DUPLICATE_ERROR","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVALID_ARGUMENT","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"INVALID_DATA","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"UNAUTHORIZED","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_FOUND","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_ALLOWED","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"UNEXPECTED_STATE","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFLICT","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"PAYMENT_AUTHORIZATION_ERROR","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"Codes","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"INSUFFICIENT_INVENTORY","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CART_INCOMPATIBLE_STATE","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"code","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"req","type":"Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"Response<any, Record<string, any>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`NextFunction`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
##### Returns
|
|
|
|
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
### isFeatureFlagEnabled
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"flagKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="isFeatureFlagEnabled"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"(req: Request, res: Response, next: NextFunction) => Promise<void>","type":"(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="isFeatureFlagEnabled"/>
|
|
|
|
##### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"`Request`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"`Response`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`NextFunction`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
##### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
### normalizeQuery
|
|
|
|
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
|
|
|
|
<TypeList types={[{"name":"(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void","type":"(`req`: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, `res`: Response<any, Record<string, any>>, `next`: `NextFunction`) => `void`","optional":false,"defaultValue":"","description":"Normalize an input query, especially from array like query params to an array type\ne.g: /admin/orders/?fields[]=id,status,cart\\_id becomes { fields: [\"id\", \"status\", \"cart\\_id\"] }","expandable":false,"children":[]}]} sectionTitle="normalizeQuery"/>
|
|
|
|
##### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"Response<any, Record<string, any>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`NextFunction`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
##### Returns
|
|
|
|
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
### requireCustomerAuthentication
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"RequestHandler","type":"RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ParamsDictionary","type":"`ParamsDictionary`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"ParsedQs","type":"`ParsedQs`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, any>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="requireCustomerAuthentication"/>
|
|
|
|
### transformBody
|
|
|
|
#### Type Parameters
|
|
|
|
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformBody"/>
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"plainToClass","type":"[ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx)<T>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`ValidatorOptions`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformBody"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"(req: Request, res: Response, next: NextFunction) => Promise<void>","type":"(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="transformBody"/>
|
|
|
|
##### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"`Request`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"`Response`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`NextFunction`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
##### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
### transformIncludesOptions
|
|
|
|
Retrieve the includes options from the fields query param.
|
|
If the include option is present then assigned it to includes on req
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"allowedIncludes","type":"`string`[]","description":"The list of fields that can be passed and assign to req.includes","optional":false,"defaultValue":"[]","expandable":false,"children":[]},{"name":"expectedIncludes","type":"`string`[]","description":"The list of fields that the consumer can pass to the end point using this middleware. It is a subset of `allowedIncludes`","optional":false,"defaultValue":"[]","expandable":false,"children":[]}]} sectionTitle="transformIncludesOptions"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void","type":"(`req`: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, `res`: Response<any, Record<string, any>>, `next`: `NextFunction`) => `void`","optional":false,"defaultValue":"","description":"Retrieve the includes options from the fields query param.\nIf the include option is present then assigned it to includes on req","expandable":false,"children":[]}]} sectionTitle="transformIncludesOptions"/>
|
|
|
|
##### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"Response<any, Record<string, any>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`NextFunction`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
##### Returns
|
|
|
|
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
### transformQuery
|
|
|
|
Middleware that transform the query input for the admin end points
|
|
|
|
#### Type Parameters
|
|
|
|
<TypeList types={[{"name":"T","type":"[RequestQueryFields](../../medusa/interfaces/medusa.RequestQueryFields/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TEntity","type":"`BaseEntity`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformQuery"/>
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"plainToClass","type":"[ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx)<T>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"queryConfig","type":"[QueryConfig](../../medusa/types/medusa.QueryConfig/page.mdx)<TEntity>","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"defaults","type":"(keyof TEntity \\| `string`)[]","description":"Default fields and relations to return","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultFields","type":"(keyof TEntity \\| `string`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"Fields and relations that are allowed to be requested","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultLimit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"config","type":"`ValidatorOptions`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} sectionTitle="transformQuery"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"(req: Request, res: Response, next: NextFunction) => Promise<void>","type":"(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => Promise<void>","optional":false,"defaultValue":"","description":"Middleware that transform the query input for the admin end points","expandable":false,"children":[]}]} sectionTitle="transformQuery"/>
|
|
|
|
##### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"`Request`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"`Response`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`NextFunction`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
##### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
### transformStoreQuery
|
|
|
|
Middleware that transform the query input for the store endpoints
|
|
|
|
#### Type Parameters
|
|
|
|
<TypeList types={[{"name":"T","type":"[RequestQueryFields](../../medusa/interfaces/medusa.RequestQueryFields/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"TEntity","type":"`BaseEntity`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="transformStoreQuery"/>
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"plainToClass","type":"[ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx)<T>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`ValidatorOptions`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"queryConfig","type":"[QueryConfig](../../medusa/types/medusa.QueryConfig/page.mdx)<TEntity>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"defaults","type":"(keyof TEntity \\| `string`)[]","description":"Default fields and relations to return","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultFields","type":"(keyof TEntity \\| `string`)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"Fields and relations that are allowed to be requested","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedRelations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultLimit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="transformStoreQuery"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"(req: Request, res: Response, next: NextFunction) => Promise<void>","type":"(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => Promise<void>","optional":false,"defaultValue":"","description":"Middleware that transform the query input for the store endpoints","expandable":false,"children":[]}]} sectionTitle="transformStoreQuery"/>
|
|
|
|
##### Parameters
|
|
|
|
<TypeList types={[{"name":"req","type":"`Request`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"res","type":"`Response`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`NextFunction`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
##### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
|
|
|
#### Deprecated
|
|
|
|
use `transformQuery` instead
|
|
|
|
### reserveQuantityForDraftOrder
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"order","type":"[Order](../../types/types/types.Order/page.mdx)","description":"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.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"productVariantInventoryService","type":"`ProductVariantInventoryService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locationId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context.productVariantInventoryService","type":"`ProductVariantInventoryService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context.locationId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="reserveQuantityForDraftOrder"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="reserveQuantityForDraftOrder"/>
|
|
|
|
### unauthenticatedInviteRoutes
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"app","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="unauthenticatedInviteRoutes"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="unauthenticatedInviteRoutes"/>
|
|
|
|
### adjustInventoryForCancelledFulfillment
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"fulfillment","type":"[Fulfillment](../../fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx)","description":"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.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOption](../../fulfillment_models/classes/fulfillment_models.ShippingOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](../../fulfillment_models/classes/fulfillment_models.FulfillmentProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"delivery_address","type":"[Address](../../fulfillment_models/classes/fulfillment_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"items","type":"Collection<[FulfillmentItem](../../fulfillment_models/classes/fulfillment_models.FulfillmentItem/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](../../fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"labels","type":"Collection<[FulfillmentLabel](../../fulfillment_models/classes/fulfillment_models.FulfillmentLabel/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](../../fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"productVariantInventoryService","type":"`ProductVariantInventoryService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context.productVariantInventoryService","type":"`ProductVariantInventoryService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adjustInventoryForCancelledFulfillment"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="adjustInventoryForCancelledFulfillment"/>
|
|
|
|
### updateInventoryAndReservations
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"fulfillments","type":"[Fulfillment](../../fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOption](../../fulfillment_models/classes/fulfillment_models.ShippingOption/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](../../fulfillment_models/classes/fulfillment_models.FulfillmentProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"delivery_address","type":"[Address](../../fulfillment_models/classes/fulfillment_models.Address/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"items","type":"Collection<[FulfillmentItem](../../fulfillment_models/classes/fulfillment_models.FulfillmentItem/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](../../fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"labels","type":"Collection<[FulfillmentLabel](../../fulfillment_models/classes/fulfillment_models.FulfillmentLabel/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](../../fulfillment_models/classes/fulfillment_models.Fulfillment/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableEntityDateColumns](../../types/DAL/types/types.DAL.SoftDeletableEntityDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"inventoryService","type":"`ProductVariantInventoryService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locationId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context.inventoryService","type":"`ProductVariantInventoryService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context.locationId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="updateInventoryAndReservations"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="updateInventoryAndReservations"/>
|
|
|
|
### unauthenticatedUserRoutes
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"app","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="unauthenticatedUserRoutes"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="unauthenticatedUserRoutes"/>
|
|
|
|
### extendedFindParamsMixin
|
|
|
|
#### Parameters
|
|
|
|
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__namedParameters.limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="extendedFindParamsMixin"/>
|
|
|
|
#### Returns
|
|
|
|
<TypeList types={[{"name":"ClassConstructor","type":"[ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx)<[FindParams](../../medusa/classes/medusa.FindParams/page.mdx) & [FindPaginationParams](../../medusa/classes/medusa.FindPaginationParams/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"FindParams","type":"`object`","description":"Parameters that can be used to configure how data is retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"FindPaginationParams","type":"`object`","description":"Parameters that can be used to configure how a list of data is paginated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="extendedFindParamsMixin"/>
|