asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
bd60efbe6578dce9a508c5885e9d3ce4f86c8f09
medusa-store/www/apps/docs/content/references/modules/medusa.mdx
Shahed Nasser ddc6cc13a0 docs: add TSDoc for payment processor + generate docs (#5917) 
* added tsdocs for payment processor

* generated reference for payment processor
2023-12-18 14:02:18 +02:00

16817 lines
522 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import ParameterTypes from "@site/src/components/ParameterTypes"
# medusa
## Namespaces
- ["medusa-interfaces"](../medusa/modules/medusa._medusa_interfaces_.mdx)
## Enumerations
- [BatchJobStatus](../medusa/enums/medusa.BatchJobStatus.mdx)
- [DefaultPriceType](../medusa/enums/medusa.DefaultPriceType.mdx)
- [MODULE\_RESOURCE\_TYPE](../medusa/enums/medusa.MODULE_RESOURCE_TYPE.mdx)
- [PostgresError](../medusa/enums/medusa.PostgresError.mdx)
- [PriceListStatus](../medusa/enums/medusa.PriceListStatus.mdx)
- [PriceListStatus](../medusa/enums/medusa.PriceListStatus-1.mdx)
- [PriceListType](../medusa/enums/medusa.PriceListType.mdx)
- [PriceListType](../medusa/enums/medusa.PriceListType-1.mdx)
- [ProductStatus](../medusa/enums/medusa.ProductStatus.mdx)
## Classes
- [AbstractBatchJobStrategy](../medusa/classes/medusa.AbstractBatchJobStrategy.mdx)
- [AbstractCartCompletionStrategy](../medusa/classes/medusa.AbstractCartCompletionStrategy.mdx)
- [AbstractFileService](../medusa/classes/medusa.AbstractFileService.mdx)
- [AbstractFulfillmentService](../medusa/classes/medusa.AbstractFulfillmentService.mdx)
- [AbstractNotificationService](../medusa/classes/medusa.AbstractNotificationService.mdx)
- [AbstractPaymentProcessor](../medusa/classes/medusa.AbstractPaymentProcessor.mdx)
- [AbstractPaymentService](../medusa/classes/medusa.AbstractPaymentService.mdx)
- [AbstractPriceSelectionStrategy](../medusa/classes/medusa.AbstractPriceSelectionStrategy.mdx)
- [AbstractTaxService](../medusa/classes/medusa.AbstractTaxService.mdx)
- [AdditionalItem](../medusa/classes/medusa.AdditionalItem.mdx)
- [AdditionalItem](../medusa/classes/medusa.AdditionalItem-1.mdx)
- [AdditionalItem](../medusa/classes/medusa.AdditionalItem-2.mdx)
- [AddressCreatePayload](../medusa/classes/medusa.AddressCreatePayload.mdx)
- [AddressPayload](../medusa/classes/medusa.AddressPayload.mdx)
- [AdminCreateCondition](../medusa/classes/medusa.AdminCreateCondition.mdx)
- [AdminCreateUserRequest](../medusa/classes/medusa.AdminCreateUserRequest.mdx)
- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../medusa/classes/medusa.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx)
- [AdminDeleteDiscountsDiscountConditionsConditionBatchParams](../medusa/classes/medusa.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.mdx)
- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../medusa/classes/medusa.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx)
- [AdminDeleteDiscountsDiscountConditionsConditionParams](../medusa/classes/medusa.AdminDeleteDiscountsDiscountConditionsConditionParams.mdx)
- [AdminDeletePriceListPricesPricesReq](../medusa/classes/medusa.AdminDeletePriceListPricesPricesReq.mdx)
- [AdminDeletePriceListsPriceListProductsPricesBatchReq](../medusa/classes/medusa.AdminDeletePriceListsPriceListProductsPricesBatchReq.mdx)
- [AdminDeleteProductCategoriesCategoryProductsBatchParams](../medusa/classes/medusa.AdminDeleteProductCategoriesCategoryProductsBatchParams.mdx)
- [AdminDeleteProductCategoriesCategoryProductsBatchReq](../medusa/classes/medusa.AdminDeleteProductCategoriesCategoryProductsBatchReq.mdx)
- [AdminDeleteProductsFromCollectionReq](../medusa/classes/medusa.AdminDeleteProductsFromCollectionReq.mdx)
- [AdminDeletePublishableApiKeySalesChannelsBatchReq](../medusa/classes/medusa.AdminDeletePublishableApiKeySalesChannelsBatchReq.mdx)
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../medusa/classes/medusa.AdminDeleteSalesChannelsChannelProductsBatchReq.mdx)
- [AdminDeleteSalesChannelsChannelStockLocationsReq](../medusa/classes/medusa.AdminDeleteSalesChannelsChannelStockLocationsReq.mdx)
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductTypesParams.mdx)
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductTypesReq.mdx)
- [AdminDeleteTaxRatesTaxRateProductsParams](../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductsParams.mdx)
- [AdminDeleteTaxRatesTaxRateProductsReq](../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateProductsReq.mdx)
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateShippingOptionsParams.mdx)
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../medusa/classes/medusa.AdminDeleteTaxRatesTaxRateShippingOptionsReq.mdx)
- [AdminDeleteUploadsReq](../medusa/classes/medusa.AdminDeleteUploadsReq.mdx)
- [AdminGetBatchPaginationParams](../medusa/classes/medusa.AdminGetBatchPaginationParams.mdx)
- [AdminGetBatchParams](../medusa/classes/medusa.AdminGetBatchParams.mdx)
- [AdminGetCollectionsPaginationParams](../medusa/classes/medusa.AdminGetCollectionsPaginationParams.mdx)
- [AdminGetCollectionsParams](../medusa/classes/medusa.AdminGetCollectionsParams.mdx)
- [AdminGetCurrenciesParams](../medusa/classes/medusa.AdminGetCurrenciesParams.mdx)
- [AdminGetCustomerGroupsGroupParams](../medusa/classes/medusa.AdminGetCustomerGroupsGroupParams.mdx)
- [AdminGetCustomerGroupsParams](../medusa/classes/medusa.AdminGetCustomerGroupsParams.mdx)
- [AdminGetCustomersParams](../medusa/classes/medusa.AdminGetCustomersParams.mdx)
- [AdminGetDiscountParams](../medusa/classes/medusa.AdminGetDiscountParams.mdx)
- [AdminGetDiscountsDiscountCodeParams](../medusa/classes/medusa.AdminGetDiscountsDiscountCodeParams.mdx)
- [AdminGetDiscountsDiscountConditionsConditionParams](../medusa/classes/medusa.AdminGetDiscountsDiscountConditionsConditionParams.mdx)
- [AdminGetDiscountsDiscountRuleParams](../medusa/classes/medusa.AdminGetDiscountsDiscountRuleParams.mdx)
- [AdminGetDiscountsParams](../medusa/classes/medusa.AdminGetDiscountsParams.mdx)
- [AdminGetDraftOrdersParams](../medusa/classes/medusa.AdminGetDraftOrdersParams.mdx)
- [AdminGetGiftCardsParams](../medusa/classes/medusa.AdminGetGiftCardsParams.mdx)
- [AdminGetInventoryItemsItemLocationLevelsParams](../medusa/classes/medusa.AdminGetInventoryItemsItemLocationLevelsParams.mdx)
- [AdminGetInventoryItemsItemParams](../medusa/classes/medusa.AdminGetInventoryItemsItemParams.mdx)
- [AdminGetInventoryItemsParams](../medusa/classes/medusa.AdminGetInventoryItemsParams.mdx)
- [AdminGetNotesParams](../medusa/classes/medusa.AdminGetNotesParams.mdx)
- [AdminGetNotificationsParams](../medusa/classes/medusa.AdminGetNotificationsParams.mdx)
- [AdminGetOrdersOrderParams](../medusa/classes/medusa.AdminGetOrdersOrderParams.mdx)
- [AdminGetOrdersParams](../medusa/classes/medusa.AdminGetOrdersParams.mdx)
- [AdminGetPaymentCollectionsParams](../medusa/classes/medusa.AdminGetPaymentCollectionsParams.mdx)
- [AdminGetPriceListPaginationParams](../medusa/classes/medusa.AdminGetPriceListPaginationParams.mdx)
- [AdminGetPriceListsPriceListProductsParams](../medusa/classes/medusa.AdminGetPriceListsPriceListProductsParams.mdx)
- [AdminGetProductCategoriesParams](../medusa/classes/medusa.AdminGetProductCategoriesParams.mdx)
- [AdminGetProductCategoryParams](../medusa/classes/medusa.AdminGetProductCategoryParams.mdx)
- [AdminGetProductParams](../medusa/classes/medusa.AdminGetProductParams.mdx)
- [AdminGetProductTagsPaginationParams](../medusa/classes/medusa.AdminGetProductTagsPaginationParams.mdx)
- [AdminGetProductTagsParams](../medusa/classes/medusa.AdminGetProductTagsParams.mdx)
- [AdminGetProductTypesParams](../medusa/classes/medusa.AdminGetProductTypesParams.mdx)
- [AdminGetProductsParams](../medusa/classes/medusa.AdminGetProductsParams.mdx)
- [AdminGetProductsVariantsParams](../medusa/classes/medusa.AdminGetProductsVariantsParams.mdx)
- [AdminGetRegionsParams](../medusa/classes/medusa.AdminGetRegionsParams.mdx)
- [AdminGetRegionsRegionFulfillmentOptionsRes](../medusa/classes/medusa.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)
- [AdminGetReservationsParams](../medusa/classes/medusa.AdminGetReservationsParams.mdx)
- [AdminGetReturnsParams](../medusa/classes/medusa.AdminGetReturnsParams.mdx)
- [AdminGetSalesChannelsParams](../medusa/classes/medusa.AdminGetSalesChannelsParams.mdx)
- [AdminGetShippingOptionsParams](../medusa/classes/medusa.AdminGetShippingOptionsParams.mdx)
- [AdminGetStockLocationsLocationParams](../medusa/classes/medusa.AdminGetStockLocationsLocationParams.mdx)
- [AdminGetStockLocationsParams](../medusa/classes/medusa.AdminGetStockLocationsParams.mdx)
- [AdminGetSwapsParams](../medusa/classes/medusa.AdminGetSwapsParams.mdx)
- [AdminGetTaxRatesParams](../medusa/classes/medusa.AdminGetTaxRatesParams.mdx)
- [AdminGetTaxRatesTaxRateParams](../medusa/classes/medusa.AdminGetTaxRatesTaxRateParams.mdx)
- [AdminGetVariantParams](../medusa/classes/medusa.AdminGetVariantParams.mdx)
- [AdminGetVariantsParams](../medusa/classes/medusa.AdminGetVariantsParams.mdx)
- [AdminListCustomerSelector](../medusa/classes/medusa.AdminListCustomerSelector.mdx)
- [AdminListOrdersSelector](../medusa/classes/medusa.AdminListOrdersSelector.mdx)
- [AdminPostAnalyticsConfigAnalyticsConfigReq](../medusa/classes/medusa.AdminPostAnalyticsConfigAnalyticsConfigReq.mdx)
- [AdminPostAnalyticsConfigReq](../medusa/classes/medusa.AdminPostAnalyticsConfigReq.mdx)
- [AdminPostAuthReq](../medusa/classes/medusa.AdminPostAuthReq.mdx)
- [AdminPostBatchesReq](../medusa/classes/medusa.AdminPostBatchesReq.mdx)
- [AdminPostCollectionsCollectionReq](../medusa/classes/medusa.AdminPostCollectionsCollectionReq.mdx)
- [AdminPostCollectionsReq](../medusa/classes/medusa.AdminPostCollectionsReq.mdx)
- [AdminPostCurrenciesCurrencyReq](../medusa/classes/medusa.AdminPostCurrenciesCurrencyReq.mdx)
- [AdminPostCustomerGroupsGroupCustomersBatchReq](../medusa/classes/medusa.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx)
- [AdminPostCustomerGroupsGroupReq](../medusa/classes/medusa.AdminPostCustomerGroupsGroupReq.mdx)
- [AdminPostCustomerGroupsReq](../medusa/classes/medusa.AdminPostCustomerGroupsReq.mdx)
- [AdminPostCustomersCustomerReq](../medusa/classes/medusa.AdminPostCustomersCustomerReq.mdx)
- [AdminPostCustomersReq](../medusa/classes/medusa.AdminPostCustomersReq.mdx)
- [AdminPostDiscountsDiscountConditions](../medusa/classes/medusa.AdminPostDiscountsDiscountConditions.mdx)
- [AdminPostDiscountsDiscountConditionsCondition](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsCondition.mdx)
- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx)
- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx)
- [AdminPostDiscountsDiscountConditionsConditionParams](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsConditionParams.mdx)
- [AdminPostDiscountsDiscountConditionsParams](../medusa/classes/medusa.AdminPostDiscountsDiscountConditionsParams.mdx)
- [AdminPostDiscountsDiscountDynamicCodesReq](../medusa/classes/medusa.AdminPostDiscountsDiscountDynamicCodesReq.mdx)
- [AdminPostDiscountsDiscountParams](../medusa/classes/medusa.AdminPostDiscountsDiscountParams.mdx)
- [AdminPostDiscountsDiscountReq](../medusa/classes/medusa.AdminPostDiscountsDiscountReq.mdx)
- [AdminPostDiscountsDiscountRule](../medusa/classes/medusa.AdminPostDiscountsDiscountRule.mdx)
- [AdminPostDiscountsParams](../medusa/classes/medusa.AdminPostDiscountsParams.mdx)
- [AdminPostDiscountsReq](../medusa/classes/medusa.AdminPostDiscountsReq.mdx)
- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../medusa/classes/medusa.AdminPostDraftOrdersDraftOrderLineItemsItemReq.mdx)
- [AdminPostDraftOrdersDraftOrderLineItemsReq](../medusa/classes/medusa.AdminPostDraftOrdersDraftOrderLineItemsReq.mdx)
- [AdminPostDraftOrdersDraftOrderReq](../medusa/classes/medusa.AdminPostDraftOrdersDraftOrderReq.mdx)
- [AdminPostDraftOrdersReq](../medusa/classes/medusa.AdminPostDraftOrdersReq.mdx)
- [AdminPostGiftCardsGiftCardReq](../medusa/classes/medusa.AdminPostGiftCardsGiftCardReq.mdx)
- [AdminPostGiftCardsReq](../medusa/classes/medusa.AdminPostGiftCardsReq.mdx)
- [AdminPostInventoryItemsInventoryItemParams](../medusa/classes/medusa.AdminPostInventoryItemsInventoryItemParams.mdx)
- [AdminPostInventoryItemsInventoryItemReq](../medusa/classes/medusa.AdminPostInventoryItemsInventoryItemReq.mdx)
- [AdminPostInventoryItemsItemLocationLevelsLevelParams](../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsLevelParams.mdx)
- [AdminPostInventoryItemsItemLocationLevelsLevelReq](../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsLevelReq.mdx)
- [AdminPostInventoryItemsItemLocationLevelsParams](../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsParams.mdx)
- [AdminPostInventoryItemsItemLocationLevelsReq](../medusa/classes/medusa.AdminPostInventoryItemsItemLocationLevelsReq.mdx)
- [AdminPostInventoryItemsParams](../medusa/classes/medusa.AdminPostInventoryItemsParams.mdx)
- [AdminPostInventoryItemsReq](../medusa/classes/medusa.AdminPostInventoryItemsReq.mdx)
- [AdminPostInvitesInviteAcceptReq](../medusa/classes/medusa.AdminPostInvitesInviteAcceptReq.mdx)
- [AdminPostInvitesInviteAcceptUserReq](../medusa/classes/medusa.AdminPostInvitesInviteAcceptUserReq.mdx)
- [AdminPostInvitesReq](../medusa/classes/medusa.AdminPostInvitesReq.mdx)
- [AdminPostNotesNoteReq](../medusa/classes/medusa.AdminPostNotesNoteReq.mdx)
- [AdminPostNotesReq](../medusa/classes/medusa.AdminPostNotesReq.mdx)
- [AdminPostNotificationsNotificationResendReq](../medusa/classes/medusa.AdminPostNotificationsNotificationResendReq.mdx)
- [AdminPostOrderEditsEditLineItemsLineItemReq](../medusa/classes/medusa.AdminPostOrderEditsEditLineItemsLineItemReq.mdx)
- [AdminPostOrderEditsEditLineItemsReq](../medusa/classes/medusa.AdminPostOrderEditsEditLineItemsReq.mdx)
- [AdminPostOrderEditsOrderEditReq](../medusa/classes/medusa.AdminPostOrderEditsOrderEditReq.mdx)
- [AdminPostOrderEditsReq](../medusa/classes/medusa.AdminPostOrderEditsReq.mdx)
- [AdminPostOrderEditsRequestConfirmationReq](../medusa/classes/medusa.AdminPostOrderEditsRequestConfirmationReq.mdx)
- [AdminPostOrdersClaimCancel](../medusa/classes/medusa.AdminPostOrdersClaimCancel.mdx)
- [AdminPostOrdersClaimFulfillmentsCancelParams](../medusa/classes/medusa.AdminPostOrdersClaimFulfillmentsCancelParams.mdx)
- [AdminPostOrdersOrderArchiveParams](../medusa/classes/medusa.AdminPostOrdersOrderArchiveParams.mdx)
- [AdminPostOrdersOrderCancel](../medusa/classes/medusa.AdminPostOrdersOrderCancel.mdx)
- [AdminPostOrdersOrderCaptureParams](../medusa/classes/medusa.AdminPostOrdersOrderCaptureParams.mdx)
- [AdminPostOrdersOrderClaimsClaimFulfillmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.mdx)
- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx)
- [AdminPostOrdersOrderClaimsClaimParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimParams.mdx)
- [AdminPostOrdersOrderClaimsClaimReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimReq.mdx)
- [AdminPostOrdersOrderClaimsClaimShipmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsParams.mdx)
- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx)
- [AdminPostOrdersOrderClaimsParams](../medusa/classes/medusa.AdminPostOrdersOrderClaimsParams.mdx)
- [AdminPostOrdersOrderClaimsReq](../medusa/classes/medusa.AdminPostOrdersOrderClaimsReq.mdx)
- [AdminPostOrdersOrderCompleteParams](../medusa/classes/medusa.AdminPostOrdersOrderCompleteParams.mdx)
- [AdminPostOrdersOrderFulfillementsCancelParams](../medusa/classes/medusa.AdminPostOrdersOrderFulfillementsCancelParams.mdx)
- [AdminPostOrdersOrderFulfillmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderFulfillmentsParams.mdx)
- [AdminPostOrdersOrderFulfillmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderFulfillmentsReq.mdx)
- [AdminPostOrdersOrderParams](../medusa/classes/medusa.AdminPostOrdersOrderParams.mdx)
- [AdminPostOrdersOrderRefundsParams](../medusa/classes/medusa.AdminPostOrdersOrderRefundsParams.mdx)
- [AdminPostOrdersOrderRefundsReq](../medusa/classes/medusa.AdminPostOrdersOrderRefundsReq.mdx)
- [AdminPostOrdersOrderReq](../medusa/classes/medusa.AdminPostOrdersOrderReq.mdx)
- [AdminPostOrdersOrderReturnsParams](../medusa/classes/medusa.AdminPostOrdersOrderReturnsParams.mdx)
- [AdminPostOrdersOrderReturnsReq](../medusa/classes/medusa.AdminPostOrdersOrderReturnsReq.mdx)
- [AdminPostOrdersOrderShipmentParams](../medusa/classes/medusa.AdminPostOrdersOrderShipmentParams.mdx)
- [AdminPostOrdersOrderShipmentReq](../medusa/classes/medusa.AdminPostOrdersOrderShipmentReq.mdx)
- [AdminPostOrdersOrderShippingMethodsParams](../medusa/classes/medusa.AdminPostOrdersOrderShippingMethodsParams.mdx)
- [AdminPostOrdersOrderShippingMethodsReq](../medusa/classes/medusa.AdminPostOrdersOrderShippingMethodsReq.mdx)
- [AdminPostOrdersOrderSwapFulfillementsCancelParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapFulfillementsCancelParams.mdx)
- [AdminPostOrdersOrderSwapsParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapsParams.mdx)
- [AdminPostOrdersOrderSwapsReq](../medusa/classes/medusa.AdminPostOrdersOrderSwapsReq.mdx)
- [AdminPostOrdersOrderSwapsSwapFulfillmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.mdx)
- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx)
- [AdminPostOrdersOrderSwapsSwapProcessPaymentParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.mdx)
- [AdminPostOrdersOrderSwapsSwapShipmentsParams](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsParams.mdx)
- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx)
- [AdminPostOrdersSwapCancelParams](../medusa/classes/medusa.AdminPostOrdersSwapCancelParams.mdx)
- [AdminPostPaymentRefundsReq](../medusa/classes/medusa.AdminPostPaymentRefundsReq.mdx)
- [AdminPostPriceListPricesPricesReq](../medusa/classes/medusa.AdminPostPriceListPricesPricesReq.mdx)
- [AdminPostPriceListsPriceListPriceListReq](../medusa/classes/medusa.AdminPostPriceListsPriceListPriceListReq.mdx)
- [AdminPostPriceListsPriceListReq](../medusa/classes/medusa.AdminPostPriceListsPriceListReq.mdx)
- [AdminPostProductCategoriesCategoryParams](../medusa/classes/medusa.AdminPostProductCategoriesCategoryParams.mdx)
- [AdminPostProductCategoriesCategoryProductsBatchParams](../medusa/classes/medusa.AdminPostProductCategoriesCategoryProductsBatchParams.mdx)
- [AdminPostProductCategoriesCategoryProductsBatchReq](../medusa/classes/medusa.AdminPostProductCategoriesCategoryProductsBatchReq.mdx)
- [AdminPostProductCategoriesCategoryReq](../medusa/classes/medusa.AdminPostProductCategoriesCategoryReq.mdx)
- [AdminPostProductCategoriesParams](../medusa/classes/medusa.AdminPostProductCategoriesParams.mdx)
- [AdminPostProductCategoriesReq](../medusa/classes/medusa.AdminPostProductCategoriesReq.mdx)
- [AdminPostProductsProductMetadataReq](../medusa/classes/medusa.AdminPostProductsProductMetadataReq.mdx)
- [AdminPostProductsProductOptionsOption](../medusa/classes/medusa.AdminPostProductsProductOptionsOption.mdx)
- [AdminPostProductsProductOptionsReq](../medusa/classes/medusa.AdminPostProductsProductOptionsReq.mdx)
- [AdminPostProductsProductReq](../medusa/classes/medusa.AdminPostProductsProductReq.mdx)
- [AdminPostProductsProductVariantsReq](../medusa/classes/medusa.AdminPostProductsProductVariantsReq.mdx)
- [AdminPostProductsProductVariantsVariantReq](../medusa/classes/medusa.AdminPostProductsProductVariantsVariantReq.mdx)
- [AdminPostProductsReq](../medusa/classes/medusa.AdminPostProductsReq.mdx)
- [AdminPostProductsToCollectionReq](../medusa/classes/medusa.AdminPostProductsToCollectionReq.mdx)
- [AdminPostPublishableApiKeySalesChannelsBatchReq](../medusa/classes/medusa.AdminPostPublishableApiKeySalesChannelsBatchReq.mdx)
- [AdminPostPublishableApiKeysPublishableApiKeyReq](../medusa/classes/medusa.AdminPostPublishableApiKeysPublishableApiKeyReq.mdx)
- [AdminPostPublishableApiKeysReq](../medusa/classes/medusa.AdminPostPublishableApiKeysReq.mdx)
- [AdminPostRegionsRegionCountriesReq](../medusa/classes/medusa.AdminPostRegionsRegionCountriesReq.mdx)
- [AdminPostRegionsRegionFulfillmentProvidersReq](../medusa/classes/medusa.AdminPostRegionsRegionFulfillmentProvidersReq.mdx)
- [AdminPostRegionsRegionPaymentProvidersReq](../medusa/classes/medusa.AdminPostRegionsRegionPaymentProvidersReq.mdx)
- [AdminPostRegionsRegionReq](../medusa/classes/medusa.AdminPostRegionsRegionReq.mdx)
- [AdminPostRegionsReq](../medusa/classes/medusa.AdminPostRegionsReq.mdx)
- [AdminPostReservationsReq](../medusa/classes/medusa.AdminPostReservationsReq.mdx)
- [AdminPostReservationsReservationReq](../medusa/classes/medusa.AdminPostReservationsReservationReq.mdx)
- [AdminPostReturnReasonsReasonReq](../medusa/classes/medusa.AdminPostReturnReasonsReasonReq.mdx)
- [AdminPostReturnReasonsReq](../medusa/classes/medusa.AdminPostReturnReasonsReq.mdx)
- [AdminPostReturnsReturnReceiveReq](../medusa/classes/medusa.AdminPostReturnsReturnReceiveReq.mdx)
- [AdminPostSalesChannelsChannelProductsBatchReq](../medusa/classes/medusa.AdminPostSalesChannelsChannelProductsBatchReq.mdx)
- [AdminPostSalesChannelsChannelStockLocationsReq](../medusa/classes/medusa.AdminPostSalesChannelsChannelStockLocationsReq.mdx)
- [AdminPostSalesChannelsReq](../medusa/classes/medusa.AdminPostSalesChannelsReq.mdx)
- [AdminPostSalesChannelsSalesChannelReq](../medusa/classes/medusa.AdminPostSalesChannelsSalesChannelReq.mdx)
- [AdminPostShippingOptionsOptionReq](../medusa/classes/medusa.AdminPostShippingOptionsOptionReq.mdx)
- [AdminPostShippingOptionsReq](../medusa/classes/medusa.AdminPostShippingOptionsReq.mdx)
- [AdminPostShippingProfilesProfileReq](../medusa/classes/medusa.AdminPostShippingProfilesProfileReq.mdx)
- [AdminPostShippingProfilesReq](../medusa/classes/medusa.AdminPostShippingProfilesReq.mdx)
- [AdminPostStockLocationsLocationParams](../medusa/classes/medusa.AdminPostStockLocationsLocationParams.mdx)
- [AdminPostStockLocationsLocationReq](../medusa/classes/medusa.AdminPostStockLocationsLocationReq.mdx)
- [AdminPostStockLocationsParams](../medusa/classes/medusa.AdminPostStockLocationsParams.mdx)
- [AdminPostStockLocationsReq](../medusa/classes/medusa.AdminPostStockLocationsReq.mdx)
- [AdminPostStoreReq](../medusa/classes/medusa.AdminPostStoreReq.mdx)
- [AdminPostTaxRatesParams](../medusa/classes/medusa.AdminPostTaxRatesParams.mdx)
- [AdminPostTaxRatesReq](../medusa/classes/medusa.AdminPostTaxRatesReq.mdx)
- [AdminPostTaxRatesTaxRateParams](../medusa/classes/medusa.AdminPostTaxRatesTaxRateParams.mdx)
- [AdminPostTaxRatesTaxRateProductTypesParams](../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductTypesParams.mdx)
- [AdminPostTaxRatesTaxRateProductTypesReq](../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductTypesReq.mdx)
- [AdminPostTaxRatesTaxRateProductsParams](../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductsParams.mdx)
- [AdminPostTaxRatesTaxRateProductsReq](../medusa/classes/medusa.AdminPostTaxRatesTaxRateProductsReq.mdx)
- [AdminPostTaxRatesTaxRateReq](../medusa/classes/medusa.AdminPostTaxRatesTaxRateReq.mdx)
- [AdminPostTaxRatesTaxRateShippingOptionsParams](../medusa/classes/medusa.AdminPostTaxRatesTaxRateShippingOptionsParams.mdx)
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../medusa/classes/medusa.AdminPostTaxRatesTaxRateShippingOptionsReq.mdx)
- [AdminPostUploadsDownloadUrlReq](../medusa/classes/medusa.AdminPostUploadsDownloadUrlReq.mdx)
- [AdminPriceListPricesCreateReq](../medusa/classes/medusa.AdminPriceListPricesCreateReq.mdx)
- [AdminPriceListPricesUpdateReq](../medusa/classes/medusa.AdminPriceListPricesUpdateReq.mdx)
- [AdminPriceSelectionParams](../medusa/classes/medusa.AdminPriceSelectionParams.mdx)
- [AdminProductCategoriesReqBase](../medusa/classes/medusa.AdminProductCategoriesReqBase.mdx)
- [AdminResetPasswordRequest](../medusa/classes/medusa.AdminResetPasswordRequest.mdx)
- [AdminResetPasswordTokenRequest](../medusa/classes/medusa.AdminResetPasswordTokenRequest.mdx)
- [AdminUpdateDiscountRule](../medusa/classes/medusa.AdminUpdateDiscountRule.mdx)
- [AdminUpdatePaymentCollectionsReq](../medusa/classes/medusa.AdminUpdatePaymentCollectionsReq.mdx)
- [AdminUpdateUserRequest](../medusa/classes/medusa.AdminUpdateUserRequest.mdx)
- [AdminUpsertCondition](../medusa/classes/medusa.AdminUpsertCondition.mdx)
- [AdminUpsertConditionsReq](../medusa/classes/medusa.AdminUpsertConditionsReq.mdx)
- [CustomShippingOption](../medusa/classes/medusa.CustomShippingOption.mdx)
- [CustomerGroup](../medusa/classes/medusa.CustomerGroup.mdx)
- [CustomerGroup](../medusa/classes/medusa.CustomerGroup-1.mdx)
- [CustomerGroupsBatchCustomer](../medusa/classes/medusa.CustomerGroupsBatchCustomer.mdx)
- [DateComparisonOperator](../medusa/classes/medusa.DateComparisonOperator.mdx)
- [Discount](../medusa/classes/medusa.Discount.mdx)
- [Discount](../medusa/classes/medusa.Discount-1.mdx)
- [Discount](../medusa/classes/medusa.Discount-2.mdx)
- [EmptyQueryParams](../medusa/classes/medusa.EmptyQueryParams.mdx)
- [FilterableBatchJobProps](../medusa/classes/medusa.FilterableBatchJobProps.mdx)
- [FilterableCustomerGroupProps](../medusa/classes/medusa.FilterableCustomerGroupProps.mdx)
- [FilterablePriceListProps](../medusa/classes/medusa.FilterablePriceListProps.mdx)
- [FilterableProductProps](../medusa/classes/medusa.FilterableProductProps.mdx)
- [FindPaginationParams](../medusa/classes/medusa.FindPaginationParams.mdx)
- [FindParams](../medusa/classes/medusa.FindParams.mdx)
- [FulfillmentOption](../medusa/classes/medusa.FulfillmentOption.mdx)
- [GetOrderEditsOrderEditParams](../medusa/classes/medusa.GetOrderEditsOrderEditParams.mdx)
- [GetOrderEditsParams](../medusa/classes/medusa.GetOrderEditsParams.mdx)
- [GetPaymentsParams](../medusa/classes/medusa.GetPaymentsParams.mdx)
- [GetPublishableApiKeySalesChannelsParams](../medusa/classes/medusa.GetPublishableApiKeySalesChannelsParams.mdx)
- [GetPublishableApiKeysParams](../medusa/classes/medusa.GetPublishableApiKeysParams.mdx)
- [GiftCard](../medusa/classes/medusa.GiftCard.mdx)
- [Group](../medusa/classes/medusa.Group.mdx)
- [IAdminPostUploadsFileReq](../medusa/classes/medusa.IAdminPostUploadsFileReq.mdx)
- [Image](../medusa/classes/medusa.Image.mdx)
- [Item](../medusa/classes/medusa.Item.mdx)
- [Item](../medusa/classes/medusa.Item-1.mdx)
- [Item](../medusa/classes/medusa.Item-2.mdx)
- [Item](../medusa/classes/medusa.Item-3.mdx)
- [Item](../medusa/classes/medusa.Item-4.mdx)
- [Item](../medusa/classes/medusa.Item-5.mdx)
- [Item](../medusa/classes/medusa.Item-6.mdx)
- [Item](../medusa/classes/medusa.Item-7.mdx)
- [MedusaError](../medusa/classes/medusa.MedusaError.mdx)
- [NumericalComparisonOperator](../medusa/classes/medusa.NumericalComparisonOperator.mdx)
- [OptionRequirement](../medusa/classes/medusa.OptionRequirement.mdx)
- [OptionRequirement](../medusa/classes/medusa.OptionRequirement-1.mdx)
- [OrdersReturnItem](../medusa/classes/medusa.OrdersReturnItem.mdx)
- [PaymentMethod](../medusa/classes/medusa.PaymentMethod.mdx)
- [PriceSelectionParams](../medusa/classes/medusa.PriceSelectionParams.mdx)
- [ProductBatchProductCategory](../medusa/classes/medusa.ProductBatchProductCategory.mdx)
- [ProductBatchSalesChannel](../medusa/classes/medusa.ProductBatchSalesChannel.mdx)
- [ProductOptionReq](../medusa/classes/medusa.ProductOptionReq.mdx)
- [ProductProductCategoryReq](../medusa/classes/medusa.ProductProductCategoryReq.mdx)
- [ProductSalesChannelReq](../medusa/classes/medusa.ProductSalesChannelReq.mdx)
- [ProductTagReq](../medusa/classes/medusa.ProductTagReq.mdx)
- [ProductTypeReq](../medusa/classes/medusa.ProductTypeReq.mdx)
- [ProductVariantOptionReq](../medusa/classes/medusa.ProductVariantOptionReq.mdx)
- [ProductVariantOptionReq](../medusa/classes/medusa.ProductVariantOptionReq-1.mdx)
- [ProductVariantOptionReq](../medusa/classes/medusa.ProductVariantOptionReq-2.mdx)
- [ProductVariantOptionReq](../medusa/classes/medusa.ProductVariantOptionReq-3.mdx)
- [ProductVariantPricesCreateReq](../medusa/classes/medusa.ProductVariantPricesCreateReq.mdx)
- [ProductVariantPricesUpdateReq](../medusa/classes/medusa.ProductVariantPricesUpdateReq.mdx)
- [ProductVariantReq](../medusa/classes/medusa.ProductVariantReq.mdx)
- [ProductVariantReq](../medusa/classes/medusa.ProductVariantReq-1.mdx)
- [ReturnItem](../medusa/classes/medusa.ReturnItem.mdx)
- [ReturnShipping](../medusa/classes/medusa.ReturnShipping.mdx)
- [ReturnShipping](../medusa/classes/medusa.ReturnShipping-1.mdx)
- [ReturnShipping](../medusa/classes/medusa.ReturnShipping-2.mdx)
- [ReturnShipping](../medusa/classes/medusa.ReturnShipping-3.mdx)
- [ShippingAddressPayload](../medusa/classes/medusa.ShippingAddressPayload.mdx)
- [ShippingMethod](../medusa/classes/medusa.ShippingMethod.mdx)
- [ShippingMethod](../medusa/classes/medusa.ShippingMethod-1.mdx)
- [ShippingMethod](../medusa/classes/medusa.ShippingMethod-2.mdx)
- [ShippingMethod](../medusa/classes/medusa.ShippingMethod-3.mdx)
- [StockLocationAddress](../medusa/classes/medusa.StockLocationAddress.mdx)
- [StockLocationAddress](../medusa/classes/medusa.StockLocationAddress-1.mdx)
- [StoreGetCollectionsParams](../medusa/classes/medusa.StoreGetCollectionsParams.mdx)
- [StoreGetCustomersCustomerOrdersPaginationParams](../medusa/classes/medusa.StoreGetCustomersCustomerOrdersPaginationParams.mdx)
- [StoreGetCustomersCustomerOrdersParams](../medusa/classes/medusa.StoreGetCustomersCustomerOrdersParams.mdx)
- [StoreGetOrdersParams](../medusa/classes/medusa.StoreGetOrdersParams.mdx)
- [StoreGetPaymentCollectionsParams](../medusa/classes/medusa.StoreGetPaymentCollectionsParams.mdx)
- [StoreGetProductCategoriesCategoryParams](../medusa/classes/medusa.StoreGetProductCategoriesCategoryParams.mdx)
- [StoreGetProductCategoriesParams](../medusa/classes/medusa.StoreGetProductCategoriesParams.mdx)
- [StoreGetProductTagsParams](../medusa/classes/medusa.StoreGetProductTagsParams.mdx)
- [StoreGetProductTypesParams](../medusa/classes/medusa.StoreGetProductTypesParams.mdx)
- [StoreGetProductsPaginationParams](../medusa/classes/medusa.StoreGetProductsPaginationParams.mdx)
- [StoreGetProductsParams](../medusa/classes/medusa.StoreGetProductsParams.mdx)
- [StoreGetRegionsParams](../medusa/classes/medusa.StoreGetRegionsParams.mdx)
- [StoreGetRegionsRegionParams](../medusa/classes/medusa.StoreGetRegionsRegionParams.mdx)
- [StoreGetShippingOptionsParams](../medusa/classes/medusa.StoreGetShippingOptionsParams.mdx)
- [StoreGetVariantsParams](../medusa/classes/medusa.StoreGetVariantsParams.mdx)
- [StoreGetVariantsVariantParams](../medusa/classes/medusa.StoreGetVariantsVariantParams.mdx)
- [StorePaymentCollectionSessionsReq](../medusa/classes/medusa.StorePaymentCollectionSessionsReq.mdx)
- [StorePostAuthReq](../medusa/classes/medusa.StorePostAuthReq.mdx)
- [StorePostCartReq](../medusa/classes/medusa.StorePostCartReq.mdx)
- [StorePostCartsCartLineItemsItemReq](../medusa/classes/medusa.StorePostCartsCartLineItemsItemReq.mdx)
- [StorePostCartsCartLineItemsReq](../medusa/classes/medusa.StorePostCartsCartLineItemsReq.mdx)
- [StorePostCartsCartPaymentSessionReq](../medusa/classes/medusa.StorePostCartsCartPaymentSessionReq.mdx)
- [StorePostCartsCartPaymentSessionUpdateReq](../medusa/classes/medusa.StorePostCartsCartPaymentSessionUpdateReq.mdx)
- [StorePostCartsCartReq](../medusa/classes/medusa.StorePostCartsCartReq.mdx)
- [StorePostCartsCartShippingMethodReq](../medusa/classes/medusa.StorePostCartsCartShippingMethodReq.mdx)
- [StorePostCustomersCustomerAcceptClaimReq](../medusa/classes/medusa.StorePostCustomersCustomerAcceptClaimReq.mdx)
- [StorePostCustomersCustomerAddressesAddressReq](../medusa/classes/medusa.StorePostCustomersCustomerAddressesAddressReq.mdx)
- [StorePostCustomersCustomerAddressesReq](../medusa/classes/medusa.StorePostCustomersCustomerAddressesReq.mdx)
- [StorePostCustomersCustomerOrderClaimReq](../medusa/classes/medusa.StorePostCustomersCustomerOrderClaimReq.mdx)
- [StorePostCustomersCustomerPasswordTokenReq](../medusa/classes/medusa.StorePostCustomersCustomerPasswordTokenReq.mdx)
- [StorePostCustomersCustomerReq](../medusa/classes/medusa.StorePostCustomersCustomerReq.mdx)
- [StorePostCustomersReq](../medusa/classes/medusa.StorePostCustomersReq.mdx)
- [StorePostCustomersResetPasswordReq](../medusa/classes/medusa.StorePostCustomersResetPasswordReq.mdx)
- [StorePostOrderEditsOrderEditDecline](../medusa/classes/medusa.StorePostOrderEditsOrderEditDecline.mdx)
- [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../medusa/classes/medusa.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.mdx)
- [StorePostPaymentCollectionsBatchSessionsReq](../medusa/classes/medusa.StorePostPaymentCollectionsBatchSessionsReq.mdx)
- [StorePostPaymentCollectionsSessionsReq](../medusa/classes/medusa.StorePostPaymentCollectionsSessionsReq.mdx)
- [StorePostReturnsReq](../medusa/classes/medusa.StorePostReturnsReq.mdx)
- [StorePostSearchReq](../medusa/classes/medusa.StorePostSearchReq.mdx)
- [StorePostSwapsReq](../medusa/classes/medusa.StorePostSwapsReq.mdx)
- [StringComparisonOperator](../medusa/classes/medusa.StringComparisonOperator.mdx)
- [Tag](../medusa/classes/medusa.Tag.mdx)
- [TransactionBaseService](../medusa/classes/medusa.TransactionBaseService.mdx)
## Interfaces
- [CustomFindOptions](../medusa/interfaces/medusa.CustomFindOptions.mdx)
- [DeleteResponse](../medusa/interfaces/medusa.DeleteResponse.mdx)
- [FindConfig](../medusa/interfaces/medusa.FindConfig.mdx)
- [FulfillmentService](../medusa/interfaces/medusa.FulfillmentService.mdx)
- [IBatchJobStrategy](../medusa/interfaces/medusa.IBatchJobStrategy.mdx)
- [ICartCompletionStrategy](../medusa/interfaces/medusa.ICartCompletionStrategy.mdx)
- [IFileService](../medusa/interfaces/medusa.IFileService.mdx)
- [INotificationService](../medusa/interfaces/medusa.INotificationService.mdx)
- [IPriceSelectionStrategy](../medusa/interfaces/medusa.IPriceSelectionStrategy.mdx)
- [ITaxCalculationStrategy](../medusa/interfaces/medusa.ITaxCalculationStrategy.mdx)
- [ITaxService](../medusa/interfaces/medusa.ITaxService.mdx)
- [ITransactionBaseService](../medusa/interfaces/medusa.ITransactionBaseService.mdx)
- [JoinerServiceConfig](../medusa/interfaces/medusa.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../medusa/interfaces/medusa.JoinerServiceConfigAlias.mdx)
- [MedusaRequest](../medusa/interfaces/medusa.MedusaRequest.mdx)
- [PaginatedResponse](../medusa/interfaces/medusa.PaginatedResponse.mdx)
- [PaymentProcessor](../medusa/interfaces/medusa.PaymentProcessor.mdx)
- [PaymentProcessorContext](../medusa/interfaces/medusa.PaymentProcessorContext.mdx)
- [PaymentProcessorError](../medusa/interfaces/medusa.PaymentProcessorError.mdx)
- [PaymentProcessorSessionResponse](../medusa/interfaces/medusa.PaymentProcessorSessionResponse.mdx)
- [PaymentService](../medusa/interfaces/medusa.PaymentService.mdx)
- [ProductCategoryDTO](../medusa/interfaces/medusa.ProductCategoryDTO.mdx)
- [ProductCollectionDTO](../medusa/interfaces/medusa.ProductCollectionDTO.mdx)
- [ProductDTO](../medusa/interfaces/medusa.ProductDTO.mdx)
- [ProductImageDTO](../medusa/interfaces/medusa.ProductImageDTO.mdx)
- [ProductOptionDTO](../medusa/interfaces/medusa.ProductOptionDTO.mdx)
- [ProductOptionValueDTO](../medusa/interfaces/medusa.ProductOptionValueDTO.mdx)
- [ProductTagDTO](../medusa/interfaces/medusa.ProductTagDTO.mdx)
- [ProductTypeDTO](../medusa/interfaces/medusa.ProductTypeDTO.mdx)
- [ProductVariantDTO](../medusa/interfaces/medusa.ProductVariantDTO.mdx)
- [RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)
- [SubscriberContext](../medusa/interfaces/medusa.SubscriberContext.mdx)
## Type Aliases
- [AdminAnalyticsConfigDeleteRes](../medusa/types/medusa.AdminAnalyticsConfigDeleteRes.mdx)
- [AdminAnalyticsConfigRes](../medusa/types/medusa.AdminAnalyticsConfigRes.mdx)
- [AdminAuthRes](../medusa/types/medusa.AdminAuthRes.mdx)
- [AdminBatchJobListRes](../medusa/types/medusa.AdminBatchJobListRes.mdx)
- [AdminBatchJobRes](../medusa/types/medusa.AdminBatchJobRes.mdx)
- [AdminBearerAuthRes](../medusa/types/medusa.AdminBearerAuthRes.mdx)
- [AdminCollectionsDeleteRes](../medusa/types/medusa.AdminCollectionsDeleteRes.mdx)
- [AdminCollectionsListRes](../medusa/types/medusa.AdminCollectionsListRes.mdx)
- [AdminCollectionsRes](../medusa/types/medusa.AdminCollectionsRes.mdx)
- [AdminCurrenciesListRes](../medusa/types/medusa.AdminCurrenciesListRes.mdx)
- [AdminCurrenciesRes](../medusa/types/medusa.AdminCurrenciesRes.mdx)
- [AdminCustomerGroupsDeleteRes](../medusa/types/medusa.AdminCustomerGroupsDeleteRes.mdx)
- [AdminCustomerGroupsListRes](../medusa/types/medusa.AdminCustomerGroupsListRes.mdx)
- [AdminCustomerGroupsRes](../medusa/types/medusa.AdminCustomerGroupsRes.mdx)
- [AdminCustomersListRes](../medusa/types/medusa.AdminCustomersListRes.mdx)
- [AdminCustomersRes](../medusa/types/medusa.AdminCustomersRes.mdx)
- [AdminDeleteProductsFromCollectionRes](../medusa/types/medusa.AdminDeleteProductsFromCollectionRes.mdx)
- [AdminDeleteShippingProfileRes](../medusa/types/medusa.AdminDeleteShippingProfileRes.mdx)
- [AdminDeleteUploadsRes](../medusa/types/medusa.AdminDeleteUploadsRes.mdx)
- [AdminDeleteUserRes](../medusa/types/medusa.AdminDeleteUserRes.mdx)
- [AdminDiscountConditionsDeleteRes](../medusa/types/medusa.AdminDiscountConditionsDeleteRes.mdx)
- [AdminDiscountConditionsRes](../medusa/types/medusa.AdminDiscountConditionsRes.mdx)
- [AdminDiscountsDeleteRes](../medusa/types/medusa.AdminDiscountsDeleteRes.mdx)
- [AdminDiscountsListRes](../medusa/types/medusa.AdminDiscountsListRes.mdx)
- [AdminDiscountsRes](../medusa/types/medusa.AdminDiscountsRes.mdx)
- [AdminDraftOrdersDeleteRes](../medusa/types/medusa.AdminDraftOrdersDeleteRes.mdx)
- [AdminDraftOrdersListRes](../medusa/types/medusa.AdminDraftOrdersListRes.mdx)
- [AdminDraftOrdersRes](../medusa/types/medusa.AdminDraftOrdersRes.mdx)
- [AdminExtendedStoresRes](../medusa/types/medusa.AdminExtendedStoresRes.mdx)
- [AdminGetVariantsVariantInventoryRes](../medusa/types/medusa.AdminGetVariantsVariantInventoryRes.mdx)
- [AdminGiftCardsDeleteRes](../medusa/types/medusa.AdminGiftCardsDeleteRes.mdx)
- [AdminGiftCardsListRes](../medusa/types/medusa.AdminGiftCardsListRes.mdx)
- [AdminGiftCardsRes](../medusa/types/medusa.AdminGiftCardsRes.mdx)
- [AdminInventoryItemsDeleteRes](../medusa/types/medusa.AdminInventoryItemsDeleteRes.mdx)
- [AdminInventoryItemsListRes](../medusa/types/medusa.AdminInventoryItemsListRes.mdx)
- [AdminInventoryItemsListWithVariantsAndLocationLevelsRes](../medusa/types/medusa.AdminInventoryItemsListWithVariantsAndLocationLevelsRes.mdx)
- [AdminInventoryItemsLocationLevelsRes](../medusa/types/medusa.AdminInventoryItemsLocationLevelsRes.mdx)
- [AdminInventoryItemsRes](../medusa/types/medusa.AdminInventoryItemsRes.mdx)
- [AdminInviteDeleteRes](../medusa/types/medusa.AdminInviteDeleteRes.mdx)
- [AdminListInvitesRes](../medusa/types/medusa.AdminListInvitesRes.mdx)
- [AdminNotesDeleteRes](../medusa/types/medusa.AdminNotesDeleteRes.mdx)
- [AdminNotesListRes](../medusa/types/medusa.AdminNotesListRes.mdx)
- [AdminNotesRes](../medusa/types/medusa.AdminNotesRes.mdx)
- [AdminNotificationsListRes](../medusa/types/medusa.AdminNotificationsListRes.mdx)
- [AdminNotificationsRes](../medusa/types/medusa.AdminNotificationsRes.mdx)
- [AdminOrderEditDeleteRes](../medusa/types/medusa.AdminOrderEditDeleteRes.mdx)
- [AdminOrderEditItemChangeDeleteRes](../medusa/types/medusa.AdminOrderEditItemChangeDeleteRes.mdx)
- [AdminOrderEditsListRes](../medusa/types/medusa.AdminOrderEditsListRes.mdx)
- [AdminOrderEditsRes](../medusa/types/medusa.AdminOrderEditsRes.mdx)
- [AdminOrdersListRes](../medusa/types/medusa.AdminOrdersListRes.mdx)
- [AdminOrdersRes](../medusa/types/medusa.AdminOrdersRes.mdx)
- [AdminPaymentCollectionDeleteRes](../medusa/types/medusa.AdminPaymentCollectionDeleteRes.mdx)
- [AdminPaymentCollectionsRes](../medusa/types/medusa.AdminPaymentCollectionsRes.mdx)
- [AdminPaymentProvidersList](../medusa/types/medusa.AdminPaymentProvidersList.mdx)
- [AdminPaymentRes](../medusa/types/medusa.AdminPaymentRes.mdx)
- [AdminPostDraftOrdersDraftOrderRegisterPaymentRes](../medusa/types/medusa.AdminPostDraftOrdersDraftOrderRegisterPaymentRes.mdx)
- [AdminPriceListDeleteBatchRes](../medusa/types/medusa.AdminPriceListDeleteBatchRes.mdx)
- [AdminPriceListDeleteProductPricesRes](../medusa/types/medusa.AdminPriceListDeleteProductPricesRes.mdx)
- [AdminPriceListDeleteRes](../medusa/types/medusa.AdminPriceListDeleteRes.mdx)
- [AdminPriceListDeleteVariantPricesRes](../medusa/types/medusa.AdminPriceListDeleteVariantPricesRes.mdx)
- [AdminPriceListRes](../medusa/types/medusa.AdminPriceListRes.mdx)
- [AdminPriceListsListRes](../medusa/types/medusa.AdminPriceListsListRes.mdx)
- [AdminPriceListsProductsListRes](../medusa/types/medusa.AdminPriceListsProductsListRes.mdx)
- [AdminProductCategoriesCategoryDeleteRes](../medusa/types/medusa.AdminProductCategoriesCategoryDeleteRes.mdx)
- [AdminProductCategoriesCategoryRes](../medusa/types/medusa.AdminProductCategoriesCategoryRes.mdx)
- [AdminProductCategoriesListRes](../medusa/types/medusa.AdminProductCategoriesListRes.mdx)
- [AdminProductTagsListRes](../medusa/types/medusa.AdminProductTagsListRes.mdx)
- [AdminProductTypesListRes](../medusa/types/medusa.AdminProductTypesListRes.mdx)
- [AdminProductsDeleteOptionRes](../medusa/types/medusa.AdminProductsDeleteOptionRes.mdx)
- [AdminProductsDeleteRes](../medusa/types/medusa.AdminProductsDeleteRes.mdx)
- [AdminProductsDeleteVariantRes](../medusa/types/medusa.AdminProductsDeleteVariantRes.mdx)
- [AdminProductsListRes](../medusa/types/medusa.AdminProductsListRes.mdx)
- [AdminProductsListTagsRes](../medusa/types/medusa.AdminProductsListTagsRes.mdx)
- [AdminProductsListTypesRes](../medusa/types/medusa.AdminProductsListTypesRes.mdx)
- [AdminProductsListVariantsRes](../medusa/types/medusa.AdminProductsListVariantsRes.mdx)
- [AdminProductsRes](../medusa/types/medusa.AdminProductsRes.mdx)
- [AdminPublishableApiKeyDeleteRes](../medusa/types/medusa.AdminPublishableApiKeyDeleteRes.mdx)
- [AdminPublishableApiKeysListRes](../medusa/types/medusa.AdminPublishableApiKeysListRes.mdx)
- [AdminPublishableApiKeysListSalesChannelsRes](../medusa/types/medusa.AdminPublishableApiKeysListSalesChannelsRes.mdx)
- [AdminPublishableApiKeysRes](../medusa/types/medusa.AdminPublishableApiKeysRes.mdx)
- [AdminRefundRes](../medusa/types/medusa.AdminRefundRes.mdx)
- [AdminRegionsDeleteRes](../medusa/types/medusa.AdminRegionsDeleteRes.mdx)
- [AdminRegionsListRes](../medusa/types/medusa.AdminRegionsListRes.mdx)
- [AdminRegionsRes](../medusa/types/medusa.AdminRegionsRes.mdx)
- [AdminReservationsDeleteRes](../medusa/types/medusa.AdminReservationsDeleteRes.mdx)
- [AdminReservationsListRes](../medusa/types/medusa.AdminReservationsListRes.mdx)
- [AdminReservationsRes](../medusa/types/medusa.AdminReservationsRes.mdx)
- [AdminReturnReasonsDeleteRes](../medusa/types/medusa.AdminReturnReasonsDeleteRes.mdx)
- [AdminReturnReasonsListRes](../medusa/types/medusa.AdminReturnReasonsListRes.mdx)
- [AdminReturnReasonsRes](../medusa/types/medusa.AdminReturnReasonsRes.mdx)
- [AdminReturnsCancelRes](../medusa/types/medusa.AdminReturnsCancelRes.mdx)
- [AdminReturnsListRes](../medusa/types/medusa.AdminReturnsListRes.mdx)
- [AdminReturnsRes](../medusa/types/medusa.AdminReturnsRes.mdx)
- [AdminSalesChannelsDeleteLocationRes](../medusa/types/medusa.AdminSalesChannelsDeleteLocationRes.mdx)
- [AdminSalesChannelsDeleteRes](../medusa/types/medusa.AdminSalesChannelsDeleteRes.mdx)
- [AdminSalesChannelsListRes](../medusa/types/medusa.AdminSalesChannelsListRes.mdx)
- [AdminSalesChannelsRes](../medusa/types/medusa.AdminSalesChannelsRes.mdx)
- [AdminShippingOptionsDeleteRes](../medusa/types/medusa.AdminShippingOptionsDeleteRes.mdx)
- [AdminShippingOptionsListRes](../medusa/types/medusa.AdminShippingOptionsListRes.mdx)
- [AdminShippingOptionsRes](../medusa/types/medusa.AdminShippingOptionsRes.mdx)
- [AdminShippingProfilesListRes](../medusa/types/medusa.AdminShippingProfilesListRes.mdx)
- [AdminShippingProfilesRes](../medusa/types/medusa.AdminShippingProfilesRes.mdx)
- [AdminStockLocationsDeleteRes](../medusa/types/medusa.AdminStockLocationsDeleteRes.mdx)
- [AdminStockLocationsListRes](../medusa/types/medusa.AdminStockLocationsListRes.mdx)
- [AdminStockLocationsRes](../medusa/types/medusa.AdminStockLocationsRes.mdx)
- [AdminStoresRes](../medusa/types/medusa.AdminStoresRes.mdx)
- [AdminSwapsListRes](../medusa/types/medusa.AdminSwapsListRes.mdx)
- [AdminSwapsRes](../medusa/types/medusa.AdminSwapsRes.mdx)
- [AdminTaxProvidersList](../medusa/types/medusa.AdminTaxProvidersList.mdx)
- [AdminTaxRatesDeleteRes](../medusa/types/medusa.AdminTaxRatesDeleteRes.mdx)
- [AdminTaxRatesListRes](../medusa/types/medusa.AdminTaxRatesListRes.mdx)
- [AdminTaxRatesRes](../medusa/types/medusa.AdminTaxRatesRes.mdx)
- [AdminUploadsDownloadUrlRes](../medusa/types/medusa.AdminUploadsDownloadUrlRes.mdx)
- [AdminUploadsRes](../medusa/types/medusa.AdminUploadsRes.mdx)
- [AdminUserRes](../medusa/types/medusa.AdminUserRes.mdx)
- [AdminUsersListRes](../medusa/types/medusa.AdminUsersListRes.mdx)
- [AdminVariantsListRes](../medusa/types/medusa.AdminVariantsListRes.mdx)
- [AdminVariantsRes](../medusa/types/medusa.AdminVariantsRes.mdx)
- [BatchJobCreateProps](../medusa/types/medusa.BatchJobCreateProps.mdx)
- [BatchJobResultError](../medusa/types/medusa.BatchJobResultError.mdx)
- [BatchJobResultStatDescriptor](../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)
- [BatchJobUpdateProps](../medusa/types/medusa.BatchJobUpdateProps.mdx)
- [CartCompletionResponse](../medusa/types/medusa.CartCompletionResponse.mdx)
- [ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)
- [ConfigModule](../medusa/types/medusa.ConfigModule.mdx)
- [ConfigModule](../medusa/types/medusa.ConfigModule-1.mdx)
- [Constructor](../medusa/types/medusa.Constructor.mdx)
- [Constructor](../medusa/types/medusa.Constructor-1.mdx)
- [CreateBatchJobInput](../medusa/types/medusa.CreateBatchJobInput.mdx)
- [CreatePriceListInput](../medusa/types/medusa.CreatePriceListInput.mdx)
- [CreateReturnType](../medusa/types/medusa.CreateReturnType.mdx)
- [Data](../medusa/types/medusa.Data.mdx)
- [DecoratedInventoryItemDTO](../medusa/types/medusa.DecoratedInventoryItemDTO.mdx)
- [DeleteFileType](../medusa/types/medusa.DeleteFileType.mdx)
- [DeleteResponse](../medusa/types/medusa.DeleteResponse-1.mdx)
- [DiscountAllocation](../medusa/types/medusa.DiscountAllocation.mdx)
- [ExtendedFindConfig](../medusa/types/medusa.ExtendedFindConfig.mdx)
- [ExtendedRequest](../medusa/types/medusa.ExtendedRequest.mdx)
- [ExtendedReservationItem](../medusa/types/medusa.ExtendedReservationItem.mdx)
- [ExtendedStoreDTO](../medusa/types/medusa.ExtendedStoreDTO.mdx)
- [ExternalModuleDeclaration](../medusa/types/medusa.ExternalModuleDeclaration.mdx)
- [FeatureFlagsResponse](../medusa/types/medusa.FeatureFlagsResponse.mdx)
- [FileServiceGetUploadStreamResult](../medusa/types/medusa.FileServiceGetUploadStreamResult.mdx)
- [FileServiceUploadResult](../medusa/types/medusa.FileServiceUploadResult.mdx)
- [FulfillmentProviderData](../medusa/types/medusa.FulfillmentProviderData.mdx)
- [GetUploadedFileType](../medusa/types/medusa.GetUploadedFileType.mdx)
- [GiftCardAllocation](../medusa/types/medusa.GiftCardAllocation.mdx)
- [HttpCompressionOptions](../medusa/types/medusa.HttpCompressionOptions.mdx)
- [InnerSelector](../medusa/types/medusa.InnerSelector.mdx)
- [InternalModuleDeclaration](../medusa/types/medusa.InternalModuleDeclaration.mdx)
- [InventoryItemDTO](../medusa/types/medusa.InventoryItemDTO.mdx)
- [InventoryLevelDTO](../medusa/types/medusa.InventoryLevelDTO.mdx)
- [ItemTaxCalculationLine](../medusa/types/medusa.ItemTaxCalculationLine.mdx)
- [JoinerRelationship](../medusa/types/medusa.JoinerRelationship.mdx)
- [LevelWithAvailability](../medusa/types/medusa.LevelWithAvailability.mdx)
- [LineAllocationsMap](../medusa/types/medusa.LineAllocationsMap.mdx)
- [Logger](../medusa/types/medusa.Logger.mdx)
- [MedusaContainer](../medusa/types/medusa.MedusaContainer.mdx)
- [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)
- [MedusaContainer](../medusa/types/medusa.MedusaContainer-2.mdx)
- [MedusaErrorHandlerFunction](../medusa/types/medusa.MedusaErrorHandlerFunction.mdx)
- [MedusaNextFunction](../medusa/types/medusa.MedusaNextFunction.mdx)
- [MedusaRequestHandler](../medusa/types/medusa.MedusaRequestHandler.mdx)
- [MedusaResponse](../medusa/types/medusa.MedusaResponse.mdx)
- [MiddlewareFunction](../medusa/types/medusa.MiddlewareFunction.mdx)
- [MiddlewareRoute](../medusa/types/medusa.MiddlewareRoute.mdx)
- [MiddlewareVerb](../medusa/types/medusa.MiddlewareVerb.mdx)
- [MiddlewaresConfig](../medusa/types/medusa.MiddlewaresConfig.mdx)
- [ModuleDefinition](../medusa/types/medusa.ModuleDefinition.mdx)
- [ModuleJoinerConfig](../medusa/types/medusa.ModuleJoinerConfig.mdx)
- [ModuleJoinerRelationship](../medusa/types/medusa.ModuleJoinerRelationship.mdx)
- [ModulesResponse](../medusa/types/medusa.ModulesResponse.mdx)
- [ModulesResponse](../medusa/types/medusa.ModulesResponse-1.mdx)
- [PaginatedResponse](../medusa/types/medusa.PaginatedResponse-1.mdx)
- [ParserConfig](../medusa/types/medusa.ParserConfig.mdx)
- [PartialPick](../medusa/types/medusa.PartialPick.mdx)
- [PaymentContext](../medusa/types/medusa.PaymentContext.mdx)
- [PaymentData](../medusa/types/medusa.PaymentData.mdx)
- [PaymentSessionData](../medusa/types/medusa.PaymentSessionData.mdx)
- [PaymentSessionResponse](../medusa/types/medusa.PaymentSessionResponse.mdx)
- [PriceListLoadConfig](../medusa/types/medusa.PriceListLoadConfig.mdx)
- [PriceListPriceCreateInput](../medusa/types/medusa.PriceListPriceCreateInput.mdx)
- [PriceListPriceUpdateInput](../medusa/types/medusa.PriceListPriceUpdateInput.mdx)
- [PriceSelectionContext](../medusa/types/medusa.PriceSelectionContext.mdx)
- [PriceSelectionResult](../medusa/types/medusa.PriceSelectionResult.mdx)
- [PriceType](../medusa/types/medusa.PriceType.mdx)
- [PricedProduct](../medusa/types/medusa.PricedProduct.mdx)
- [PricedShippingOption](../medusa/types/medusa.PricedShippingOption.mdx)
- [PricedVariant](../medusa/types/medusa.PricedVariant.mdx)
- [ProductVariantPricing](../medusa/types/medusa.ProductVariantPricing.mdx)
- [ProjectConfigOptions](../medusa/types/medusa.ProjectConfigOptions.mdx)
- [ProviderLineItemTaxLine](../medusa/types/medusa.ProviderLineItemTaxLine.mdx)
- [ProviderShippingMethodTaxLine](../medusa/types/medusa.ProviderShippingMethodTaxLine.mdx)
- [ProviderTaxLine](../medusa/types/medusa.ProviderTaxLine.mdx)
- [QueryConfig](../medusa/types/medusa.QueryConfig.mdx)
- [QuerySelector](../medusa/types/medusa.QuerySelector.mdx)
- [RequestContext](../medusa/types/medusa.RequestContext.mdx)
- [ReservationItemDTO](../medusa/types/medusa.ReservationItemDTO.mdx)
- [ResponseInventoryItem](../medusa/types/medusa.ResponseInventoryItem.mdx)
- [ReturnedData](../medusa/types/medusa.ReturnedData.mdx)
- [RouteVerb](../medusa/types/medusa.RouteVerb.mdx)
- [ScheduledJobArgs](../medusa/types/medusa.ScheduledJobArgs.mdx)
- [ScheduledJobConfig](../medusa/types/medusa.ScheduledJobConfig.mdx)
- [Selector](../medusa/types/medusa.Selector.mdx)
- [SessionOptions](../medusa/types/medusa.SessionOptions.mdx)
- [ShippingMethodData](../medusa/types/medusa.ShippingMethodData.mdx)
- [ShippingOptionData](../medusa/types/medusa.ShippingOptionData.mdx)
- [ShippingOptionPricing](../medusa/types/medusa.ShippingOptionPricing.mdx)
- [ShippingTaxCalculationLine](../medusa/types/medusa.ShippingTaxCalculationLine.mdx)
- [StockLocationAddressDTO](../medusa/types/medusa.StockLocationAddressDTO.mdx)
- [StockLocationDTO](../medusa/types/medusa.StockLocationDTO.mdx)
- [StockLocationExpandedDTO](../medusa/types/medusa.StockLocationExpandedDTO.mdx)
- [StoreAuthRes](../medusa/types/medusa.StoreAuthRes.mdx)
- [StoreBearerAuthRes](../medusa/types/medusa.StoreBearerAuthRes.mdx)
- [StoreCartShippingOptionsListRes](../medusa/types/medusa.StoreCartShippingOptionsListRes.mdx)
- [StoreCartsRes](../medusa/types/medusa.StoreCartsRes.mdx)
- [StoreCollectionsListRes](../medusa/types/medusa.StoreCollectionsListRes.mdx)
- [StoreCollectionsRes](../medusa/types/medusa.StoreCollectionsRes.mdx)
- [StoreCompleteCartRes](../medusa/types/medusa.StoreCompleteCartRes.mdx)
- [StoreCustomersListOrdersRes](../medusa/types/medusa.StoreCustomersListOrdersRes.mdx)
- [StoreCustomersListPaymentMethodsRes](../medusa/types/medusa.StoreCustomersListPaymentMethodsRes.mdx)
- [StoreCustomersRes](../medusa/types/medusa.StoreCustomersRes.mdx)
- [StoreCustomersResetPasswordRes](../medusa/types/medusa.StoreCustomersResetPasswordRes.mdx)
- [StoreGetAuthEmailRes](../medusa/types/medusa.StoreGetAuthEmailRes.mdx)
- [StoreGetProductCategoriesCategoryRes](../medusa/types/medusa.StoreGetProductCategoriesCategoryRes.mdx)
- [StoreGetProductCategoriesRes](../medusa/types/medusa.StoreGetProductCategoriesRes.mdx)
- [StoreGiftCardsRes](../medusa/types/medusa.StoreGiftCardsRes.mdx)
- [StoreOrderEditsRes](../medusa/types/medusa.StoreOrderEditsRes.mdx)
- [StoreOrdersRes](../medusa/types/medusa.StoreOrdersRes.mdx)
- [StorePaymentCollectionsRes](../medusa/types/medusa.StorePaymentCollectionsRes.mdx)
- [StorePaymentCollectionsSessionRes](../medusa/types/medusa.StorePaymentCollectionsSessionRes.mdx)
- [StorePostSearchRes](../medusa/types/medusa.StorePostSearchRes.mdx)
- [StoreProductTagsListRes](../medusa/types/medusa.StoreProductTagsListRes.mdx)
- [StoreProductTypesListRes](../medusa/types/medusa.StoreProductTypesListRes.mdx)
- [StoreProductsListRes](../medusa/types/medusa.StoreProductsListRes.mdx)
- [StoreProductsRes](../medusa/types/medusa.StoreProductsRes.mdx)
- [StoreRegionsListRes](../medusa/types/medusa.StoreRegionsListRes.mdx)
- [StoreRegionsRes](../medusa/types/medusa.StoreRegionsRes.mdx)
- [StoreReturnReasonsListRes](../medusa/types/medusa.StoreReturnReasonsListRes.mdx)
- [StoreReturnReasonsRes](../medusa/types/medusa.StoreReturnReasonsRes.mdx)
- [StoreReturnsRes](../medusa/types/medusa.StoreReturnsRes.mdx)
- [StoreShippingOptionsListRes](../medusa/types/medusa.StoreShippingOptionsListRes.mdx)
- [StoreSwapsRes](../medusa/types/medusa.StoreSwapsRes.mdx)
- [StoreVariantsListRes](../medusa/types/medusa.StoreVariantsListRes.mdx)
- [StoreVariantsRes](../medusa/types/medusa.StoreVariantsRes.mdx)
- [SubscriberArgs](../medusa/types/medusa.SubscriberArgs.mdx)
- [SubscriberConfig](../medusa/types/medusa.SubscriberConfig.mdx)
- [TaxCalculationContext](../medusa/types/medusa.TaxCalculationContext.mdx)
- [TaxServiceRate](../medusa/types/medusa.TaxServiceRate.mdx)
- [TaxedPricing](../medusa/types/medusa.TaxedPricing.mdx)
- [TotalField](../medusa/types/medusa.TotalField.mdx)
- [TreeQuerySelector](../medusa/types/medusa.TreeQuerySelector.mdx)
- [UpdatePriceListInput](../medusa/types/medusa.UpdatePriceListInput.mdx)
- [UploadStreamDescriptorType](../medusa/types/medusa.UploadStreamDescriptorType.mdx)
- [VariantInventory](../medusa/types/medusa.VariantInventory.mdx)
- [WithRequiredProperty](../medusa/types/medusa.WithRequiredProperty.mdx)
- [Writable](../medusa/types/medusa.Writable.mdx)
- [handler](../medusa/types/medusa.handler.mdx)
- [payload](../medusa/types/medusa.payload.mdx)
___
## Enumeration Members
### DEFAULT
**DEFAULT**: `"default"`
___
### EXTERNAL
**EXTERNAL**: `"external"`
___
### INTERNAL
**INTERNAL**: `"internal"`
___
## Variables
### AvailableOrderIncludes
`Const` **AvailableOrderIncludes**: `Object`
#### Type declaration
<ParameterTypes parameters={[
{
"name": "RETURNABLE_ITEMS",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"returnable_items\"",
"expandable": false,
"children": []
}
]} />
___
### HTTP\_METHODS
`Const` **HTTP\_METHODS**: readonly [`"GET"`, `"POST"`, `"PUT"`, `"PATCH"`, `"DELETE"`, `"OPTIONS"`, `"HEAD"`]
List of all the supported HTTP methods
___
### PriceType
**PriceType**: `Object`
#### Type declaration
<ParameterTypes parameters={[
{
"name": "DEFAULT",
"type": "[DEFAULT](medusa.mdx#default)",
"description": "",
"optional": false,
"defaultValue": "\"default\"",
"expandable": false,
"children": []
},
{
"name": "OVERRIDE",
"type": "[OVERRIDE](../medusa/enums/medusa.PriceListType.mdx#override)",
"description": "",
"optional": false,
"defaultValue": "\"override\"",
"expandable": false,
"children": []
},
{
"name": "SALE",
"type": "[SALE](../medusa/enums/medusa.PriceListType.mdx#sale)",
"description": "",
"optional": false,
"defaultValue": "\"sale\"",
"expandable": false,
"children": []
}
]} />
___
### allowedAdminProductCategoryRelations
`Const` **allowedAdminProductCategoryRelations**: `string`[]
___
### allowedFields
`Const` **allowedFields**: `string`[]
___
### allowedOrderIncludes
`Const` **allowedOrderIncludes**: `string`[]
___
### allowedStoreCustomersFields
`Const` **allowedStoreCustomersFields**: `string`[]
___
### allowedStoreCustomersRelations
`Const` **allowedStoreCustomersRelations**: `string`[]
___
### allowedStoreGiftCardFields
`Const` **allowedStoreGiftCardFields**: `string`[]
___
### allowedStoreGiftCardRelations
`Const` **allowedStoreGiftCardRelations**: `string`[]
___
### allowedStoreOrdersFields
`Const` **allowedStoreOrdersFields**: `string`[]
___
### allowedStoreOrdersRelations
`Const` **allowedStoreOrdersRelations**: `string`[]
___
### allowedStoreProductCategoryFields
`Const` **allowedStoreProductCategoryFields**: `string`[]
___
### allowedStoreProductTagFields
`Const` **allowedStoreProductTagFields**: `string`[]
___
### allowedStoreProductTypeFields
`Const` **allowedStoreProductTypeFields**: `string`[]
___
### allowedStoreProductsFields
`Const` **allowedStoreProductsFields**: `string`[]
___
### allowedStoreProductsRelations
`Const` **allowedStoreProductsRelations**: `string`[]
___
### allowedStoreVariantRelations
`Const` **allowedStoreVariantRelations**: `string`[]
___
### defaulPaymentCollectionRelations
`Const` **defaulPaymentCollectionRelations**: `string`[]
___
### defaultAdminBatchFields
`Const` **defaultAdminBatchFields**: `string`[]
___
### defaultAdminCollectionsFields
`Const` **defaultAdminCollectionsFields**: `string`[]
___
### defaultAdminCollectionsRelations
`Const` **defaultAdminCollectionsRelations**: `string`[]
___
### defaultAdminCustomerGroupsRelations
`Const` **defaultAdminCustomerGroupsRelations**: `never`[] = `[]`
___
### defaultAdminCustomersRelations
`Const` **defaultAdminCustomersRelations**: `string`[]
___
### defaultAdminDiscountConditionFields
`Const` **defaultAdminDiscountConditionFields**: keyof [DiscountCondition](../entities/classes/entities.DiscountCondition.mdx)[]
___
### defaultAdminDiscountConditionRelations
`Const` **defaultAdminDiscountConditionRelations**: `string`[]
___
### defaultAdminDiscountsFields
`Const` **defaultAdminDiscountsFields**: keyof [Discount](../entities/classes/entities.Discount.mdx)[]
___
### defaultAdminDiscountsRelations
`Const` **defaultAdminDiscountsRelations**: `string`[]
___
### defaultAdminDraftOrdersCartFields
`Const` **defaultAdminDraftOrdersCartFields**: keyof [Cart](../entities/classes/entities.Cart.mdx)[]
___
### defaultAdminDraftOrdersCartRelations
`Const` **defaultAdminDraftOrdersCartRelations**: `string`[]
___
### defaultAdminDraftOrdersFields
`Const` **defaultAdminDraftOrdersFields**: keyof [DraftOrder](../entities/classes/entities.DraftOrder.mdx)[]
___
### defaultAdminDraftOrdersRelations
`Const` **defaultAdminDraftOrdersRelations**: `string`[]
___
### defaultAdminGetProductsVariantsFields
`Const` **defaultAdminGetProductsVariantsFields**: `string`[]
___
### defaultAdminGiftCardFields
`Const` **defaultAdminGiftCardFields**: keyof [GiftCard](../entities/classes/entities.GiftCard.mdx)[]
___
### defaultAdminGiftCardRelations
`Const` **defaultAdminGiftCardRelations**: `string`[]
___
### defaultAdminInventoryItemFields
`Const` **defaultAdminInventoryItemFields**: keyof [InventoryItemDTO](../medusa/types/medusa.InventoryItemDTO.mdx)[]
___
### defaultAdminInventoryItemRelations
`Const` **defaultAdminInventoryItemRelations**: `never`[] = `[]`
___
### defaultAdminLocationLevelFields
`Const` **defaultAdminLocationLevelFields**: keyof [InventoryLevelDTO](../medusa/types/medusa.InventoryLevelDTO.mdx)[]
___
### defaultAdminNotificationsFields
`Const` **defaultAdminNotificationsFields**: `string`[]
___
### defaultAdminNotificationsRelations
`Const` **defaultAdminNotificationsRelations**: `string`[]
___
### defaultAdminPriceListFields
`Const` **defaultAdminPriceListFields**: `string`[]
___
### defaultAdminPriceListRelations
`Const` **defaultAdminPriceListRelations**: `string`[]
___
### defaultAdminPriceListRemoteQueryObject
`Const` **defaultAdminPriceListRemoteQueryObject**: `Object`
#### Type declaration
<ParameterTypes parameters={[
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_rules",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "price_list_rule_values",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "rule_type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "price_set_money_amounts",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "money_amount",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_rules",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_set",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "variant_link",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### defaultAdminProductCategoryRelations
`Const` **defaultAdminProductCategoryRelations**: `string`[]
___
### defaultAdminProductFields
`Const` **defaultAdminProductFields**: keyof [Product](../entities/classes/entities.Product.mdx)[]
___
### defaultAdminProductRelations
`Const` **defaultAdminProductRelations**: `string`[]
___
### defaultAdminProductRemoteQueryObject
`Const` **defaultAdminProductRemoteQueryObject**: `Object`
This is temporary.
#### Type declaration
<ParameterTypes parameters={[
{
"name": "categories",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "collection",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "fields",
"type": "keyof [Product](../entities/classes/entities.Product.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "defaultAdminProductFields",
"expandable": false,
"children": []
},
{
"name": "images",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "options",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "values",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "profile",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "sales_channels",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "tags",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "variants",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### defaultAdminProductTagsFields
`Const` **defaultAdminProductTagsFields**: `string`[]
___
### defaultAdminProductTagsRelations
`Const` **defaultAdminProductTagsRelations**: `never`[] = `[]`
___
### defaultAdminProductTypeFields
`Const` **defaultAdminProductTypeFields**: `string`[]
___
### defaultAdminProductTypeRelations
`Const` **defaultAdminProductTypeRelations**: `never`[] = `[]`
___
### defaultAdminRegionFields
`Const` **defaultAdminRegionFields**: keyof [Region](../entities/classes/entities.Region.mdx)[]
___
### defaultAdminRegionRelations
`Const` **defaultAdminRegionRelations**: `string`[]
___
### defaultAdminReservationRelations
`Const` **defaultAdminReservationRelations**: `never`[] = `[]`
___
### defaultAdminReturnReasonsFields
`Const` **defaultAdminReturnReasonsFields**: keyof [ReturnReason](../entities/classes/entities.ReturnReason.mdx)[]
___
### defaultAdminReturnReasonsRelations
`Const` **defaultAdminReturnReasonsRelations**: keyof [ReturnReason](../entities/classes/entities.ReturnReason.mdx)[]
___
### defaultAdminShippingProfilesFields
`Const` **defaultAdminShippingProfilesFields**: keyof [ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)[]
___
### defaultAdminShippingProfilesRelations
`Const` **defaultAdminShippingProfilesRelations**: `string`[]
___
### defaultAdminStockLocationFields
`Const` **defaultAdminStockLocationFields**: keyof [StockLocationDTO](../medusa/types/medusa.StockLocationDTO.mdx)[]
___
### defaultAdminStockLocationRelations
`Const` **defaultAdminStockLocationRelations**: `never`[] = `[]`
___
### defaultAdminSwapFields
`Const` **defaultAdminSwapFields**: `string`[]
___
### defaultAdminSwapRelations
`Const` **defaultAdminSwapRelations**: `string`[]
___
### defaultAdminTaxRatesFields
`Const` **defaultAdminTaxRatesFields**: keyof [TaxRate](../entities/classes/entities.TaxRate.mdx)[]
___
### defaultAdminTaxRatesRelations
`Const` **defaultAdminTaxRatesRelations**: `never`[] = `[]`
___
### defaultAdminVariantFields
`Const` **defaultAdminVariantFields**: keyof [ProductVariant](../entities/classes/entities.ProductVariant.mdx)[]
___
### defaultAdminVariantRelations
`Const` **defaultAdminVariantRelations**: `string`[]
___
### defaultFields
`Const` **defaultFields**: keyof [ShippingOption](../entities/classes/entities.ShippingOption.mdx)[]
___
### defaultPaymentCollectionFields
`Const` **defaultPaymentCollectionFields**: `string`[]
___
### defaultPaymentCollectionRelations
`Const` **defaultPaymentCollectionRelations**: `string`[]
___
### defaultPaymentFields
`Const` **defaultPaymentFields**: `string`[]
___
### defaultProductCategoryFields
`Const` **defaultProductCategoryFields**: `string`[]
___
### defaultRelations
`Const` **defaultRelations**: `string`[]
___
### defaultRelationsExtended
`Const` **defaultRelationsExtended**: `string`[]
___
### defaultRelationsList
`Const` **defaultRelationsList**: `string`[]
___
### defaultReservationFields
`Const` **defaultReservationFields**: `string`[]
___
### defaultReturnCancelFields
`Const` **defaultReturnCancelFields**: keyof [Order](../entities/classes/entities.Order.mdx)[]
___
### defaultReturnCancelRelations
`Const` **defaultReturnCancelRelations**: `string`[]
___
### defaultStoreCartFields
`Const` **defaultStoreCartFields**: keyof [Cart](../entities/classes/entities.Cart.mdx)[] = `[]`
___
### defaultStoreCartRelations
`Const` **defaultStoreCartRelations**: `string`[]
___
### defaultStoreCategoryScope
`Const` **defaultStoreCategoryScope**: `Object`
#### Type declaration
<ParameterTypes parameters={[
{
"name": "is_active",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
___
### defaultStoreCollectionRelations
`Const` **defaultStoreCollectionRelations**: `never`[] = `[]`
___
### defaultStoreCustomersFields
`Const` **defaultStoreCustomersFields**: keyof [Customer](../entities/classes/entities.Customer.mdx)[]
___
### defaultStoreCustomersRelations
`Const` **defaultStoreCustomersRelations**: `string`[]
___
### defaultStoreGiftCardFields
`Const` **defaultStoreGiftCardFields**: keyof [GiftCard](../entities/classes/entities.GiftCard.mdx)[]
___
### defaultStoreGiftCardRelations
`Const` **defaultStoreGiftCardRelations**: `string`[]
___
### defaultStoreOrdersFields
`Const` **defaultStoreOrdersFields**: keyof [Order](../entities/classes/entities.Order.mdx)[]
___
### defaultStoreOrdersRelations
`Const` **defaultStoreOrdersRelations**: `string`[]
___
### defaultStoreProductCategoryFields
`Const` **defaultStoreProductCategoryFields**: `string`[]
___
### defaultStoreProductCategoryRelations
`Const` **defaultStoreProductCategoryRelations**: `string`[]
___
### defaultStoreProductRemoteQueryObject
`Const` **defaultStoreProductRemoteQueryObject**: `Object`
This is temporary.
#### Type declaration
<ParameterTypes parameters={[
{
"name": "collection",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "fields",
"type": "keyof [Product](../entities/classes/entities.Product.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "defaultStoreProductsFields",
"expandable": false,
"children": []
},
{
"name": "images",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "options",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "values",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "profile",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "sales_channels",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "tags",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "variants",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### defaultStoreProductTagFields
`Const` **defaultStoreProductTagFields**: `string`[]
___
### defaultStoreProductTagRelations
`Const` **defaultStoreProductTagRelations**: `never`[] = `[]`
___
### defaultStoreProductTypeFields
`Const` **defaultStoreProductTypeFields**: `string`[]
___
### defaultStoreProductTypeRelations
`Const` **defaultStoreProductTypeRelations**: `never`[] = `[]`
___
### defaultStoreProductsFields
`Const` **defaultStoreProductsFields**: keyof [Product](../entities/classes/entities.Product.mdx)[]
___
### defaultStoreProductsRelations
`Const` **defaultStoreProductsRelations**: `string`[]
___
### defaultStoreRegionFields
`Const` **defaultStoreRegionFields**: `string`[]
___
### defaultStoreRegionRelations
`Const` **defaultStoreRegionRelations**: `string`[]
___
### defaultStoreReturnReasonFields
`Const` **defaultStoreReturnReasonFields**: keyof [ReturnReason](../entities/classes/entities.ReturnReason.mdx)[]
___
### defaultStoreReturnReasonRelations
`Const` **defaultStoreReturnReasonRelations**: keyof [ReturnReason](../entities/classes/entities.ReturnReason.mdx)[]
___
### defaultStoreSwapFields
`Const` **defaultStoreSwapFields**: [FindConfig](../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Swap](../entities/classes/entities.Swap.mdx)&#62;[`"select"`]
___
### defaultStoreSwapRelations
`Const` **defaultStoreSwapRelations**: `string`[]
___
### defaultStoreVariantRelations
`Const` **defaultStoreVariantRelations**: `string`[]
___
### filterableAdminOrdersFields
`Const` **filterableAdminOrdersFields**: `string`[]
___
### joinerConfig
`Const` **joinerConfig**: [ModuleJoinerConfig](../medusa/types/medusa.ModuleJoinerConfig.mdx)[]
___
## Functions
### DbAwareColumn
#### Parameters
<ParameterTypes parameters={[
{
"name": "columnOptions",
"type": "`ColumnOptions`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "PropertyDecorator",
"type": "`PropertyDecorator`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### IsType
#### Parameters
<ParameterTypes parameters={[
{
"name": "types",
"type": "`any`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "validationOptions",
"type": "`ValidationOptions`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "(object: Object, propertyName: string) => void",
"type": "(`object`: `Object`, `propertyName`: `string`) => `void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "object",
"type": "`Object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "propertyName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### addOrderToSelect
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TEntity",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "order",
"type": "FindOptionsOrder&#60;TEntity&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "select",
"type": "FindOptionsSelect&#60;TEntity&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### adjustInventoryForCancelledFulfillment
#### Parameters
<ParameterTypes parameters={[
{
"name": "fulfillment",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)",
"description": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the Fulfillment was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_order",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "additional_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the claim was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_items",
"type": "[ClaimItem](../entities/classes/entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../entities/enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The claim's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be send.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the claim comes from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../entities/enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
"expandable": false,
"children": []
},
{
"name": "refund_amount",
"type": "`number`",
"description": "The amount that will be refunded in conjunction with the claim",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_order",
"type": "[Return](../entities/classes/entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The ID of the address that the new items should be shipped to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "type",
"type": "[ClaimType](../entities/enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "claim_order_id",
"type": "`string`",
"description": "The ID of the Claim that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The fulfillment's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[FulfillmentItem](../entities/classes/entities.FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "fulfillment",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "fulfillment_id",
"type": "`string`",
"description": "The ID of the Fulfillment that the Fulfillment Item belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "item",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "item_id",
"type": "`string`",
"description": "The ID of the Line Item that the Fulfillment Item references.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The quantity of the Line Item that is included in the Fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "location_id",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the fulfillment will be shipped from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be sent.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "billing_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "billing_address_id",
"type": "`string`",
"description": "The ID of the billing address associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date the order was canceled on.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claims",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[Currency](../entities/classes/entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "currency_code",
"type": "`string`",
"description": "The 3 character currency code that is used in the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer",
"type": "[Customer](../entities/classes/entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "customer_id",
"type": "`string`",
"description": "The ID of the customer associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discount_total",
"type": "`number`",
"description": "The total of discount rounded",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discounts",
"type": "[Discount](../entities/classes/entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "display_id",
"type": "`number`",
"description": "The order's display ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "draft_order",
"type": "[DraftOrder](../entities/classes/entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "draft_order_id",
"type": "`string`",
"description": "The ID of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "edits",
"type": "[OrderEdit](../entities/classes/entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "email",
"type": "`string`",
"description": "The email associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../entities/enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "gift_card_tax_total",
"type": "`number`",
"description": "The total of gift cards with taxes",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_total",
"type": "`number`",
"description": "The total of gift cards",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](../entities/classes/entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "gift_cards",
"type": "[GiftCard](../entities/classes/entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The order's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the processing of the order in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "item_tax_total",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be send.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "object",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
"expandable": false,
"children": []
},
{
"name": "paid_total",
"type": "`number`",
"description": "The total amount paid",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_status",
"type": "[PaymentStatus](../entities/enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
"expandable": false,
"children": []
},
{
"name": "payments",
"type": "[Payment](../entities/classes/entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "raw_discount_total",
"type": "`number`",
"description": "The total of discount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refundable_amount",
"type": "`number`",
"description": "The amount that can be refunded",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refunded_total",
"type": "`number`",
"description": "The total amount refunded if the order is returned.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refunds",
"type": "[Refund](../entities/classes/entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "region",
"type": "[Region](../entities/classes/entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "region_id",
"type": "`string`",
"description": "The ID of the region this order was created in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returnable_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "returns",
"type": "[Return](../entities/classes/entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "sales_channel",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "sales_channel_id",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The ID of the shipping address associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_tax_total",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_total",
"type": "`number`",
"description": "The total of shipping",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[OrderStatus](../entities/enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
"expandable": false,
"children": []
},
{
"name": "subtotal",
"type": "`number`",
"description": "The subtotal of the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swaps",
"type": "[Swap](../entities/classes/entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tax_rate",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_total",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`number`",
"description": "The total amount of the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the Order that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "provider",
"type": "[FulfillmentProvider](../entities/classes/entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of the fulfillment provider as given by the fulfillment service.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
}
]
},
{
"name": "provider_id",
"type": "`string`",
"description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipped_at",
"type": "`Date`",
"description": "The date with timezone at which the Fulfillment was shipped.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "additional_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "If true, swaps can be completed with items out of stock",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the Swap was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "confirmed_at",
"type": "`Date`",
"description": "The date with timezone at which the Swap was confirmed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "difference_due",
"type": "`number`",
"description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../entities/enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The swap's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the swap in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "If set to true, no notification will be sent related to this swap",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment",
"type": "[Payment](../entities/classes/entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../entities/enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_order",
"type": "[Return](../entities/classes/entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "swap_id",
"type": "`string`",
"description": "The ID of the Swap that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tracking_links",
"type": "[TrackingLink](../entities/classes/entities.TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)",
"description": "The details of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "fulfillment_id",
"type": "`string`",
"description": "The ID of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The tracking link's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of a process in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tracking_number",
"type": "`string`",
"description": "The tracking number given by the shipping carrier.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "url",
"type": "`string`",
"description": "The URL at which the status of the shipment can be tracked.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "tracking_numbers",
"type": "`string`[]",
"description": "The tracking numbers that can be used to track the status of the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "context",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "productVariantInventoryService",
"type": "[ProductVariantInventoryService](../services/classes/services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](../services/classes/services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelInventoryService_",
"type": "[SalesChannelInventoryService](../services/classes/services.SalesChannelInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "context.productVariantInventoryService",
"type": "[ProductVariantInventoryService](../services/classes/services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](../services/classes/services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cartRepository_",
"type": "Repository&#60;[Cart](../entities/classes/entities.Cart.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](../services/classes/services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "moneyAmountRepository_",
"type": "Repository&#60;[MoneyAmount](../entities/classes/entities.MoneyAmount.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "priceSelectionStrategy_",
"type": "[IPriceSelectionStrategy](../medusa/interfaces/medusa.IPriceSelectionStrategy.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productOptionValueRepository_",
"type": "Repository&#60;[ProductOptionValue](../entities/classes/entities.ProductOptionValue.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](../entities/classes/entities.Product.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantRepository_",
"type": "Repository&#60;[ProductVariant](../entities/classes/entities.ProductVariant.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](../services/classes/services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "salesChannelInventoryService_",
"type": "[SalesChannelInventoryService](../services/classes/services.SalesChannelInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelService_",
"type": "[SalesChannelService](../services/classes/services.SalesChannelService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### authenticate
#### Returns
<ParameterTypes parameters={[
{
"name": "RequestHandler",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ParamsDictionary",
"type": "`ParamsDictionary`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "ParsedQs",
"type": "`ParsedQs`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "Record",
"type": "`Record<string, any>`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### authenticateCustomer
#### Returns
<ParameterTypes parameters={[
{
"name": "RequestHandler",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ParamsDictionary",
"type": "`ParamsDictionary`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "ParsedQs",
"type": "`ParsedQs`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "Record",
"type": "`Record<string, any>`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### buildLegacyFieldsListFrom
Revert new object structure of find options to the legacy structure of previous version
#### Example
```ts
input: {
test: {
test1: true,
test2: true,
test3: {
test4: true
},
},
test2: true
}
output: ['test.test1', 'test.test2', 'test.test3.test4', 'test2']
```
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TEntity",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "FindOptionsWhere&#60;TEntity&#62; \\| FindOptionsSelect&#60;TEntity&#62; \\| FindOptionsOrder&#60;TEntity&#62; \\| FindOptionsRelations&#60;TEntity&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "keyof TEntity[]",
"type": "keyof `TEntity`[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "keyof TEntity",
"type": "keyof `TEntity`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
#### Deprecated
in favor of import &#123; objectToStringPath &#125; from "@medusajs/utils"
___
### buildQuery
Used to build TypeORM queries.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TWhereKeys",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TEntity",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`TWhereKeys`",
"description": "The selector",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../medusa/interfaces/medusa.FindConfig.mdx)&#60;TEntity&#62;",
"description": "The config",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": [
{
"name": "order",
"type": "`object`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "relations",
"type": "`string`[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "select",
"type": "keyof `Entity`[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "skip",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "take",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ExtendedFindConfig",
"type": "[ExtendedFindConfig](../medusa/types/medusa.ExtendedFindConfig.mdx)&#60;TEntity&#62;",
"optional": false,
"defaultValue": "",
"description": "The QueryBuilderConfig",
"expandable": false,
"children": [
{
"name": "TEntity",
"type": "`TEntity`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### calculatePriceTaxAmount
Return the tax amount that
- is includes in the price if it is tax inclusive
- will be applied on to the price if it is tax exclusive
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "includesTax",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxRate",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "__namedParameters.includesTax",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__namedParameters.price",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__namedParameters.taxRate",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "number",
"type": "`number`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### canAccessBatchJob
#### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### categoryMatchesScope
#### Parameters
<ParameterTypes parameters={[
{
"name": "category",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "A product category can be used to categorize products into a hierarchy of categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "categories",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"featureFlag": "product_categories",
"children": []
},
{
"name": "collection",
"type": "[ProductCollection](../entities/classes/entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "collection_id",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discountable",
"type": "`boolean`",
"description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "height",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "hs_code",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "images",
"type": "[Image](../entities/classes/entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "is_giftcard",
"type": "`boolean`",
"description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "length",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "material",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "mid_code",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "[ProductOption](../entities/classes/entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profile",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "profile_id",
"type": "`string`",
"description": "The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profiles",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sales_channels",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "status",
"type": "[ProductStatus](../entities/enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
"expandable": false,
"children": []
},
{
"name": "subtitle",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tags",
"type": "[ProductTag](../entities/classes/entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "A title that can be displayed for easy identification of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "[ProductType](../entities/classes/entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "type_id",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants",
"type": "[ProductVariant](../entities/classes/entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "width",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "query",
"type": "FindOptionsWhere&#60;[ProductCategory](../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "categories",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"featureFlag": "product_categories",
"children": []
},
{
"name": "collection",
"type": "[ProductCollection](../entities/classes/entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "collection_id",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discountable",
"type": "`boolean`",
"description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "height",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "hs_code",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "images",
"type": "[Image](../entities/classes/entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "is_giftcard",
"type": "`boolean`",
"description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "length",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "material",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "mid_code",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "[ProductOption](../entities/classes/entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profile",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "profile_id",
"type": "`string`",
"description": "The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profiles",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sales_channels",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "status",
"type": "[ProductStatus](../entities/enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
"expandable": false,
"children": []
},
{
"name": "subtitle",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tags",
"type": "[ProductTag](../entities/classes/entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "A title that can be displayed for easy identification of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "[ProductType](../entities/classes/entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "type_id",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants",
"type": "[ProductVariant](../entities/classes/entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "width",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### cleanResponseData
Filter response data to contain props specified in the `allowedProperties`.
You can read more in the transformQuery middleware utility methods.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`T`",
"description": "record or an array of records in the response",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fields",
"type": "`string`[]",
"description": "record props allowed in the response",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "T extends [] ? Partial&#60;T&#62;[] : Partial&#60;T&#62;",
"type": "`T` extends [] ? Partial&#60;T&#62;[] : Partial&#60;T&#62;",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### csvCellContentFormatter
#### Parameters
<ParameterTypes parameters={[
{
"name": "str",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### csvRevertCellContentFormatter
#### Parameters
<ParameterTypes parameters={[
{
"name": "str",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### doesConditionBelongToDiscount
#### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### errorHandler
#### Returns
<ParameterTypes parameters={[
{
"name": "(err: MedusaError, req: Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;, res: Response&#60;any, Record&#60;string, any&#62;&#62;, next: NextFunction) => void",
"type": "(`err`: [MedusaError](../medusa/classes/medusa.MedusaError.mdx), `req`: Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;, `res`: Response&#60;any, Record&#60;string, any&#62;&#62;, `next`: `NextFunction`) => `void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "[MedusaError](../medusa/classes/medusa.MedusaError.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "date",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "message",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Codes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "CART_INCOMPATIBLE_STATE",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "INSUFFICIENT_INVENTORY",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "Types",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "CONFLICT",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "DB_ERROR",
"type": "`string`",
"description": "Errors stemming from the database",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "DUPLICATE_ERROR",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "INVALID_ARGUMENT",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "INVALID_DATA",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "NOT_ALLOWED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "NOT_FOUND",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "PAYMENT_AUTHORIZATION_ERROR",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "UNAUTHORIZED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "UNEXPECTED_STATE",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "req",
"type": "Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "Response&#60;any, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`NextFunction`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### extendedFindParamsMixin
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": [
{
"name": "limit",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "offset",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "__namedParameters.limit",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__namedParameters.offset",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ClassConstructor",
"type": "[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;[FindParams](../medusa/classes/medusa.FindParams.mdx) & [FindPaginationParams](../medusa/classes/medusa.FindPaginationParams.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "FindParams & FindPaginationParams",
"type": "[FindParams](../medusa/classes/medusa.FindParams.mdx) & [FindPaginationParams](../medusa/classes/medusa.FindPaginationParams.mdx)",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### fetchCategoryDescendantsIds
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategory",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "A product category can be used to categorize products into a hierarchy of categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "categories",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"featureFlag": "product_categories",
"children": []
},
{
"name": "collection",
"type": "[ProductCollection](../entities/classes/entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "collection_id",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discountable",
"type": "`boolean`",
"description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "height",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "hs_code",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "images",
"type": "[Image](../entities/classes/entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "is_giftcard",
"type": "`boolean`",
"description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "length",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "material",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "mid_code",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "[ProductOption](../entities/classes/entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profile",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "profile_id",
"type": "`string`",
"description": "The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profiles",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sales_channels",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "status",
"type": "[ProductStatus](../entities/enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
"expandable": false,
"children": []
},
{
"name": "subtitle",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tags",
"type": "[ProductTag](../entities/classes/entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "A title that can be displayed for easy identification of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "[ProductType](../entities/classes/entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "type_id",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants",
"type": "[ProductVariant](../entities/classes/entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "width",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "query",
"type": "FindOptionsWhere&#60;[ProductCategory](../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "category_children",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the category's children.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`string`",
"description": "The product category's description.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`string`",
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product category's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_active",
"type": "`Boolean`",
"description": "A flag to make product category visible/hidden in the store front",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_internal",
"type": "`Boolean`",
"description": "A flag to make product category an internal category for admins",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The product category's name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_category",
"type": "`null` \\| [ProductCategory](../entities/classes/entities.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_category_id",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "products",
"type": "[Product](../entities/classes/entities.Product.mdx)[]",
"description": "The details of the products that belong to this category.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "categories",
"type": "[ProductCategory](../entities/classes/entities.ProductCategory.mdx)[]",
"description": "The details of the product categories that this product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"featureFlag": "product_categories",
"children": []
},
{
"name": "collection",
"type": "[ProductCollection](../entities/classes/entities.ProductCollection.mdx)",
"description": "The details of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "collection_id",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discountable",
"type": "`boolean`",
"description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "handle",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "height",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "hs_code",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The product's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "images",
"type": "[Image](../entities/classes/entities.Image.mdx)[]",
"description": "The details of the product's images.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "is_giftcard",
"type": "`boolean`",
"description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "length",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "material",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "mid_code",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "[ProductOption](../entities/classes/entities.ProductOption.mdx)[]",
"description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "origin_country",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profile",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)",
"description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "profile_id",
"type": "`string`",
"description": "The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profiles",
"type": "[ShippingProfile](../entities/classes/entities.ShippingProfile.mdx)[]",
"description": "Available if the relation `profiles` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sales_channels",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)[]",
"description": "The details of the sales channels this product is available in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "status",
"type": "[ProductStatus](../entities/enums/entities.ProductStatus.mdx)",
"description": "The status of the product",
"optional": false,
"defaultValue": "draft",
"expandable": false,
"children": []
},
{
"name": "subtitle",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tags",
"type": "[ProductTag](../entities/classes/entities.ProductTag.mdx)[]",
"description": "The details of the product tags used in this product.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "A title that can be displayed for easy identification of the Product.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "[ProductType](../entities/classes/entities.ProductType.mdx)",
"description": "The details of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "type_id",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants",
"type": "[ProductVariant](../entities/classes/entities.ProductVariant.mdx)[]",
"description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "weight",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "width",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "rank",
"type": "`number`",
"description": "An integer that depicts the rank of category in a tree node",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryProductJoinTable",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product_category_product\"",
"expandable": false,
"children": []
},
{
"name": "treeRelations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string[]",
"type": "`string`[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### formatException
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "constructor",
"type": "(`type`: `string`, `message`: `string`, `code?`: `string`, ...`params`: `any`) => [MedusaError](../medusa/classes/medusa.MedusaError.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "code",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "date",
"type": "`Date`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "message",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Codes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "CART_INCOMPATIBLE_STATE",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "INSUFFICIENT_INVENTORY",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "Types",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "CONFLICT",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "DB_ERROR",
"type": "`string`",
"description": "Errors stemming from the database",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "DUPLICATE_ERROR",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "INVALID_ARGUMENT",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "INVALID_DATA",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "NOT_ALLOWED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "NOT_FOUND",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "PAYMENT_AUTHORIZATION_ERROR",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "UNAUTHORIZED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "UNEXPECTED_STATE",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### generateEntityId
Generate a composed id based on the input parameters and return either the is if it exists or the generated one.
#### Parameters
<ParameterTypes parameters={[
{
"name": "idProperty",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "prefix",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### getRequestedBatchJob
#### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### getVariantsFromPriceList
#### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "[MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "createScope",
"type": "() => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "registerAdd",
"type": "`<T>`(`name`: `string`, `registration`: `T`) => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "priceListId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductVariantDTO](../medusa/interfaces/medusa.ProductVariantDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ProductVariantDTO[]",
"type": "[ProductVariantDTO](../medusa/interfaces/medusa.ProductVariantDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ProductVariantDTO",
"type": "`object`",
"description": "A product variant's data.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### hasChanges
Compare two objects and return true if there is changes detected from obj2 compared to obj1
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T1",
"type": "`Object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "T2",
"type": "`Object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj1",
"type": "`T1`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "obj2",
"type": "`T2`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isBatchJobStrategy
#### Parameters
<ParameterTypes parameters={[
{
"name": "object",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "object",
"type": "object is IBatchJobStrategy",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isCartCompletionStrategy
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isDate
#### Parameters
<ParameterTypes parameters={[
{
"name": "value",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "value",
"type": "value is Date",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isFileService
#### Parameters
<ParameterTypes parameters={[
{
"name": "object",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isNotificationService
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isObject
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "obj",
"type": "obj is object",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isPaymentProcessor
Return if the input object is AbstractPaymentProcessor
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isPaymentProcessorError
Utility function to determine if an object is a processor error
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "obj",
"type": "obj is PaymentProcessorError",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isPaymentService
Return if the input object is one of AbstractPaymentService or PaymentService or AbstractPaymentPluginService
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isPriceSelectionStrategy
#### Parameters
<ParameterTypes parameters={[
{
"name": "object",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "object",
"type": "object is IPriceSelectionStrategy",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isString
#### Parameters
<ParameterTypes parameters={[
{
"name": "val",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "val",
"type": "val is string",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isTaxCalculationStrategy
#### Parameters
<ParameterTypes parameters={[
{
"name": "object",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "object",
"type": "object is ITaxCalculationStrategy",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### listProducts
#### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "[MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "createScope",
"type": "() => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "registerAdd",
"type": "`<T>`(`name`: `string`, `registration`: `T`) => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "filterableFields",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "listConfig",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any[]",
"type": "`any`[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### normalizeQuery
Normalize an input query, especially from array like query params to an array type
e.g: /admin/orders/?fields[]=id,status,cart\_id becomes &#123; fields: ["id", "status", "cart\_id"] &#125;
#### Returns
<ParameterTypes parameters={[
{
"name": "(req: Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;, res: Response&#60;any, Record&#60;string, any&#62;&#62;, next: NextFunction) => void",
"type": "(`req`: Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;, `res`: Response&#60;any, Record&#60;string, any&#62;&#62;, `next`: `NextFunction`) => `void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "Response&#60;any, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`NextFunction`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### nullableValue
#### Parameters
<ParameterTypes parameters={[
{
"name": "value",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "FindOperator",
"type": "FindOperator&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### omitDeep
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "input",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "excludes",
"type": "(`string` \\| `number`)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "T",
"type": "`T`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### registerOverriddenValidators
When overriding a validator, you can register it to be used instead of the original one.
For example, the place where you are overriding the core validator, you can call this function
#### Example
```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)
```
#### Parameters
<ParameterTypes parameters={[
{
"name": "extendedValidator",
"type": "[Constructor](../medusa/types/medusa.Constructor-1.mdx)&#60;any&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### remoteQueryFetchData
#### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "[MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "createScope",
"type": "() => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "registerAdd",
"type": "`<T>`(`name`: `string`, `registration`: `T`) => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "(expand: any, keyField: any, ids: any, relationship: any) => Promise&#60;any&#62;",
"type": "(`expand`: `any`, `keyField`: `any`, `ids`: `any`, `relationship`: `any`) => Promise&#60;any&#62;",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "expand",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "keyField",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ids",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "relationship",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### removeUndefinedProperties
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "inputObj",
"type": "`T`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "T",
"type": "`T`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### requireCustomerAuthentication
#### Returns
<ParameterTypes parameters={[
{
"name": "RequestHandler",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ParamsDictionary",
"type": "`ParamsDictionary`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "ParsedQs",
"type": "`ParsedQs`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "Record",
"type": "`Record<string, any>`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### reserveQuantityForDraftOrder
#### Parameters
<ParameterTypes parameters={[
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "billing_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "address_1",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "address_2",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "city",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "company",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "country",
"type": "`null` \\| [Country](../entities/classes/entities.Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "country_code",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer",
"type": "`null` \\| [Customer](../entities/classes/entities.Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer_id",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "first_name",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "ID of the address",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "last_name",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "phone",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "postal_code",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "province",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "billing_address_id",
"type": "`string`",
"description": "The ID of the billing address associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date the order was canceled on.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "billing_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the billing address associated with the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "billing_address_id",
"type": "`string`",
"description": "The billing address's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "completed_at",
"type": "`Date`",
"description": "The date with timezone at which the cart was completed.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "`Record<string, unknown>`",
"description": "The context of the cart which can include info like IP or user agent.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer",
"type": "[Customer](../entities/classes/entities.Customer.mdx)",
"description": "The details of the customer the cart belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "customer_id",
"type": "`string`",
"description": "The customer's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discount_total",
"type": "`number`",
"description": "The total of discount rounded",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discounts",
"type": "[Discount](../entities/classes/entities.Discount.mdx)[]",
"description": "An array of details of all discounts applied to the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "email",
"type": "`string`",
"description": "The email associated with the cart",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_tax_total",
"type": "`number`",
"description": "The total of gift cards with taxes",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_total",
"type": "`number`",
"description": "The total of gift cards",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_cards",
"type": "[GiftCard](../entities/classes/entities.GiftCard.mdx)[]",
"description": "An array of details of all gift cards applied to the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The cart's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of a cart in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "item_tax_total",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The line items added to the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "object",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
"expandable": false,
"children": []
},
{
"name": "payment",
"type": "[Payment](../entities/classes/entities.Payment.mdx)",
"description": "The details of the payment associated with the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "payment_authorized_at",
"type": "`Date`",
"description": "The date with timezone at which the payment was authorized.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_id",
"type": "`string`",
"description": "The payment's ID if available",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_session",
"type": "`null` \\| [PaymentSession](../entities/classes/entities.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "payment_sessions",
"type": "[PaymentSession](../entities/classes/entities.PaymentSession.mdx)[]",
"description": "The details of all payment sessions created on the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "raw_discount_total",
"type": "`number`",
"description": "The total of discount",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refundable_amount",
"type": "`number`",
"description": "The amount that can be refunded",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refunded_total",
"type": "`number`",
"description": "The total amount refunded if the order associated with this cart is returned.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "region",
"type": "[Region](../entities/classes/entities.Region.mdx)",
"description": "The details of the region associated with the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "region_id",
"type": "`string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sales_channel",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)",
"description": "The details of the sales channel associated with the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "sales_channel_id",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_address",
"type": "`null` \\| [Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The shipping address's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods added to the cart.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_tax_total",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_total",
"type": "`number`",
"description": "The total of shipping",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "subtotal",
"type": "`number`",
"description": "The subtotal of the cart",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_total",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`number`",
"description": "The total amount of the cart",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "[CartType](../entities/enums/entities.CartType.mdx)",
"description": "The cart's type.",
"optional": false,
"defaultValue": "default",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claims",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "additional_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the claim was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_items",
"type": "[ClaimItem](../entities/classes/entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../entities/enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The claim's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be send.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the claim comes from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../entities/enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
"expandable": false,
"children": []
},
{
"name": "refund_amount",
"type": "`number`",
"description": "The amount that will be refunded in conjunction with the claim",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_order",
"type": "[Return](../entities/classes/entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The ID of the address that the new items should be shipped to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "type",
"type": "[ClaimType](../entities/enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[Currency](../entities/classes/entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "code",
"type": "`string`",
"description": "The 3 character ISO code for the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Whether the currency prices include tax",
"optional": true,
"defaultValue": "false",
"expandable": false,
"featureFlag": "tax_inclusive_pricing",
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The written name of the currency",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "symbol",
"type": "`string`",
"description": "The symbol used to indicate the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "symbol_native",
"type": "`string`",
"description": "The native symbol used to indicate the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "currency_code",
"type": "`string`",
"description": "The 3 character currency code that is used in the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer",
"type": "[Customer](../entities/classes/entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "billing_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the billing address associated with the customer.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "billing_address_id",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "email",
"type": "`string`",
"description": "The customer's email",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "first_name",
"type": "`string`",
"description": "The customer's first name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "groups",
"type": "[CustomerGroup](../entities/classes/entities.CustomerGroup.mdx)[]",
"description": "The customer groups the customer belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "has_account",
"type": "`boolean`",
"description": "Whether the customer has an account or not",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The customer's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "last_name",
"type": "`string`",
"description": "The customer's last name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "orders",
"type": "[Order](../entities/classes/entities.Order.mdx)[]",
"description": "The details of the orders this customer placed.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "password_hash",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "phone",
"type": "`string`",
"description": "The customer's phone number",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_addresses",
"type": "[Address](../entities/classes/entities.Address.mdx)[]",
"description": "The details of the shipping addresses associated with the customer.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "customer_id",
"type": "`string`",
"description": "The ID of the customer associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discount_total",
"type": "`number`",
"description": "The total of discount rounded",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discounts",
"type": "[Discount](../entities/classes/entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "code",
"type": "`string`",
"description": "A unique code for the discount - this will be used by the customer to apply the discount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ends_at",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The discount's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_disabled",
"type": "`boolean`",
"description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_dynamic",
"type": "`boolean`",
"description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "parent_discount",
"type": "[Discount](../entities/classes/entities.Discount.mdx)",
"description": "The details of the parent discount that this discount was created from.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "parent_discount_id",
"type": "`string`",
"description": "The Discount that the discount was created from. This will always be a dynamic discount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regions",
"type": "[Region](../entities/classes/entities.Region.mdx)[]",
"description": "The details of the regions in which the Discount can be used.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rule",
"type": "[DiscountRule](../entities/classes/entities.DiscountRule.mdx)",
"description": "The details of the discount rule that defines how the discount will be applied to a cart..",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rule_id",
"type": "`string`",
"description": "The ID of the discount rule that defines how the discount will be applied to a cart.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "starts_at",
"type": "`Date`",
"description": "The time at which the discount can be used.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "usage_count",
"type": "`number`",
"description": "The number of times a discount has been used.",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "usage_limit",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "valid_duration",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "display_id",
"type": "`number`",
"description": "The order's display ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "draft_order",
"type": "[DraftOrder](../entities/classes/entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date the draft order was canceled at.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart associated with the draft order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart associated with the draft order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "completed_at",
"type": "`Date`",
"description": "The date the draft order was completed at.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "display_id",
"type": "`number`",
"description": "The draft order's display ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The draft order's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification_order",
"type": "`boolean`",
"description": "Whether to send the customer notifications regarding order updates.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order created from the draft order when its payment is captured.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order created from the draft order when its payment is captured.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[DraftOrderStatus](../entities/enums/entities.DraftOrderStatus.mdx)",
"description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.",
"optional": false,
"defaultValue": "open",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "draft_order_id",
"type": "`string`",
"description": "The ID of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "edits",
"type": "[OrderEdit](../entities/classes/entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the edit was cancelled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "canceled_by",
"type": "`string`",
"description": "The unique identifier of the user or customer who cancelled the order edit.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "changes",
"type": "[OrderItemChange](../entities/classes/entities.OrderItemChange.mdx)[]",
"description": "The details of all the changes on the original order's line items.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "confirmed_at",
"type": "`Date`",
"description": "The date with timezone at which the edit was confirmed.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "confirmed_by",
"type": "`string`",
"description": "The unique identifier of the user or customer who confirmed the order edit.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_by",
"type": "`string`",
"description": "The unique identifier of the user or customer who created the order edit.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "declined_at",
"type": "`Date`",
"description": "The date with timezone at which the edit was declined.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "declined_by",
"type": "`string`",
"description": "The unique identifier of the user or customer who declined the order edit.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "declined_reason",
"type": "`string`",
"description": "An optional note why the order edit is declined.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "difference_due",
"type": "`number`",
"description": "The difference between the total amount of the order and total amount of edited order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discount_total",
"type": "`number`",
"description": "The total of discount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_tax_total",
"type": "`number`",
"description": "The total of the gift card tax amount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_total",
"type": "`number`",
"description": "The total of the gift card amount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The order edit's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "internal_note",
"type": "`string`",
"description": "An optional note with additional details about the order edit.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that this order edit was created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that is edited",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_collection",
"type": "[PaymentCollection](../entities/classes/entities.PaymentCollection.mdx)",
"description": "The details of the payment collection used to authorize additional payment if necessary.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "payment_collection_id",
"type": "`string`",
"description": "The ID of the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requested_at",
"type": "`Date`",
"description": "The date with timezone at which the edit was requested.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requested_by",
"type": "`string`",
"description": "The unique identifier of the user or customer who requested the order edit.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_total",
"type": "`number`",
"description": "The total of the shipping amount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[OrderEditStatus](../entities/enums/entities.OrderEditStatus.mdx)",
"description": "The status of the order edit.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "subtotal",
"type": "`number`",
"description": "The total of subtotal",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_total",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`number`",
"description": "The total amount of the edited order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "email",
"type": "`string`",
"description": "The email associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../entities/enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
"expandable": false,
"children": [
{
"name": "CANCELED",
"type": "`\"canceled\"`",
"description": "The order's fulfillments are canceled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "FULFILLED",
"type": "`\"fulfilled\"`",
"description": "The order's items are fulfilled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "NOT_FULFILLED",
"type": "`\"not_fulfilled\"`",
"description": "The order's items are not fulfilled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "PARTIALLY_FULFILLED",
"type": "`\"partially_fulfilled\"`",
"description": "Some of the order's items, but not all, are fulfilled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "PARTIALLY_RETURNED",
"type": "`\"partially_returned\"`",
"description": "Some of the order's items, but not all, are returned.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "PARTIALLY_SHIPPED",
"type": "`\"partially_shipped\"`",
"description": "Some of the order's items, but not all, are shipped.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "REQUIRES_ACTION",
"type": "`\"requires_action\"`",
"description": "The order's fulfillment requires action.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "RETURNED",
"type": "`\"returned\"`",
"description": "The order's items are returned.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "SHIPPED",
"type": "`\"shipped\"`",
"description": "The order's items are shipped.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the Fulfillment was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_order",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "claim_order_id",
"type": "`string`",
"description": "The ID of the Claim that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The fulfillment's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[FulfillmentItem](../entities/classes/entities.FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "location_id",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the fulfillment will be shipped from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be sent.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the Order that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "provider",
"type": "[FulfillmentProvider](../entities/classes/entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "provider_id",
"type": "`string`",
"description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipped_at",
"type": "`Date`",
"description": "The date with timezone at which the Fulfillment was shipped.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "swap_id",
"type": "`string`",
"description": "The ID of the Swap that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tracking_links",
"type": "[TrackingLink](../entities/classes/entities.TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tracking_numbers",
"type": "`string`[]",
"description": "The tracking numbers that can be used to track the status of the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "gift_card_tax_total",
"type": "`number`",
"description": "The total of gift cards with taxes",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_total",
"type": "`number`",
"description": "The total of gift cards",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](../entities/classes/entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "amount",
"type": "`number`",
"description": "The amount that was used from the Gift Card.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card",
"type": "[GiftCard](../entities/classes/entities.GiftCard.mdx)",
"description": "The details of the gift card associated used in this transaction.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "gift_card_id",
"type": "`string`",
"description": "The ID of the Gift Card that was used in the transaction.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The gift card transaction's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_taxable",
"type": "`boolean`",
"description": "Whether the transaction is taxable or not.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the gift card was used for payment.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the gift card was used for payment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_rate",
"type": "`null` \\| `number`",
"description": "The tax rate of the transaction",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "gift_cards",
"type": "[GiftCard](../entities/classes/entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "balance",
"type": "`number`",
"description": "The remaining value on the Gift Card.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "code",
"type": "`string`",
"description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ends_at",
"type": "`Date`",
"description": "The time at which the Gift Card can no longer be used.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The gift card's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_disabled",
"type": "`boolean`",
"description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the gift card was purchased in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "region",
"type": "[Region](../entities/classes/entities.Region.mdx)",
"description": "The details of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "region_id",
"type": "`string`",
"description": "The ID of the region this gift card is available in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_rate",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`number`",
"description": "The value that the Gift Card represents.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "id",
"type": "`string`",
"description": "The order's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the processing of the order in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "item_tax_total",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "adjustments",
"type": "[LineItemAdjustment](../entities/classes/entities.LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "allow_discounts",
"type": "`boolean`",
"description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_order",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "claim_order_id",
"type": "`string`",
"description": "The ID of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discount_total",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfilled_quantity",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_total",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "has_shipping",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The line item's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
"featureFlag": "tax_inclusive_pricing",
"children": []
},
{
"name": "is_giftcard",
"type": "`boolean`",
"description": "Flag to indicate if the Line Item is a Gift Card.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_return",
"type": "`boolean`",
"description": "Is the item being returned",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_edit",
"type": "`null` \\| [OrderEdit](../entities/classes/entities.OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_edit_id",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order_id",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_item_id",
"type": "`null` \\| `string`",
"description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_tax_total",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_total",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "product_id",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The quantity of the content in the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "raw_discount_total",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refundable",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returned_quantity",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipped_quantity",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "should_merge",
"type": "`boolean`",
"description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "subtotal",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "swap_id",
"type": "`string`",
"description": "The ID of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_lines",
"type": "[LineItemTaxLine](../entities/classes/entities.LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tax_total",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The title of the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "unit_price",
"type": "`number`",
"description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant",
"type": "[ProductVariant](../entities/classes/entities.ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "variant_id",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be send.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "object",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
"expandable": false,
"children": []
},
{
"name": "paid_total",
"type": "`number`",
"description": "The total amount paid",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_status",
"type": "[PaymentStatus](../entities/enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
"expandable": false,
"children": [
{
"name": "AWAITING",
"type": "`\"awaiting\"`",
"description": "The order's payment is awaiting capturing.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "CANCELED",
"type": "`\"canceled\"`",
"description": "The order's payment is canceled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "CAPTURED",
"type": "`\"captured\"`",
"description": "The order's payment is captured.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "NOT_PAID",
"type": "`\"not_paid\"`",
"description": "The order's payment is not paid.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "PARTIALLY_REFUNDED",
"type": "`\"partially_refunded\"`",
"description": "Some of the order's payment amount is refunded.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "REFUNDED",
"type": "`\"refunded\"`",
"description": "The order's payment amount is refunded.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "REQUIRES_ACTION",
"type": "`\"requires_action\"`",
"description": "The order's payment requires action.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "payments",
"type": "[Payment](../entities/classes/entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "amount",
"type": "`number`",
"description": "The amount that the Payment has been authorized for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "amount_refunded",
"type": "`number`",
"description": "The amount of the original Payment amount that has been refunded back to the Customer.",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "canceled_at",
"type": "`string` \\| `Date`",
"description": "The date with timezone at which the Payment was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "captured_at",
"type": "`string` \\| `Date`",
"description": "The date with timezone at which the Payment was captured.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[Currency](../entities/classes/entities.Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "currency_code",
"type": "`string`",
"description": "The 3 character ISO currency code of the payment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The payment's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of a payment in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "provider_id",
"type": "`string`",
"description": "The id of the Payment Provider that is responsible for the Payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "swap_id",
"type": "`string`",
"description": "The ID of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "raw_discount_total",
"type": "`number`",
"description": "The total of discount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refundable_amount",
"type": "`number`",
"description": "The amount that can be refunded",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refunded_total",
"type": "`number`",
"description": "The total amount refunded if the order is returned.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refunds",
"type": "[Refund](../entities/classes/entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "amount",
"type": "`number`",
"description": "The amount that has be refunded to the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The refund's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the refund in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "note",
"type": "`string`",
"description": "An optional note explaining why the amount was refunded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order this refund was created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order this refund was created for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment",
"type": "[Payment](../entities/classes/entities.Payment.mdx)",
"description": "The details of the payment associated with the refund.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "payment_id",
"type": "`string`",
"description": "The payment's ID, if available.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reason",
"type": "`string`",
"description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "region",
"type": "[Region](../entities/classes/entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "automatic_taxes",
"type": "`boolean`",
"description": "Whether taxes should be automated in this region.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "countries",
"type": "[Country](../entities/classes/entities.Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[Currency](../entities/classes/entities.Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "currency_code",
"type": "`string`",
"description": "The three character currency code used in the region.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_providers",
"type": "[FulfillmentProvider](../entities/classes/entities.FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "gift_cards_taxable",
"type": "`boolean`",
"description": "Whether the gift cards are taxable or not in this region.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Whether the prices for the region include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
"featureFlag": "tax_inclusive_pricing",
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_providers",
"type": "[PaymentProvider](../entities/classes/entities.PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tax_code",
"type": "`string`",
"description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_provider",
"type": "[TaxProvider](../entities/classes/entities.TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tax_provider_id",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_rate",
"type": "`number`",
"description": "The tax rate that should be charged on purchases in the Region.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_rates",
"type": "`null` \\| [TaxRate](../entities/classes/entities.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "region_id",
"type": "`string`",
"description": "The ID of the region this order was created in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returnable_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "adjustments",
"type": "[LineItemAdjustment](../entities/classes/entities.LineItemAdjustment.mdx)[]",
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "allow_discounts",
"type": "`boolean`",
"description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_order",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)",
"description": "The details of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "claim_order_id",
"type": "`string`",
"description": "The ID of the claim that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discount_total",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfilled_quantity",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_total",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "has_shipping",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The line item's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Indicates if the line item unit\\_price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
"featureFlag": "tax_inclusive_pricing",
"children": []
},
{
"name": "is_giftcard",
"type": "`boolean`",
"description": "Flag to indicate if the Line Item is a Gift Card.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "is_return",
"type": "`boolean`",
"description": "Is the item being returned",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_edit",
"type": "`null` \\| [OrderEdit](../entities/classes/entities.OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_edit_id",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order_id",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_item_id",
"type": "`null` \\| `string`",
"description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_tax_total",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_total",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "product_id",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The quantity of the content in the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "raw_discount_total",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refundable",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returned_quantity",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipped_quantity",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "should_merge",
"type": "`boolean`",
"description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "subtotal",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "swap_id",
"type": "`string`",
"description": "The ID of the swap that the line item may belong to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_lines",
"type": "[LineItemTaxLine](../entities/classes/entities.LineItemTaxLine.mdx)[]",
"description": "The details of the item's tax lines.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tax_total",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "thumbnail",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The title of the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "unit_price",
"type": "`number`",
"description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant",
"type": "[ProductVariant](../entities/classes/entities.ProductVariant.mdx)",
"description": "The details of the product variant that this item was created from.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "variant_id",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "returns",
"type": "[Return](../entities/classes/entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "claim_order",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)",
"description": "The details of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "claim_order_id",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The return's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[ReturnItem](../entities/classes/entities.ReturnItem.mdx)[]",
"description": "The details of the items that the customer is returning.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "location_id",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the return was created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "received_at",
"type": "`Date`",
"description": "The date with timezone at which the return was received.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refund_amount",
"type": "`number`",
"description": "The amount that should be refunded as a result of the return.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_data",
"type": "`Record<string, unknown>`",
"description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_method",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)",
"description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "status",
"type": "[ReturnStatus](../entities/enums/entities.ReturnStatus.mdx)",
"description": "Status of the Return.",
"optional": false,
"defaultValue": "requested",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "swap_id",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "sales_channel",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "description",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The sales channel's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_disabled",
"type": "`boolean`",
"description": "Specify if the sales channel is enabled or disabled.",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "locations",
"type": "[SalesChannelLocation](../entities/classes/entities.SalesChannelLocation.mdx)[]",
"description": "The details of the stock locations related to the sales channel.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "metadata",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The name of the sales channel.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "sales_channel_id",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "address_1",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "address_2",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "city",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "company",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "country",
"type": "`null` \\| [Country](../entities/classes/entities.Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "country_code",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer",
"type": "`null` \\| [Customer](../entities/classes/entities.Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer_id",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "first_name",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "ID of the address",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "last_name",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "phone",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "postal_code",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "province",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The ID of the shipping address associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_order",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)",
"description": "The details of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "claim_order_id",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The shipping method's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "includes_tax",
"type": "`boolean`",
"description": "Whether the shipping method price include tax",
"optional": false,
"defaultValue": "false",
"expandable": false,
"featureFlag": "tax_inclusive_pricing",
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price",
"type": "`number`",
"description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_id",
"type": "`string`",
"description": "The ID of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_order",
"type": "[Return](../entities/classes/entities.Return.mdx)",
"description": "The details of the return that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_option",
"type": "[ShippingOption](../entities/classes/entities.ShippingOption.mdx)",
"description": "The details of the shipping option the method was created from.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_option_id",
"type": "`string`",
"description": "The ID of the Shipping Option that the Shipping Method is built from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "subtotal",
"type": "`number`",
"description": "The subtotal of the shipping",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "swap_id",
"type": "`string`",
"description": "The ID of the swap that the shipping method is used in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_lines",
"type": "[ShippingMethodTaxLine](../entities/classes/entities.ShippingMethodTaxLine.mdx)[]",
"description": "The details of the tax lines applied on the shipping method.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tax_total",
"type": "`number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`number`",
"description": "The total amount of the shipping",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "shipping_tax_total",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_total",
"type": "`number`",
"description": "The total of shipping",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[OrderStatus](../entities/enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
"expandable": false,
"children": [
{
"name": "ARCHIVED",
"type": "`\"archived\"`",
"description": "The order is archived.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "CANCELED",
"type": "`\"canceled\"`",
"description": "The order is canceled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "COMPLETED",
"type": "`\"completed\"`",
"description": "The order is completed, meaning that \nthe items have been fulfilled and the payment\nhas been captured.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "PENDING",
"type": "`\"pending\"`",
"description": "The order is pending.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "REQUIRES_ACTION",
"type": "`\"requires_action\"`",
"description": "The order requires action.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "subtotal",
"type": "`number`",
"description": "The subtotal of the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swaps",
"type": "[Swap](../entities/classes/entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "additional_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "If true, swaps can be completed with items out of stock",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the Swap was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "confirmed_at",
"type": "`Date`",
"description": "The date with timezone at which the Swap was confirmed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "difference_due",
"type": "`number`",
"description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../entities/enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The swap's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the swap in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "If set to true, no notification will be sent related to this swap",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment",
"type": "[Payment](../entities/classes/entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../entities/enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_order",
"type": "[Return](../entities/classes/entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "tax_rate",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_total",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`number`",
"description": "The total amount of the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "context",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "locationId",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantInventoryService",
"type": "[ProductVariantInventoryService](../services/classes/services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](../services/classes/services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelInventoryService_",
"type": "[SalesChannelInventoryService](../services/classes/services.SalesChannelInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "context.locationId",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context.productVariantInventoryService",
"type": "[ProductVariantInventoryService](../services/classes/services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](../services/classes/services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cartRepository_",
"type": "Repository&#60;[Cart](../entities/classes/entities.Cart.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](../services/classes/services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "moneyAmountRepository_",
"type": "Repository&#60;[MoneyAmount](../entities/classes/entities.MoneyAmount.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "priceSelectionStrategy_",
"type": "[IPriceSelectionStrategy](../medusa/interfaces/medusa.IPriceSelectionStrategy.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productOptionValueRepository_",
"type": "Repository&#60;[ProductOptionValue](../entities/classes/entities.ProductOptionValue.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](../entities/classes/entities.Product.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantRepository_",
"type": "Repository&#60;[ProductVariant](../entities/classes/entities.ProductVariant.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](../services/classes/services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "salesChannelInventoryService_",
"type": "[SalesChannelInventoryService](../services/classes/services.SalesChannelInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelService_",
"type": "[SalesChannelService](../services/classes/services.SalesChannelService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### resolveDbGenerationStrategy
#### Parameters
<ParameterTypes parameters={[
{
"name": "pgSqlType",
"type": "`\"uuid\"` \\| `\"rowid\"` \\| `\"increment\"`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "\"increment\" \\| \"uuid\" \\| \"rowid\"",
"type": "`\"increment\"` \\| `\"uuid\"` \\| `\"rowid\"`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### resolveDbType
#### Parameters
<ParameterTypes parameters={[
{
"name": "pgSqlType",
"type": "`ColumnType`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ColumnType",
"type": "`ColumnType`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### retrieveProduct
#### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "remoteQueryObject",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### setMetadata
Dedicated method to set metadata.
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`undefined` \\| `null` \\| `object`",
"description": "the entity to apply metadata to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "the metadata to set",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Record",
"type": "`Record<string, unknown>`",
"optional": false,
"defaultValue": "",
"description": "resolves to the updated result.",
"expandable": false,
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "unknown",
"type": "`unknown`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### transformBody
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "plainToClass",
"type": "[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`ValidatorOptions`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "(req: Request, res: Response, next: NextFunction) => Promise&#60;void&#62;",
"type": "(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => Promise&#60;void&#62;",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`Request`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "`Response`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`NextFunction`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### transformIncludesOptions
Retrieve the includes options from the fields query param.
If the include option is present then assigned it to includes on req
#### Parameters
<ParameterTypes parameters={[
{
"name": "allowedIncludes",
"type": "`string`[]",
"description": "The list of fields that can be passed and assign to req.includes",
"optional": false,
"defaultValue": "[]",
"expandable": false,
"children": []
},
{
"name": "expectedIncludes",
"type": "`string`[]",
"description": "The list of fields that the consumer can pass to the end point using this middleware. It is a subset of `allowedIncludes`",
"optional": false,
"defaultValue": "[]",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "(req: Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;, res: Response&#60;any, Record&#60;string, any&#62;&#62;, next: NextFunction) => void",
"type": "(`req`: Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;, `res`: Response&#60;any, Record&#60;string, any&#62;&#62;, `next`: `NextFunction`) => `void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "Response&#60;any, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`NextFunction`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### transformQuery
Middleware that transform the query input for the admin end points
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "[RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "expand",
"type": "`string`",
"description": "Comma-separated relations that should be expanded in the returned data.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fields",
"type": "`string`",
"description": "Comma-separated fields that should be included in the returned data.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "limit",
"type": "`number`",
"description": "Limit the number of items returned in the list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "offset",
"type": "`number`",
"description": "The number of items to skip when retrieving a list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "`string`",
"description": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "TEntity",
"type": "`BaseEntity`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "plainToClass",
"type": "[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "queryConfig",
"type": "Omit&#60;[QueryConfig](../medusa/types/medusa.QueryConfig.mdx)&#60;TEntity&#62;, \"allowedFields\" \\| \"allowedRelations\"&#62;",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "defaultFields",
"type": "(keyof `TEntity` \\| `string`)[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultLimit",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultRelations",
"type": "`string`[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isList",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "config",
"type": "`ValidatorOptions`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "(req: Request, res: Response, next: NextFunction) => Promise&#60;void&#62;",
"type": "(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => Promise&#60;void&#62;",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`Request`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "`Response`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`NextFunction`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### transformStoreQuery
Middleware that transform the query input for the store endpoints
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "[RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "expand",
"type": "`string`",
"description": "Comma-separated relations that should be expanded in the returned data.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fields",
"type": "`string`",
"description": "Comma-separated fields that should be included in the returned data.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "limit",
"type": "`number`",
"description": "Limit the number of items returned in the list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "offset",
"type": "`number`",
"description": "The number of items to skip when retrieving a list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "`string`",
"description": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "TEntity",
"type": "`BaseEntity`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "plainToClass",
"type": "[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "queryConfig",
"type": "[QueryConfig](../medusa/types/medusa.QueryConfig.mdx)&#60;TEntity&#62;",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "allowedFields",
"type": "`string`[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "allowedRelations",
"type": "`string`[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultFields",
"type": "(keyof `TEntity` \\| `string`)[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultLimit",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultRelations",
"type": "`string`[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isList",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "config",
"type": "`ValidatorOptions`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "(req: Request, res: Response, next: NextFunction) => Promise&#60;void&#62;",
"type": "(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => Promise&#60;void&#62;",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
##### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`Request`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "res",
"type": "`Response`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "`NextFunction`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### unauthenticatedInviteRoutes
#### Parameters
<ParameterTypes parameters={[
{
"name": "app",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### unauthenticatedUserRoutes
#### Parameters
<ParameterTypes parameters={[
{
"name": "app",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### updateInventoryAndReservations
#### Parameters
<ParameterTypes parameters={[
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the Fulfillment was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_order",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)",
"description": "The details of the claim that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "additional_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the new items to be shipped when the claim's type is `replace`",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the claim was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claim_items",
"type": "[ClaimItem](../entities/classes/entities.ClaimItem.mdx)[]",
"description": "The details of the items that should be replaced or refunded.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[ClaimFulfillmentStatus](../entities/enums/entities.ClaimFulfillmentStatus.mdx)",
"description": "The claim's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The fulfillments of the new items to be shipped",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The claim's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be send.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that this claim was created for.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the claim comes from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_status",
"type": "[ClaimPaymentStatus](../entities/enums/entities.ClaimPaymentStatus.mdx)",
"description": "The status of the claim's payment",
"optional": false,
"defaultValue": "na",
"expandable": false,
"children": []
},
{
"name": "refund_amount",
"type": "`number`",
"description": "The amount that will be refunded in conjunction with the claim",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_order",
"type": "[Return](../entities/classes/entities.Return.mdx)",
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the address that new items should be shipped to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The ID of the address that the new items should be shipped to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods that the claim order will be shipped with.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "type",
"type": "[ClaimType](../entities/enums/entities.ClaimType.mdx)",
"description": "The claim's type",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "claim_order_id",
"type": "`string`",
"description": "The ID of the Claim that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The fulfillment's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[FulfillmentItem](../entities/classes/entities.FulfillmentItem.mdx)[]",
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "fulfillment",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)",
"description": "The details of the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "fulfillment_id",
"type": "`string`",
"description": "The ID of the Fulfillment that the Fulfillment Item belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "item",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)",
"description": "The details of the line item.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "item_id",
"type": "`string`",
"description": "The ID of the Line Item that the Fulfillment Item references.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "The quantity of the Line Item that is included in the Fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "location_id",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the fulfillment will be shipped from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be sent.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "billing_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the billing address associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "billing_address_id",
"type": "`string`",
"description": "The ID of the billing address associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date the order was canceled on.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claims",
"type": "[ClaimOrder](../entities/classes/entities.ClaimOrder.mdx)[]",
"description": "The details of the claims created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[Currency](../entities/classes/entities.Currency.mdx)",
"description": "The details of the currency used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "currency_code",
"type": "`string`",
"description": "The 3 character currency code that is used in the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customer",
"type": "[Customer](../entities/classes/entities.Customer.mdx)",
"description": "The details of the customer associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "customer_id",
"type": "`string`",
"description": "The ID of the customer associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discount_total",
"type": "`number`",
"description": "The total of discount rounded",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discounts",
"type": "[Discount](../entities/classes/entities.Discount.mdx)[]",
"description": "The details of the discounts applied on the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "display_id",
"type": "`number`",
"description": "The order's display ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "draft_order",
"type": "[DraftOrder](../entities/classes/entities.DraftOrder.mdx)",
"description": "The details of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "draft_order_id",
"type": "`string`",
"description": "The ID of the draft order this order was created from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "edits",
"type": "[OrderEdit](../entities/classes/entities.OrderEdit.mdx)[]",
"description": "The details of the order edits done on the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "email",
"type": "`string`",
"description": "The email associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "external_id",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[FulfillmentStatus](../entities/enums/entities.FulfillmentStatus.mdx)",
"description": "The order's fulfillment status",
"optional": false,
"defaultValue": "not_fulfilled",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "gift_card_tax_total",
"type": "`number`",
"description": "The total of gift cards with taxes",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_total",
"type": "`number`",
"description": "The total of gift cards",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "gift_card_transactions",
"type": "[GiftCardTransaction](../entities/classes/entities.GiftCardTransaction.mdx)[]",
"description": "The gift card transactions made in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "gift_cards",
"type": "[GiftCard](../entities/classes/entities.GiftCard.mdx)[]",
"description": "The details of the gift card used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The order's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the processing of the order in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "item_tax_total",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the line items that belong to the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "Flag for describing whether or not notifications related to this should be send.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "object",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
"expandable": false,
"children": []
},
{
"name": "paid_total",
"type": "`number`",
"description": "The total amount paid",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment_status",
"type": "[PaymentStatus](../entities/enums/entities.PaymentStatus.mdx)",
"description": "The order's payment status",
"optional": false,
"defaultValue": "not_paid",
"expandable": false,
"children": []
},
{
"name": "payments",
"type": "[Payment](../entities/classes/entities.Payment.mdx)[]",
"description": "The details of the payments used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "raw_discount_total",
"type": "`number`",
"description": "The total of discount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refundable_amount",
"type": "`number`",
"description": "The amount that can be refunded",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refunded_total",
"type": "`number`",
"description": "The total amount refunded if the order is returned.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refunds",
"type": "[Refund](../entities/classes/entities.Refund.mdx)[]",
"description": "The details of the refunds created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "region",
"type": "[Region](../entities/classes/entities.Region.mdx)",
"description": "The details of the region this order was created in.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "region_id",
"type": "`string`",
"description": "The ID of the region this order was created in.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returnable_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the line items that are returnable as part of the order, swaps, or claims",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "returns",
"type": "[Return](../entities/classes/entities.Return.mdx)[]",
"description": "The details of the returns created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "sales_channel",
"type": "[SalesChannel](../entities/classes/entities.SalesChannel.mdx)",
"description": "The details of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "sales_channel_id",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the shipping address associated with the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The ID of the shipping address associated with the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used in the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_tax_total",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_total",
"type": "`number`",
"description": "The total of shipping",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[OrderStatus](../entities/enums/entities.OrderStatus.mdx)",
"description": "The order's status",
"optional": false,
"defaultValue": "pending",
"expandable": false,
"children": []
},
{
"name": "subtotal",
"type": "`number`",
"description": "The subtotal of the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swaps",
"type": "[Swap](../entities/classes/entities.Swap.mdx)[]",
"description": "The details of the swaps created for the order.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "tax_rate",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tax_total",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "total",
"type": "`number`",
"description": "The total amount of the order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the Order that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "provider",
"type": "[FulfillmentProvider](../entities/classes/entities.FulfillmentProvider.mdx)",
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of the fulfillment provider as given by the fulfillment service.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_installed",
"type": "`boolean`",
"description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
}
]
},
{
"name": "provider_id",
"type": "`string`",
"description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipped_at",
"type": "`Date`",
"description": "The date with timezone at which the Fulfillment was shipped.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "swap",
"type": "[Swap](../entities/classes/entities.Swap.mdx)",
"description": "The details of the swap that the fulfillment may belong to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "additional_items",
"type": "[LineItem](../entities/classes/entities.LineItem.mdx)[]",
"description": "The details of the new products to send to the customer, represented as line items.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "allow_backorder",
"type": "`boolean`",
"description": "If true, swaps can be completed with items out of stock",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "canceled_at",
"type": "`Date`",
"description": "The date with timezone at which the Swap was canceled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../entities/classes/entities.Cart.mdx)",
"description": "The details of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "cart_id",
"type": "`string`",
"description": "The ID of the cart that the customer uses to complete the swap.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "confirmed_at",
"type": "`Date`",
"description": "The date with timezone at which the Swap was confirmed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "difference_due",
"type": "`number`",
"description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment_status",
"type": "[SwapFulfillmentStatus](../entities/enums/entities.SwapFulfillmentStatus.mdx)",
"description": "The status of the Fulfillment of the Swap.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillments",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)[]",
"description": "The details of the fulfillments that are used to send the new items to the customer.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The swap's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of the swap in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "no_notification",
"type": "`boolean`",
"description": "If set to true, no notification will be sent related to this swap",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "[Order](../entities/classes/entities.Order.mdx)",
"description": "The details of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "order_id",
"type": "`string`",
"description": "The ID of the order that the swap belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payment",
"type": "[Payment](../entities/classes/entities.Payment.mdx)",
"description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "payment_status",
"type": "[SwapPaymentStatus](../entities/enums/entities.SwapPaymentStatus.mdx)",
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "return_order",
"type": "[Return](../entities/classes/entities.Return.mdx)",
"description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address",
"type": "[Address](../entities/classes/entities.Address.mdx)",
"description": "The details of the shipping address that the new items should be sent to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "shipping_address_id",
"type": "`string`",
"description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shipping_methods",
"type": "[ShippingMethod](../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "The details of the shipping methods used to fulfill the additional items purchased.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "swap_id",
"type": "`string`",
"description": "The ID of the Swap that the Fulfillment belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tracking_links",
"type": "[TrackingLink](../entities/classes/entities.TrackingLink.mdx)[]",
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment",
"type": "[Fulfillment](../entities/classes/entities.Fulfillment.mdx)",
"description": "The details of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "fulfillment_id",
"type": "`string`",
"description": "The ID of the fulfillment that the tracking link belongs to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The tracking link's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotency_key",
"type": "`string`",
"description": "Randomly generated key used to continue the completion of a process in case of failure.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "tracking_number",
"type": "`string`",
"description": "The tracking number given by the shipping carrier.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "url",
"type": "`string`",
"description": "The URL at which the status of the shipment can be tracked.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "tracking_numbers",
"type": "`string`[]",
"description": "The tracking numbers that can be used to track the status of the fulfillment.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "context",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "inventoryService",
"type": "[ProductVariantInventoryService](../services/classes/services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](../services/classes/services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelInventoryService_",
"type": "[SalesChannelInventoryService](../services/classes/services.SalesChannelInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "locationId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "context.inventoryService",
"type": "[ProductVariantInventoryService](../services/classes/services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](../services/classes/services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cartRepository_",
"type": "Repository&#60;[Cart](../entities/classes/entities.Cart.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](../services/classes/services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "moneyAmountRepository_",
"type": "Repository&#60;[MoneyAmount](../entities/classes/entities.MoneyAmount.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "priceSelectionStrategy_",
"type": "[IPriceSelectionStrategy](../medusa/interfaces/medusa.IPriceSelectionStrategy.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productOptionValueRepository_",
"type": "Repository&#60;[ProductOptionValue](../entities/classes/entities.ProductOptionValue.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](../entities/classes/entities.Product.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantRepository_",
"type": "Repository&#60;[ProductVariant](../entities/classes/entities.ProductVariant.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](../services/classes/services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "salesChannelInventoryService_",
"type": "[SalesChannelInventoryService](../services/classes/services.SalesChannelInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](../services/classes/services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelService_",
"type": "[SalesChannelService](../services/classes/services.SalesChannelService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "context.locationId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### validateId
#### Parameters
<ParameterTypes parameters={[
{
"name": "rawId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": [
{
"name": "length",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "prefix",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "config.length",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config.prefix",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### validator
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "V",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "typedClass",
"type": "[ClassConstructor](../medusa/types/medusa.ClassConstructor.mdx)&#60;T&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "plain",
"type": "`V`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`ValidatorOptions`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;T&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "T",
"type": "`T`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### wrapHandler
#### Parameters
<ParameterTypes parameters={[
{
"name": "fn",
"type": "[handler](../medusa/types/medusa.handler.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "RequestHandler",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ParamsDictionary",
"type": "`ParamsDictionary`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "ParsedQs",
"type": "`ParsedQs`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "Record",
"type": "`Record<string, any>`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
#### Deprecated
use `import { wrapHandler } from "@medusajs/utils"`
Reference in New Issue View Git Blame Copy Permalink