--- displayed_sidebar: jsClientSidebar --- # Namespace: internal [internal](internal-8.md).internal ## Enumerations - [PaymentCollectionType](../enums/internal-8.internal.PaymentCollectionType.md) - [PaymentSessionStatus](../enums/internal-8.internal.PaymentSessionStatus.md) - [PostgresError](../enums/internal-8.internal.PostgresError.md) - [RefundReason](../enums/internal-8.internal.RefundReason.md) ## Classes - [AbstractBatchJobStrategy](../classes/internal-8.internal.AbstractBatchJobStrategy.md) - [AbstractCartCompletionStrategy](../classes/internal-8.internal.AbstractCartCompletionStrategy.md) - [AbstractFileService](../classes/internal-8.internal.AbstractFileService.md) - [AbstractFulfillmentService](../classes/internal-8.internal.AbstractFulfillmentService.md) - [AbstractNotificationService](../classes/internal-8.internal.AbstractNotificationService.md) - [AbstractPaymentProcessor](../classes/internal-8.internal.AbstractPaymentProcessor.md) - [AbstractPaymentService](../classes/internal-8.internal.AbstractPaymentService.md) - [AbstractPriceSelectionStrategy](../classes/internal-8.internal.AbstractPriceSelectionStrategy.md) - [AbstractTaxService](../classes/internal-8.internal.AbstractTaxService.md) - [AdminCreateUserRequest](../classes/internal-8.internal.AdminCreateUserRequest.md) - [AdminDeleteDiscountsDiscountConditionsConditionBatchParams](../classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md) - [AdminDeleteDiscountsDiscountConditionsConditionParams](../classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md) - [AdminDeletePriceListPricesPricesReq](../classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md) - [AdminDeletePriceListsPriceListProductsPricesBatchReq](../classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md) - [AdminDeleteProductCategoriesCategoryProductsBatchParams](../classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md) - [AdminDeleteProductCategoriesCategoryProductsBatchReq](../classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md) - [AdminDeletePublishableApiKeySalesChannelsBatchReq](../classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) - [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md) - [AdminDeleteSalesChannelsChannelStockLocationsReq](../classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md) - [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) - [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) - [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md) - [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md) - [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) - [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) - [AdminDeleteUploadsReq](../classes/internal-8.internal.AdminDeleteUploadsReq.md) - [AdminGetDiscountParams](../classes/internal-8.internal.AdminGetDiscountParams.md) - [AdminGetDiscountsDiscountCodeParams](../classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md) - [AdminGetDraftOrdersParams](../classes/internal-8.internal.AdminGetDraftOrdersParams.md) - [AdminGetGiftCardsParams](../classes/internal-8.internal.AdminGetGiftCardsParams.md) - [AdminGetInventoryItemsItemLocationLevelsParams](../classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md) - [AdminGetInventoryItemsItemParams](../classes/internal-8.internal.AdminGetInventoryItemsItemParams.md) - [AdminGetInventoryItemsParams](../classes/internal-8.internal.AdminGetInventoryItemsParams.md) - [AdminGetNotesParams](../classes/internal-8.internal.AdminGetNotesParams.md) - [AdminGetNotificationsParams](../classes/internal-8.internal.AdminGetNotificationsParams.md) - [AdminGetOrdersOrderParams](../classes/internal-8.internal.AdminGetOrdersOrderParams.md) - [AdminGetOrdersParams](../classes/internal-8.internal.AdminGetOrdersParams.md) - [AdminGetPaymentCollectionsParams](../classes/internal-8.internal.AdminGetPaymentCollectionsParams.md) - [AdminGetPriceListPaginationParams](../classes/internal-8.internal.AdminGetPriceListPaginationParams.md) - [AdminGetPriceListsPriceListProductsParams](../classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md) - [AdminGetProductCategoriesParams](../classes/internal-8.internal.AdminGetProductCategoriesParams.md) - [AdminGetProductCategoryParams](../classes/internal-8.internal.AdminGetProductCategoryParams.md) - [AdminGetProductTagsPaginationParams](../classes/internal-8.internal.AdminGetProductTagsPaginationParams.md) - [AdminGetProductTagsParams](../classes/internal-8.internal.AdminGetProductTagsParams.md) - [AdminGetProductTypesParams](../classes/internal-8.internal.AdminGetProductTypesParams.md) - [AdminGetProductsParams](../classes/internal-8.internal.AdminGetProductsParams.md) - [AdminGetProductsVariantsParams](../classes/internal-8.internal.AdminGetProductsVariantsParams.md) - [AdminGetRegionsPaginationParams](../classes/internal-8.internal.AdminGetRegionsPaginationParams.md) - [AdminGetRegionsParams](../classes/internal-8.internal.AdminGetRegionsParams.md) - [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md) - [AdminGetReservationsParams](../classes/internal-8.internal.AdminGetReservationsParams.md) - [AdminGetReturnsParams](../classes/internal-8.internal.AdminGetReturnsParams.md) - [AdminGetSalesChannelsParams](../classes/internal-8.internal.AdminGetSalesChannelsParams.md) - [AdminGetShippingOptionsParams](../classes/internal-8.internal.AdminGetShippingOptionsParams.md) - [AdminGetStockLocationsLocationParams](../classes/internal-8.internal.AdminGetStockLocationsLocationParams.md) - [AdminGetStockLocationsParams](../classes/internal-8.internal.AdminGetStockLocationsParams.md) - [AdminGetSwapsParams](../classes/internal-8.internal.AdminGetSwapsParams.md) - [AdminGetTaxRatesParams](../classes/internal-8.internal.AdminGetTaxRatesParams.md) - [AdminGetTaxRatesTaxRateParams](../classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md) - [AdminGetVariantParams](../classes/internal-8.internal.AdminGetVariantParams.md) - [AdminGetVariantsParams](../classes/internal-8.internal.AdminGetVariantsParams.md) - [AdminPostAnalyticsConfigAnalyticsConfigReq](../classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md) - [AdminPostAnalyticsConfigReq](../classes/internal-8.internal.AdminPostAnalyticsConfigReq.md) - [AdminPostDiscountsDiscountParams](../classes/internal-8.internal.AdminPostDiscountsDiscountParams.md) - [AdminPostDiscountsParams](../classes/internal-8.internal.AdminPostDiscountsParams.md) - [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) - [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md) - [AdminPostDraftOrdersDraftOrderReq](../classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md) - [AdminPostDraftOrdersReq](../classes/internal-8.internal.AdminPostDraftOrdersReq.md) - [AdminPostGiftCardsGiftCardReq](../classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md) - [AdminPostGiftCardsReq](../classes/internal-8.internal.AdminPostGiftCardsReq.md) - [AdminPostInventoryItemsInventoryItemParams](../classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md) - [AdminPostInventoryItemsInventoryItemReq](../classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md) - [AdminPostInventoryItemsItemLocationLevelsLevelParams](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md) - [AdminPostInventoryItemsItemLocationLevelsLevelReq](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md) - [AdminPostInventoryItemsItemLocationLevelsParams](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md) - [AdminPostInventoryItemsItemLocationLevelsReq](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md) - [AdminPostInventoryItemsParams](../classes/internal-8.internal.AdminPostInventoryItemsParams.md) - [AdminPostInventoryItemsReq](../classes/internal-8.internal.AdminPostInventoryItemsReq.md) - [AdminPostInvitesInviteAcceptReq](../classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md) - [AdminPostInvitesInviteAcceptUserReq](../classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md) - [AdminPostInvitesReq](../classes/internal-8.internal.AdminPostInvitesReq.md) - [AdminPostNotesNoteReq](../classes/internal-8.internal.AdminPostNotesNoteReq.md) - [AdminPostNotesReq](../classes/internal-8.internal.AdminPostNotesReq.md) - [AdminPostNotificationsNotificationResendReq](../classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md) - [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md) - [AdminPostOrderEditsEditLineItemsReq](../classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md) - [AdminPostOrderEditsOrderEditReq](../classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md) - [AdminPostOrderEditsReq](../classes/internal-8.internal.AdminPostOrderEditsReq.md) - [AdminPostOrderEditsRequestConfirmationReq](../classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md) - [AdminPostOrdersClaimCancel](../classes/internal-8.internal.AdminPostOrdersClaimCancel.md) - [AdminPostOrdersClaimFulfillmentsCancelParams](../classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md) - [AdminPostOrdersOrderArchiveParams](../classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md) - [AdminPostOrdersOrderCancel](../classes/internal-8.internal.AdminPostOrdersOrderCancel.md) - [AdminPostOrdersOrderCaptureParams](../classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md) - [AdminPostOrdersOrderClaimsClaimFulfillmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md) - [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) - [AdminPostOrdersOrderClaimsClaimParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md) - [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md) - [AdminPostOrdersOrderClaimsClaimShipmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md) - [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) - [AdminPostOrdersOrderClaimsParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md) - [AdminPostOrdersOrderClaimsReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md) - [AdminPostOrdersOrderCompleteParams](../classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md) - [AdminPostOrdersOrderFulfillementsCancelParams](../classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md) - [AdminPostOrdersOrderFulfillmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md) - [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md) - [AdminPostOrdersOrderParams](../classes/internal-8.internal.AdminPostOrdersOrderParams.md) - [AdminPostOrdersOrderRefundsParams](../classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md) - [AdminPostOrdersOrderRefundsReq](../classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md) - [AdminPostOrdersOrderReq](../classes/internal-8.internal.AdminPostOrdersOrderReq.md) - [AdminPostOrdersOrderReturnsParams](../classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md) - [AdminPostOrdersOrderReturnsReq](../classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md) - [AdminPostOrdersOrderShipmentParams](../classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md) - [AdminPostOrdersOrderShipmentReq](../classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md) - [AdminPostOrdersOrderShippingMethodsParams](../classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md) - [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md) - [AdminPostOrdersOrderSwapFulfillementsCancelParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md) - [AdminPostOrdersOrderSwapsParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md) - [AdminPostOrdersOrderSwapsReq](../classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md) - [AdminPostOrdersOrderSwapsSwapFulfillmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md) - [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) - [AdminPostOrdersOrderSwapsSwapProcessPaymentParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md) - [AdminPostOrdersOrderSwapsSwapShipmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md) - [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) - [AdminPostOrdersSwapCancelParams](../classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md) - [AdminPostPaymentRefundsReq](../classes/internal-8.internal.AdminPostPaymentRefundsReq.md) - [AdminPostPriceListPricesPricesReq](../classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md) - [AdminPostPriceListsPriceListPriceListReq](../classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md) - [AdminPostPriceListsPriceListReq](../classes/internal-8.internal.AdminPostPriceListsPriceListReq.md) - [AdminPostProductCategoriesCategoryParams](../classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md) - [AdminPostProductCategoriesCategoryProductsBatchParams](../classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md) - [AdminPostProductCategoriesCategoryProductsBatchReq](../classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md) - [AdminPostProductCategoriesCategoryReq](../classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md) - [AdminPostProductCategoriesParams](../classes/internal-8.internal.AdminPostProductCategoriesParams.md) - [AdminPostProductCategoriesReq](../classes/internal-8.internal.AdminPostProductCategoriesReq.md) - [AdminPostProductsProductMetadataReq](../classes/internal-8.internal.AdminPostProductsProductMetadataReq.md) - [AdminPostProductsProductOptionsOption](../classes/internal-8.internal.AdminPostProductsProductOptionsOption.md) - [AdminPostProductsProductOptionsReq](../classes/internal-8.internal.AdminPostProductsProductOptionsReq.md) - [AdminPostProductsProductReq](../classes/internal-8.internal.AdminPostProductsProductReq.md) - [AdminPostProductsProductVariantsReq](../classes/internal-8.internal.AdminPostProductsProductVariantsReq.md) - [AdminPostProductsProductVariantsVariantReq](../classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md) - [AdminPostProductsReq](../classes/internal-8.internal.AdminPostProductsReq.md) - [AdminPostPublishableApiKeySalesChannelsBatchReq](../classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md) - [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md) - [AdminPostPublishableApiKeysReq](../classes/internal-8.internal.AdminPostPublishableApiKeysReq.md) - [AdminPostRegionsRegionCountriesReq](../classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md) - [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md) - [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md) - [AdminPostRegionsRegionReq](../classes/internal-8.internal.AdminPostRegionsRegionReq.md) - [AdminPostRegionsReq](../classes/internal-8.internal.AdminPostRegionsReq.md) - [AdminPostReservationsReq](../classes/internal-8.internal.AdminPostReservationsReq.md) - [AdminPostReservationsReservationReq](../classes/internal-8.internal.AdminPostReservationsReservationReq.md) - [AdminPostReturnReasonsReasonReq](../classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md) - [AdminPostReturnReasonsReq](../classes/internal-8.internal.AdminPostReturnReasonsReq.md) - [AdminPostReturnsReturnReceiveReq](../classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md) - [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md) - [AdminPostSalesChannelsChannelStockLocationsReq](../classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md) - [AdminPostSalesChannelsReq](../classes/internal-8.internal.AdminPostSalesChannelsReq.md) - [AdminPostSalesChannelsSalesChannelReq](../classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md) - [AdminPostShippingOptionsOptionReq](../classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md) - [AdminPostShippingOptionsReq](../classes/internal-8.internal.AdminPostShippingOptionsReq.md) - [AdminPostShippingProfilesProfileReq](../classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md) - [AdminPostShippingProfilesReq](../classes/internal-8.internal.AdminPostShippingProfilesReq.md) - [AdminPostStockLocationsLocationParams](../classes/internal-8.internal.AdminPostStockLocationsLocationParams.md) - [AdminPostStockLocationsLocationReq](../classes/internal-8.internal.AdminPostStockLocationsLocationReq.md) - [AdminPostStockLocationsParams](../classes/internal-8.internal.AdminPostStockLocationsParams.md) - [AdminPostStockLocationsReq](../classes/internal-8.internal.AdminPostStockLocationsReq.md) - [AdminPostStoreReq](../classes/internal-8.internal.AdminPostStoreReq.md) - [AdminPostTaxRatesParams](../classes/internal-8.internal.AdminPostTaxRatesParams.md) - [AdminPostTaxRatesReq](../classes/internal-8.internal.AdminPostTaxRatesReq.md) - [AdminPostTaxRatesTaxRateParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md) - [AdminPostTaxRatesTaxRateProductTypesParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md) - [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md) - [AdminPostTaxRatesTaxRateProductsParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md) - [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md) - [AdminPostTaxRatesTaxRateReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md) - [AdminPostTaxRatesTaxRateShippingOptionsParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md) - [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) - [AdminPostUploadsDownloadUrlReq](../classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md) - [AdminPriceListPricesCreateReq](../classes/internal-8.internal.AdminPriceListPricesCreateReq.md) - [AdminPriceListPricesUpdateReq](../classes/internal-8.internal.AdminPriceListPricesUpdateReq.md) - [AdminRegionsRes](../classes/internal-8.internal.AdminRegionsRes.md) - [AdminResetPasswordRequest](../classes/internal-8.internal.AdminResetPasswordRequest.md) - [AdminResetPasswordTokenRequest](../classes/internal-8.internal.AdminResetPasswordTokenRequest.md) - [AdminUpdatePaymentCollectionsReq](../classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md) - [AdminUpdateUserRequest](../classes/internal-8.internal.AdminUpdateUserRequest.md) - [AnalyticsConfig](../classes/internal-8.internal.AnalyticsConfig.md) - [AnalyticsConfigService](../classes/internal-8.internal.AnalyticsConfigService.md) - [AuthService](../classes/internal-8.internal.AuthService.md) - [BatchJobService](../classes/internal-8.internal.BatchJobService.md) - [CartService](../classes/internal-8.internal.CartService.md) - [ClaimItemService](../classes/internal-8.internal.ClaimItemService.md) - [ClaimService](../classes/internal-8.internal.ClaimService.md) - [CurrencyService](../classes/internal-8.internal.CurrencyService.md) - [CustomShippingOption](../classes/internal-8.internal.CustomShippingOption.md) - [CustomShippingOptionService](../classes/internal-8.internal.CustomShippingOptionService.md) - [CustomerGroupService](../classes/internal-8.internal.CustomerGroupService.md) - [CustomerService](../classes/internal-8.internal.CustomerService.md) - [DiscountConditionCustomerGroup](../classes/internal-8.internal.DiscountConditionCustomerGroup.md) - [DiscountConditionProduct](../classes/internal-8.internal.DiscountConditionProduct.md) - [DiscountConditionProductCollection](../classes/internal-8.internal.DiscountConditionProductCollection.md) - [DiscountConditionProductTag](../classes/internal-8.internal.DiscountConditionProductTag.md) - [DiscountConditionProductType](../classes/internal-8.internal.DiscountConditionProductType.md) - [DiscountConditionService](../classes/internal-8.internal.DiscountConditionService.md) - [DiscountService](../classes/internal-8.internal.DiscountService.md) - [DraftOrderService](../classes/internal-8.internal.DraftOrderService.md) - [EmptyQueryParams](../classes/internal-8.internal.EmptyQueryParams.md) - [EventBusService](../classes/internal-8.internal.EventBusService.md) - [FilterableBatchJobProps](../classes/internal-8.internal.FilterableBatchJobProps.md) - [FilterablePriceListProps](../classes/internal-8.internal.FilterablePriceListProps.md) - [FulfillmentOption](../classes/internal-8.internal.FulfillmentOption.md) - [FulfillmentProviderService](../classes/internal-8.internal.FulfillmentProviderService.md) - [GetOrderEditsOrderEditParams](../classes/internal-8.internal.GetOrderEditsOrderEditParams.md) - [GetOrderEditsParams](../classes/internal-8.internal.GetOrderEditsParams.md) - [GetPaymentsParams](../classes/internal-8.internal.GetPaymentsParams.md) - [GetPublishableApiKeySalesChannelsParams](../classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md) - [GetPublishableApiKeysParams](../classes/internal-8.internal.GetPublishableApiKeysParams.md) - [GiftCardService](../classes/internal-8.internal.GiftCardService.md) - [IAdminPostUploadsFileReq](../classes/internal-8.internal.IAdminPostUploadsFileReq.md) - [IdempotencyKey](../classes/internal-8.internal.IdempotencyKey.md) - [IdempotencyKeyService](../classes/internal-8.internal.IdempotencyKeyService.md) - [Invite](../classes/internal-8.internal.Invite.md) - [Item](../classes/internal-8.internal.Item.md) - [LineItemAdjustmentService](../classes/internal-8.internal.LineItemAdjustmentService.md) - [LineItemService](../classes/internal-8.internal.LineItemService.md) - [MiddlewareService](../classes/internal-8.internal.MiddlewareService.md) - [NewTotalsService](../classes/internal-8.internal.NewTotalsService.md) - [Note](../classes/internal-8.internal.Note.md) - [NoteService](../classes/internal-8.internal.NoteService.md) - [Notification](../classes/internal-8.internal.Notification.md) - [NotificationService](../classes/internal-8.internal.NotificationService.md) - [NumericalComparisonOperator](../classes/internal-8.internal.NumericalComparisonOperator.md) - [Oauth](../classes/internal-8.internal.Oauth.md) - [OauthService](../classes/internal-8.internal.OauthService.md) - [OrderEditItemChangeService](../classes/internal-8.internal.OrderEditItemChangeService.md) - [OrderEditService](../classes/internal-8.internal.OrderEditService.md) - [OrderService](../classes/internal-8.internal.OrderService.md) - [PaymentCollectionService](../classes/internal-8.internal.PaymentCollectionService.md) - [PaymentProviderService](../classes/internal-8.internal.PaymentProviderService.md) - [PriceListService](../classes/internal-8.internal.PriceListService.md) - [PricingService](../classes/internal-8.internal.PricingService.md) - [ProductCategoryService](../classes/internal-8.internal.ProductCategoryService.md) - [ProductCollectionService](../classes/internal-8.internal.ProductCollectionService.md) - [ProductService](../classes/internal-8.internal.ProductService.md) - [ProductTaxRate](../classes/internal-8.internal.ProductTaxRate.md) - [ProductTypeService](../classes/internal-8.internal.ProductTypeService.md) - [ProductTypeTaxRate](../classes/internal-8.internal.ProductTypeTaxRate.md) - [ProductVariantInventoryService](../classes/internal-8.internal.ProductVariantInventoryService.md) - [ProductVariantMoneyAmount](../classes/internal-8.internal.ProductVariantMoneyAmount.md) - [ProductVariantService](../classes/internal-8.internal.ProductVariantService.md) - [PublishableApiKey](../classes/internal-8.internal.PublishableApiKey.md) - [PublishableApiKeySalesChannel](../classes/internal-8.internal.PublishableApiKeySalesChannel.md) - [RegionService](../classes/internal-8.internal.RegionService.md) - [ReturnReasonService](../classes/internal-8.internal.ReturnReasonService.md) - [ReturnService](../classes/internal-8.internal.ReturnService.md) - [SalesChannelInventoryService](../classes/internal-8.internal.SalesChannelInventoryService.md) - [SalesChannelLocationService](../classes/internal-8.internal.SalesChannelLocationService.md) - [SalesChannelService](../classes/internal-8.internal.SalesChannelService.md) - [SearchService](../classes/internal-8.internal.SearchService.md) - [ShippingAddressPayload](../classes/internal-8.internal.ShippingAddressPayload.md) - [ShippingOptionService](../classes/internal-8.internal.ShippingOptionService.md) - [ShippingProfileService](../classes/internal-8.internal.ShippingProfileService.md) - [ShippingTaxRate](../classes/internal-8.internal.ShippingTaxRate.md) - [StagedJob](../classes/internal-8.internal.StagedJob.md) - [StagedJobService](../classes/internal-8.internal.StagedJobService.md) - [Store](../classes/internal-8.internal.Store.md) - [StoreGetCollectionsParams](../classes/internal-8.internal.StoreGetCollectionsParams.md) - [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md) - [StoreGetCustomersCustomerOrdersParams](../classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md) - [StoreGetOrdersParams](../classes/internal-8.internal.StoreGetOrdersParams.md) - [StoreGetPaymentCollectionsParams](../classes/internal-8.internal.StoreGetPaymentCollectionsParams.md) - [StoreGetProductCategoriesCategoryParams](../classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md) - [StoreGetProductCategoriesParams](../classes/internal-8.internal.StoreGetProductCategoriesParams.md) - [StoreGetProductTagsParams](../classes/internal-8.internal.StoreGetProductTagsParams.md) - [StoreGetProductTypesParams](../classes/internal-8.internal.StoreGetProductTypesParams.md) - [StoreGetProductsPaginationParams](../classes/internal-8.internal.StoreGetProductsPaginationParams.md) - [StoreGetProductsParams](../classes/internal-8.internal.StoreGetProductsParams.md) - [StoreGetRegionsParams](../classes/internal-8.internal.StoreGetRegionsParams.md) - [StoreGetShippingOptionsParams](../classes/internal-8.internal.StoreGetShippingOptionsParams.md) - [StoreGetVariantsParams](../classes/internal-8.internal.StoreGetVariantsParams.md) - [StoreGetVariantsVariantParams](../classes/internal-8.internal.StoreGetVariantsVariantParams.md) - [StorePaymentCollectionSessionsReq](../classes/internal-8.internal.StorePaymentCollectionSessionsReq.md) - [StorePostAuthReq](../classes/internal-8.internal.StorePostAuthReq.md) - [StorePostCartReq](../classes/internal-8.internal.StorePostCartReq.md) - [StorePostCartsCartLineItemsItemReq](../classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md) - [StorePostCartsCartLineItemsReq](../classes/internal-8.internal.StorePostCartsCartLineItemsReq.md) - [StorePostCartsCartPaymentSessionReq](../classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md) - [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md) - [StorePostCartsCartReq](../classes/internal-8.internal.StorePostCartsCartReq.md) - [StorePostCartsCartShippingMethodReq](../classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md) - [StorePostCustomersCustomerAcceptClaimReq](../classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md) - [StorePostCustomersCustomerOrderClaimReq](../classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md) - [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md) - [StorePostCustomersCustomerReq](../classes/internal-8.internal.StorePostCustomersCustomerReq.md) - [StorePostCustomersReq](../classes/internal-8.internal.StorePostCustomersReq.md) - [StorePostCustomersResetPasswordReq](../classes/internal-8.internal.StorePostCustomersResetPasswordReq.md) - [StorePostOrderEditsOrderEditDecline](../classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md) - [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) - [StorePostPaymentCollectionsBatchSessionsReq](../classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md) - [StorePostPaymentCollectionsSessionsReq](../classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md) - [StorePostReturnsReq](../classes/internal-8.internal.StorePostReturnsReq.md) - [StorePostSearchReq](../classes/internal-8.internal.StorePostSearchReq.md) - [StorePostSwapsReq](../classes/internal-8.internal.StorePostSwapsReq.md) - [StoreService](../classes/internal-8.internal.StoreService.md) - [StrategyResolverService](../classes/internal-8.internal.StrategyResolverService.md) - [SwapService](../classes/internal-8.internal.SwapService.md) - [SystemPaymentProviderService](../classes/internal-8.internal.SystemPaymentProviderService.md) - [TaxProviderService](../classes/internal-8.internal.TaxProviderService.md) - [TaxRateService](../classes/internal-8.internal.TaxRateService.md) - [TokenService](../classes/internal-8.internal.TokenService.md) - [TotalsService](../classes/internal-8.internal.TotalsService.md) - [TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md) - [UserService](../classes/internal-8.internal.UserService.md) ## Interfaces - [CustomFindOptions](../interfaces/internal-8.internal.CustomFindOptions.md) - [FindConfig](../interfaces/internal-8.internal.FindConfig.md) - [FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md) - [IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md) - [ICartCompletionStrategy](../interfaces/internal-8.internal.ICartCompletionStrategy.md) - [IFileService](../interfaces/internal-8.internal.IFileService.md) - [INotificationService](../interfaces/internal-8.internal.INotificationService.md) - [IPriceSelectionStrategy](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) - [ITaxCalculationStrategy](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) - [ITaxService](../interfaces/internal-8.internal.ITaxService.md) - [PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md) - [PaymentProcessorError](../interfaces/internal-8.internal.PaymentProcessorError.md) - [PaymentService](../interfaces/internal-8.internal.PaymentService.md) ## References ### Address Re-exports [Address](../classes/internal-3.Address.md) ___ ### AddressCreatePayload Re-exports [AddressCreatePayload](../classes/internal.AddressCreatePayload.md) ___ ### AddressPayload Re-exports [AddressPayload](../classes/internal.AddressPayload.md) ___ ### AdminAuthRes Re-exports [AdminAuthRes](internal-1.md#adminauthres) ___ ### AdminBatchJobListRes Re-exports [AdminBatchJobListRes](internal-2.md#adminbatchjoblistres) ___ ### AdminBatchJobRes Re-exports [AdminBatchJobRes](internal-2.md#adminbatchjobres) ___ ### AdminBearerAuthRes Re-exports [AdminBearerAuthRes](internal-1.md#adminbearerauthres) ___ ### AdminCollectionsListRes Re-exports [AdminCollectionsListRes](internal-3.md#admincollectionslistres) ___ ### AdminCollectionsRes Re-exports [AdminCollectionsRes](internal-3.md#admincollectionsres) ___ ### AdminCreateCondition Re-exports [AdminCreateCondition](../classes/internal-8.AdminCreateCondition.md) ___ ### AdminCurrenciesListRes Re-exports [AdminCurrenciesListRes](internal-4.md#admincurrencieslistres) ___ ### AdminCurrenciesRes Re-exports [AdminCurrenciesRes](internal-4.md#admincurrenciesres) ___ ### AdminCustomerGroupsListRes Re-exports [AdminCustomerGroupsListRes](internal-6.md#admincustomergroupslistres) ___ ### AdminCustomerGroupsRes Re-exports [AdminCustomerGroupsRes](internal-6.md#admincustomergroupsres) ___ ### AdminCustomersListRes Re-exports [AdminCustomersListRes](internal-7.md#admincustomerslistres) ___ ### AdminCustomersRes Re-exports [AdminCustomersRes](internal-7.md#admincustomersres) ___ ### AdminDeleteCustomerGroupsGroupCustomerBatchReq Re-exports [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) ___ ### AdminDeleteDiscountsDiscountConditionsConditionBatchReq Re-exports [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) ___ ### AdminDeleteProductsFromCollectionReq Re-exports [AdminDeleteProductsFromCollectionReq](../classes/internal-3.AdminDeleteProductsFromCollectionReq.md) ___ ### AdminDeleteProductsFromCollectionRes Re-exports [AdminDeleteProductsFromCollectionRes](internal-3.md#admindeleteproductsfromcollectionres) ___ ### AdminDiscountConditionsRes Re-exports [AdminDiscountConditionsRes](internal-8.md#admindiscountconditionsres) ___ ### AdminDiscountsListRes Re-exports [AdminDiscountsListRes](internal-8.md#admindiscountslistres) ___ ### AdminDiscountsRes Re-exports [AdminDiscountsRes](internal-8.md#admindiscountsres) ___ ### AdminGetBatchPaginationParams Re-exports [AdminGetBatchPaginationParams](../classes/internal-2.AdminGetBatchPaginationParams.md) ___ ### AdminGetBatchParams Re-exports [AdminGetBatchParams](../classes/internal-2.AdminGetBatchParams.md) ___ ### AdminGetCollectionsPaginationParams Re-exports [AdminGetCollectionsPaginationParams](../classes/internal-3.AdminGetCollectionsPaginationParams.md) ___ ### AdminGetCollectionsParams Re-exports [AdminGetCollectionsParams](../classes/internal-3.AdminGetCollectionsParams.md) ___ ### AdminGetCurrenciesParams Re-exports [AdminGetCurrenciesParams](../classes/internal-4.AdminGetCurrenciesParams.md) ___ ### AdminGetCustomerGroupsGroupParams Re-exports [AdminGetCustomerGroupsGroupParams](../classes/internal-6.AdminGetCustomerGroupsGroupParams.md) ___ ### AdminGetCustomerGroupsParams Re-exports [AdminGetCustomerGroupsParams](../classes/internal-6.AdminGetCustomerGroupsParams.md) ___ ### AdminGetCustomersParams Re-exports [AdminGetCustomersParams](../classes/internal-7.AdminGetCustomersParams.md) ___ ### AdminGetDiscountsDiscountConditionsConditionParams Re-exports [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) ___ ### AdminGetDiscountsParams Re-exports [AdminGetDiscountsParams](../classes/internal-8.AdminGetDiscountsParams.md) ___ ### AdminPostAuthReq Re-exports [AdminPostAuthReq](../classes/internal-1.AdminPostAuthReq.md) ___ ### AdminPostBatchesReq Re-exports [AdminPostBatchesReq](../classes/internal-2.AdminPostBatchesReq.md) ___ ### AdminPostCollectionsCollectionReq Re-exports [AdminPostCollectionsCollectionReq](../classes/internal-3.AdminPostCollectionsCollectionReq.md) ___ ### AdminPostCollectionsReq Re-exports [AdminPostCollectionsReq](../classes/internal-3.AdminPostCollectionsReq.md) ___ ### AdminPostCurrenciesCurrencyReq Re-exports [AdminPostCurrenciesCurrencyReq](../classes/internal-4.AdminPostCurrenciesCurrencyReq.md) ___ ### AdminPostCustomerGroupsGroupCustomersBatchReq Re-exports [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md) ___ ### AdminPostCustomerGroupsGroupReq Re-exports [AdminPostCustomerGroupsGroupReq](../classes/internal-6.AdminPostCustomerGroupsGroupReq.md) ___ ### AdminPostCustomerGroupsReq Re-exports [AdminPostCustomerGroupsReq](../classes/internal-6.AdminPostCustomerGroupsReq.md) ___ ### AdminPostCustomersCustomerReq Re-exports [AdminPostCustomersCustomerReq](../classes/internal-7.AdminPostCustomersCustomerReq.md) ___ ### AdminPostCustomersReq Re-exports [AdminPostCustomersReq](../classes/internal-7.AdminPostCustomersReq.md) ___ ### AdminPostDiscountsDiscountConditions Re-exports [AdminPostDiscountsDiscountConditions](../classes/internal-8.AdminPostDiscountsDiscountConditions.md) ___ ### AdminPostDiscountsDiscountConditionsCondition Re-exports [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md) ___ ### AdminPostDiscountsDiscountConditionsConditionBatchParams Re-exports [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) ___ ### AdminPostDiscountsDiscountConditionsConditionBatchReq Re-exports [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) ___ ### AdminPostDiscountsDiscountConditionsConditionParams Re-exports [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) ___ ### AdminPostDiscountsDiscountConditionsParams Re-exports [AdminPostDiscountsDiscountConditionsParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md) ___ ### AdminPostDiscountsDiscountDynamicCodesReq Re-exports [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md) ___ ### AdminPostDiscountsDiscountReq Re-exports [AdminPostDiscountsDiscountReq](../classes/internal-8.AdminPostDiscountsDiscountReq.md) ___ ### AdminPostDiscountsDiscountRule Re-exports [AdminPostDiscountsDiscountRule](../classes/internal-8.AdminPostDiscountsDiscountRule.md) ___ ### AdminPostDiscountsReq Re-exports [AdminPostDiscountsReq](../classes/internal-8.AdminPostDiscountsReq.md) ___ ### AdminPostProductsToCollectionReq Re-exports [AdminPostProductsToCollectionReq](../classes/internal-3.AdminPostProductsToCollectionReq.md) ___ ### AdminUpdateDiscountRule Re-exports [AdminUpdateDiscountRule](../classes/internal-8.AdminUpdateDiscountRule.md) ___ ### AdminUpsertCondition Re-exports [AdminUpsertCondition](../classes/internal-8.AdminUpsertCondition.md) ___ ### AllocationType Re-exports [AllocationType](../enums/internal-3.AllocationType.md) ___ ### BaseEntity Re-exports [BaseEntity](../classes/internal-1.BaseEntity.md) ___ ### BatchJob Re-exports [BatchJob](../classes/internal-2.BatchJob.md) ___ ### BatchJobResultError Re-exports [BatchJobResultError](internal-2.md#batchjobresulterror) ___ ### BatchJobResultStatDescriptor Re-exports [BatchJobResultStatDescriptor](internal-2.md#batchjobresultstatdescriptor) ___ ### BatchJobStatus Re-exports [BatchJobStatus](../enums/internal-2.BatchJobStatus.md) ___ ### Cart Re-exports [Cart](../classes/internal-3.Cart.md) ___ ### CartType Re-exports [CartType](../enums/internal-3.CartType.md) ___ ### ClaimFulfillmentStatus Re-exports [ClaimFulfillmentStatus](../enums/internal-3.ClaimFulfillmentStatus.md) ___ ### ClaimImage Re-exports [ClaimImage](../classes/internal-3.ClaimImage.md) ___ ### ClaimItem Re-exports [ClaimItem](../classes/internal-3.ClaimItem.md) ___ ### ClaimOrder Re-exports [ClaimOrder](../classes/internal-3.ClaimOrder.md) ___ ### ClaimPaymentStatus Re-exports [ClaimPaymentStatus](../enums/internal-3.ClaimPaymentStatus.md) ___ ### ClaimReason Re-exports [ClaimReason](../enums/internal-3.ClaimReason.md) ___ ### ClaimTag Re-exports [ClaimTag](../classes/internal-3.ClaimTag.md) ___ ### ClaimType Re-exports [ClaimType](../enums/internal-3.ClaimType.md) ___ ### Country Re-exports [Country](../classes/internal-3.Country.md) ___ ### Currency Re-exports [Currency](../classes/internal-3.Currency.md) ___ ### Customer Re-exports [Customer](../classes/internal-3.Customer.md) ___ ### CustomerGroup Re-exports [CustomerGroup](../classes/internal-3.CustomerGroup.md) ___ ### DateComparisonOperator Re-exports [DateComparisonOperator](../classes/internal-2.DateComparisonOperator.md) ___ ### Discount Re-exports [Discount](../classes/internal-3.Discount.md) ___ ### DiscountCondition Re-exports [DiscountCondition](../classes/internal-3.DiscountCondition.md) ___ ### DiscountConditionOperator Re-exports [DiscountConditionOperator](../enums/internal-3.DiscountConditionOperator.md) ___ ### DiscountConditionType Re-exports [DiscountConditionType](../enums/internal-3.DiscountConditionType.md) ___ ### DiscountRule Re-exports [DiscountRule](../classes/internal-3.DiscountRule.md) ___ ### DiscountRuleType Re-exports [DiscountRuleType](../enums/internal-3.DiscountRuleType.md) ___ ### DraftOrder Re-exports [DraftOrder](../classes/internal-3.DraftOrder.md) ___ ### DraftOrderStatus Re-exports [DraftOrderStatus](../enums/internal-3.DraftOrderStatus.md) ___ ### FindPaginationParams Re-exports [FindPaginationParams](../classes/internal-4.FindPaginationParams.md) ___ ### FindParams Re-exports [FindParams](../classes/internal-6.FindParams.md) ___ ### Fulfillment Re-exports [Fulfillment](../classes/internal-3.Fulfillment.md) ___ ### FulfillmentItem Re-exports [FulfillmentItem](../classes/internal-3.FulfillmentItem.md) ___ ### FulfillmentProvider Re-exports [FulfillmentProvider](../classes/internal-3.FulfillmentProvider.md) ___ ### FulfillmentStatus Re-exports [FulfillmentStatus](../enums/internal-3.FulfillmentStatus.md) ___ ### GiftCard Re-exports [GiftCard](../classes/internal-3.GiftCard.md) ___ ### GiftCardTransaction Re-exports [GiftCardTransaction](../classes/internal-3.GiftCardTransaction.md) ___ ### Image Re-exports [Image](../classes/internal-3.Image.md) ___ ### LineItem Re-exports [LineItem](../classes/internal-3.LineItem.md) ___ ### LineItemAdjustment Re-exports [LineItemAdjustment](../classes/internal-3.LineItemAdjustment.md) ___ ### LineItemTaxLine Re-exports [LineItemTaxLine](../classes/internal-3.LineItemTaxLine.md) ___ ### MoneyAmount Re-exports [MoneyAmount](../classes/internal-3.MoneyAmount.md) ___ ### Order Re-exports [Order](../classes/internal-3.Order.md) ___ ### OrderEdit Re-exports [OrderEdit](../classes/internal-3.OrderEdit.md) ___ ### OrderEditItemChangeType Re-exports [OrderEditItemChangeType](../enums/internal-3.OrderEditItemChangeType.md) ___ ### OrderEditStatus Re-exports [OrderEditStatus](../enums/internal-3.OrderEditStatus.md) ___ ### OrderItemChange Re-exports [OrderItemChange](../classes/internal-3.OrderItemChange.md) ___ ### OrderStatus Re-exports [OrderStatus](../enums/internal-3.OrderStatus.md) ___ ### PaginatedResponse Re-exports [PaginatedResponse](internal-2.md#paginatedresponse) ___ ### Payment Re-exports [Payment](../classes/internal-3.Payment.md) ___ ### PaymentCollection Re-exports [PaymentCollection](../classes/internal-3.PaymentCollection.md) ___ ### PaymentCollectionStatus Re-exports [PaymentCollectionStatus](../enums/internal-3.PaymentCollectionStatus.md) ___ ### PaymentProvider Re-exports [PaymentProvider](../classes/internal-3.PaymentProvider.md) ___ ### PaymentSession Re-exports [PaymentSession](../classes/internal-3.PaymentSession.md) ___ ### PaymentStatus Re-exports [PaymentStatus](../enums/internal-3.PaymentStatus.md) ___ ### PriceList Re-exports [PriceList](../classes/internal-3.PriceList.md) ___ ### PriceListStatus Re-exports [PriceListStatus](../enums/internal-3.PriceListStatus.md) ___ ### PriceListType Re-exports [PriceListType](../enums/internal-3.PriceListType.md) ___ ### Product Re-exports [Product](../classes/internal-3.Product.md) ___ ### ProductCategory Re-exports [ProductCategory](../classes/internal-3.ProductCategory.md) ___ ### ProductCollection Re-exports [ProductCollection](../classes/internal-3.ProductCollection.md) ___ ### ProductOption Re-exports [ProductOption](../classes/internal-3.ProductOption.md) ___ ### ProductOptionValue Re-exports [ProductOptionValue](../classes/internal-3.ProductOptionValue.md) ___ ### ProductStatus Re-exports [ProductStatus](../enums/internal-3.ProductStatus.md) ___ ### ProductTag Re-exports [ProductTag](../classes/internal-3.ProductTag.md) ___ ### ProductType Re-exports [ProductType](../classes/internal-3.ProductType.md) ___ ### ProductVariant Re-exports [ProductVariant](../classes/internal-3.ProductVariant.md) ___ ### ProductVariantInventoryItem Re-exports [ProductVariantInventoryItem](../classes/internal-3.ProductVariantInventoryItem.md) ___ ### Refund Re-exports [Refund](../classes/internal-3.Refund.md) ___ ### Region Re-exports [Region](../classes/internal-3.Region.md) ___ ### RequirementType Re-exports [RequirementType](../enums/internal-3.RequirementType.md) ___ ### Return Re-exports [Return](../classes/internal-3.Return.md) ___ ### ReturnItem Re-exports [ReturnItem](../classes/internal-3.ReturnItem.md) ___ ### ReturnReason Re-exports [ReturnReason](../classes/internal-3.ReturnReason.md) ___ ### ReturnStatus Re-exports [ReturnStatus](../enums/internal-3.ReturnStatus.md) ___ ### SalesChannel Re-exports [SalesChannel](../classes/internal-3.SalesChannel.md) ___ ### SalesChannelLocation Re-exports [SalesChannelLocation](../classes/internal-3.SalesChannelLocation.md) ___ ### ShippingMethod Re-exports [ShippingMethod](../classes/internal-3.ShippingMethod.md) ___ ### ShippingMethodTaxLine Re-exports [ShippingMethodTaxLine](../classes/internal-3.ShippingMethodTaxLine.md) ___ ### ShippingOption Re-exports [ShippingOption](../classes/internal-3.ShippingOption.md) ___ ### ShippingOptionPriceType Re-exports [ShippingOptionPriceType](../enums/internal-3.ShippingOptionPriceType.md) ___ ### ShippingOptionRequirement Re-exports [ShippingOptionRequirement](../classes/internal-3.ShippingOptionRequirement.md) ___ ### ShippingProfile Re-exports [ShippingProfile](../classes/internal-3.ShippingProfile.md) ___ ### ShippingProfileType Re-exports [ShippingProfileType](../enums/internal-3.ShippingProfileType.md) ___ ### SoftDeletableEntity Re-exports [SoftDeletableEntity](../classes/internal-1.SoftDeletableEntity.md) ___ ### StorePostCustomersCustomerAddressesAddressReq Re-exports [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md) ___ ### StorePostCustomersCustomerAddressesReq Re-exports [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md) ___ ### StringComparisonOperator Re-exports [StringComparisonOperator](../classes/internal-6.StringComparisonOperator.md) ___ ### Swap Re-exports [Swap](../classes/internal-3.Swap.md) ___ ### SwapFulfillmentStatus Re-exports [SwapFulfillmentStatus](../enums/internal-3.SwapFulfillmentStatus.md) ___ ### SwapPaymentStatus Re-exports [SwapPaymentStatus](../enums/internal-3.SwapPaymentStatus.md) ___ ### TaxProvider Re-exports [TaxProvider](../classes/internal-3.TaxProvider.md) ___ ### TaxRate Re-exports [TaxRate](../classes/internal-3.TaxRate.md) ___ ### TrackingLink Re-exports [TrackingLink](../classes/internal-3.TrackingLink.md) ___ ### User Re-exports [User](../classes/internal-1.User.md) ___ ### UserRoles Re-exports [UserRoles](../enums/internal-1.UserRoles.md) ## Type Aliases ### AdminAnalyticsConfigDeleteRes Ƭ **AdminAnalyticsConfigDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) #### Defined in packages/medusa/dist/api/routes/admin/analytics-configs/index.d.ts:9 ___ ### AdminAnalyticsConfigRes Ƭ **AdminAnalyticsConfigRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `analytics_config` | [`AnalyticsConfig`](../classes/internal-8.internal.AnalyticsConfig.md) | #### Defined in packages/medusa/dist/api/routes/admin/analytics-configs/index.d.ts:6 ___ ### AdminCollectionsDeleteRes Ƭ **AdminCollectionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminCollectionsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Collection object: type: string description: The type of the object that was deleted. default: product-collection deleted: type: boolean description: Whether the collection was deleted successfully or not. default: true #### Defined in packages/medusa/dist/api/routes/admin/collections/index.d.ts:55 ___ ### AdminCustomerGroupsDeleteRes Ƭ **AdminCustomerGroupsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminCustomerGroupsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted customer group. object: type: string description: The type of the object that was deleted. default: customer_group deleted: type: boolean description: Whether the customer group was deleted successfully or not. default: true #### Defined in packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:38 ___ ### AdminDeleteShippingProfileRes Ƭ **AdminDeleteShippingProfileRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminDeleteShippingProfileRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Shipping Profile. object: type: string description: The type of the object that was deleted. default: shipping_profile deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:28 ___ ### AdminDeleteUploadsRes Ƭ **AdminDeleteUploadsRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminDeleteUploadsRes type: object required: - id - object - deleted properties: id: type: string description: The file key of the upload deleted object: type: string description: The type of the object that was deleted. default: file deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/uploads/index.d.ts:51 ___ ### AdminDeleteUserRes Ƭ **AdminDeleteUserRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminDeleteUserRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted user. object: type: string description: The type of the object that was deleted. default: user deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/users/index.d.ts:54 ___ ### AdminDiscountConditionsDeleteRes Ƭ **AdminDiscountConditionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) & { `discount`: [`Discount`](../classes/internal-3.Discount.md) } **`Schema`** AdminDiscountConditionsDeleteRes type: object required: - id - object - deleted - discount properties: id: type: string description: The ID of the deleted Discount Condition object: type: string description: The type of the object that was deleted. default: discount-condition deleted: type: boolean description: Whether the discount condition was deleted successfully. default: true discount: description: The Discount to which the condition used to belong to. $ref: "#/components/schemas/Discount" #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:96 ___ ### AdminDiscountsDeleteRes Ƭ **AdminDiscountsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminDiscountsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Discount object: type: string description: The type of the object that was deleted. default: discount deleted: type: boolean description: Whether the discount was deleted successfully. default: true #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:71 ___ ### AdminDraftOrdersDeleteRes Ƭ **AdminDraftOrdersDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminDraftOrdersDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Draft Order. object: type: string description: The type of the object that was deleted. default: draft-order deleted: type: boolean description: Whether the draft order was deleted successfully. default: true #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:114 ___ ### AdminDraftOrdersListRes Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal-3.DraftOrder.md)[] } **`Schema`** AdminDraftOrdersListRes type: object x-expanded-relations: field: draft_orders relations: - order - cart - cart.items - cart.items.adjustments required: - draft_orders - count - offset - limit properties: draft_orders: type: array description: An array of draft order's details. items: $ref: "#/components/schemas/DraftOrder" count: type: integer description: The total number of items available offset: type: integer description: The number of draft orders skipped when retrieving the draft orders. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:146 ___ ### AdminDraftOrdersRes Ƭ **AdminDraftOrdersRes**: `Object` **`Schema`** AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required: - draft_order properties: draft_order: description: Draft order's details. $ref: "#/components/schemas/DraftOrder" #### Type declaration | Name | Type | | :------ | :------ | | `draft_order` | [`DraftOrder`](../classes/internal-3.DraftOrder.md) | #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:91 ___ ### AdminExtendedStoresRes Ƭ **AdminExtendedStoresRes**: `Object` **`Schema`** AdminExtendedStoresRes type: object x-expanded-relations: field: store relations: - currencies - default_currency required: - store properties: store: description: Store details. $ref: "#/components/schemas/ExtendedStoreDTO" #### Type declaration | Name | Type | | :------ | :------ | | `store` | [`ExtendedStoreDTO`](internal-8.md#extendedstoredto) | #### Defined in packages/medusa/dist/api/routes/admin/store/index.d.ts:21 ___ ### AdminGetVariantsVariantInventoryRes Ƭ **AdminGetVariantsVariantInventoryRes**: `Object` **`Schema`** AdminGetVariantsVariantInventoryRes type: object properties: variant: type: object description: "The product variant's." $ref: "#/components/schemas/VariantInventory" #### Type declaration | Name | Type | | :------ | :------ | | `variant` | [`VariantInventory`](internal-8.internal.md#variantinventory) | #### Defined in packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:134 ___ ### AdminGiftCardsDeleteRes Ƭ **AdminGiftCardsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminGiftCardsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Gift Card object: type: string description: The type of the object that was deleted. default: gift-card deleted: type: boolean description: Whether the gift card was deleted successfully. default: true #### Defined in packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:49 ___ ### AdminGiftCardsListRes Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal-3.GiftCard.md)[] } **`Schema`** AdminGiftCardsListRes type: object x-expanded-relations: field: gift_cards relations: - order - region eager: - region.fulfillment_providers - region.payment_providers required: - gift_cards - count - offset - limit properties: gift_cards: type: array items: $ref: "#/components/schemas/GiftCard" count: type: integer description: The total number of items available offset: type: integer description: The number of gift cards skipped when retrieving the gift cards. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:81 ___ ### AdminGiftCardsRes Ƭ **AdminGiftCardsRes**: `Object` **`Schema`** AdminGiftCardsRes type: object x-expanded-relations: field: gift_card relations: - order - region eager: - region.fulfillment_providers - region.payment_providers required: - gift_card properties: gift_card: description: "A gift card's details." $ref: "#/components/schemas/GiftCard" #### Type declaration | Name | Type | | :------ | :------ | | `gift_card` | [`GiftCard`](../classes/internal-3.GiftCard.md) | #### Defined in packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:26 ___ ### AdminInventoryItemsDeleteRes Ƭ **AdminInventoryItemsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminInventoryItemsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Inventory Item. object: type: string description: The type of the object that was deleted. format: inventory_item deleted: type: boolean description: Whether or not the Inventory Item was deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:43 ___ ### AdminInventoryItemsListRes Ƭ **AdminInventoryItemsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `inventory_items`: [`InventoryItemDTO`](internal-8.md#inventoryitemdto)[] } **`Schema`** AdminInventoryItemsListRes type: object required: - inventory_items - count - offset - limit properties: inventory_items: type: array description: an array of Inventory Item details items: $ref: "#/components/schemas/InventoryItemDTO" count: type: integer description: The total number of items available offset: type: integer description: The number of inventory items skipped when retrieving the inventory items. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:68 ___ ### AdminInventoryItemsListWithVariantsAndLocationLevelsRes Ƭ **AdminInventoryItemsListWithVariantsAndLocationLevelsRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `inventory_items`: [`DecoratedInventoryItemDTO`](internal-8.internal.md#decoratedinventoryitemdto)[] } **`Schema`** AdminInventoryItemsListWithVariantsAndLocationLevelsRes type: object required: - inventory_items - count - offset - limit properties: inventory_items: type: array description: an array of Inventory Item details items: $ref: "#/components/schemas/DecoratedInventoryItemDTO" count: type: integer description: The total number of items available offset: type: integer description: The number of inventory items skipped when retrieving the inventory items. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:128 ___ ### AdminInventoryItemsLocationLevelsRes Ƭ **AdminInventoryItemsLocationLevelsRes**: `Object` **`Schema`** AdminInventoryItemsLocationLevelsRes type: object required: - inventory_item properties: inventory_item: type: object required: - id - location_levels properties: id: description: The id of the location location_levels: description: List of stock levels at a given location type: array items: $ref: "#/components/schemas/InventoryLevelDTO" #### Type declaration | Name | Type | | :------ | :------ | | `inventory_item` | { `id`: `any` ; `location_levels`: [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] } | | `inventory_item.id` | `any` | | `inventory_item.location_levels` | [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] | #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:151 ___ ### AdminInventoryItemsRes Ƭ **AdminInventoryItemsRes**: `Object` **`Schema`** AdminInventoryItemsRes type: object required: - inventory_item properties: inventory_item: description: Inventory Item details $ref: "#/components/schemas/InventoryItemDTO" #### Type declaration | Name | Type | | :------ | :------ | | `inventory_item` | [`InventoryItemDTO`](internal-8.md#inventoryitemdto) | #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:20 ___ ### AdminInviteDeleteRes Ƭ **AdminInviteDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminInviteDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Invite. object: type: string description: The type of the object that was deleted. default: invite deleted: type: boolean description: Whether or not the invite was deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/invites/index.d.ts:27 ___ ### AdminListInvitesRes Ƭ **AdminListInvitesRes**: `Object` **`Schema`** AdminListInvitesRes type: object required: - invites properties: invites: type: array description: An array of invites items: $ref: "#/components/schemas/Invite" #### Type declaration | Name | Type | | :------ | :------ | | `invites` | [`Invite`](../classes/internal-8.internal.Invite.md)[] | #### Defined in packages/medusa/dist/api/routes/admin/invites/index.d.ts:40 ___ ### AdminNotesDeleteRes Ƭ **AdminNotesDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminNotesDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Note. object: type: string description: The type of the object that was deleted. default: note deleted: type: boolean description: Whether or not the Note was deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/notes/index.d.ts:39 ___ ### AdminNotesListRes Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-8.internal.Note.md)[] } **`Schema`** AdminNotesListRes type: object required: - notes - count - offset - limit properties: notes: type: array description: An array of notes items: $ref: "#/components/schemas/Note" count: type: integer description: The total number of items available offset: type: integer description: The number of notes skipped when retrieving the notes. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/notes/index.d.ts:64 ___ ### AdminNotesRes Ƭ **AdminNotesRes**: `Object` **`Schema`** AdminNotesRes type: object required: - note properties: note: description: Note details. $ref: "#/components/schemas/Note" #### Type declaration | Name | Type | | :------ | :------ | | `note` | [`Note`](../classes/internal-8.internal.Note.md) | #### Defined in packages/medusa/dist/api/routes/admin/notes/index.d.ts:16 ___ ### AdminNotificationsListRes Ƭ **AdminNotificationsListRes**: [`PaginatedResponse`](internal-8.md#paginatedresponse) & { `notifications`: [`Notification`](../classes/internal-8.internal.Notification.md)[] } **`Schema`** AdminNotificationsListRes type: object x-expanded-relations: field: notifications relations: - resends required: - notifications properties: notifications: type: array description: an array of notifications items: $ref: "#/components/schemas/Notification" count: type: integer description: The total number of notifications offset: type: integer description: The number of notifications skipped when retrieving the notifications. limit: type: integer description: The number of notifications per page #### Defined in packages/medusa/dist/api/routes/admin/notifications/index.d.ts:32 ___ ### AdminNotificationsRes Ƭ **AdminNotificationsRes**: `Object` **`Schema`** AdminNotificationsRes type: object x-expanded-relations: field: notification relations: - resends required: - notification properties: notification: description: Notification details $ref: "#/components/schemas/Notification" #### Type declaration | Name | Type | | :------ | :------ | | `notification` | [`Notification`](../classes/internal-8.internal.Notification.md) | #### Defined in packages/medusa/dist/api/routes/admin/notifications/index.d.ts:49 ___ ### AdminOrderEditDeleteRes Ƭ **AdminOrderEditDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminOrderEditDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Order Edit. object: type: string description: The type of the object that was deleted. default: order_edit deleted: type: boolean description: Whether or not the Order Edit was deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:135 ___ ### AdminOrderEditItemChangeDeleteRes Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object` **`Schema`** AdminOrderEditItemChangeDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Order Edit Item Change. object: type: string description: The type of the object that was deleted. default: item_change deleted: type: boolean description: Whether or not the Order Edit Item Change was deleted. default: true #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `id` | `string` | | `object` | ``"item_change"`` | #### Defined in packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:156 ___ ### AdminOrderEditsListRes Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/internal-3.OrderEdit.md)[] } **`Schema`** AdminOrderEditsListRes type: object x-expanded-relations: field: order_edits relations: - changes - changes.line_item - changes.line_item.variant - changes.original_line_item - changes.original_line_item.variant - items - items.adjustments - items.tax_lines - items.variant - payment_collection implicit: - items - items.tax_lines - items.adjustments - items.variant totals: - difference_due - discount_total - gift_card_tax_total - gift_card_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required: - order_edits - count - offset - limit properties: order_edits: type: array description: "An array of order edit details" items: $ref: "#/components/schemas/OrderEdit" count: type: integer description: The total number of items available offset: type: integer description: The number of order edits skipped when retrieving the order edits. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:112 ___ ### AdminOrderEditsRes Ƭ **AdminOrderEditsRes**: `Object` **`Schema`** AdminOrderEditsRes type: object x-expanded-relations: field: order_edit relations: - changes - changes.line_item - changes.line_item.variant - changes.original_line_item - changes.original_line_item.variant - items - items.adjustments - items.tax_lines - items.variant - payment_collection implicit: - items - items.tax_lines - items.adjustments - items.variant totals: - difference_due - discount_total - gift_card_tax_total - gift_card_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required: - order_edit properties: order_edit: description: "Order edit details" $ref: "#/components/schemas/OrderEdit" #### Type declaration | Name | Type | | :------ | :------ | | `order_edit` | [`OrderEdit`](../classes/internal-3.OrderEdit.md) | #### Defined in packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:50 ___ ### AdminOrdersListRes Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal-3.Order.md)[] } **`Schema`** AdminOrdersListRes type: object x-expanded-relations: field: orders relations: - billing_address - claims - claims.additional_items - claims.additional_items.variant - claims.claim_items - claims.claim_items.images - claims.claim_items.item - claims.fulfillments - claims.fulfillments.tracking_links - claims.return_order - claims.return_order.shipping_method - claims.return_order.shipping_method.tax_lines - claims.shipping_address - claims.shipping_methods - customer - discounts - discounts.rule - fulfillments - fulfillments.items - fulfillments.tracking_links - gift_card_transactions - gift_cards - items - payments - refunds - region - returns - returns.items - returns.items.reason - returns.shipping_method - returns.shipping_method.tax_lines - shipping_address - shipping_methods eager: - fulfillments.items - region.fulfillment_providers - region.payment_providers - returns.items - shipping_methods.shipping_option implicit: - claims - claims.additional_items - claims.additional_items.adjustments - claims.additional_items.refundable - claims.additional_items.tax_lines - discounts - discounts.rule - gift_card_transactions - gift_card_transactions.gift_card - gift_cards - items - items.adjustments - items.refundable - items.tax_lines - items.variant - items.variant.product - items.variant.product.profiles - refunds - region - shipping_methods - shipping_methods.tax_lines - swaps - swaps.additional_items - swaps.additional_items.adjustments - swaps.additional_items.refundable - swaps.additional_items.tax_lines totals: - discount_total - gift_card_tax_total - gift_card_total - paid_total - refundable_amount - refunded_total - shipping_total - subtotal - tax_total - total - claims.additional_items.discount_total - claims.additional_items.gift_card_total - claims.additional_items.original_tax_total - claims.additional_items.original_total - claims.additional_items.refundable - claims.additional_items.subtotal - claims.additional_items.tax_total - claims.additional_items.total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total - swaps.additional_items.discount_total - swaps.additional_items.gift_card_total - swaps.additional_items.original_tax_total - swaps.additional_items.original_total - swaps.additional_items.refundable - swaps.additional_items.subtotal - swaps.additional_items.tax_total - swaps.additional_items.total required: - orders - count - offset - limit properties: orders: type: array description: "An array of order details." items: $ref: "#/components/schemas/Order" count: type: integer description: The total number of items available offset: type: integer description: The number of orders skipped when retrieving the orders. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/orders/index.d.ts:252 ___ ### AdminOrdersRes Ƭ **AdminOrdersRes**: `Object` **`Schema`** AdminOrdersRes type: object x-expanded-relations: field: order relations: - billing_address - claims - claims.additional_items - claims.additional_items.variant - claims.claim_items - claims.claim_items.images - claims.claim_items.item - claims.fulfillments - claims.fulfillments.tracking_links - claims.return_order - claims.return_order.shipping_method - claims.return_order.shipping_method.tax_lines - claims.shipping_address - claims.shipping_methods - customer - discounts - discounts.rule - fulfillments - fulfillments.items - fulfillments.tracking_links - gift_card_transactions - gift_cards - items - payments - refunds - region - returns - returns.items - returns.items.reason - returns.shipping_method - returns.shipping_method.tax_lines - shipping_address - shipping_methods eager: - fulfillments.items - region.fulfillment_providers - region.payment_providers - returns.items - shipping_methods.shipping_option implicit: - claims - claims.additional_items - claims.additional_items.adjustments - claims.additional_items.refundable - claims.additional_items.tax_lines - discounts - discounts.rule - gift_card_transactions - gift_card_transactions.gift_card - gift_cards - items - items.adjustments - items.refundable - items.tax_lines - items.variant - items.variant.product - items.variant.product.profiles - refunds - region - shipping_methods - shipping_methods.tax_lines - swaps - swaps.additional_items - swaps.additional_items.adjustments - swaps.additional_items.refundable - swaps.additional_items.tax_lines totals: - discount_total - gift_card_tax_total - gift_card_total - paid_total - refundable_amount - refunded_total - shipping_total - subtotal - tax_total - total - claims.additional_items.discount_total - claims.additional_items.gift_card_total - claims.additional_items.original_tax_total - claims.additional_items.original_total - claims.additional_items.refundable - claims.additional_items.subtotal - claims.additional_items.tax_total - claims.additional_items.total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total - swaps.additional_items.discount_total - swaps.additional_items.gift_card_total - swaps.additional_items.original_tax_total - swaps.additional_items.original_total - swaps.additional_items.refundable - swaps.additional_items.subtotal - swaps.additional_items.tax_total - swaps.additional_items.total required: - order properties: order: description: "Order details." $ref: "#/components/schemas/Order" #### Type declaration | Name | Type | | :------ | :------ | | `order` | [`Order`](../classes/internal-3.Order.md) | #### Defined in packages/medusa/dist/api/routes/admin/orders/index.d.ts:121 ___ ### AdminPaymentCollectionDeleteRes Ƭ **AdminPaymentCollectionDeleteRes**: `Object` **`Schema`** AdminPaymentCollectionDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Payment Collection. object: type: string description: The type of the object that was deleted. default: payment_collection deleted: type: boolean description: Whether or not the Payment Collection was deleted. default: true #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `id` | `string` | | `object` | ``"payment_collection"`` | #### Defined in packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:49 ___ ### AdminPaymentCollectionsRes Ƭ **AdminPaymentCollectionsRes**: `Object` **`Schema`** AdminPaymentCollectionsRes type: object x-expanded-relations: field: payment_collection relations: - payment_sessions - payments - region eager: - region.fulfillment_providers - region.payment_providers required: - payment_collection properties: payment_collection: description: Payment Collection details. $ref: "#/components/schemas/PaymentCollection" #### Type declaration | Name | Type | | :------ | :------ | | `payment_collection` | [`PaymentCollection`](../classes/internal-3.PaymentCollection.md) | #### Defined in packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:26 ___ ### AdminPaymentProvidersList Ƭ **AdminPaymentProvidersList**: `Object` **`Schema`** AdminPaymentProvidersList type: object required: - payment_providers properties: payment_providers: type: array description: An array of payment providers details. items: $ref: "#/components/schemas/PaymentProvider" #### Type declaration | Name | Type | | :------ | :------ | | `payment_providers` | [`PaymentProvider`](../classes/internal-3.PaymentProvider.md)[] | #### Defined in packages/medusa/dist/api/routes/admin/store/index.d.ts:64 ___ ### AdminPaymentRes Ƭ **AdminPaymentRes**: `Object` **`Schema`** AdminPaymentRes type: object required: - payment properties: payment: description: "Payment details" $ref: "#/components/schemas/Payment" #### Type declaration | Name | Type | | :------ | :------ | | `payment` | [`Payment`](../classes/internal-3.Payment.md) | #### Defined in packages/medusa/dist/api/routes/admin/payments/index.d.ts:16 ___ ### AdminPostDraftOrdersDraftOrderRegisterPaymentRes Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` **`Schema`** AdminPostDraftOrdersDraftOrderRegisterPaymentRes type: object required: - order properties: order: description: Order's details. $ref: "#/components/schemas/Order" #### Type declaration | Name | Type | | :------ | :------ | | `order` | [`Order`](../classes/internal-3.Order.md) | #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:19 ___ ### AdminPriceListDeleteBatchRes Ƭ **AdminPriceListDeleteBatchRes**: `Object` **`Schema`** AdminPriceListDeleteBatchRes type: object required: - ids - object - deleted properties: ids: type: array items: type: string description: The IDs of the deleted prices. object: type: string description: The type of the object that was deleted. A price is also named `money-amount`. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `ids` | `string`[] | | `object` | `string` | #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:49 ___ ### AdminPriceListDeleteProductPricesRes Ƭ **AdminPriceListDeleteProductPricesRes**: [`AdminPriceListDeleteBatchRes`](internal-8.internal.md#adminpricelistdeletebatchres) **`Schema`** AdminPriceListDeleteProductPricesRes type: object required: - ids - object - deleted properties: ids: type: array description: The IDs of the deleted prices. items: type: string object: type: string description: The type of the object that was deleted. A price is also named `money-amount`. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:76 ___ ### AdminPriceListDeleteRes Ƭ **AdminPriceListDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminPriceListDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Price List. object: type: string description: The type of the object that was deleted. default: price-list deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:120 ___ ### AdminPriceListDeleteVariantPricesRes Ƭ **AdminPriceListDeleteVariantPricesRes**: [`AdminPriceListDeleteBatchRes`](internal-8.internal.md#adminpricelistdeletebatchres) **`Schema`** AdminPriceListDeleteVariantPricesRes type: object required: - ids - object - deleted properties: ids: type: array description: The IDs of the deleted prices. items: type: string object: type: string description: The type of the object that was deleted. A price is also named `money-amount`. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:99 ___ ### AdminPriceListRes Ƭ **AdminPriceListRes**: `Object` **`Schema`** AdminPriceListRes type: object x-expanded-relations: field: price_list relations: - customer_groups - prices required: - price_list properties: price_list: description: "Price List details." $ref: "#/components/schemas/PriceList" #### Type declaration | Name | Type | | :------ | :------ | | `price_list` | [`PriceList`](../classes/internal-3.PriceList.md) | #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:24 ___ ### AdminPriceListsListRes Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal-3.PriceList.md)[] } **`Schema`** AdminPriceListsListRes type: object required: - price_lists - count - offset - limit properties: price_lists: type: array description: "An array of price lists details." items: $ref: "#/components/schemas/PriceList" count: type: integer description: The total number of items available offset: type: integer description: The number of price lists skipped when retrieving the price lists. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:145 ___ ### AdminPriceListsProductsListRes Ƭ **AdminPriceListsProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal-3.Product.md)[] } **`Schema`** AdminPriceListsProductsListRes type: object x-expanded-relations: field: products relations: - categories - collection - images - options - tags - type - variants - variants.options required: - products - count - offset - limit properties: products: type: array description: "An array of products details." items: $ref: "#/components/schemas/Product" count: type: integer description: The total number of items available offset: type: integer description: The number of price lists skipped when retrieving the price lists. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:183 ___ ### AdminProductCategoriesCategoryDeleteRes Ƭ **AdminProductCategoriesCategoryDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminProductCategoriesCategoryDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted product category object: type: string description: The type of the object that was deleted. default: product-category deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:53 ___ ### AdminProductCategoriesCategoryRes Ƭ **AdminProductCategoriesCategoryRes**: `Object` **`Schema`** AdminProductCategoriesCategoryRes type: object x-expanded-relations: field: product_category relations: - category_children - parent_category required: - product_category properties: product_category: description: "Product category details." $ref: "#/components/schemas/ProductCategory" #### Type declaration | Name | Type | | :------ | :------ | | `product_category` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | #### Defined in packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:30 ___ ### AdminProductCategoriesListRes Ƭ **AdminProductCategoriesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/internal-3.ProductCategory.md)[] } **`Schema`** AdminProductCategoriesListRes type: object x-expanded-relations: field: product_categories relations: - category_children - parent_category required: - product_categories - count - offset - limit properties: product_categories: type: array description: "An array of product category details." items: $ref: "#/components/schemas/ProductCategory" count: type: integer description: The total number of items available offset: type: integer description: The number of product categories skipped when retrieving the product categories. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:83 ___ ### AdminProductTagsListRes Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal-3.ProductTag.md)[] } **`Schema`** AdminProductTagsListRes type: object required: - product_tags - count - offset - limit properties: product_tags: type: array description: "An array of product tag details." items: $ref: "#/components/schemas/ProductTag" count: type: integer description: The total number of items available offset: type: integer description: The number of product tags skipped when retrieving the product tags. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:32 ___ ### AdminProductTypesListRes Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal-3.ProductType.md)[] } **`Schema`** AdminProductTypesListRes type: object required: - product_types - count - offset - limit properties: product_types: type: array description: An array of product types details. items: $ref: "#/components/schemas/ProductType" count: type: integer description: The total number of items available offset: type: integer description: The number of product types skipped when retrieving the product types. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/product-types/index.d.ts:32 ___ ### AdminProductsDeleteOptionRes Ƭ **AdminProductsDeleteOptionRes**: `Object` **`Schema`** AdminProductsDeleteOptionRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - option_id - object - deleted - product properties: option_id: type: string description: The ID of the deleted Product Option object: type: string description: The type of the object that was deleted. default: option deleted: type: boolean description: Whether or not the items were deleted. default: true product: description: Product details. $ref: "#/components/schemas/PricedProduct" #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `object` | ``"option"`` | | `option_id` | `string` | | `product` | [`Product`](../classes/internal-3.Product.md) | #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:79 ___ ### AdminProductsDeleteRes Ƭ **AdminProductsDeleteRes**: `Object` **`Schema`** AdminProductsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Product. object: type: string description: The type of the object that was deleted. default: product deleted: type: boolean description: Whether or not the items were deleted. default: true #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `id` | `string` | | `object` | ``"product"`` | #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:146 ___ ### AdminProductsDeleteVariantRes Ƭ **AdminProductsDeleteVariantRes**: `Object` **`Schema`** AdminProductsDeleteVariantRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - variant_id - object - deleted - product properties: variant_id: type: string description: The ID of the deleted Product Variant. object: type: string description: The type of the object that was deleted. default: product-variant deleted: type: boolean description: Whether or not the items were deleted. default: true product: description: Product details. $ref: "#/components/schemas/PricedProduct" #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `object` | ``"product-variant"`` | | `product` | [`Product`](../classes/internal-3.Product.md) | | `variant_id` | `string` | #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:120 ___ ### AdminProductsListRes Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-8.md#pricedproduct) \| [`Product`](../classes/internal-3.Product.md))[] } **`Schema`** AdminProductsListRes type: object x-expanded-relations: field: products relations: - collection - images - options - tags - type - variants - variants.options - variants.prices totals: - variants.purchasable required: - products - count - offset - limit properties: products: type: array description: An array of products details. items: $ref: "#/components/schemas/PricedProduct" count: type: integer description: The total number of items available offset: type: integer description: The number of products skipped when retrieving the products. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:188 ___ ### AdminProductsListTagsRes Ƭ **AdminProductsListTagsRes**: `Object` **`Schema`** AdminProductsListTagsRes type: object required: - tags properties: tags: description: An array of product tags details. type: array items: type: object required: - id - usage_count - value properties: id: description: The ID of the tag. type: string usage_count: description: The number of products that use this tag. type: string value: description: The value of the tag. type: string #### Type declaration | Name | Type | | :------ | :------ | | `tags` | [`Pick`](internal-1.md#pick)<[`ProductTag`](../classes/internal-3.ProductTag.md), ``"id"`` \| ``"value"``\> & { `usage_count`: `number` }[] | #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:259 ___ ### AdminProductsListTypesRes Ƭ **AdminProductsListTypesRes**: `Object` **`Schema`** AdminProductsListTypesRes type: object required: - types properties: types: type: array description: An array of product types details. items: $ref: "#/components/schemas/ProductType" #### Type declaration | Name | Type | | :------ | :------ | | `types` | [`ProductType`](../classes/internal-3.ProductType.md)[] | #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:230 ___ ### AdminProductsListVariantsRes Ƭ **AdminProductsListVariantsRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] } **`Schema`** AdminProductsListVariantsRes type: object required: - variants - count - offset - limit properties: variants: type: array description: An array of product variants details. items: $ref: "#/components/schemas/ProductVariant" count: type: integer description: The total number of items available offset: type: integer description: The number of product variants skipped when retrieving the product variants. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:215 ___ ### AdminProductsRes Ƭ **AdminProductsRes**: `Object` **`Schema`** AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: "#/components/schemas/PricedProduct" #### Type declaration | Name | Type | | :------ | :------ | | `product` | [`Product`](../classes/internal-3.Product.md) | #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:285 ___ ### AdminPublishableApiKeyDeleteRes Ƭ **AdminPublishableApiKeyDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminPublishableApiKeyDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted publishable API key. object: type: string description: The type of the object that was deleted. default: publishable_api_key deleted: type: boolean description: Whether the publishable API key was deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:65 ___ ### AdminPublishableApiKeysListRes Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/internal-8.internal.PublishableApiKey.md)[] } **`Schema`** AdminPublishableApiKeysListRes type: object required: - publishable_api_keys - count - offset - limit properties: publishable_api_keys: type: array description: "An array of publishable API keys details." items: $ref: "#/components/schemas/PublishableApiKey" count: type: integer description: The total number of items available offset: type: integer description: The number of publishable API keys skipped when retrieving the publishable API keys. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:42 ___ ### AdminPublishableApiKeysListSalesChannelsRes Ƭ **AdminPublishableApiKeysListSalesChannelsRes**: `Object` **`Schema`** AdminPublishableApiKeysListSalesChannelsRes type: object required: - sales_channels properties: sales_channels: description: "An array of sales channels details." type: array items: $ref: "#/components/schemas/SalesChannel" #### Type declaration | Name | Type | | :------ | :------ | | `sales_channels` | [`SalesChannel`](../classes/internal-3.SalesChannel.md)[] | #### Defined in packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:78 ___ ### AdminPublishableApiKeysRes Ƭ **AdminPublishableApiKeysRes**: `Object` **`Schema`** AdminPublishableApiKeysRes type: object required: - publishable_api_key properties: publishable_api_key: description: "Publishable API key details." $ref: "#/components/schemas/PublishableApiKey" #### Type declaration | Name | Type | | :------ | :------ | | `publishable_api_key` | [`PublishableApiKey`](../classes/internal-8.internal.PublishableApiKey.md) | #### Defined in packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:15 ___ ### AdminRefundRes Ƭ **AdminRefundRes**: `Object` **`Schema`** AdminRefundRes type: object required: - refund properties: refund: description: "Refund details" $ref: "#/components/schemas/Refund" #### Type declaration | Name | Type | | :------ | :------ | | `refund` | [`Refund`](../classes/internal-3.Refund.md) | #### Defined in packages/medusa/dist/api/routes/admin/payments/index.d.ts:29 ___ ### AdminRegionsDeleteRes Ƭ **AdminRegionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminRegionsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Region. object: type: string description: The type of the object that was deleted. default: region deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/regions/index.d.ts:87 ___ ### AdminRegionsListRes Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal-3.Region.md)[] } **`Schema`** AdminRegionsListRes type: object x-expanded-relations: field: regions relations: - countries - fulfillment_providers - payment_providers eager: - fulfillment_providers - payment_providers required: - regions - count - offset - limit properties: regions: type: array description: "An array of regions details." items: $ref: "#/components/schemas/Region" count: type: integer description: The total number of items available offset: type: integer description: The number of regions skipped when retrieving the regions. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/regions/index.d.ts:64 ___ ### AdminReservationsDeleteRes Ƭ **AdminReservationsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminReservationsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Reservation. object: type: string description: The type of the object that was deleted. default: reservation deleted: type: boolean description: Whether or not the Reservation was deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/reservations/index.d.ts:86 ___ ### AdminReservationsListRes Ƭ **AdminReservationsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `reservations`: [`ReservationItemDTO`](internal-8.md#reservationitemdto)[] } **`Schema`** AdminReservationsListRes type: object required: - reservations - count - offset - limit properties: reservations: type: array description: An array of reservations details. items: $ref: "#/components/schemas/ExtendedReservationItem" count: type: integer description: The total number of items available offset: type: integer description: The number of reservations skipped when retrieving the reservations. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/reservations/index.d.ts:61 ___ ### AdminReservationsRes Ƭ **AdminReservationsRes**: `Object` **`Schema`** AdminReservationsRes type: object required: - reservation properties: reservation: description: Reservation details. $ref: "#/components/schemas/ReservationItemDTO" #### Type declaration | Name | Type | | :------ | :------ | | `reservation` | [`ReservationItemDTO`](internal-8.md#reservationitemdto) | #### Defined in packages/medusa/dist/api/routes/admin/reservations/index.d.ts:16 ___ ### AdminReturnReasonsDeleteRes Ƭ **AdminReturnReasonsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminReturnReasonsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted return reason object: type: string description: The type of the object that was deleted. default: return_reason deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:63 ___ ### AdminReturnReasonsListRes Ƭ **AdminReturnReasonsListRes**: `Object` **`Schema`** AdminReturnReasonsListRes type: object x-expanded-relations: field: return_reasons relations: - parent_return_reason - return_reason_children required: - return_reasons properties: return_reasons: type: array items: $ref: "#/components/schemas/ReturnReason" #### Type declaration | Name | Type | | :------ | :------ | | `return_reasons` | [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] | #### Defined in packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:40 ___ ### AdminReturnReasonsRes Ƭ **AdminReturnReasonsRes**: `Object` **`Schema`** AdminReturnReasonsRes type: object x-expanded-relations: field: return_reason relations: - parent_return_reason - return_reason_children required: - return_reason properties: return_reason: $ref: "#/components/schemas/ReturnReason" #### Type declaration | Name | Type | | :------ | :------ | | `return_reason` | [`ReturnReason`](../classes/internal-3.ReturnReason.md) | #### Defined in packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:21 ___ ### AdminReturnsCancelRes Ƭ **AdminReturnsCancelRes**: `Object` **`Schema`** AdminReturnsCancelRes type: object x-expanded-relations: field: order relations: - billing_address - claims - claims.additional_items - claims.additional_items.variant - claims.claim_items - claims.claim_items.images - claims.claim_items.item - claims.fulfillments - claims.fulfillments.tracking_links - claims.return_order - claims.return_order.shipping_method - claims.return_order.shipping_method.tax_lines - claims.shipping_address - claims.shipping_methods - customer - discounts - discounts.rule - fulfillments - fulfillments.items - fulfillments.tracking_links - gift_card_transactions - gift_cards - items - payments - refunds - region - returns - returns.items - returns.items.reason - returns.shipping_method - returns.shipping_method.tax_lines - shipping_address - shipping_methods - swaps - swaps.additional_items - swaps.additional_items.variant - swaps.fulfillments - swaps.fulfillments.tracking_links - swaps.payment - swaps.return_order - swaps.return_order.shipping_method - swaps.return_order.shipping_method.tax_lines - swaps.shipping_address - swaps.shipping_methods - swaps.shipping_methods.tax_lines required: - order properties: order: description: Order details. $ref: "#/components/schemas/Order" #### Type declaration | Name | Type | | :------ | :------ | | `order` | [`Order`](../classes/internal-3.Order.md) | #### Defined in packages/medusa/dist/api/routes/admin/returns/index.d.ts:68 ___ ### AdminReturnsListRes Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal-3.Return.md)[] } **`Schema`** AdminReturnsListRes type: object x-expanded-relation: field: returns relations: - order - swap required: - returns - count - offset - limit properties: returns: type: array description: An array of returns details. items: $ref: "#/components/schemas/Return" count: type: integer description: The total number of items available offset: type: integer description: The number of returns skipped when retrieving the returns. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/returns/index.d.ts:100 ___ ### AdminReturnsRes Ƭ **AdminReturnsRes**: `Object` **`Schema`** AdminReturnsRes type: object x-expanded-relation: field: return relations: - swap required: - return properties: return: description: Return details. $ref: "#/components/schemas/Return" #### Type declaration | Name | Type | | :------ | :------ | | `return` | [`Return`](../classes/internal-3.Return.md) | #### Defined in packages/medusa/dist/api/routes/admin/returns/index.d.ts:117 ___ ### AdminSalesChannelsDeleteLocationRes Ƭ **AdminSalesChannelsDeleteLocationRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminSalesChannelsDeleteLocationRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the removed stock location from a sales channel object: type: string description: The type of the object that was removed. default: stock-location deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:60 ___ ### AdminSalesChannelsDeleteRes Ƭ **AdminSalesChannelsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminSalesChannelsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted sales channel object: type: string description: The type of the object that was deleted. default: sales-channel deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:39 ___ ### AdminSalesChannelsListRes Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal-3.SalesChannel.md)[] } **`Schema`** AdminSalesChannelsListRes type: object required: - sales_channels - count - offset - limit properties: sales_channels: type: array description: "An array of sales channels details." items: $ref: "#/components/schemas/SalesChannel" count: type: integer description: The total number of items available offset: type: integer description: The number of items skipped before the returned results limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:85 ___ ### AdminSalesChannelsRes Ƭ **AdminSalesChannelsRes**: `Object` **`Schema`** AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: "#/components/schemas/SalesChannel" #### Type declaration | Name | Type | | :------ | :------ | | `sales_channel` | [`SalesChannel`](../classes/internal-3.SalesChannel.md) | #### Defined in packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:16 ___ ### AdminShippingOptionsDeleteRes Ƭ **AdminShippingOptionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminShippingOptionsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Shipping Option. object: type: string description: The type of the object that was deleted. default: shipping-option deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:86 ___ ### AdminShippingOptionsListRes Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal-3.ShippingOption.md)[] } **`Schema`** AdminShippingOptionsListRes type: object x-expanded-relations: field: shipping_options relations: - profile - region - requirements eager: - region.fulfillment_providers - region.payment_providers required: - shipping_options - count - offset - limit properties: shipping_options: type: array description: "An array of shipping options details." items: $ref: "#/components/schemas/ShippingOption" count: type: integer description: The total number of items available offset: type: integer description: The number of shipping options skipped when retrieving the shipping options. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:41 ___ ### AdminShippingOptionsRes Ƭ **AdminShippingOptionsRes**: `Object` **`Schema`** AdminShippingOptionsRes type: object x-expanded-relations: field: shipping_option relations: - profile - region - requirements eager: - region.fulfillment_providers - region.payment_providers required: - shipping_option properties: shipping_option: description: "Shipping option details." $ref: "#/components/schemas/ShippingOption" #### Type declaration | Name | Type | | :------ | :------ | | `shipping_option` | [`ShippingOption`](../classes/internal-3.ShippingOption.md) | #### Defined in packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:63 ___ ### AdminShippingProfilesListRes Ƭ **AdminShippingProfilesListRes**: `Object` **`Schema`** AdminShippingProfilesListRes type: object required: - shipping_profiles properties: shipping_profiles: type: array description: An array of shipping profiles details. items: $ref: "#/components/schemas/ShippingProfile" #### Type declaration | Name | Type | | :------ | :------ | | `shipping_profiles` | [`ShippingProfile`](../classes/internal-3.ShippingProfile.md)[] | #### Defined in packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:59 ___ ### AdminShippingProfilesRes Ƭ **AdminShippingProfilesRes**: `Object` **`Schema`** AdminShippingProfilesRes type: object x-expanded-relations: field: shipping_profile relations: - products - shipping_options required: - shipping_profile properties: shipping_profile: description: Shipping profile details. $ref: "#/components/schemas/ShippingProfile" #### Type declaration | Name | Type | | :------ | :------ | | `shipping_profile` | [`ShippingProfile`](../classes/internal-3.ShippingProfile.md) | #### Defined in packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:44 ___ ### AdminStockLocationsDeleteRes Ƭ **AdminStockLocationsDeleteRes**: [`DeleteResponse`](internal-8.md#deleteresponse) **`Schema`** AdminStockLocationsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Stock Location. object: type: string description: The type of the object that was deleted. default: stock_location deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:26 ___ ### AdminStockLocationsListRes Ƭ **AdminStockLocationsListRes**: [`PaginatedResponse`](internal-8.md#paginatedresponse) & { `stock_locations`: [`StockLocationExpandedDTO`](internal-8.md#stocklocationexpandeddto)[] } **`Schema`** AdminStockLocationsListRes type: object required: - stock_locations - count - offset - limit properties: stock_locations: type: array items: $ref: "#/components/schemas/StockLocationExpandedDTO" count: type: integer description: The total number of items available offset: type: integer description: The number of stock locations skipped when retrieving the stock locations. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:63 ___ ### AdminStockLocationsRes Ƭ **AdminStockLocationsRes**: `Object` **`Schema`** AdminStockLocationsRes type: object required: - stock_location properties: stock_location: description: "Stock location details." $ref: "#/components/schemas/StockLocationExpandedDTO" #### Type declaration | Name | Type | | :------ | :------ | | `stock_location` | [`StockLocationExpandedDTO`](internal-8.md#stocklocationexpandeddto) | #### Defined in packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:37 ___ ### AdminStoresRes Ƭ **AdminStoresRes**: `Object` **`Schema`** AdminStoresRes type: object required: - store properties: store: description: Store details. $ref: "#/components/schemas/Store" #### Type declaration | Name | Type | | :------ | :------ | | `store` | [`Store`](../classes/internal-8.internal.Store.md) | #### Defined in packages/medusa/dist/api/routes/admin/store/index.d.ts:34 ___ ### AdminSwapsListRes Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal-3.Swap.md)[] } **`Schema`** AdminSwapsListRes type: object required: - swaps - count - offset - limit properties: swaps: type: array description: "An array of swaps details." items: $ref: "#/components/schemas/Swap" count: type: integer description: The total number of items available offset: type: integer description: The number of swaps skipped when retrieving the swaps. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/swaps/index.d.ts:31 ___ ### AdminSwapsRes Ƭ **AdminSwapsRes**: `Object` **`Schema`** AdminSwapsRes type: object x-expanded-relations: field: swap relations: - additional_items - additional_items.adjustments - cart - cart.items - cart.items.adjustments - cart.items.variant - fulfillments - order - payment - return_order - shipping_address - shipping_methods eager: - fulfillments.items - shipping_methods.shipping_option required: - swap properties: swap: description: "Swap details." $ref: "#/components/schemas/Swap" #### Type declaration | Name | Type | | :------ | :------ | | `swap` | [`Swap`](../classes/internal-3.Swap.md) | #### Defined in packages/medusa/dist/api/routes/admin/swaps/index.d.ts:62 ___ ### AdminTaxProvidersList Ƭ **AdminTaxProvidersList**: `Object` **`Schema`** AdminTaxProvidersList type: object required: - tax_providers properties: tax_providers: type: array description: An array of tax providers details. items: $ref: "#/components/schemas/TaxProvider" #### Type declaration | Name | Type | | :------ | :------ | | `tax_providers` | [`TaxProvider`](../classes/internal-3.TaxProvider.md)[] | #### Defined in packages/medusa/dist/api/routes/admin/store/index.d.ts:49 ___ ### AdminTaxRatesDeleteRes Ƭ **AdminTaxRatesDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) **`Schema`** AdminTaxRatesDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Shipping Option. object: type: string description: The type of the object that was deleted. default: tax-rate deleted: type: boolean description: Whether or not the items were deleted. default: true #### Defined in packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:27 ___ ### AdminTaxRatesListRes Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal-3.TaxRate.md)[] } **`Schema`** AdminTaxRatesListRes type: object required: - tax_rates - count - offset - limit properties: tax_rates: type: array description: "An array of tax rate details." items: $ref: "#/components/schemas/TaxRate" count: type: integer description: The total number of items available offset: type: integer description: The number of tax rates to skip when retrieving the tax rates. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:52 ___ ### AdminTaxRatesRes Ƭ **AdminTaxRatesRes**: `Object` **`Schema`** AdminTaxRatesRes type: object required: - tax_rate properties: tax_rate: description: "Tax rate details." $ref: "#/components/schemas/TaxRate" #### Type declaration | Name | Type | | :------ | :------ | | `tax_rate` | [`TaxRate`](../classes/internal-3.TaxRate.md) | #### Defined in packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:65 ___ ### AdminUploadsDownloadUrlRes Ƭ **AdminUploadsDownloadUrlRes**: `Object` **`Schema`** AdminUploadsDownloadUrlRes type: object required: - download_url properties: download_url: description: The Download URL of the file type: string #### Type declaration | Name | Type | | :------ | :------ | | `download_url` | `string` | #### Defined in packages/medusa/dist/api/routes/admin/uploads/index.d.ts:62 ___ ### AdminUploadsRes Ƭ **AdminUploadsRes**: `Object` **`Schema`** AdminUploadsRes type: object required: - uploads properties: uploads: type: array description: "Uploaded files details." items: type: object required: - url - key properties: url: description: The URL of the uploaded file. type: string format: uri key: description: The key of the file that is identifiable by the file service. It can be used later to retrieve or manipulate the file. type: string #### Type declaration | Name | Type | | :------ | :------ | | `uploads` | [`FileServiceUploadResult`](internal-8.md#fileserviceuploadresult)[] | #### Defined in packages/medusa/dist/api/routes/admin/uploads/index.d.ts:28 ___ ### AdminUserRes Ƭ **AdminUserRes**: `Object` **`Schema`** AdminUserRes type: object required: - user properties: user: description: "User details." $ref: "#/components/schemas/User" #### Type declaration | Name | Type | | :------ | :------ | | `user` | [`Omit`](internal-1.md#omit)<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | #### Defined in packages/medusa/dist/api/routes/admin/users/index.d.ts:16 ___ ### AdminUsersListRes Ƭ **AdminUsersListRes**: `Object` **`Schema`** AdminUsersListRes type: object required: - users properties: users: type: array description: "An array of users details." items: $ref: "#/components/schemas/User" #### Type declaration | Name | Type | | :------ | :------ | | `users` | [`Omit`](internal-1.md#omit)<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] | #### Defined in packages/medusa/dist/api/routes/admin/users/index.d.ts:31 ___ ### AdminVariantsListRes Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-8.md#pricedvariant)[] } **`Schema`** AdminVariantsListRes type: object x-expanded-relations: field: variants relations: - options - prices - product totals: - purchasable required: - variants - count - offset - limit properties: variants: type: array description: "An array of product variant details." items: $ref: "#/components/schemas/PricedVariant" count: type: integer description: The total number of items available offset: type: integer description: The number of product variants skipped when retrieving the product variants. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/variants/index.d.ts:40 ___ ### AdminVariantsRes Ƭ **AdminVariantsRes**: `Object` **`Schema`** AdminVariantsRes type: object x-expanded-relations: field: variant relations: - options - prices - product required: - variant properties: variant: description: "Product variant's details." $ref: "#/components/schemas/PricedVariant" #### Type declaration | Name | Type | | :------ | :------ | | `variant` | [`PricedVariant`](internal-8.md#pricedvariant) | #### Defined in packages/medusa/dist/api/routes/admin/variants/index.d.ts:59 ___ ### BatchJobCreateProps Ƭ **BatchJobCreateProps**: [`Pick`](internal-1.md#pick)<[`BatchJob`](../classes/internal-2.BatchJob.md), ``"context"`` \| ``"type"`` \| ``"created_by"`` \| ``"dry_run"``\> #### Defined in packages/medusa/dist/types/batch-job.d.ts:36 ___ ### BatchJobUpdateProps Ƭ **BatchJobUpdateProps**: [`Partial`](internal-8.md#partial)<[`Pick`](internal-1.md#pick)<[`BatchJob`](../classes/internal-2.BatchJob.md), ``"context"`` \| ``"result"``\>\> #### Defined in packages/medusa/dist/types/batch-job.d.ts:12 ___ ### CartCompletionResponse Ƭ **CartCompletionResponse**: `Object` #### Type declaration | Name | Type | Description | | :------ | :------ | :------ | | `response_body` | [`Record`](internal.md#record)<`string`, `unknown`\> | The response body for the completion request | | `response_code` | `number` | The response code for the completion request | #### Defined in packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:4 ___ ### ClassConstructor Ƭ **ClassConstructor**<`T`\>: (...`args`: `unknown`[]) => `T` #### Type parameters | Name | | :------ | | `T` | #### Type declaration • **new ClassConstructor**(`...args`): `T` ##### Parameters | Name | Type | | :------ | :------ | | `...args` | `unknown`[] | ##### Returns `T` #### Defined in packages/medusa/dist/types/global.d.ts:28 ___ ### ConfigModule Ƭ **ConfigModule**: [`ConfigModule`](internal-8.md#configmodule) #### Defined in packages/medusa/dist/types/global.d.ts:48 ___ ### Constructor Ƭ **Constructor**<`T`\>: `Object` #### Type parameters | Name | | :------ | | `T` | #### Defined in packages/medusa/dist/types/global.d.ts:47 ___ ### CreateBatchJobInput Ƭ **CreateBatchJobInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `context` | [`BatchJob`](../classes/internal-2.BatchJob.md)[``"context"``] | | `dry_run` | `boolean` | | `type` | `string` | #### Defined in packages/medusa/dist/types/batch-job.d.ts:13 ___ ### CreatePriceListInput Ƭ **CreatePriceListInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customer_groups?` | { `id`: `string` }[] | | `description` | `string` | | `ends_at?` | `Date` | | `includes_tax?` | `boolean` | | `name` | `string` | | `prices` | [`AdminPriceListPricesCreateReq`](../classes/internal-8.internal.AdminPriceListPricesCreateReq.md)[] | | `starts_at?` | `Date` | | `status?` | [`PriceListStatus`](../enums/internal-3.PriceListStatus.md) | | `type` | [`PriceListType`](../enums/internal-3.PriceListType.md) | #### Defined in packages/medusa/dist/types/price-list.d.ts:40 ___ ### Data Ƭ **Data**: [`Record`](internal.md#record)<`string`, `unknown`\> #### Defined in packages/medusa/dist/interfaces/payment-service.d.ts:3 ___ ### DecoratedInventoryItemDTO Ƭ **DecoratedInventoryItemDTO**: [`InventoryItemDTO`](internal-8.md#inventoryitemdto) & { `location_levels?`: [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] ; `reserved_quantity`: `number` ; `stocked_quantity`: `number` ; `variants?`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] } **`Schema`** DecoratedInventoryItemDTO type: object allOf: - $ref: "#/components/schemas/InventoryItemDTO" - type: object required: - stocked_quantity - reserved_quantity properties: location_levels: type: array description: An array of location level details items: $ref: "#/components/schemas/InventoryLevelDTO" variants: type: array description: An array of product variant details items: $ref: "#/components/schemas/ProductVariant" stocked_quantity: type: number description: The total quantity of the item in stock across levels reserved_quantity: type: number description: The total quantity of the item available across levels #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:98 ___ ### DeleteResponse Ƭ **DeleteResponse**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `id` | `string` | | `object` | `string` | #### Defined in packages/medusa/dist/types/common.d.ts:75 ___ ### ExtendedFindConfig Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](internal-1.md#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](internal-1.md#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } #### Type parameters | Name | | :------ | | `TEntity` | #### Defined in packages/medusa/dist/types/common.d.ts:28 ___ ### ExtendedRequest Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` } #### Type parameters | Name | | :------ | | `TEntity` | #### Defined in packages/medusa/dist/types/global.d.ts:25 ___ ### ExtendedReservationItem Ƭ **ExtendedReservationItem**: [`ReservationItemDTO`](internal-8.md#reservationitemdto) & { `inventory_item?`: [`InventoryItemDTO`](internal-8.md#inventoryitemdto) ; `line_item?`: [`LineItem`](../classes/internal-3.LineItem.md) } **`Schema`** ExtendedReservationItem type: object allOf: - $ref: "#/components/schemas/ReservationItemDTO" - type: object properties: line_item: description: The line item associated with the reservation. $ref: "#/components/schemas/LineItem" inventory_item: description: The inventory item associated with the reservation. $ref: "#/components/schemas/InventoryItemDTO" #### Defined in packages/medusa/dist/api/routes/admin/reservations/index.d.ts:33 ___ ### ItemTaxCalculationLine Ƭ **ItemTaxCalculationLine**: `Object` A line item and the tax rates that have been configured to apply to the product contained in the line item. #### Type declaration | Name | Type | | :------ | :------ | | `item` | [`LineItem`](../classes/internal-3.LineItem.md) | | `rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] | #### Defined in packages/medusa/dist/interfaces/tax-service.d.ts:21 ___ ### LevelWithAvailability Ƭ **LevelWithAvailability**: [`InventoryLevelDTO`](internal-8.md#inventoryleveldto) & { `available_quantity`: `number` } #### Defined in packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:56 ___ ### Logger Ƭ **Logger**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `activity` | (`message`: `string`, `config?`: `any`) => `void` | | `debug` | (`message`: `any`) => `void` | | `error` | (`messageOrError`: `any`, `error?`: `any`) => `void` | | `failure` | (`activityId`: `any`, `message`: `any`) => `void` | | `info` | (`message`: `any`) => `void` | | `log` | (...`args`: `any`[]) => `void` | | `panic` | (`data`: `any`) => `void` | | `progress` | (`activityId`: `any`, `message`: `any`) => `void` | | `setLogLevel` | (`level`: `string`) => `void` | | `shouldLog` | (`level`: `string`) => `void` | | `success` | (`activityId`: `any`, `message`: `any`) => `void` | | `unsetLogLevel` | () => `void` | | `warn` | (`message`: `any`) => `void` | #### Defined in packages/medusa/dist/types/global.d.ts:32 ___ ### MedusaContainer Ƭ **MedusaContainer**: [`MedusaContainer`](internal-8.md#medusacontainer-1) #### Defined in packages/medusa/dist/types/global.d.ts:31 ___ ### PartialPick Ƭ **PartialPick**<`T`, `K`\>: { [P in K]?: T[P] } #### Type parameters | Name | Type | | :------ | :------ | | `T` | `T` | | `K` | extends keyof `T` | #### Defined in packages/medusa/dist/types/common.d.ts:13 ___ ### PaymentContext Ƭ **PaymentContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `cart` | { `billing_address?`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `context`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `email`: `string` ; `id`: `string` ; `shipping_address`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `shipping_methods`: [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] } | | `cart.billing_address?` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | | `cart.context` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `cart.email` | `string` | | `cart.id` | `string` | | `cart.shipping_address` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | | `cart.shipping_methods` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] | | `currency_code` | `string` | | `customer?` | [`Customer`](../classes/internal-3.Customer.md) | | `paymentSessionData` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `resource_id` | `string` | #### Defined in packages/medusa/dist/interfaces/payment-service.d.ts:6 ___ ### PaymentData Ƭ **PaymentData**: [`Data`](internal-8.internal.md#data) #### Defined in packages/medusa/dist/interfaces/payment-service.d.ts:4 ___ ### PaymentProcessorContext Ƭ **PaymentProcessorContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `billing_address?` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | | `context` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `currency_code` | `string` | | `customer?` | [`Customer`](../classes/internal-3.Customer.md) | | `email` | `string` | | `paymentSessionData` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `resource_id` | `string` | #### Defined in packages/medusa/dist/interfaces/payment-processor.d.ts:3 ___ ### PaymentProcessorSessionResponse Ƭ **PaymentProcessorSessionResponse**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `session_data` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `update_requests?` | { `customer_metadata?`: [`Record`](internal.md#record)<`string`, `unknown`\> } | | `update_requests.customer_metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | #### Defined in packages/medusa/dist/interfaces/payment-processor.d.ts:13 ___ ### PaymentSessionData Ƭ **PaymentSessionData**: [`Data`](internal-8.internal.md#data) #### Defined in packages/medusa/dist/interfaces/payment-service.d.ts:5 ___ ### PaymentSessionResponse Ƭ **PaymentSessionResponse**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `session_data` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `update_requests` | { `customer_metadata`: [`Record`](internal.md#record)<`string`, `unknown`\> } | | `update_requests.customer_metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> | #### Defined in packages/medusa/dist/interfaces/payment-service.d.ts:21 ___ ### PriceListLoadConfig Ƭ **PriceListLoadConfig**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cart_id?` | `string` | | `currency_code?` | `string` | | `customer_id?` | `string` | | `include_discount_prices?` | `boolean` | | `region_id?` | `string` | #### Defined in packages/medusa/dist/types/price-list.d.ts:76 ___ ### PriceListPriceCreateInput Ƭ **PriceListPriceCreateInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `currency_code?` | `string` | | `max_quantity?` | `number` | | `min_quantity?` | `number` | | `region_id?` | `string` | | `variant_id` | `string` | #### Defined in packages/medusa/dist/types/price-list.d.ts:68 ___ ### PriceListPriceUpdateInput Ƭ **PriceListPriceUpdateInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount?` | `number` | | `currency_code?` | `string` | | `id?` | `string` | | `max_quantity?` | `number` | | `min_quantity?` | `number` | | `region_id?` | `string` | | `variant_id?` | `string` | #### Defined in packages/medusa/dist/types/price-list.d.ts:59 ___ ### PriceSelectionContext Ƭ **PriceSelectionContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cart_id?` | `string` | | `currency_code?` | `string` | | `customer_id?` | `string` | | `ignore_cache?` | `boolean` | | `include_discount_prices?` | `boolean` | | `quantity?` | `number` | | `region_id?` | `string` | | `tax_rates?` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] | #### Defined in packages/medusa/dist/interfaces/price-selection-strategy.d.ts:34 ___ ### PriceSelectionResult Ƭ **PriceSelectionResult**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `calculatedPrice` | `number` \| ``null`` | | `calculatedPriceIncludesTax?` | `boolean` \| ``null`` | | `calculatedPriceType?` | [`PriceType`](internal-8.internal.md#pricetype-1) | | `originalPrice` | `number` \| ``null`` | | `originalPriceIncludesTax?` | `boolean` \| ``null`` | | `prices` | [`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[] | #### Defined in packages/medusa/dist/interfaces/price-selection-strategy.d.ts:53 ___ ### PriceType Ƭ **PriceType**: [`DefaultPriceType`](../enums/internal-8.DefaultPriceType.md) \| [`PriceListType`](../enums/internal-3.PriceListType.md) #### Defined in packages/medusa/dist/interfaces/price-selection-strategy.d.ts:47 packages/medusa/dist/interfaces/price-selection-strategy.d.ts:48 ___ ### QueryConfig Ƭ **QueryConfig**<`TEntity`\>: `Object` #### Type parameters | Name | Type | | :------ | :------ | | `TEntity` | extends [`BaseEntity`](../classes/internal-1.BaseEntity.md) | #### Type declaration | Name | Type | | :------ | :------ | | `allowedFields?` | `string`[] | | `allowedRelations?` | `string`[] | | `defaultFields?` | (keyof `TEntity` \| `string`)[] | | `defaultLimit?` | `number` | | `defaultRelations?` | `string`[] | | `isList?` | `boolean` | #### Defined in packages/medusa/dist/types/common.d.ts:55 ___ ### QuerySelector Ƭ **QuerySelector**<`TEntity`\>: [`Selector`](internal-8.internal.md#selector)<`TEntity`\> & { `q?`: `string` } #### Type parameters | Name | | :------ | | `TEntity` | #### Defined in packages/medusa/dist/types/common.d.ts:36 ___ ### RequestQueryFields Ƭ **RequestQueryFields**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `expand?` | `string` | | `fields?` | `string` | | `limit?` | `number` | | `offset?` | `number` | | `order?` | `string` | #### Defined in packages/medusa/dist/types/common.d.ts:63 ___ ### ResponseInventoryItem Ƭ **ResponseInventoryItem**: [`Partial`](internal-8.md#partial)<[`InventoryItemDTO`](internal-8.md#inventoryitemdto)\> & { `location_levels?`: [`LevelWithAvailability`](internal-8.internal.md#levelwithavailability)[] } **`Schema`** ResponseInventoryItem allOf: - $ref: "#/components/schemas/InventoryItemDTO" - type: object properties: location_levels: type: array description: The inventory's location levels. items: allOf: - $ref: "#/components/schemas/InventoryItemDTO" - type: object required: - available_quantity properties: available_quantity: description: The available quantity in the inventory location. type: number #### Defined in packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:79 ___ ### Selector Ƭ **Selector**<`TEntity`\>: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator } #### Type parameters | Name | | :------ | | `TEntity` | #### Defined in packages/medusa/dist/types/common.d.ts:42 ___ ### ShippingTaxCalculationLine Ƭ **ShippingTaxCalculationLine**: `Object` A shipping method and the tax rates that have been configured to apply to the shipping method. #### Type declaration | Name | Type | | :------ | :------ | | `rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] | | `shipping_method` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md) | #### Defined in packages/medusa/dist/interfaces/tax-service.d.ts:13 ___ ### StoreAuthRes Ƭ **StoreAuthRes**: `Object` **`Schema`** StoreAuthRes type: object x-expanded-relations: field: customer relations: - orders - orders.items - shipping_addresses required: - customer properties: customer: description: "Customer's details." $ref: "#/components/schemas/Customer" #### Type declaration | Name | Type | | :------ | :------ | | `customer` | [`Customer`](../classes/internal-3.Customer.md) | #### Defined in packages/medusa/dist/api/routes/store/auth/index.d.ts:21 ___ ### StoreBearerAuthRes Ƭ **StoreBearerAuthRes**: `Object` **`Schema`** StoreBearerAuthRes type: object properties: accessToken: description: Access token for subsequent authorization. type: string #### Type declaration | Name | Type | | :------ | :------ | | `access_token` | `string` | #### Defined in packages/medusa/dist/api/routes/store/auth/index.d.ts:32 ___ ### StoreCartShippingOptionsListRes Ƭ **StoreCartShippingOptionsListRes**: `Object` **`Schema`** StoreCartShippingOptionsListRes type: object x-expanded-relations: field: shipping_options implicit: - profile - requirements required: - shipping_options properties: shipping_options: type: array description: "An array of shipping options details." items: $ref: "#/components/schemas/PricedShippingOption" #### Type declaration | Name | Type | | :------ | :------ | | `shipping_options` | [`PricedShippingOption`](internal-8.md#pricedshippingoption)[] | #### Defined in packages/medusa/dist/api/routes/store/shipping-options/index.d.ts:41 ___ ### StoreCartsRes Ƭ **StoreCartsRes**: `Object` **`Schema`** StoreCartsRes type: object x-expanded-relations: field: cart relations: - billing_address - discounts - discounts.rule - gift_cards - items - items.adjustments - items.variant - payment - payment_sessions - region - region.countries - region.payment_providers - shipping_address - shipping_methods eager: - region.fulfillment_providers - region.payment_providers - shipping_methods.shipping_option implicit: - items - items.variant - items.variant.product - items.variant.product.profiles - items.tax_lines - items.adjustments - gift_cards - discounts - discounts.rule - shipping_methods - shipping_methods.tax_lines - shipping_address - region - region.tax_rates totals: - discount_total - gift_card_tax_total - gift_card_total - item_tax_total - refundable_amount - refunded_total - shipping_tax_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required: - cart properties: cart: description: "Cart details." $ref: "#/components/schemas/Cart" #### Type declaration | Name | Type | | :------ | :------ | | `cart` | [`Omit`](internal-1.md#omit)<[`Cart`](../classes/internal-3.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | #### Defined in packages/medusa/dist/api/routes/store/carts/index.d.ts:73 ___ ### StoreCollectionsListRes Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal-3.ProductCollection.md)[] } **`Schema`** StoreCollectionsListRes type: object required: - collections - count - offset - limit properties: collections: type: array description: "An array of product collections details" items: $ref: "#/components/schemas/ProductCollection" count: type: integer description: The total number of items available offset: type: integer description: The number of product collections skipped when retrieving the product collections. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/store/collections/index.d.ts:31 ___ ### StoreCollectionsRes Ƭ **StoreCollectionsRes**: `Object` **`Schema`** StoreCollectionsRes type: object required: - collection properties: collection: description: "Product collection details." $ref: "#/components/schemas/ProductCollection" #### Type declaration | Name | Type | | :------ | :------ | | `collection` | [`ProductCollection`](../classes/internal-3.ProductCollection.md) | #### Defined in packages/medusa/dist/api/routes/store/collections/index.d.ts:44 ___ ### StoreCompleteCartRes Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal-3.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal-3.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal-3.Swap.md) ; `type`: ``"swap"`` } **`Schema`** StoreCompleteCartRes type: object required: - type - data properties: type: type: string description: "The type of the data property. If the cart completion fails, type will be `cart` and the data object will be the cart's details. If the cart completion is successful and the cart is used for checkout, type will be `order` and the data object will be the order's details. If the cart completion is successful and the cart is used for swap creation, type will be `swap` and the data object will be the swap's details." enum: [order, cart, swap] data: type: object description: The data of the result object. Its type depends on the type field. oneOf: - type: object allOf: - description: Cart was successfully authorized and order was placed successfully. - $ref: "#/components/schemas/Order" - type: object allOf: - description: Cart was successfully authorized but requires further actions. - $ref: "#/components/schemas/Cart" - type: object allOf: - description: Cart was used for a swap and it has been completed successfully. - $ref: "#/components/schemas/Swap" #### Defined in packages/medusa/dist/api/routes/store/carts/index.d.ts:106 ___ ### StoreCustomersListOrdersRes Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal-3.Order.md)[] } **`Schema`** StoreCustomersListOrdersRes type: object x-expanded-relations: field: orders relations: - customer - discounts - discounts.rule - fulfillments - fulfillments.tracking_links - items - items.variant - payments - region - shipping_address - shipping_methods eager: - region.fulfillment_providers - region.payment_providers - shipping_methods.shipping_option implicit: - claims - claims.additional_items - claims.additional_items.adjustments - claims.additional_items.refundable - claims.additional_items.tax_lines - customer - discounts - discounts.rule - gift_card_transactions - gift_card_transactions.gift_card - gift_cards - items - items.adjustments - items.refundable - items.tax_lines - items.variant - items.variant.product - items.variant.product.profiles - refunds - region - shipping_address - shipping_methods - shipping_methods.tax_lines - swaps - swaps.additional_items - swaps.additional_items.adjustments - swaps.additional_items.refundable - swaps.additional_items.tax_lines totals: - discount_total - gift_card_tax_total - gift_card_total - paid_total - refundable_amount - refunded_total - shipping_total - subtotal - tax_total - total - claims.additional_items.discount_total - claims.additional_items.gift_card_total - claims.additional_items.original_tax_total - claims.additional_items.original_total - claims.additional_items.refundable - claims.additional_items.subtotal - claims.additional_items.tax_total - claims.additional_items.total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total - swaps.additional_items.discount_total - swaps.additional_items.gift_card_total - swaps.additional_items.original_tax_total - swaps.additional_items.original_total - swaps.additional_items.refundable - swaps.additional_items.subtotal - swaps.additional_items.tax_total - swaps.additional_items.total required: - orders - count - offset - limit properties: orders: type: array description: "An array of orders details." items: $ref: "#/components/schemas/Order" count: description: The total number of items available type: integer offset: description: The number of orders skipped when retrieving the orders. type: integer limit: description: The number of items per page type: integer #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:146 ___ ### StoreCustomersListPaymentMethodsRes Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` **`Schema`** StoreCustomersListPaymentMethodsRes type: object required: - payment_methods properties: payment_methods: type: array description: "An array of saved payment method details." items: type: object required: - provider_id - data properties: provider_id: description: The ID of the Payment Provider where the payment method is saved. type: string data: description: The data needed for the Payment Provider to use the saved payment method. type: object #### Type declaration | Name | Type | | :------ | :------ | | `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] | #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:171 ___ ### StoreCustomersRes Ƭ **StoreCustomersRes**: `Object` **`Schema`** StoreCustomersRes type: object x-expanded-relations: field: customer relations: - billing_address - shipping_addresses required: - customer properties: customer: description: "Customer details." $ref: "#/components/schemas/Customer" #### Type declaration | Name | Type | | :------ | :------ | | `customer` | [`Omit`](internal-1.md#omit)<[`Customer`](../classes/internal-3.Customer.md), ``"password_hash"``\> | #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:24 ___ ### StoreCustomersResetPasswordRes Ƭ **StoreCustomersResetPasswordRes**: `Object` **`Schema`** StoreCustomersResetPasswordRes type: object required: - customer properties: customer: description: "Customer details." $ref: "#/components/schemas/Customer" #### Type declaration | Name | Type | | :------ | :------ | | `customer` | [`Omit`](internal-1.md#omit)<[`Customer`](../classes/internal-3.Customer.md), ``"password_hash"``\> | #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:37 ___ ### StoreGetAuthEmailRes Ƭ **StoreGetAuthEmailRes**: `Object` **`Schema`** StoreGetAuthEmailRes type: object required: - exists properties: exists: description: Whether email exists or not. type: boolean #### Type declaration | Name | Type | | :------ | :------ | | `exists` | `boolean` | #### Defined in packages/medusa/dist/api/routes/store/auth/index.d.ts:45 ___ ### StoreGetProductCategoriesCategoryRes Ƭ **StoreGetProductCategoriesCategoryRes**: `Object` **`Schema`** StoreGetProductCategoriesCategoryRes type: object x-expanded-relations: field: product_category relations: - category_children - parent_category required: - product_category properties: product_category: description: "Product category details." $ref: "#/components/schemas/ProductCategory" #### Type declaration | Name | Type | | :------ | :------ | | `product_category` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | #### Defined in packages/medusa/dist/api/routes/store/product-categories/index.d.ts:27 ___ ### StoreGetProductCategoriesRes Ƭ **StoreGetProductCategoriesRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/internal-3.ProductCategory.md)[] } **`Schema`** StoreGetProductCategoriesRes type: object x-expanded-relations: field: product_categories relations: - category_children - parent_category required: - product_categories - count - offset - limit properties: product_categories: type: array description: "An array of product categories details." items: $ref: "#/components/schemas/ProductCategory" count: type: integer description: The total number of items available offset: type: integer description: The number of product categories skipped when retrieving the product categories. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/store/product-categories/index.d.ts:59 ___ ### StoreGiftCardsRes Ƭ **StoreGiftCardsRes**: `Object` **`Schema`** StoreGiftCardsRes type: object required: - gift_card properties: gift_card: description: "Gift card details." $ref: "#/components/schemas/GiftCard" #### Type declaration | Name | Type | | :------ | :------ | | `gift_card` | [`GiftCard`](../classes/internal-3.GiftCard.md) | #### Defined in packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:18 ___ ### StoreOrderEditsRes Ƭ **StoreOrderEditsRes**: `Object` **`Schema`** StoreOrderEditsRes type: object x-expanded-relations: field: order_edit relations: - changes - changes.line_item - changes.line_item.variant - changes.original_line_item - changes.original_line_item.variant - items - items.adjustments - items.tax_lines - items.variant - payment_collection implicit: - items - items.tax_lines - items.adjustments - items.variant totals: - difference_due - discount_total - gift_card_tax_total - gift_card_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required: - order_edit properties: order_edit: description: "Order edit details." $ref: "#/components/schemas/OrderEdit" #### Type declaration | Name | Type | | :------ | :------ | | `order_edit` | [`Omit`](internal-1.md#omit)<[`OrderEdit`](../classes/internal-3.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> | #### Defined in packages/medusa/dist/api/routes/store/order-edits/index.d.ts:49 ___ ### StoreOrdersRes Ƭ **StoreOrdersRes**: `Object` **`Schema`** StoreOrdersRes type: object required: - order x-expanded-relations: field: order relations: - customer - discounts - discounts.rule - fulfillments - fulfillments.tracking_links - items - items.variant - payments - region - shipping_address - shipping_methods eager: - fulfillments.items - region.fulfillment_providers - region.payment_providers - shipping_methods.shipping_option implicit: - claims - claims.additional_items - claims.additional_items.adjustments - claims.additional_items.refundable - claims.additional_items.tax_lines - discounts - discounts.rule - gift_card_transactions - gift_card_transactions.gift_card - gift_cards - items - items.adjustments - items.refundable - items.tax_lines - items.variant - items.variant.product - items.variant.product.profiles - refunds - region - shipping_methods - shipping_methods.tax_lines - swaps - swaps.additional_items - swaps.additional_items.adjustments - swaps.additional_items.refundable - swaps.additional_items.tax_lines totals: - discount_total - gift_card_tax_total - gift_card_total - paid_total - refundable_amount - refunded_total - shipping_total - subtotal - tax_total - total - claims.additional_items.discount_total - claims.additional_items.gift_card_total - claims.additional_items.original_tax_total - claims.additional_items.original_total - claims.additional_items.refundable - claims.additional_items.subtotal - claims.additional_items.tax_total - claims.additional_items.total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total - swaps.additional_items.discount_total - swaps.additional_items.gift_card_total - swaps.additional_items.original_tax_total - swaps.additional_items.original_total - swaps.additional_items.refundable - swaps.additional_items.subtotal - swaps.additional_items.tax_total - swaps.additional_items.total properties: order: description: "Order details." $ref: "#/components/schemas/Order" #### Type declaration | Name | Type | | :------ | :------ | | `order` | [`Order`](../classes/internal-3.Order.md) | #### Defined in packages/medusa/dist/api/routes/store/orders/index.d.ts:100 ___ ### StorePaymentCollectionsRes Ƭ **StorePaymentCollectionsRes**: `Object` **`Schema`** StorePaymentCollectionsRes type: object x-expanded-relations: field: payment_collection relations: - payment_sessions - region eager: - region.fulfillment_providers - region.payment_providers required: - payment_collection properties: payment_collection: description: "Payment collection's details." $ref: "#/components/schemas/PaymentCollection" #### Type declaration | Name | Type | | :------ | :------ | | `payment_collection` | [`PaymentCollection`](../classes/internal-3.PaymentCollection.md) | #### Defined in packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:25 ___ ### StorePaymentCollectionsSessionRes Ƭ **StorePaymentCollectionsSessionRes**: `Object` **`Schema`** StorePaymentCollectionsSessionRes type: object required: - payment_session properties: payment_session: description: "Payment session's details." $ref: "#/components/schemas/PaymentSession" #### Type declaration | Name | Type | | :------ | :------ | | `payment_session` | [`PaymentSession`](../classes/internal-3.PaymentSession.md) | #### Defined in packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:38 ___ ### StorePostSearchRes Ƭ **StorePostSearchRes**: { `hits`: `unknown`[] } & [`Record`](internal.md#record)<`string`, `unknown`\> **`Schema`** StorePostSearchRes allOf: - type: object required: - hits properties: hits: description: "Array of search results. The format of the items depends on the search engine installed on the Medusa backend." type: array - type: object #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:86 ___ ### StoreProductTagsListRes Ƭ **StoreProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal-3.ProductTag.md)[] } **`Schema`** StoreProductTagsListRes type: object required: - product_tags - count - offset - limit properties: product_tags: type: array description: "An array of product tags details." items: $ref: "#/components/schemas/ProductTag" count: type: integer description: The total number of items available offset: type: integer description: The number of product tags skipped when retrieving the product tags. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/store/product-tags/index.d.ts:33 ___ ### StoreProductTypesListRes Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal-3.ProductType.md)[] } **`Schema`** StoreProductTypesListRes type: object required: - product_types - count - offset - limit properties: product_types: type: array description: "An array of product types details." items: $ref: "#/components/schemas/ProductType" count: type: integer description: The total number of items available offset: type: integer description: The number of product types skipped when retrieving the product types. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/store/product-types/index.d.ts:33 ___ ### StoreProductsListRes Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`PricedProduct`](internal-8.md#pricedproduct)[] } **`Schema`** StoreProductsListRes type: object x-expanded-relations: field: products relations: - collection - images - options - options.values - tags - type - variants - variants.options - variants.prices totals: - variants.purchasable required: - products - count - offset - limit properties: products: type: array description: "An array of products details." items: $ref: "#/components/schemas/PricedProduct" count: type: integer description: The total number of items available offset: type: integer description: The number of products skipped when retrieving the products. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:127 ___ ### StoreProductsRes Ƭ **StoreProductsRes**: `Object` **`Schema`** StoreProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - options.values - tags - type - variants - variants.options - variants.prices totals: - variants.purchasable required: - product properties: product: description: "Product details." $ref: "#/components/schemas/PricedProduct" #### Type declaration | Name | Type | | :------ | :------ | | `product` | [`PricedProduct`](internal-8.md#pricedproduct) | #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:71 ___ ### StoreRegionsListRes Ƭ **StoreRegionsListRes**: [`PaginatedResponse`](internal-8.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal-3.Region.md)[] } **`Schema`** StoreRegionsListRes type: object x-expanded-relations: field: regions relations: - countries - payment_providers - fulfillment_providers eager: - payment_providers - fulfillment_providers required: - regions properties: regions: type: array description: "An array of regions details." items: $ref: "#/components/schemas/Region" count: type: integer description: The total number of items available offset: type: integer description: The number of regions skipped when retrieving the regions. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/store/regions/index.d.ts:36 ___ ### StoreRegionsRes Ƭ **StoreRegionsRes**: `Object` **`Schema`** StoreRegionsRes type: object x-expanded-relations: field: region relations: - countries - payment_providers - fulfillment_providers eager: - payment_providers - fulfillment_providers required: - region properties: region: description: "Region details." $ref: "#/components/schemas/Region" #### Type declaration | Name | Type | | :------ | :------ | | `region` | [`Region`](../classes/internal-3.Region.md) | #### Defined in packages/medusa/dist/api/routes/store/regions/index.d.ts:58 ___ ### StoreReturnReasonsListRes Ƭ **StoreReturnReasonsListRes**: `Object` **`Schema`** StoreReturnReasonsListRes type: object x-expanded-relations: field: return_reasons relations: - parent_return_reason - return_reason_children required: - return_reasons properties: return_reasons: type: array description: "An array of return reasons details." items: $ref: "#/components/schemas/ReturnReason" #### Type declaration | Name | Type | | :------ | :------ | | `return_reasons` | [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] | #### Defined in packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:23 ___ ### StoreReturnReasonsRes Ƭ **StoreReturnReasonsRes**: `Object` **`Schema`** StoreReturnReasonsRes type: object x-expanded-relations: field: return_reason relations: - parent_return_reason - return_reason_children required: - return_reason properties: return_reason: description: "Return reason details." $ref: "#/components/schemas/ReturnReason" #### Type declaration | Name | Type | | :------ | :------ | | `return_reason` | [`ReturnReason`](../classes/internal-3.ReturnReason.md) | #### Defined in packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:41 ___ ### StoreReturnsRes Ƭ **StoreReturnsRes**: `Object` **`Schema`** StoreReturnsRes type: object x-expanded-relations: field: return relations: - items - items.reason eager: - items required: - return properties: return: description: "Return details." $ref: "#/components/schemas/Return" #### Type declaration | Name | Type | | :------ | :------ | | `return` | [`Return`](../classes/internal-3.Return.md) | #### Defined in packages/medusa/dist/api/routes/store/returns/index.d.ts:22 ___ ### StoreShippingOptionsListRes Ƭ **StoreShippingOptionsListRes**: `Object` **`Schema`** StoreShippingOptionsListRes type: object x-expanded-relations: field: shipping_options relations: - requirements required: - shipping_options properties: shipping_options: type: array description: "An array of shipping options details." items: $ref: "#/components/schemas/PricedShippingOption" #### Type declaration | Name | Type | | :------ | :------ | | `shipping_options` | [`PricedShippingOption`](internal-8.md#pricedshippingoption)[] | #### Defined in packages/medusa/dist/api/routes/store/shipping-options/index.d.ts:21 ___ ### StoreSwapsRes Ƭ **StoreSwapsRes**: `Object` **`Schema`** StoreSwapsRes type: object x-expanded-relations: field: swap relations: - additional_items - additional_items.variant - cart - fulfillments - order - payment - return_order - return_order.shipping_method - shipping_address - shipping_methods eager: - fulfillments.items required: - swap properties: swap: description: "Swap details." $ref: "#/components/schemas/Swap" #### Type declaration | Name | Type | | :------ | :------ | | `swap` | [`Swap`](../classes/internal-3.Swap.md) | #### Defined in packages/medusa/dist/api/routes/store/swaps/index.d.ts:32 ___ ### StoreVariantsListRes Ƭ **StoreVariantsListRes**: `Object` **`Schema`** StoreVariantsListRes type: object x-expanded-relations: field: variants relations: - prices - options - product totals: - purchasable required: - variants properties: variants: type: array description: "An array of product variant descriptions." items: $ref: "#/components/schemas/PricedVariant" #### Type declaration | Name | Type | | :------ | :------ | | `variants` | [`PricedVariant`](internal-8.md#pricedvariant)[] | #### Defined in packages/medusa/dist/api/routes/store/variants/index.d.ts:47 ___ ### StoreVariantsRes Ƭ **StoreVariantsRes**: `Object` **`Schema`** StoreVariantsRes type: object x-expanded-relations: field: variant relations: - prices - options - product totals: - purchasable required: - variant properties: variant: description: "Product variant description." $ref: "#/components/schemas/PricedVariant" #### Type declaration | Name | Type | | :------ | :------ | | `variant` | [`PricedVariant`](internal-8.md#pricedvariant) | #### Defined in packages/medusa/dist/api/routes/store/variants/index.d.ts:24 ___ ### TaxCalculationContext Ƭ **TaxCalculationContext**: `Object` Information relevant to a tax calculation, such as the shipping address where the items are going. #### Type declaration | Name | Type | | :------ | :------ | | `allocation_map` | [`LineAllocationsMap`](internal-8.md#lineallocationsmap) | | `customer` | [`Customer`](../classes/internal-3.Customer.md) | | `is_return` | `boolean` | | `region` | [`Region`](../classes/internal-3.Region.md) | | `shipping_address` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | | `shipping_methods` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] | #### Defined in packages/medusa/dist/interfaces/tax-service.d.ts:29 ___ ### TotalField Ƭ **TotalField**: ``"shipping_total"`` \| ``"discount_total"`` \| ``"tax_total"`` \| ``"refunded_total"`` \| ``"total"`` \| ``"subtotal"`` \| ``"refundable_amount"`` \| ``"gift_card_total"`` \| ``"gift_card_tax_total"`` #### Defined in packages/medusa/dist/types/common.d.ts:45 ___ ### TreeQuerySelector Ƭ **TreeQuerySelector**<`TEntity`\>: [`QuerySelector`](internal-8.internal.md#queryselector)<`TEntity`\> & { `include_descendants_tree?`: `boolean` } #### Type parameters | Name | | :------ | | `TEntity` | #### Defined in packages/medusa/dist/types/common.d.ts:39 ___ ### UpdatePriceListInput Ƭ **UpdatePriceListInput**: [`Partial`](internal-8.md#partial)<[`Pick`](internal-1.md#pick)<[`PriceList`](../classes/internal-3.PriceList.md), ``"name"`` \| ``"description"`` \| ``"starts_at"`` \| ``"ends_at"`` \| ``"status"`` \| ``"type"`` \| ``"includes_tax"``\>\> & { `customer_groups?`: { `id`: `string` }[] ; `prices?`: [`AdminPriceListPricesUpdateReq`](../classes/internal-8.internal.AdminPriceListPricesUpdateReq.md)[] } #### Defined in packages/medusa/dist/types/price-list.d.ts:53 ___ ### VariantInventory Ƭ **VariantInventory**: `Object` **`Schema`** VariantInventory type: object required: - id - inventory - sales_channel_availability properties: id: description: the ID of the variant type: string inventory: description: The inventory details. $ref: "#/components/schemas/ResponseInventoryItem" sales_channel_availability: type: array description: An array of details about the variant's inventory availability in sales channels. items: type: object required: - channel_name - channel_id - available_quantity properties: channel_name: description: Sales channel's name type: string channel_id: description: Sales channel's ID type: string available_quantity: description: Available quantity in the sales channel type: number #### Type declaration | Name | Type | | :------ | :------ | | `id` | `string` | | `inventory` | [`ResponseInventoryItem`](internal-8.internal.md#responseinventoryitem)[] | | `sales_channel_availability` | { `available_quantity`: `number` ; `channel_id`: `string` ; `channel_name`: `string` }[] | #### Defined in packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:116 ___ ### WithRequiredProperty Ƭ **WithRequiredProperty**<`T`, `K`\>: `T` & { [Property in K]-?: T[Property] } Utility type used to remove some optional attributes (coming from K) from a type T #### Type parameters | Name | Type | | :------ | :------ | | `T` | `T` | | `K` | extends keyof `T` | #### Defined in packages/medusa/dist/types/common.d.ts:10 ___ ### Writable Ƭ **Writable**<`T`\>: { -readonly [key in keyof T]: T[key] \| FindOperator \| FindOperator \| FindOperator } #### Type parameters | Name | | :------ | | `T` | #### Defined in packages/medusa/dist/types/common.d.ts:16 ___ ### payload Ƭ **payload**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `email` | `string` | | `password` | `string` | | `user_id` | `string` | #### Defined in packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:68 ## Variables ### AvailableOrderIncludes • `Const` **AvailableOrderIncludes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `RETURNABLE_ITEMS` | `string` | #### Defined in packages/medusa/dist/api/routes/admin/orders/index.d.ts:256 ___ ### PriceType • **PriceType**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `DEFAULT` | [`DEFAULT`](internal-8.md#default) | | `OVERRIDE` | [`OVERRIDE`](../enums/internal-3.PriceListType.md#override) | | `SALE` | [`SALE`](../enums/internal-3.PriceListType.md#sale) | #### Defined in packages/medusa/dist/interfaces/price-selection-strategy.d.ts:47 packages/medusa/dist/interfaces/price-selection-strategy.d.ts:48 ___ ### allowedAdminProductCategoryRelations • `Const` **allowedAdminProductCategoryRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:13 ___ ### allowedFields • `Const` **allowedFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/collections/index.d.ts:6 ___ ### allowedOrderIncludes • `Const` **allowedOrderIncludes**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/orders/index.d.ts:259 ___ ### allowedStoreCustomersFields • `Const` **allowedStoreCustomersFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:8 ___ ### allowedStoreCustomersRelations • `Const` **allowedStoreCustomersRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:7 ___ ### allowedStoreGiftCardFields • `Const` **allowedStoreGiftCardFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:7 ___ ### allowedStoreGiftCardRelations • `Const` **allowedStoreGiftCardRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:6 ___ ### allowedStoreOrdersFields • `Const` **allowedStoreOrdersFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/orders/index.d.ts:8 ___ ### allowedStoreOrdersRelations • `Const` **allowedStoreOrdersRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/orders/index.d.ts:6 ___ ### allowedStoreProductCategoryFields • `Const` **allowedStoreProductCategoryFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/product-categories/index.d.ts:11 ___ ### allowedStoreProductTagFields • `Const` **allowedStoreProductTagFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/product-tags/index.d.ts:7 ___ ### allowedStoreProductTypeFields • `Const` **allowedStoreProductTypeFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/product-types/index.d.ts:6 ___ ### allowedStoreProductsFields • `Const` **allowedStoreProductsFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:10 ___ ### allowedStoreProductsRelations • `Const` **allowedStoreProductsRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:11 ___ ### allowedStoreVariantRelations • `Const` **allowedStoreVariantRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/variants/index.d.ts:5 ___ ### defaulPaymentCollectionRelations • `Const` **defaulPaymentCollectionRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:6 ___ ### defaultAdminBatchFields • `Const` **defaultAdminBatchFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/batch/index.d.ts:45 ___ ### defaultAdminCollectionsFields • `Const` **defaultAdminCollectionsFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/collections/index.d.ts:6 ___ ### defaultAdminCollectionsRelations • `Const` **defaultAdminCollectionsRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/collections/index.d.ts:7 ___ ### defaultAdminCustomerGroupsRelations • `Const` **defaultAdminCustomerGroupsRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:66 ___ ### defaultAdminCustomersRelations • `Const` **defaultAdminCustomersRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/customers/index.d.ts:50 ___ ### defaultAdminDiscountConditionFields • `Const` **defaultAdminDiscountConditionFields**: keyof [`DiscountCondition`](../classes/internal-3.DiscountCondition.md)[] #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:9 ___ ### defaultAdminDiscountConditionRelations • `Const` **defaultAdminDiscountConditionRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:10 ___ ### defaultAdminDiscountsFields • `Const` **defaultAdminDiscountsFields**: keyof [`Discount`](../classes/internal-3.Discount.md)[] #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:7 ___ ### defaultAdminDiscountsRelations • `Const` **defaultAdminDiscountsRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:8 ___ ### defaultAdminDraftOrdersCartFields • `Const` **defaultAdminDraftOrdersCartFields**: keyof [`Cart`](../classes/internal-3.Cart.md)[] #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:7 ___ ### defaultAdminDraftOrdersCartRelations • `Const` **defaultAdminDraftOrdersCartRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:6 ___ ### defaultAdminDraftOrdersFields • `Const` **defaultAdminDraftOrdersFields**: keyof [`DraftOrder`](../classes/internal-3.DraftOrder.md)[] #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:8 ___ ### defaultAdminDraftOrdersRelations • `Const` **defaultAdminDraftOrdersRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:5 ___ ### defaultAdminGetProductsVariantsFields • `Const` **defaultAdminGetProductsVariantsFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:10 ___ ### defaultAdminGiftCardFields • `Const` **defaultAdminGiftCardFields**: keyof [`GiftCard`](../classes/internal-3.GiftCard.md)[] #### Defined in packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:6 ___ ### defaultAdminGiftCardRelations • `Const` **defaultAdminGiftCardRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:7 ___ ### defaultAdminInventoryItemFields • `Const` **defaultAdminInventoryItemFields**: keyof [`InventoryItemDTO`](internal-8.md#inventoryitemdto)[] #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:7 ___ ### defaultAdminInventoryItemRelations • `Const` **defaultAdminInventoryItemRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:9 ___ ### defaultAdminLocationLevelFields • `Const` **defaultAdminLocationLevelFields**: keyof [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:8 ___ ### defaultAdminNotificationsFields • `Const` **defaultAdminNotificationsFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/notifications/index.d.ts:6 ___ ### defaultAdminNotificationsRelations • `Const` **defaultAdminNotificationsRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/notifications/index.d.ts:5 ___ ### defaultAdminPriceListFields • `Const` **defaultAdminPriceListFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:7 ___ ### defaultAdminPriceListRelations • `Const` **defaultAdminPriceListRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:8 ___ ### defaultAdminProductCategoryRelations • `Const` **defaultAdminProductCategoryRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:12 ___ ### defaultAdminProductFields • `Const` **defaultAdminProductFields**: keyof [`Product`](../classes/internal-3.Product.md)[] #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:9 ___ ### defaultAdminProductRelations • `Const` **defaultAdminProductRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:8 ___ ### defaultAdminProductRemoteQueryObject • `Const` **defaultAdminProductRemoteQueryObject**: `Object` This is temporary. #### Type declaration | Name | Type | | :------ | :------ | | `collection` | { `fields`: `string`[] } | | `collection.fields` | `string`[] | | `fields` | keyof [`Product`](../classes/internal-3.Product.md)[] | | `images` | { `fields`: `string`[] } | | `images.fields` | `string`[] | | `options` | { `fields`: `string`[] ; `values`: { `fields`: `string`[] } } | | `options.fields` | `string`[] | | `options.values` | { `fields`: `string`[] } | | `options.values.fields` | `string`[] | | `profile` | { `fields`: `string`[] } | | `profile.fields` | `string`[] | | `tags` | { `fields`: `string`[] } | | `tags.fields` | `string`[] | | `type` | { `fields`: `string`[] } | | `type.fields` | `string`[] | | `variants` | { `fields`: `string`[] ; `options`: { `fields`: `string`[] } } | | `variants.fields` | `string`[] | | `variants.options` | { `fields`: `string`[] } | | `variants.options.fields` | `string`[] | #### Defined in packages/medusa/dist/api/routes/admin/products/index.d.ts:14 ___ ### defaultAdminProductTagsFields • `Const` **defaultAdminProductTagsFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:6 ___ ### defaultAdminProductTagsRelations • `Const` **defaultAdminProductTagsRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:7 ___ ### defaultAdminProductTypeFields • `Const` **defaultAdminProductTypeFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/product-types/index.d.ts:6 ___ ### defaultAdminProductTypeRelations • `Const` **defaultAdminProductTypeRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/admin/product-types/index.d.ts:7 ___ ### defaultAdminRegionFields • `Const` **defaultAdminRegionFields**: keyof [`Region`](../classes/internal-3.Region.md)[] #### Defined in packages/medusa/dist/api/routes/admin/regions/index.d.ts:7 ___ ### defaultAdminRegionRelations • `Const` **defaultAdminRegionRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/regions/index.d.ts:8 ___ ### defaultAdminReservationRelations • `Const` **defaultAdminReservationRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/admin/reservations/index.d.ts:64 ___ ### defaultAdminReturnReasonsFields • `Const` **defaultAdminReturnReasonsFields**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] #### Defined in packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:5 ___ ### defaultAdminReturnReasonsRelations • `Const` **defaultAdminReturnReasonsRelations**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] #### Defined in packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:6 ___ ### defaultAdminShippingProfilesFields • `Const` **defaultAdminShippingProfilesFields**: keyof [`ShippingProfile`](../classes/internal-3.ShippingProfile.md)[] #### Defined in packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:6 ___ ### defaultAdminShippingProfilesRelations • `Const` **defaultAdminShippingProfilesRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:7 ___ ### defaultAdminStockLocationFields • `Const` **defaultAdminStockLocationFields**: keyof [`StockLocationDTO`](internal-8.md#stocklocationdto)[] #### Defined in packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:4 ___ ### defaultAdminStockLocationRelations • `Const` **defaultAdminStockLocationRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:5 ___ ### defaultAdminSwapFields • `Const` **defaultAdminSwapFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/swaps/index.d.ts:6 ___ ### defaultAdminSwapRelations • `Const` **defaultAdminSwapRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/swaps/index.d.ts:5 ___ ### defaultAdminTaxRatesFields • `Const` **defaultAdminTaxRatesFields**: keyof [`TaxRate`](../classes/internal-3.TaxRate.md)[] #### Defined in packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:6 ___ ### defaultAdminTaxRatesRelations • `Const` **defaultAdminTaxRatesRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:5 ___ ### defaultAdminVariantFields • `Const` **defaultAdminVariantFields**: keyof [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] #### Defined in packages/medusa/dist/api/routes/admin/variants/index.d.ts:7 ___ ### defaultAdminVariantRelations • `Const` **defaultAdminVariantRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/variants/index.d.ts:6 ___ ### defaultFields • `Const` **defaultFields**: keyof [`ShippingOption`](../classes/internal-3.ShippingOption.md)[] #### Defined in packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:6 ___ ### defaultPaymentCollectionFields • `Const` **defaultPaymentCollectionFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:5 ___ ### defaultPaymentCollectionRelations • `Const` **defaultPaymentCollectionRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:6 ___ ### defaultPaymentFields • `Const` **defaultPaymentFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/payments/index.d.ts:5 ___ ### defaultProductCategoryFields • `Const` **defaultProductCategoryFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:14 ___ ### defaultRelations • `Const` **defaultRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/returns/index.d.ts:6 ___ ### defaultRelationsExtended • `Const` **defaultRelationsExtended**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/store/index.d.ts:5 ___ ### defaultRelationsList • `Const` **defaultRelationsList**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/returns/index.d.ts:7 ___ ### defaultReservationFields • `Const` **defaultReservationFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/reservations/index.d.ts:65 ___ ### defaultReturnCancelFields • `Const` **defaultReturnCancelFields**: keyof [`Order`](../classes/internal-3.Order.md)[] #### Defined in packages/medusa/dist/api/routes/admin/returns/index.d.ts:9 ___ ### defaultReturnCancelRelations • `Const` **defaultReturnCancelRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/returns/index.d.ts:8 ___ ### defaultStoreCartFields • `Const` **defaultStoreCartFields**: keyof [`Cart`](../classes/internal-3.Cart.md)[] #### Defined in packages/medusa/dist/api/routes/store/carts/index.d.ts:5 ___ ### defaultStoreCartRelations • `Const` **defaultStoreCartRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/carts/index.d.ts:6 ___ ### defaultStoreCategoryScope • `Const` **defaultStoreCategoryScope**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `is_active` | `boolean` | | `is_internal` | `boolean` | #### Defined in packages/medusa/dist/api/routes/store/product-categories/index.d.ts:6 ___ ### defaultStoreCollectionRelations • `Const` **defaultStoreCollectionRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/store/collections/index.d.ts:5 ___ ### defaultStoreCustomersFields • `Const` **defaultStoreCustomersFields**: keyof [`Customer`](../classes/internal-3.Customer.md)[] #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:6 ___ ### defaultStoreCustomersRelations • `Const` **defaultStoreCustomersRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/customers/index.d.ts:5 ___ ### defaultStoreGiftCardFields • `Const` **defaultStoreGiftCardFields**: keyof [`GiftCard`](../classes/internal-3.GiftCard.md)[] #### Defined in packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:5 ___ ### defaultStoreGiftCardRelations • `Const` **defaultStoreGiftCardRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:4 ___ ### defaultStoreOrdersFields • `Const` **defaultStoreOrdersFields**: keyof [`Order`](../classes/internal-3.Order.md)[] #### Defined in packages/medusa/dist/api/routes/store/orders/index.d.ts:7 ___ ### defaultStoreOrdersRelations • `Const` **defaultStoreOrdersRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/orders/index.d.ts:5 ___ ### defaultStoreProductCategoryFields • `Const` **defaultStoreProductCategoryFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/product-categories/index.d.ts:10 ___ ### defaultStoreProductCategoryRelations • `Const` **defaultStoreProductCategoryRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/product-categories/index.d.ts:5 ___ ### defaultStoreProductRemoteQueryObject • `Const` **defaultStoreProductRemoteQueryObject**: `Object` This is temporary. #### Type declaration | Name | Type | | :------ | :------ | | `collection` | { `fields`: `string`[] } | | `collection.fields` | `string`[] | | `fields` | keyof [`Product`](../classes/internal-3.Product.md)[] | | `images` | { `fields`: `string`[] } | | `images.fields` | `string`[] | | `options` | { `fields`: `string`[] ; `values`: { `fields`: `string`[] } } | | `options.fields` | `string`[] | | `options.values` | { `fields`: `string`[] } | | `options.values.fields` | `string`[] | | `profile` | { `fields`: `string`[] } | | `profile.fields` | `string`[] | | `tags` | { `fields`: `string`[] } | | `tags.fields` | `string`[] | | `type` | { `fields`: `string`[] } | | `type.fields` | `string`[] | | `variants` | { `fields`: `string`[] ; `options`: { `fields`: `string`[] } } | | `variants.fields` | `string`[] | | `variants.options` | { `fields`: `string`[] } | | `variants.options.fields` | `string`[] | #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:15 ___ ### defaultStoreProductTagFields • `Const` **defaultStoreProductTagFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/product-tags/index.d.ts:6 ___ ### defaultStoreProductTagRelations • `Const` **defaultStoreProductTagRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/store/product-tags/index.d.ts:8 ___ ### defaultStoreProductTypeFields • `Const` **defaultStoreProductTypeFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/product-types/index.d.ts:7 ___ ### defaultStoreProductTypeRelations • `Const` **defaultStoreProductTypeRelations**: `never`[] #### Defined in packages/medusa/dist/api/routes/store/product-types/index.d.ts:8 ___ ### defaultStoreProductsFields • `Const` **defaultStoreProductsFields**: keyof [`Product`](../classes/internal-3.Product.md)[] #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:9 ___ ### defaultStoreProductsRelations • `Const` **defaultStoreProductsRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/products/index.d.ts:8 ___ ### defaultStoreReturnReasonFields • `Const` **defaultStoreReturnReasonFields**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] #### Defined in packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:4 ___ ### defaultStoreReturnReasonRelations • `Const` **defaultStoreReturnReasonRelations**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] #### Defined in packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:5 ___ ### defaultStoreSwapFields • `Const` **defaultStoreSwapFields**: [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](../classes/internal-3.Swap.md)\>[``"select"``] #### Defined in packages/medusa/dist/api/routes/store/swaps/index.d.ts:6 ___ ### defaultStoreSwapRelations • `Const` **defaultStoreSwapRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/swaps/index.d.ts:5 ___ ### defaultStoreVariantRelations • `Const` **defaultStoreVariantRelations**: `string`[] #### Defined in packages/medusa/dist/api/routes/store/variants/index.d.ts:4 ___ ### filterableAdminOrdersFields • `Const` **filterableAdminOrdersFields**: `string`[] #### Defined in packages/medusa/dist/api/routes/admin/orders/index.d.ts:255 ## Functions ### DbAwareColumn ▸ **DbAwareColumn**(`columnOptions`): [`PropertyDecorator`](internal-8.md#propertydecorator) #### Parameters | Name | Type | | :------ | :------ | | `columnOptions` | `ColumnOptions` | #### Returns [`PropertyDecorator`](internal-8.md#propertydecorator) #### Defined in packages/medusa/dist/utils/db-aware-column.d.ts:4 ___ ### IsType ▸ **IsType**(`types`, `validationOptions?`): (`object`: [`Object`](internal-8.md#object), `propertyName`: `string`) => `void` #### Parameters | Name | Type | | :------ | :------ | | `types` | `any`[] | | `validationOptions?` | `ValidationOptions` | #### Returns `fn` ▸ (`object`, `propertyName`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `object` | [`Object`](internal-8.md#object) | | `propertyName` | `string` | ##### Returns `void` #### Defined in packages/medusa/dist/utils/validators/is-type.d.ts:2 ___ ### addOrderToSelect ▸ **addOrderToSelect**<`TEntity`\>(`order`, `select`): `void` #### Type parameters | Name | | :------ | | `TEntity` | #### Parameters | Name | Type | | :------ | :------ | | `order` | `FindOptionsOrder`<`TEntity`\> | | `select` | `FindOptionsSelect`<`TEntity`\> | #### Returns `void` #### Defined in packages/medusa/dist/utils/build-query.d.ts:29 ___ ### adjustInventoryForCancelledFulfillment ▸ **adjustInventoryForCancelledFulfillment**(`fulfillment`, `context`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | | `fulfillment` | [`Fulfillment`](../classes/internal-3.Fulfillment.md) | | `context` | `Object` | | `context.productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | #### Returns `Promise`<`void`\> #### Defined in packages/medusa/dist/api/routes/admin/orders/cancel-fulfillment.d.ts:62 ___ ### authenticate ▸ **authenticate**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Returns `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Defined in packages/medusa/dist/api/middlewares/authenticate.d.ts:2 ___ ### authenticateCustomer ▸ **authenticateCustomer**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Returns `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Defined in packages/medusa/dist/api/middlewares/authenticate-customer.d.ts:2 ___ ### buildLegacyFieldsListFrom ▸ **buildLegacyFieldsListFrom**<`TEntity`\>(`input?`): keyof `TEntity`[] Revert new object structure of find options to the legacy structure of previous version #### Type parameters | Name | | :------ | | `TEntity` | #### Parameters | Name | Type | | :------ | :------ | | `input?` | `FindOptionsWhere`<`TEntity`\> \| `FindOptionsSelect`<`TEntity`\> \| `FindOptionsOrder`<`TEntity`\> \| `FindOptionsRelations`<`TEntity`\> | #### Returns keyof `TEntity`[] **`Deprecated`** in favor of import { objectToStringPath } from "@medusajs/utils" **`Example`** ```ts input: { test: { test1: true, test2: true, test3: { test4: true }, }, test2: true } output: ['test.test1', 'test.test2', 'test.test3.test4', 'test2'] ``` #### Defined in packages/medusa/dist/utils/build-query.d.ts:28 ___ ### buildQuery ▸ **buildQuery**<`TWhereKeys`, `TEntity`\>(`selector`, `config?`): [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<`TEntity`\> Used to build TypeORM queries. #### Type parameters | Name | Type | | :------ | :------ | | `TWhereKeys` | extends `object` | | `TEntity` | `unknown` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `selector` | `TWhereKeys` | The selector | | `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<`TEntity`\> | The config | #### Returns [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<`TEntity`\> The QueryBuilderConfig #### Defined in packages/medusa/dist/utils/build-query.d.ts:10 ___ ### calculatePriceTaxAmount ▸ **calculatePriceTaxAmount**(`«destructured»`): `number` Return the tax amount that - is includes in the price if it is tax inclusive - will be applied on to the price if it is tax exclusive #### Parameters | Name | Type | | :------ | :------ | | `«destructured»` | `Object` | | › `includesTax?` | `boolean` | | › `price` | `number` | | › `taxRate` | `number` | #### Returns `number` #### Defined in packages/medusa/dist/utils/calculate-price-tax-amount.d.ts:9 ___ ### canAccessBatchJob ▸ **canAccessBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> #### Parameters | Name | Type | | :------ | :------ | | `req` | `any` | | `res` | `any` | | `next` | `any` | #### Returns `Promise`<`any`\> #### Defined in packages/medusa/dist/api/middlewares/batch-job/can-access-batch-job.d.ts:1 ___ ### categoryMatchesScope ▸ **categoryMatchesScope**(`category`, `query`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `category` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | | `query` | `FindOptionsWhere`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> | #### Returns `boolean` #### Defined in packages/medusa/dist/utils/product-category/index.d.ts:3 ___ ### cleanResponseData ▸ **cleanResponseData**<`T`\>(`data`, `fields`): `T` extends [] ? [`Partial`](internal-8.md#partial)<`T`\>[] : [`Partial`](internal-8.md#partial)<`T`\> Filter response data to contain props specified in the `allowedProperties`. You can read more in the transformQuery middleware utility methods. #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends `unknown` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `data` | `T` | record or an array of records in the response | | `fields` | `string`[] | record props allowed in the response | #### Returns `T` extends [] ? [`Partial`](internal-8.md#partial)<`T`\>[] : [`Partial`](internal-8.md#partial)<`T`\> #### Defined in packages/medusa/dist/utils/clean-response-data.d.ts:8 ___ ### csvCellContentFormatter ▸ **csvCellContentFormatter**(`str`): `string` #### Parameters | Name | Type | | :------ | :------ | | `str` | `string` | #### Returns `string` #### Defined in packages/medusa/dist/utils/csv-cell-content-formatter.d.ts:1 ___ ### csvRevertCellContentFormatter ▸ **csvRevertCellContentFormatter**(`str`): `string` #### Parameters | Name | Type | | :------ | :------ | | `str` | `string` | #### Returns `string` #### Defined in packages/medusa/dist/utils/csv-cell-content-formatter.d.ts:2 ___ ### doesConditionBelongToDiscount ▸ **doesConditionBelongToDiscount**(`req`, `res`, `next`): `Promise`<`any`\> #### Parameters | Name | Type | | :------ | :------ | | `req` | `any` | | `res` | `any` | | `next` | `any` | #### Returns `Promise`<`any`\> #### Defined in packages/medusa/dist/api/middlewares/discount/does-condition-belong-to-discount.d.ts:1 ___ ### errorHandler ▸ **errorHandler**(): (`err`: [`MedusaError`](../classes/internal-8.MedusaError.md), `req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\>, `res`: `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\>, `next`: `NextFunction`) => `void` #### Returns `fn` ▸ (`err`, `req`, `res`, `next`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `err` | [`MedusaError`](../classes/internal-8.MedusaError.md) | | `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> | | `res` | `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\> | | `next` | `NextFunction` | ##### Returns `void` #### Defined in packages/medusa/dist/api/middlewares/error-handler.d.ts:3 ___ ### extendedFindParamsMixin ▸ **extendedFindParamsMixin**(`«destructured»?`): [`ClassConstructor`](internal-8.internal.md#classconstructor)<[`FindParams`](../classes/internal-6.FindParams.md) & [`FindPaginationParams`](../classes/internal-4.FindPaginationParams.md)\> #### Parameters | Name | Type | | :------ | :------ | | `«destructured»` | `Object` | | › `limit?` | `number` | | › `offset?` | `number` | #### Returns [`ClassConstructor`](internal-8.internal.md#classconstructor)<[`FindParams`](../classes/internal-6.FindParams.md) & [`FindPaginationParams`](../classes/internal-4.FindPaginationParams.md)\> #### Defined in packages/medusa/dist/types/common.d.ts:246 ___ ### fetchCategoryDescendantsIds ▸ **fetchCategoryDescendantsIds**(`productCategory`, `query`): `string`[] #### Parameters | Name | Type | | :------ | :------ | | `productCategory` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | | `query` | `FindOptionsWhere`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> | #### Returns `string`[] #### Defined in packages/medusa/dist/utils/product-category/index.d.ts:4 ___ ### formatException ▸ **formatException**(`err`): [`MedusaError`](../classes/internal-8.MedusaError.md) #### Parameters | Name | Type | | :------ | :------ | | `err` | `any` | #### Returns [`MedusaError`](../classes/internal-8.MedusaError.md) #### Defined in packages/medusa/dist/utils/exception-formatter.d.ts:8 ___ ### generateEntityId ▸ **generateEntityId**(`idProperty`, `prefix?`): `string` Generate a composed id based on the input parameters and return either the is if it exists or the generated one. #### Parameters | Name | Type | | :------ | :------ | | `idProperty` | `string` | | `prefix?` | `string` | #### Returns `string` #### Defined in packages/medusa/dist/utils/generate-entity-id.d.ts:6 ___ ### getRequestedBatchJob ▸ **getRequestedBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> #### Parameters | Name | Type | | :------ | :------ | | `req` | `any` | | `res` | `any` | | `next` | `any` | #### Returns `Promise`<`any`\> #### Defined in packages/medusa/dist/api/middlewares/batch-job/get-requested-batch-job.d.ts:1 ___ ### hasChanges ▸ **hasChanges**<`T1`, `T2`\>(`obj1`, `obj2`): `boolean` Compare two objects and return true if there is changes detected from obj2 compared to obj1 #### Type parameters | Name | Type | | :------ | :------ | | `T1` | extends [`Object`](internal-8.md#object) | | `T2` | extends [`Object`](internal-8.md#object) | #### Parameters | Name | Type | | :------ | :------ | | `obj1` | `T1` | | `obj2` | `T2` | #### Returns `boolean` #### Defined in packages/medusa/dist/utils/has-changes.d.ts:6 ___ ### isBatchJobStrategy ▸ **isBatchJobStrategy**(`object`): object is IBatchJobStrategy #### Parameters | Name | Type | | :------ | :------ | | `object` | `unknown` | #### Returns object is IBatchJobStrategy #### Defined in packages/medusa/dist/interfaces/batch-job-strategy.d.ts:34 ___ ### isCartCompletionStrategy ▸ **isCartCompletionStrategy**(`obj`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `obj` | `unknown` | #### Returns `boolean` #### Defined in packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:24 ___ ### isDate ▸ **isDate**(`value`): value is Date #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns value is Date #### Defined in packages/medusa/dist/utils/is-date.d.ts:1 ___ ### isFileService ▸ **isFileService**(`object`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `object` | `unknown` | #### Returns `boolean` #### Defined in packages/medusa/dist/interfaces/file-service.d.ts:48 ___ ### isNotificationService ▸ **isNotificationService**(`obj`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `obj` | `unknown` | #### Returns `boolean` #### Defined in packages/medusa/dist/interfaces/notification-service.d.ts:17 ___ ### isObject ▸ **isObject**(`obj`): obj is object #### Parameters | Name | Type | | :------ | :------ | | `obj` | `any` | #### Returns obj is object #### Defined in packages/medusa/dist/utils/is-object.d.ts:1 ___ ### isPaymentProcessor ▸ **isPaymentProcessor**(`obj`): `boolean` Return if the input object is AbstractPaymentProcessor #### Parameters | Name | Type | | :------ | :------ | | `obj` | `unknown` | #### Returns `boolean` #### Defined in packages/medusa/dist/interfaces/payment-processor.d.ts:110 ___ ### isPaymentProcessorError ▸ **isPaymentProcessorError**(`obj`): obj is PaymentProcessorError Utility function to determine if an object is a processor error #### Parameters | Name | Type | | :------ | :------ | | `obj` | `any` | #### Returns obj is PaymentProcessorError #### Defined in packages/medusa/dist/interfaces/payment-processor.d.ts:115 ___ ### isPaymentService ▸ **isPaymentService**(`obj`): `boolean` Return if the input object is one of AbstractPaymentService or PaymentService or AbstractPaymentPluginService #### Parameters | Name | Type | | :------ | :------ | | `obj` | `unknown` | #### Returns `boolean` #### Defined in packages/medusa/dist/interfaces/payment-service.d.ts:185 ___ ### isPriceSelectionStrategy ▸ **isPriceSelectionStrategy**(`object`): object is IPriceSelectionStrategy #### Parameters | Name | Type | | :------ | :------ | | `object` | `any` | #### Returns object is IPriceSelectionStrategy #### Defined in packages/medusa/dist/interfaces/price-selection-strategy.d.ts:33 ___ ### isString ▸ **isString**(`val`): val is string #### Parameters | Name | Type | | :------ | :------ | | `val` | `any` | #### Returns val is string #### Defined in packages/medusa/dist/utils/is-string.d.ts:1 ___ ### isTaxCalculationStrategy ▸ **isTaxCalculationStrategy**(`object`): object is ITaxCalculationStrategy #### Parameters | Name | Type | | :------ | :------ | | `object` | `any` | #### Returns object is ITaxCalculationStrategy #### Defined in packages/medusa/dist/interfaces/tax-calculation-strategy.d.ts:16 ___ ### normalizeQuery ▸ **normalizeQuery**(): (`req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\>, `res`: `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\>, `next`: `NextFunction`) => `void` 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 `fn` ▸ (`req`, `res`, `next`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> | | `res` | `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\> | | `next` | `NextFunction` | ##### Returns `void` #### Defined in packages/medusa/dist/api/middlewares/normalized-query.d.ts:6 ___ ### nullableValue ▸ **nullableValue**(`value`): `FindOperator`<`any`\> #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `FindOperator`<`any`\> #### Defined in packages/medusa/dist/utils/build-query.d.ts:30 ___ ### omitDeep ▸ **omitDeep**<`T`\>(`input`, `excludes`): `T` #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends `object` = `object` | #### Parameters | Name | Type | | :------ | :------ | | `input` | `object` | | `excludes` | (`string` \| `number`)[] | #### Returns `T` #### Defined in packages/medusa/dist/utils/omit-deep.d.ts:1 ___ ### registerOverriddenValidators ▸ **registerOverriddenValidators**(`extendedValidator`): `void` When overriding a validator, you can register it to be used instead of the original one. For example, the place where you are overriding the core validator, you can call this function #### Parameters | Name | Type | | :------ | :------ | | `extendedValidator` | [`Constructor`](internal-8.md#constructor)<`any`\> | #### Returns `void` **`Example`** ```ts // /src/api/routes/admin/products/create-product.ts import { registerOverriddenValidators } from "@medusajs/medusa" import { AdminPostProductsReq as MedusaAdminPostProductsReq } from "@medusajs/medusa/dist/api/routes/admin/products/create-product" import { IsString } from "class-validator" class AdminPostProductsReq extends MedusaAdminPostProductsReq { @IsString() test: string } registerOverriddenValidators(AdminPostProductsReq) ``` #### Defined in packages/medusa/dist/utils/validator.d.ts:23 ___ ### remoteQueryFetchData ▸ **remoteQueryFetchData**(`container`): (`expand`: `any`, `keyField`: `any`, `ids`: `any`, `relationship`: `any`) => `Promise`<`any`\> #### Parameters | Name | Type | | :------ | :------ | | `container` | [`MedusaContainer`](internal-8.md#medusacontainer) | #### Returns `fn` ▸ (`expand`, `keyField`, `ids`, `relationship`): `Promise`<`any`\> ##### Parameters | Name | Type | | :------ | :------ | | `expand` | `any` | | `keyField` | `any` | | `ids` | `any` | | `relationship` | `any` | ##### Returns `Promise`<`any`\> #### Defined in packages/medusa/dist/utils/remote-query-fetch-data.d.ts:2 ___ ### removeUndefinedProperties ▸ **removeUndefinedProperties**<`T`\>(`inputObj`): `T` #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends `object` | #### Parameters | Name | Type | | :------ | :------ | | `inputObj` | `T` | #### Returns `T` #### Defined in packages/medusa/dist/utils/remove-undefined-properties.d.ts:1 ___ ### requireCustomerAuthentication ▸ **requireCustomerAuthentication**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Returns `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Defined in packages/medusa/dist/api/middlewares/require-customer-authentication.d.ts:2 ___ ### reserveQuantityForDraftOrder ▸ **reserveQuantityForDraftOrder**(`order`, `context`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | | `order` | [`Order`](../classes/internal-3.Order.md) | | `context` | `Object` | | `context.locationId?` | `string` | | `context.productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | #### Returns `Promise`<`void`\> #### Defined in packages/medusa/dist/api/routes/admin/draft-orders/register-payment.d.ts:58 ___ ### resolveDbGenerationStrategy ▸ **resolveDbGenerationStrategy**(`pgSqlType`): ``"increment"`` \| ``"uuid"`` \| ``"rowid"`` #### Parameters | Name | Type | | :------ | :------ | | `pgSqlType` | ``"uuid"`` \| ``"rowid"`` \| ``"increment"`` | #### Returns ``"increment"`` \| ``"uuid"`` \| ``"rowid"`` #### Defined in packages/medusa/dist/utils/db-aware-column.d.ts:3 ___ ### resolveDbType ▸ **resolveDbType**(`pgSqlType`): `ColumnType` #### Parameters | Name | Type | | :------ | :------ | | `pgSqlType` | `ColumnType` | #### Returns `ColumnType` #### Defined in packages/medusa/dist/utils/db-aware-column.d.ts:2 ___ ### setMetadata ▸ **setMetadata**(`obj`, `metadata`): [`Record`](internal.md#record)<`string`, `unknown`\> Dedicated method to set metadata. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `obj` | `undefined` \| ``null`` \| { `metadata`: ``null`` \| [`Record`](internal.md#record)<`string`, `unknown`\> } | the entity to apply metadata to. | | `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> | the metadata to set | #### Returns [`Record`](internal.md#record)<`string`, `unknown`\> resolves to the updated result. #### Defined in packages/medusa/dist/utils/set-metadata.d.ts:7 ___ ### transformBody ▸ **transformBody**<`T`\>(`plainToClass`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> #### Type parameters | Name | | :------ | | `T` | #### Parameters | Name | Type | | :------ | :------ | | `plainToClass` | [`ClassConstructor`](internal-8.internal.md#classconstructor)<`T`\> | | `config?` | `ValidatorOptions` | #### Returns `fn` ▸ (`req`, `res`, `next`): `Promise`<`void`\> ##### Parameters | Name | Type | | :------ | :------ | | `req` | `Request` | | `res` | `Response` | | `next` | `NextFunction` | ##### Returns `Promise`<`void`\> #### Defined in packages/medusa/dist/api/middlewares/transform-body.d.ts:4 ___ ### transformIncludesOptions ▸ **transformIncludesOptions**(`allowedIncludes?`, `expectedIncludes?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `void` Retrieve the includes options from the fields query param. If the include option is present then assigned it to includes on req #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `allowedIncludes?` | `string`[] | The list of fields that can be passed and assign to req.includes | | `expectedIncludes?` | `string`[] | The list of fields that the consumer can pass to the end point using this middleware. It is a subset of `allowedIncludes` | #### Returns `fn` ▸ (`req`, `res`, `next`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `req` | `Request` | | `res` | `Response` | | `next` | `NextFunction` | ##### Returns `void` #### Defined in packages/medusa/dist/api/middlewares/transform-includes-options.d.ts:8 ___ ### transformQuery ▸ **transformQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> Middleware that transform the query input for the admin end points #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends [`RequestQueryFields`](internal-8.internal.md#requestqueryfields) | | `TEntity` | extends [`BaseEntity`](../classes/internal-1.BaseEntity.md) | #### Parameters | Name | Type | | :------ | :------ | | `plainToClass` | [`ClassConstructor`](internal-8.internal.md#classconstructor)<`T`\> | | `queryConfig?` | [`Omit`](internal-1.md#omit)<[`QueryConfig`](internal-8.internal.md#queryconfig)<`TEntity`\>, ``"allowedRelations"`` \| ``"allowedFields"``\> | | `config?` | `ValidatorOptions` | #### Returns `fn` ▸ (`req`, `res`, `next`): `Promise`<`void`\> ##### Parameters | Name | Type | | :------ | :------ | | `req` | `Request` | | `res` | `Response` | | `next` | `NextFunction` | ##### Returns `Promise`<`void`\> #### Defined in packages/medusa/dist/api/middlewares/transform-query.d.ts:12 ___ ### transformStoreQuery ▸ **transformStoreQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> Middleware that transform the query input for the store endpoints #### Type parameters | Name | Type | | :------ | :------ | | `T` | extends [`RequestQueryFields`](internal-8.internal.md#requestqueryfields) | | `TEntity` | extends [`BaseEntity`](../classes/internal-1.BaseEntity.md) | #### Parameters | Name | Type | | :------ | :------ | | `plainToClass` | [`ClassConstructor`](internal-8.internal.md#classconstructor)<`T`\> | | `queryConfig?` | [`QueryConfig`](internal-8.internal.md#queryconfig)<`TEntity`\> | | `config?` | `ValidatorOptions` | #### Returns `fn` ▸ (`req`, `res`, `next`): `Promise`<`void`\> ##### Parameters | Name | Type | | :------ | :------ | | `req` | `Request` | | `res` | `Response` | | `next` | `NextFunction` | ##### Returns `Promise`<`void`\> #### Defined in packages/medusa/dist/api/middlewares/transform-query.d.ts:19 ___ ### unauthenticatedInviteRoutes ▸ **unauthenticatedInviteRoutes**(`app`): `void` #### Parameters | Name | Type | | :------ | :------ | | `app` | `any` | #### Returns `void` #### Defined in packages/medusa/dist/api/routes/admin/invites/index.d.ts:4 ___ ### unauthenticatedUserRoutes ▸ **unauthenticatedUserRoutes**(`app`): `void` #### Parameters | Name | Type | | :------ | :------ | | `app` | `any` | #### Returns `void` #### Defined in packages/medusa/dist/api/routes/admin/users/index.d.ts:3 ___ ### updateInventoryAndReservations ▸ **updateInventoryAndReservations**(`fulfillments`, `context`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | | `fulfillments` | [`Fulfillment`](../classes/internal-3.Fulfillment.md)[] | | `context` | `Object` | | `context.inventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | | `context.locationId` | `string` | #### Returns `Promise`<`void`\> #### Defined in packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:85 ___ ### validateId ▸ **validateId**(`rawId`, `config?`): `string` #### Parameters | Name | Type | | :------ | :------ | | `rawId` | `string` | | `config?` | `Object` | | `config.length?` | `number` | | `config.prefix?` | `string` | #### Returns `string` #### Defined in packages/medusa/dist/utils/validate-id.d.ts:1 ___ ### validator ▸ **validator**<`T`, `V`\>(`typedClass`, `plain`, `config?`): `Promise`<`T`\> #### Type parameters | Name | | :------ | | `T` | | `V` | #### Parameters | Name | Type | | :------ | :------ | | `typedClass` | `ClassConstructor`<`T`\> | | `plain` | `V` | | `config?` | `ValidatorOptions` | #### Returns `Promise`<`T`\> #### Defined in packages/medusa/dist/utils/validator.d.ts:24 ___ ### wrapHandler ▸ **wrapHandler**(`fn`): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Parameters | Name | Type | | :------ | :------ | | `fn` | [`handler`](internal-8.md#handler) | #### Returns `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> #### Defined in packages/medusa/dist/api/middlewares/await-middleware.d.ts:3