Skip to main content
Skip to main content

internal

Namespaces​

Enumerations​

Classes​

Interfaces​

References​

Abortable​

Re-exports Abortable

ReadableOptions​

Re-exports ReadableOptions

WritableOptions​

Re-exports WritableOptions

Enumeration Members​

DEFAULT​

DEFAULT: "default"

Type Aliases​

AddOrderEditLineItemInput​

AddOrderEditLineItemInput: Object

Type declaration​

metadataRecord<string, unknown>
quantitynumberRequired
variant_idstringRequired

AdjustmentContext​

AdjustmentContext: Object

Type declaration​

variantobjectRequired
variant.product_idstringRequired

AdminDiscountConditionsRes​

AdminDiscountConditionsRes: Object

Schema​

Discount condition details.

Type declaration​

discount_conditionDiscountConditionRequired

AdminDiscountsListRes​

AdminDiscountsListRes: PaginatedResponse & { discounts: Discount[] }

Schema​

AdminDiscountsListRes type: object x-expanded-relations: field: discounts relations:

- parent_discount
- regions
- rule
- rule.conditions

required:

  • discounts
  • count
  • offset
  • limit properties: discounts: type: array items: $ref: "#/components/schemas/Discount" count: type: integer description: The total number of items available offset: type: integer description: The number of discounts skipped when retrieving the discounts. limit: type: integer description: The number of items per page

AdminDiscountsRes​

AdminDiscountsRes: Object

Schema​

Discount details.

Type declaration​

discountDiscountRequired

AllocationMapOptions​

AllocationMapOptions: Object

Type declaration​

exclude_discountsboolean
exclude_gift_cardsboolean

ArrayBufferLike​

ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

ArrayBufferView​

ArrayBufferView: TypedArray | DataView

AuthenticateResult​

AuthenticateResult: Object

Type declaration​

customerCustomer
errorstring
successbooleanRequired
userUser

AvailabilityContext​

AvailabilityContext: Object

Type declaration​

inventoryLocationMapMap<string, InventoryLevelDTO[]>
variantInventoryMapMap<string, ProductVariantInventoryItem[]>

BinaryLike​

BinaryLike: string | ArrayBufferView

BufferEncoding​

BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

CalculateOptionPriceInput​

CalculateOptionPriceInput: Object

Type declaration​

dataRecord<string, unknown>Required
provider_idstringRequired

CalculationContextData​

CalculationContextData: Object

Type declaration​

claimsClaimOrder[]
customerCustomerRequired
discountsDiscount[]Required
itemsLineItem[]Required
regionRegionRequired
shipping_addressAddress | nullRequired
shipping_methodsShippingMethod[]
swapsSwap[]

CalculationContextOptions​

CalculationContextOptions: Object

Type declaration​

exclude_discountsboolean
exclude_gift_cardsboolean
exclude_shippingboolean
is_returnboolean

CartCreateProps​

CartCreateProps: Object

Type declaration​

billing_addressPartial<AddressPayload>
billing_address_idstring
contextobject
country_codestring
customer_idstring
discountsDiscount[]
emailstring
gift_cardsGiftCard[]
metadataRecord<string, unknown>
regionRegion
region_idstring
sales_channel_idstring
shipping_addressPartial<AddressPayload>
shipping_address_idstring
typeCartType

CartUpdateProps​

CartUpdateProps: Object

Type declaration​

billing_addressAddressPayload | string
billing_address_idstring
completed_atDate
contextobject
country_codestring
customer_idstring
discountsDiscount[]
emailstring
gift_cardsGiftCard[]
metadataRecord<string, unknown>
payment_authorized_atDate | null
region_idstring
sales_channel_idstring
shipping_addressAddressPayload | string
shipping_address_idstring

CategoryQueryParams​

CategoryQueryParams: Object

Type declaration​

valuestring[]Required

ClaimTypeValue​

ClaimTypeValue: `${ClaimType}`

ConfigModule​

ConfigModule: Object

Type declaration​

featureFlagsRecord<string, boolean | string>Required
modulesRecord<string, false | string | Partial<InternalModuleDeclaration | ExternalModuleDeclaration>>
plugins({ options: Record<string, unknown> ; resolve: string } | string)[]Required
projectConfigProjectConfigOptionsRequired

Constructor​

Constructor<T>: Object

Type parameters​

TobjectRequired

CreateAnalyticsConfig​

CreateAnalyticsConfig: Object

Type declaration​

anonymizebooleanRequired
opt_outbooleanRequired

CreateClaimInput​

CreateClaimInput: Object

Type declaration​

additional_itemsCreateClaimItemAdditionalItemInput[]
claim_itemsCreateClaimItemInput[]Required
claim_order_idstring
metadataRecord<string, unknown>
no_notificationboolean
orderOrderRequired
refund_amountnumber
return_location_idstring
return_shippingCreateClaimReturnShippingInput
shipping_addressAddressPayload
shipping_address_idstring
shipping_methodsCreateClaimShippingMethodInput[]
typeClaimTypeValueRequired

CreateClaimItemAdditionalItemInput​

CreateClaimItemAdditionalItemInput: Object

Type declaration​

quantitynumberRequired
variant_idstringRequired

CreateClaimItemInput​

CreateClaimItemInput: Object

Type declaration​

claim_order_idstring
imagesstring[]
item_idstringRequired
notestring
quantitynumberRequired
reasonClaimReasonRequired
tagsstring[]

CreateClaimReturnShippingInput​

CreateClaimReturnShippingInput: Object

Type declaration​

option_idstring
pricenumber

CreateClaimShippingMethodInput​

CreateClaimShippingMethodInput: Object

Type declaration​

dataRecord<string, unknown>
idstring
option_idstring
pricenumber

CreateCustomShippingOptionInput​

CreateCustomShippingOptionInput: Object

Type declaration​

cart_idstring
metadataRecord<string, unknown>
pricenumberRequired
shipping_option_idstringRequired

CreateCustomerInput​

CreateCustomerInput: Object

Type declaration​

emailstringRequired
first_namestring
has_accountboolean
last_namestring
metadataRecord<string, unknown>
passwordstring
password_hashstring
phonestring

CreateDiscountInput​

CreateDiscountInput: Object

Type declaration​

codestringRequired
ends_atDate
is_disabledbooleanRequired
is_dynamicbooleanRequired
metadataRecord<string, unknown>
regionsstring[] | Region[]
ruleCreateDiscountRuleInputRequired
starts_atDate
usage_limitnumber
valid_durationstring

CreateDiscountRuleInput​

CreateDiscountRuleInput: Object

Type declaration​

allocationAllocationTypeRequired
conditionsDiscountConditionInput[]
descriptionstring
typeDiscountRuleTypeRequired
valuenumberRequired

CreateDynamicDiscountInput​

CreateDynamicDiscountInput: Object

Type declaration​

codestringRequired
ends_atDate
metadataRecord<string, unknown>
usage_limitnumberRequired

CreateFulfillmentOrder​

CreateFulfillmentOrder: Omit<ClaimOrder, "beforeInsert"> & { billing_address: Address ; currency_code: string ; discounts: Discount[] ; display_id: number ; email?: string ; is_claim?: boolean ; is_swap?: boolean ; items: LineItem[] ; no_notification: boolean ; payments: Payment[] ; region?: Region ; region_id: string ; shipping_methods: ShippingMethod[] ; tax_rate: number | null }

CreateGiftCardInput​

CreateGiftCardInput: Object

Type declaration​

balancenumber
ends_atDate
is_disabledboolean
metadataRecord<string, unknown>
order_idstring
region_idstringRequired
tax_ratenumber | null
valuenumber

CreateGiftCardTransactionInput​

CreateGiftCardTransactionInput: Object

Type declaration​

amountnumberRequired
created_atDate
gift_card_idstringRequired
is_taxableboolean
order_idstringRequired
tax_ratenumber | null

CreateIdempotencyKeyInput​

CreateIdempotencyKeyInput: Object

Type declaration​

idempotency_keystring
request_methodstring
request_paramsRecord<string, unknown>
request_pathstring

CreateOauthInput​

CreateOauthInput: Object

Type declaration​

application_namestringRequired
display_namestringRequired
install_urlstring
uninstall_urlstring

CreateOrderEditInput​

CreateOrderEditInput: Object

Type declaration​

internal_notestring
order_idstringRequired

CreateOrderEditItemChangeInput​

CreateOrderEditItemChangeInput: Object

Type declaration​

line_item_idstring
order_edit_idstringRequired
original_line_item_idstring
typeOrderEditItemChangeTypeRequired

CreatePaymentCollectionInput​

CreatePaymentCollectionInput: Object

Type declaration​

amountnumberRequired
created_bystringRequired
currency_codestringRequired
descriptionstring
metadataany
region_idstringRequired
typePaymentCollectionTypeRequired

CreatePaymentInput​

CreatePaymentInput: Object

Type declaration​

amountnumberRequired
cart_idstring
currency_codestringRequired
payment_sessionPaymentSessionRequired
provider_idstring
resource_idstring

CreateProductCategoryInput​

CreateProductCategoryInput: ProductCategoryInput & { name: string }

CreateProductCollection​

CreateProductCollection: Object

Type declaration​

handlestring
metadataRecord<string, unknown>
titlestringRequired

CreateProductInput​

CreateProductInput: Object

Service Level DTOs

Type declaration​

categoriesCreateProductProductCategoryInput[] | null
collection_idstring
descriptionstring
discountableboolean
external_idstring | null
handlestring
heightnumber
hs_codestring
imagesstring[]
is_giftcardboolean
lengthnumber
materialstring
metadataRecord<string, unknown>
mid_codestring
optionsCreateProductProductOption[]
origin_countrystring
profile_idstring
sales_channelsCreateProductProductSalesChannelInput[] | null
statusProductStatus
subtitlestring
tagsCreateProductProductTagInput[]
thumbnailstring
titlestringRequired
typeCreateProductProductTypeInput
variantsCreateProductProductVariantInput[]
weightnumber
widthnumber

CreateProductProductCategoryInput​

CreateProductProductCategoryInput: Object

Type declaration​

idstringRequired

CreateProductProductOption​

CreateProductProductOption: Object

Type declaration​

titlestringRequired

CreateProductProductSalesChannelInput​

CreateProductProductSalesChannelInput: Object

Type declaration​

idstringRequired

CreateProductProductTagInput​

CreateProductProductTagInput: Object

Type declaration​

idstring
valuestringRequired

CreateProductProductTypeInput​

CreateProductProductTypeInput: Object

Type declaration​

idstring
valuestringRequired

CreateProductProductVariantInput​

CreateProductProductVariantInput: Object

Type declaration​

allow_backorderboolean
barcodestring
eanstring
heightnumber
hs_codestring
inventory_quantitynumber
lengthnumber
manage_inventoryboolean
materialstring
metadataRecord<string, unknown>
mid_codestring
options{ value: string }[]
origin_countrystring
pricesCreateProductProductVariantPriceInput[]
skustring
titlestringRequired
upcstring
weightnumber
widthnumber

CreateProductProductVariantPriceInput​

CreateProductProductVariantPriceInput: Object

Type declaration​

amountnumberRequired
currency_codestring
max_quantitynumber
min_quantitynumber
region_idstring

CreateProductVariantInput​

CreateProductVariantInput: Object

Type declaration​

allow_backorderboolean
barcodestring
eanstring
heightnumber
hs_codestring
inventory_quantitynumber
lengthnumber
manage_inventoryboolean
materialstring
metadataRecord<string, unknown>
mid_codestring
optionsProductVariantOption[]Required
origin_countrystring
pricesProductVariantPrice[]Required
product_idstring
skustring
titlestring
upcstring
variant_ranknumber
weightnumber
widthnumber

CreateRegionInput​

CreateRegionInput: Object

Type declaration​

countriesstring[]Required
currency_codestringRequired
fulfillment_providersstring[]Required
includes_taxboolean
metadataRecord<string, unknown>
namestringRequired
payment_providersstring[]Required
tax_codestring
tax_ratenumberRequired

CreateReturnInput​

CreateReturnInput: Object

Type declaration​

claim_order_idstring
itemsOrdersReturnItem[]
location_idstring
metadataRecord<string, unknown>
no_notificationboolean
order_idstringRequired
refund_amountnumber
shipping_methodobject
shipping_method.option_idstring
shipping_method.pricenumber
swap_idstring

CreateReturnReason​

CreateReturnReason: Object

Type declaration​

descriptionstring
labelstringRequired
metadataRecord<string, unknown>
parent_return_reason_idstring
valuestringRequired

CreateReturnType​

CreateReturnType: Omit<Return, "beforeInsert">

CreateSalesChannelInput​

CreateSalesChannelInput: Object

Type declaration​

descriptionstring
is_disabledboolean
namestringRequired

CreateShipmentConfig​

CreateShipmentConfig: Object

Type declaration​

location_idstring
metadataRecord<string, unknown>
no_notificationboolean

CreateShippingMethod​

CreateShippingMethod: Object

Type declaration​

cart_idstring
claim_order_idstring
dataany
draft_order_idstring
order_idstring
pricenumber
return_idstring
shipping_option_idstring
swap_idstring

CreateShippingMethodDto​

CreateShippingMethodDto: CreateShippingMethod & { cart?: Cart ; order?: Order }

CreateShippingOptionInput​

CreateShippingOptionInput: Object

Type declaration​

admin_onlyboolean
amountnumber
dataRecord<string, unknown>Required
includes_taxboolean
is_returnboolean
metadataRecord<string, unknown>
namestringRequired
price_typeShippingOptionPriceTypeRequired
profile_idstringRequired
provider_idstringRequired
region_idstringRequired
requirementsShippingOptionRequirement[]

CreateShippingProfile​

CreateShippingProfile: Object

Type declaration​

metadataRecord<string, unknown>
namestringRequired
typeShippingProfileTypeRequired

CreateTaxRateInput​

CreateTaxRateInput: Object

Type declaration​

codestringRequired
namestringRequired
ratenumber | null
region_idstringRequired

CustomerGroupConstructorProps​

CustomerGroupConstructorProps: Object

Type declaration​

customerGroupRepositorytypeof CustomerGroupRepositoryRequired
customerServiceCustomerServiceRequired
managerEntityManagerRequired

DefaultWithoutRelations​

DefaultWithoutRelations: Omit<ExtendedFindConfig<CustomerGroup>, "relations">

DefaultWithoutRelations​

DefaultWithoutRelations: Omit<ExtendedFindConfig<Product>, "relations">

DeleteFileType​

DeleteFileType: Object

Index signature​

▪ [x: string]: unknown

Type declaration​

fileKeystringRequired

DeleteResponse​

DeleteResponse: Object

Type declaration​

deletedbooleanRequired
idstringRequired
objectstringRequired

Dictionary​

Dictionary<T>: object

Type parameters​

TobjectRequired

Index signature​

▪ [k: string]: T

Discount​

Discount: Object

Type declaration​

codestringRequired

DiscountAllocation​

DiscountAllocation: Object

The amount of a discount allocated to a line item

Type declaration​

amountnumberRequired
unit_amountnumberRequired

DiscountConditionInput​

DiscountConditionInput: Object

Type declaration​

customer_groups(string | { id: string })[]
idstring
operatorDiscountConditionOperator
product_collections(string | { id: string })[]
product_tags(string | { id: string })[]
product_types(string | { id: string })[]
products(string | { id: string })[]
rule_idstring

DiscountConditionResourceType​

DiscountConditionResourceType: EntityTarget<DiscountConditionProduct | DiscountConditionProductType | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionCustomerGroup>

DraftOrderCreateProps​

DraftOrderCreateProps: Object

Type declaration​

billing_addressPartial<AddressPayload>
billing_address_idstring
customer_idstring
discountsDiscount[]
emailstringRequired
idempotency_keystring
itemsItem[]
metadataRecord<string, unknown>
no_notification_orderboolean
region_idstringRequired
shipping_addressPartial<AddressPayload>
shipping_address_idstring
shipping_methodsShippingMethod[]Required
statusstring

EmitData​

EmitData<T>: Object

Type parameters​

TobjectRequired

Type declaration​

dataTRequired
eventNamestringRequired
optionsRecord<string, unknown>

ExpandScalar​

ExpandScalar<T>: null | T extends string ? string | RegExp : T extends Date ? Date | string : T

Type parameters​

TobjectRequired

ExtendedStoreDTO​

ExtendedStoreDTO: Store & { feature_flags: FeatureFlagsResponse ; fulfillment_providers: FulfillmentProvider[] ; modules: ModulesResponse ; payment_providers: PaymentProvider[] }

Schema​

ExtendedStoreDTO allOf:

  • $ref: "#/components/schemas/Store"
  • type: object required:
    • payment_providers
    • fulfillment_providers
    • feature_flags
    • modules properties: payment_providers: $ref: "#/components/schemas/PaymentProvider" fulfillment_providers: $ref: "#/components/schemas/FulfillmentProvider" feature_flags: $ref: "#/components/schemas/FeatureFlagsResponse" modules: $ref: "#/components/schemas/ModulesResponse"

FeatureFlagsResponse​

FeatureFlagsResponse: { key: string ; value: boolean | Record<string, boolean> }[]

Schema​

FeatureFlagsResponse type: array items: type: object required:

- key
- value

properties: key: description: The key of the feature flag. type: string value: description: The value of the feature flag. type: boolean

FileServiceGetUploadStreamResult​

FileServiceGetUploadStreamResult: Object

Index signature​

▪ [x: string]: unknown

Type declaration​

fileKeystringRequired
promisePromise<any>Required
urlstringRequired
writeStreamPassThroughRequired

FileServiceUploadResult​

FileServiceUploadResult: Object

Type declaration​

keystringRequired
urlstringRequired

FilterValue​

FilterValue<T>: OperatorMap<FilterValue2<T>> | FilterValue2<T> | FilterValue2<T>[] | null

Type parameters​

TobjectRequired

FilterValue2​

FilterValue2<T>: T | ExpandScalar<T> | Primary<T>

Type parameters​

TobjectRequired

FilterableTaxRateProps​

FilterableTaxRateProps: Object

Type declaration​

codestring | string[] | StringComparisonOperator
created_atDate | DateComparisonOperator
deleted_atDate | DateComparisonOperator
namestring | string[]
ratenumber | NumericalComparisonOperator
region_idstring | string[]
updated_atDate | DateComparisonOperator

FilterableUserProps​

FilterableUserProps: PartialPick<User, "email" | "first_name" | "last_name" | "created_at" | "updated_at" | "deleted_at">

FindProductConfig​

FindProductConfig: FindConfig<Product> & PriceListLoadConfig

FindWithRelationsOptions​

FindWithRelationsOptions: FindManyOptions<ProductVariant> & { order?: FindOptionsOrder<ProductVariant> ; withDeleted?: boolean }

FindWithoutRelationsOptions​

FindWithoutRelationsOptions: DefaultWithoutRelations & { where: DefaultWithoutRelations["where"] & { discount_condition_id?: string | FindOperator<string> } }

FindWithoutRelationsOptions​

FindWithoutRelationsOptions: DefaultWithoutRelations & { where: DefaultWithoutRelations["where"] & { categories?: FindOptionsWhere<ProductCategory> ; category_id?: CategoryQueryParams ; discount_condition_id?: string ; include_category_children?: boolean ; price_list_id?: FindOperator<PriceList> ; sales_channel_id?: FindOperator<SalesChannel> ; tags?: FindOperator<ProductTag> } }

FulFillmentItemType​

FulFillmentItemType: Object

Type declaration​

item_idstringRequired
quantitynumberRequired

FulfillmentItemPartition​

FulfillmentItemPartition: Object

Type declaration​

itemsLineItem[]Required
shipping_methodShippingMethodRequired

FulfillmentOptions​

FulfillmentOptions: Object

Type declaration​

optionsRecord<string, unknown>[]Required
provider_idstringRequired

FulfillmentProviderContainer​

FulfillmentProviderContainer: MedusaContainer & { fulfillmentProviderRepository: typeof FulfillmentProviderRepository ; manager: EntityManager } & { [key in `${FulfillmentProviderKey}`]: typeof BaseFulfillmentService }

FulfillmentProviderData​

FulfillmentProviderData: Record<string, unknown>

FulfillmentProviderKey​

FulfillmentProviderKey: `fp_${string}`

GenerateInputData​

GenerateInputData: Object

Type declaration​

metadataRecord<string, unknown>
quantitynumberRequired
unit_pricenumber
variantIdstringRequired

GenerateLineItemContext​

GenerateLineItemContext: Object

Type declaration​

cartCalculationContextData
customer_idstring
includes_taxboolean
metadataRecord<string, unknown>
order_edit_idstring
region_idstring
unit_pricenumber

GeneratedAdjustment​

GeneratedAdjustment: Object

Type declaration​

amountnumberRequired
descriptionstringRequired
discount_idstringRequired

GetLineItemTotalOptions​

GetLineItemTotalOptions: Object

Type declaration​

exclude_discountsboolean
include_taxboolean

GetRegionPriceContext​

GetRegionPriceContext: Object

Type declaration​

customer_idstring
include_discount_pricesboolean
quantitynumber
regionIdstringRequired

GetShippingMethodTotalsOptions​

GetShippingMethodTotalsOptions: Object

Type declaration​

calculation_contextTaxCalculationContext
include_taxboolean
use_tax_linesboolean

GetTotalsOptions​

GetTotalsOptions: Object

Type declaration​

exclude_gift_cardsboolean
force_taxesboolean

GetUploadedFileType​

GetUploadedFileType: Object

Index signature​

▪ [x: string]: unknown

Type declaration​

fileKeystringRequired
isPrivateboolean

GiftCardAllocation​

GiftCardAllocation: Object

The amount of a gift card allocated to a line item

Type declaration​

amountnumberRequired
unit_amountnumberRequired

GiftCardTransaction​

GiftCardTransaction: Object

Type declaration​

amountnumberRequired
gift_cardGiftCardRequired
is_taxableboolean | nullRequired
tax_ratenumber | nullRequired

IdempotencyCallbackResult​

IdempotencyCallbackResult: Object

Type declaration​

recovery_pointstring
response_bodyRecord<string, unknown>
response_codenumber

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

analyticsConfigRepositorytypeof AnalyticsConfigRepositoryRequired
managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

customerServiceCustomerServiceRequired
managerEntityManagerRequired
userServiceUserServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

batchJobRepositorytypeof BatchJobRepositoryRequired
eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
strategyResolverServiceStrategyResolverServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

addressRepositorytypeof AddressRepositoryRequired
cartRepositorytypeof CartRepositoryRequired
customShippingOptionServiceCustomShippingOptionServiceRequired
customerServiceCustomerServiceRequired
discountServiceDiscountServiceRequired
eventBusServiceEventBusServiceRequired
featureFlagRouterFlagRouterRequired
giftCardServiceGiftCardServiceRequired
lineItemAdjustmentServiceLineItemAdjustmentServiceRequired
lineItemRepositorytypeof LineItemRepositoryRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
newTotalsServiceNewTotalsServiceRequired
paymentProviderServicePaymentProviderServiceRequired
paymentSessionRepositorytypeof PaymentSessionRepositoryRequired
priceSelectionStrategyIPriceSelectionStrategyRequired
pricingServicePricingServiceRequired
productServiceProductServiceRequired
productVariantInventoryServiceProductVariantInventoryServiceRequired
productVariantServiceProductVariantServiceRequired
regionServiceRegionServiceRequired
salesChannelServiceSalesChannelServiceRequired
shippingMethodRepositorytypeof ShippingMethodRepositoryRequired
shippingOptionServiceShippingOptionServiceRequired
shippingProfileServiceShippingProfileServiceRequired
storeServiceStoreServiceRequired
taxProviderServiceTaxProviderServiceRequired
totalsServiceTotalsServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

addressRepositorytypeof AddressRepositoryRequired
claimItemServiceClaimItemServiceRequired
claimRepositorytypeof ClaimRepositoryRequired
eventBusServiceEventBusServiceRequired
fulfillmentProviderServiceFulfillmentProviderServiceRequired
fulfillmentServiceFulfillmentServiceRequired
lineItemRepositorytypeof LineItemRepositoryRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
paymentProviderServicePaymentProviderServiceRequired
productVariantInventoryServiceProductVariantInventoryServiceRequired
regionServiceRegionServiceRequired
returnServiceReturnServiceRequired
shippingMethodRepositorytypeof ShippingMethodRepositoryRequired
shippingOptionServiceShippingOptionServiceRequired
taxProviderServiceTaxProviderServiceRequired
totalsServiceTotalsServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

currencyRepositorytypeof CurrencyRepositoryRequired
eventBusServiceEventBusServiceRequired
featureFlagRouterFlagRouterRequired
managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

customShippingOptionRepositorytypeof CustomShippingOptionRepositoryRequired
managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

addressRepositorytypeof AddressRepositoryRequired
customerRepositorytypeof CustomerRepositoryRequired
eventBusServiceEventBusServiceRequired
managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

discountConditionRepositorytypeof DiscountConditionRepositoryRequired
eventBusServiceEventBusServiceRequired
managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

cartServiceCartServiceRequired
customShippingOptionServiceCustomShippingOptionServiceRequired
draftOrderRepositorytypeof DraftOrderRepositoryRequired
eventBusServiceEventBusServiceRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
orderRepositorytypeof OrderRepositoryRequired
paymentRepositorytypeof PaymentRepositoryRequired
productVariantServiceProductVariantServiceRequired
shippingOptionServiceShippingOptionServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusModuleServiceAbstractEventBusModuleServiceRequired
loggerLoggerRequired
stagedJobServiceStagedJobServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
giftCardRepositorytypeof GiftCardRepositoryRequired
giftCardTransactionRepositorytypeof GiftCardTransactionRepositoryRequired
managerEntityManagerRequired
regionServiceRegionServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

idempotencyKeyRepositorytypeof IdempotencyKeyRepositoryRequired
managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

cartRepositorytypeof CartRepositoryRequired
featureFlagRouterFlagRouterRequired
lineItemAdjustmentServiceLineItemAdjustmentServiceRequired
lineItemRepositorytypeof LineItemRepositoryRequired
lineItemTaxLineRepositorytypeof LineItemTaxLineRepositoryRequired
managerEntityManagerRequired
pricingServicePricingServiceRequired
productServiceProductServiceRequired
productVariantServiceProductVariantServiceRequired
regionServiceRegionServiceRequired
taxProviderServiceTaxProviderServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

featureFlagRouterFlagRouterRequired
managerEntityManagerRequired
taxCalculationStrategyITaxCalculationStrategyRequired
taxProviderServiceTaxProviderServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
noteRepositorytypeof NoteRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

loggerLoggerRequired
managerEntityManagerRequired
notificationProviderRepositorytypeof NotificationProviderRepositoryRequired
notificationRepositorytypeof NotificationRepositoryRequired

InjectedDependencies​

InjectedDependencies: MedusaContainer & { eventBusService: EventBusService ; manager: EntityManager ; oauthRepository: typeof OauthRepository }

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

addressRepositorytypeof AddressRepositoryRequired
cartServiceCartServiceRequired
customerServiceCustomerServiceRequired
discountServiceDiscountServiceRequired
draftOrderServiceDraftOrderServiceRequired
eventBusServiceEventBusServiceRequired
featureFlagRouterFlagRouterRequired
fulfillmentProviderServiceFulfillmentProviderServiceRequired
fulfillmentServiceFulfillmentServiceRequired
giftCardServiceGiftCardServiceRequired
inventoryServiceIInventoryServiceRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
newTotalsServiceNewTotalsServiceRequired
orderRepositorytypeof OrderRepositoryRequired
paymentProviderServicePaymentProviderServiceRequired
productVariantInventoryServiceProductVariantInventoryServiceRequired
regionServiceRegionServiceRequired
shippingOptionServiceShippingOptionServiceRequired
shippingProfileServiceShippingProfileServiceRequired
taxProviderServiceTaxProviderServiceRequired
totalsServiceTotalsServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
inventoryServiceIInventoryService
lineItemAdjustmentServiceLineItemAdjustmentServiceRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
newTotalsServiceNewTotalsServiceRequired
orderEditItemChangeServiceOrderEditItemChangeServiceRequired
orderEditRepositorytypeof OrderEditRepositoryRequired
orderServiceOrderServiceRequired
taxProviderServiceTaxProviderServiceRequired
totalsServiceTotalsServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceIEventBusServiceRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
orderItemChangeRepositorytypeof OrderItemChangeRepositoryRequired
taxProviderServiceTaxProviderServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

customerServiceCustomerServiceRequired
eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
paymentCollectionRepositorytypeof PaymentCollectionRepositoryRequired
paymentProviderServicePaymentProviderServiceRequired

InjectedDependencies​

InjectedDependencies: { customerService: CustomerService ; featureFlagRouter: FlagRouter ; logger: Logger ; manager: EntityManager ; paymentProviderRepository: typeof PaymentProviderRepository ; paymentRepository: typeof PaymentRepository ; paymentService: PaymentService ; paymentSessionRepository: typeof PaymentSessionRepository ; refundRepository: typeof RefundRepository } & { [key in `${PaymentProviderKey}`]: AbstractPaymentService | typeof BasePaymentService }

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

featureFlagRouterFlagRouterRequired
managerEntityManagerRequired
priceSelectionStrategyIPriceSelectionStrategyRequired
pricingModuleServiceIPricingModuleServiceRequired
productVariantServiceProductVariantServiceRequired
regionServiceRegionServiceRequired
remoteQueryRemoteQueryFunctionRequired
taxProviderServiceTaxProviderServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
featureFlagRouterFlagRouterRequired
imageRepositorytypeof ImageRepositoryRequired
managerEntityManagerRequired
productCategoryRepositorytypeof ProductCategoryRepositoryRequired
productOptionRepositorytypeof ProductOptionRepositoryRequired
productRepositorytypeof ProductRepositoryRequired
productTagRepositorytypeof ProductTagRepositoryRequired
productTypeRepositorytypeof ProductTypeRepositoryRequired
productVariantRepositorytypeof ProductVariantRepositoryRequired
productVariantServiceProductVariantServiceRequired
searchServiceSearchServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
productCategoryRepositorytypeof ProductCategoryRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
productCollectionRepositorytypeof ProductCollectionRepositoryRequired
productRepositorytypeof ProductRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceIEventBusServiceRequired
inventoryServiceIInventoryServiceRequired
managerEntityManagerRequired
productVariantServiceProductVariantServiceRequired
salesChannelInventoryServiceSalesChannelInventoryServiceRequired
salesChannelLocationServiceSalesChannelLocationServiceRequired
stockLocationServiceIStockLocationServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

countryRepositorytypeof CountryRepositoryRequired
currencyRepositorytypeof CurrencyRepositoryRequired
eventBusServiceEventBusServiceRequired
featureFlagRouterFlagRouterRequired
fulfillmentProviderRepositorytypeof FulfillmentProviderRepositoryRequired
fulfillmentProviderServiceFulfillmentProviderServiceRequired
managerEntityManagerRequired
paymentProviderRepositorytypeof PaymentProviderRepositoryRequired
paymentProviderServicePaymentProviderServiceRequired
regionRepositorytypeof RegionRepositoryRequired
storeServiceStoreServiceRequired
taxProviderRepositorytypeof TaxProviderRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

featureFlagRouterFlagRouterRequired
fulfillmentProviderServiceFulfillmentProviderServiceRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
orderServiceOrderServiceRequired
productVariantInventoryServiceProductVariantInventoryServiceRequired
returnItemRepositorytypeof ReturnItemRepositoryRequired
returnReasonServiceReturnReasonServiceRequired
returnRepositorytypeof ReturnRepositoryRequired
shippingOptionServiceShippingOptionServiceRequired
taxProviderServiceTaxProviderServiceRequired
totalsServiceTotalsServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

managerEntityManagerRequired
returnReasonRepositorytypeof ReturnReasonRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
salesChannelRepositorytypeof SalesChannelRepositoryRequired
storeServiceStoreServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceIEventBusServiceRequired
inventoryServiceIInventoryServiceRequired
managerEntityManagerRequired
salesChannelLocationServiceSalesChannelLocationServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceIEventBusServiceRequired
managerEntityManagerRequired
salesChannelServiceSalesChannelServiceRequired
stockLocationServiceIStockLocationServiceRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

loggerLoggerRequired
managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

featureFlagRouterFlagRouterRequired
fulfillmentProviderServiceFulfillmentProviderServiceRequired
managerEntityManagerRequired
regionServiceRegionServiceRequired
shippingMethodRepositorytypeof ShippingMethodRepositoryRequired
shippingOptionRepositorytypeof ShippingOptionRepositoryRequired
shippingOptionRequirementRepositorytypeof ShippingOptionRequirementRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

customShippingOptionServiceCustomShippingOptionServiceRequired
featureFlagRouterFlagRouterRequired
managerEntityManagerRequired
productRepositorytypeof ProductRepositoryRequired
productServiceProductServiceRequired
shippingOptionServiceShippingOptionServiceRequired
shippingProfileRepositorytypeof ShippingProfileRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

currencyRepositorytypeof CurrencyRepositoryRequired
eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
storeRepositorytypeof StoreRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Index signature​

▪ [key: string]: unknown

Type declaration​

managerEntityManagerRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

configModuleConfigModuleRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

fulfillmentProviderServiceFulfillmentProviderServiceRequired
fulfillmentRepositorytypeof FulfillmentRepositoryRequired
lineItemRepositorytypeof LineItemRepositoryRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
productVariantInventoryServiceProductVariantInventoryServiceRequired
shippingProfileServiceShippingProfileServiceRequired
totalsServiceTotalsServiceRequired
trackingLinkRepositorytypeof TrackingLinkRepositoryRequired

InjectedDependencies​

InjectedDependencies: Object

Type declaration​

eventBusServiceEventBusServiceRequired
managerEntityManagerRequired
paymentProviderServicePaymentProviderServiceRequired
paymentRepositorytypeof PaymentRepositoryRequired

InjectedProps​

InjectedProps: Object

Type declaration​

cartServiceCartServiceRequired
customShippingOptionServiceCustomShippingOptionServiceRequired
eventBusServiceEventBusServiceRequired
fulfillmentServiceFulfillmentServiceRequired
lineItemAdjustmentServiceLineItemAdjustmentServiceRequired
lineItemServiceLineItemServiceRequired
managerEntityManagerRequired
orderServiceOrderServiceRequired
paymentProviderServicePaymentProviderServiceRequired
productVariantInventoryServiceProductVariantInventoryServiceRequired
returnServiceReturnServiceRequired
shippingOptionServiceShippingOptionServiceRequired
swapRepositorytypeof SwapRepositoryRequired
totalsServiceTotalsServiceRequired

InventoryItemDTO​

InventoryItemDTO: Object

Schema​

Title of the inventory item

Type declaration​

created_atstring | DateRequired
deleted_atstring | Date | nullRequired
descriptionstring | null
heightnumber | null
hs_codestring | null
idstringRequired
lengthnumber | null
materialstring | null
metadataRecord<string, unknown> | null
mid_codestring | null
origin_countrystring | null
requires_shippingbooleanRequired
skustring | null
thumbnailstring | null
titlestring | null
updated_atstring | DateRequired
weightnumber | null
widthnumber | null

InventoryLevelDTO​

InventoryLevelDTO: Object

Schema​

The date with timezone at which the resource was created.

Type declaration​

created_atstring | DateRequired
deleted_atstring | Date | nullRequired
idstringRequired
incoming_quantitynumberRequired
inventory_item_idstringRequired
location_idstringRequired
metadataRecord<string, unknown> | nullRequired
reserved_quantitynumberRequired
stocked_quantitynumberRequired
updated_atstring | DateRequired

Item​

Item: Object

Type declaration​

metadataRecord<string, unknown>
quantitynumberRequired
titlestring
unit_pricenumber
variant_idstring

IteratorResult​

IteratorResult<T, TReturn>: IteratorYieldResult<T> | IteratorReturnResult<TReturn>

Type parameters​

TobjectRequired
TReturnobjectRequired

LineAllocationsMap​

LineAllocationsMap: object

A map of line item ids and its corresponding gift card and discount allocations

Index signature​

▪ [K: string]: { discount?: DiscountAllocation ; gift_card?: GiftCardAllocation }

LineDiscount​

LineDiscount: Object

Associates a line item and discount allocation.

Type declaration​

amountnumberRequired
lineItemLineItemRequired
variantstringRequired

LineDiscountAmount​

LineDiscountAmount: Object

Associates a line item and discount allocation.

Type declaration​

amountnumberRequired
customAdjustmentsAmountnumberRequired
itemLineItemRequired

LineItemAdjustmentServiceProps​

LineItemAdjustmentServiceProps: Object

Type declaration​

discountServiceDiscountServiceRequired
lineItemAdjustmentRepositorytypeof LineItemAdjustmentRepositoryRequired
managerEntityManagerRequired

LineItemTotals​

LineItemTotals: Object

Type declaration​

discount_totalnumberRequired
original_tax_totalnumberRequired
original_totalnumberRequired
quantitynumberRequired
raw_discount_totalnumberRequired
subtotalnumberRequired
tax_linesLineItemTaxLine[]Required
tax_totalnumberRequired
totalnumberRequired
unit_pricenumberRequired

LineItemTotals​

LineItemTotals: Object

Type declaration​

discount_totalnumberRequired
original_tax_totalnumberRequired
original_totalnumberRequired
quantitynumberRequired
raw_discount_totalnumberRequired
subtotalnumberRequired
tax_linesLineItemTaxLine[]Required
tax_totalnumberRequired
totalnumberRequired
unit_pricenumberRequired

LineItemTotalsOptions​

LineItemTotalsOptions: Object

Type declaration​

calculation_contextTaxCalculationContext
exclude_gift_cardsboolean
include_taxboolean
use_tax_linesboolean

LineItemUpdate​

LineItemUpdate: Object

Type declaration​

metadataRecord<string, unknown>
quantitynumber
region_idstring
should_calculate_pricesboolean
titlestring
unit_pricenumber
variant_idstring

LineItemValidateData​

LineItemValidateData: Object

Type declaration​

variantobject
variant.product_idstringRequired
variant_idstringRequired

ListAndCountSelector​

ListAndCountSelector: Selector<ProductCollection> & { discount_condition_id?: string ; q?: string }

LookupFunction​

LookupFunction: (hostname: string, options: LookupOneOptions, callback: (err: ErrnoException | null, address: string, family: number) => void) => void

Type declaration​

(hostname, options, callback): void

Parameters​
hostnamestringRequired
optionsLookupOneOptionsRequired
callback(err: ErrnoException | null, address: string, family: number) => voidRequired
Returns​

void

voidvoid

MedusaContainer​

MedusaContainer: AwilixContainer & { createScope: () => MedusaContainer ; registerAdd: <T>(name: string, registration: T) => MedusaContainer }

MedusaContainer​

MedusaContainer: AwilixContainer & { createScope: () => MedusaContainer ; registerAdd: <T>(name: string, registration: T) => MedusaContainer }

MiddlewareVerb​

MiddlewareVerb: "USE" | "ALL" | RouteVerb

ModuleDeclaration​

ModuleDeclaration: ExternalModuleDeclaration | InternalModuleDeclaration

ModulesResponse​

ModulesResponse: ModulesResponse

Schema​

ModulesResponse type: array items: type: object required:

- module
- resolution

properties: module: description: The key of the module. type: string resolution: description: The resolution path of the module or false if module is not installed. type: string

OperatorMap​

OperatorMap<T>: Object

Type parameters​

TobjectRequired

Type declaration​

$andQuery<T>[]
$containedstring[]
$containsstring[]
$eqExpandScalar<T> | ExpandScalar<T>[]
$existsboolean
$fulltextstring
$gtExpandScalar<T>
$gteExpandScalar<T>
$ilikestring
$inExpandScalar<T>[]
$likestring
$ltExpandScalar<T>
$lteExpandScalar<T>
$neExpandScalar<T>
$ninExpandScalar<T>[]
$notQuery<T>
$orQuery<T>[]
$overlapstring[]
$restring

Order​

Order<T>: { [key in keyof T]?: "ASC" | "DESC" | Order<T[key] extends any[] ? T[key][0] : T[key]\> }

Type parameters​

TobjectRequired

OrdersReturnItem​

OrdersReturnItem: Object

Type declaration​

item_idstringRequired
notestring
quantitynumberRequired
reason_idstring

PaginatedResponse​

PaginatedResponse: Object

Type declaration​

countnumberRequired
limitnumberRequired
offsetnumberRequired

Partial​

Partial<T>: { [P in keyof T]?: T[P] }

Make all properties in T optional

Type parameters​

TobjectRequired

PaymentCollectionsSessionsBatchInput​

PaymentCollectionsSessionsBatchInput: Object

Type declaration​

amountnumberRequired
provider_idstringRequired
session_idstring

PaymentCollectionsSessionsInput​

PaymentCollectionsSessionsInput: Object

Type declaration​

provider_idstringRequired

PaymentDataInput​

PaymentDataInput: Object

Type declaration​

amountnumberRequired
currency_codestringRequired
dataRecord<string, unknown>Required
provider_idstringRequired

PaymentProviderKey​

PaymentProviderKey: `pp_${string}` | "systemPaymentProviderService"

PaymentSessionInput​

PaymentSessionInput: Object

Type declaration​

amountnumberRequired
cartCart | { billing_address?: Address | null ; context: Record<string, unknown> ; email: string ; id: string ; shipping_address: Address | null ; shipping_methods: ShippingMethod[] }Required
currency_codestringRequired
customerCustomer | null
paymentSessionDataRecord<string, unknown>
payment_session_idstring
provider_idstringRequired
resource_idstring

PrevLimit​

PrevLimit: [never, 1, 2, 3]

Price​

Price: Partial<Omit<MoneyAmount, "created_at" | "updated_at" | "deleted_at">> & { amount: number }

PriceListConstructorProps​

PriceListConstructorProps: Object

Type declaration​

customerGroupServiceCustomerGroupServiceRequired
featureFlagRouterFlagRouterRequired
managerEntityManagerRequired
moneyAmountRepositorytypeof MoneyAmountRepositoryRequired
priceListRepositorytypeof PriceListRepositoryRequired
productServiceProductServiceRequired
productVariantRepositorytypeof ProductVariantRepositoryRequired
productVariantServiceProductVariantServiceRequired
regionServiceRegionServiceRequired

PricedProduct​

PricedProduct: Omit<Partial<Product>, "variants"> & { variants: PricedVariant[] }

Schema​

PricedProduct title: "Priced Product" type: object allOf:

  • $ref: "#/components/schemas/Product"
  • type: object properties: variants: type: array items: $ref: "#/components/schemas/PricedVariant"

PricedShippingOption​

PricedShippingOption: Partial<ShippingOption> & ShippingOptionPricing

Schema​

PricedShippingOption title: "Priced Shipping Option" type: object allOf:

  • $ref: "#/components/schemas/ShippingOption"
  • type: object properties: price_incl_tax: type: number description: Price including taxes tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate tax_amount: type: number description: The taxes applied.

PricedVariant​

PricedVariant: Partial<ProductVariant> & ProductVariantPricing

Schema​

PricedVariant title: "Priced Product Variant" type: object allOf:

  • $ref: "#/components/schemas/ProductVariant"
  • type: object properties: original_price: type: number description: The original price of the variant without any discounted prices applied. calculated_price: type: number description: The calculated price of the variant. Can be a discounted price. original_price_incl_tax: type: number description: The original price of the variant including taxes. calculated_price_incl_tax: type: number description: The calculated price of the variant including taxes. original_tax: type: number description: The taxes applied on the original price. calculated_tax: type: number description: The taxes applied on the calculated price. tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate

PricingContext​

PricingContext: Object

Type declaration​

automatic_taxesbooleanRequired
price_selectionPriceSelectionContextRequired
tax_ratenumber | nullRequired

Primary​

Primary<T>: T extends { [PrimaryKeyType]?: infer PK } ? ReadonlyPrimary<PK> : T extends { _id?: infer PK } ? ReadonlyPrimary<PK> | string : T extends { uuid?: infer PK } ? ReadonlyPrimary<PK> : T extends { id?: infer PK } ? ReadonlyPrimary<PK> : never

Type parameters​

TobjectRequired

ProductCategoryInput​

ProductCategoryInput: Object

Type declaration​

handlestring
is_activeboolean
is_internalboolean
parent_categoryProductCategory | null
parent_category_idstring | null
ranknumber

ProductOptionInput​

ProductOptionInput: Object

Type declaration​

titlestringRequired
valuesProductOptionValue[]

ProductSelector​

ProductSelector: FilterableProductProps | Selector<Product> & { category_id?: string[] | FindOperator<ProductCategory> ; discount_condition_id?: string ; price_list_id?: string[] | FindOperator<PriceList> ; q?: string ; sales_channel_id?: string[] | FindOperator<SalesChannel> }

ProductVariantOption​

ProductVariantOption: Object

Type declaration​

option_idstringRequired
valuestringRequired

ProductVariantPrice​

ProductVariantPrice: Object

Type declaration​

amountnumberRequired
currency_codestring
idstring
max_quantitynumber
min_quantitynumber
region_idstring

ProductVariantPricing​

ProductVariantPricing: { calculated_price: number | null ; calculated_price_includes_tax?: boolean | null ; calculated_price_type?: string | null ; original_price: number | null ; original_price_includes_tax?: boolean | null ; prices: MoneyAmount[] } & TaxedPricing

PropertyDecorator​

PropertyDecorator: (target: Object, propertyKey: string | symbol) => void

Type declaration​

(target, propertyKey): void

Parameters​
targetObjectRequired
propertyKeystring | symbolRequired
Returns​

void

voidvoid

PropertyKey​

PropertyKey: string | number | symbol

ProviderLineItemTaxLine​

ProviderLineItemTaxLine: Object

The tax line properties for a given line item.

Type declaration​

codestring | nullRequired
item_idstringRequired
metadataRecord<string, unknown>
namestringRequired
ratenumberRequired

ProviderShippingMethodTaxLine​

ProviderShippingMethodTaxLine: Object

The tax line properties for a given shipping method.

Type declaration​

codestring | nullRequired
metadataRecord<string, unknown>
namestringRequired
ratenumberRequired
shipping_method_idstringRequired

ProviderTaxLine​

ProviderTaxLine: ProviderLineItemTaxLine | ProviderShippingMethodTaxLine

A union type of the possible provider tax lines.

Query​

Query<T>: T extends object ? T extends Scalar ? never : FilterQuery<T> : FilterValue<T>

Type parameters​

TobjectRequired

ReadableStreamController​

ReadableStreamController<T>: ReadableStreamDefaultController<T>

Type parameters​

TobjectRequired

ReadableStreamDefaultReadResult​

ReadableStreamDefaultReadResult<T>: ReadableStreamDefaultReadValueResult<T> | ReadableStreamDefaultReadDoneResult

Type parameters​

TobjectRequired

Readonly​

Readonly<T>: { readonly [P in keyof T]: T[P] }

Make all properties in T readonly

Type parameters​

TobjectRequired

ReadonlyPrimary​

ReadonlyPrimary<T>: T extends any[] ? Readonly<T> : T

Type parameters​

TobjectRequired

RegionDetails​

RegionDetails: Object

Type declaration​

idstringRequired
tax_ratenumber | nullRequired

RemoteQueryFunction​

RemoteQueryFunction: (query: string | RemoteJoinerQuery | object, variables?: Record<string, unknown>) => Promise<any> | null

Type declaration​

(query, variables?): Promise<any> | null

Parameters​
querystring | RemoteJoinerQuery | objectRequired
variablesRecord<string, unknown>
Returns​

Promise<any> | null

Promise<any\> \| ``null``Promise<any> | null

ReorderConditions​

ReorderConditions: Object

Type declaration​

originalParentIdstring | nullRequired
originalRanknumberRequired
shouldChangeParentbooleanRequired
shouldChangeRankbooleanRequired
shouldDeleteElementbooleanRequired
shouldIncrementRankbooleanRequired
targetCategoryIdstringRequired
targetParentIdstring | null | undefinedRequired
targetRanknumber | undefinedRequired

RequestContext​

RequestContext: Object

Type declaration​

ipstringRequired

ReservationItemDTO​

ReservationItemDTO: Object

Schema​

Represents a reservation of an inventory item at a stock location

Type declaration​

created_atstring | DateRequired
created_bystring | null
deleted_atstring | Date | nullRequired
descriptionstring | null
idstringRequired
inventory_item_idstringRequired
line_item_idstring | null
location_idstringRequired
metadataRecord<string, unknown> | nullRequired
quantitynumberRequired
updated_atstring | DateRequired

ReserveQuantityContext​

ReserveQuantityContext: Object

Type declaration​

lineItemIdstring
locationIdstring
salesChannelIdstring | null

ReturnedData​

ReturnedData: Object

Type declaration​

dataRecord<string, unknown>Required
statusstringRequired
tostringRequired

RouteVerb​

RouteVerb: typeof HTTP_METHODS[number]

Scalar​

Scalar: boolean | number | string | bigint | symbol | Date | RegExp | Buffer | { toHexString: Method toHexString }

SessionOptions​

SessionOptions: Object

Type declaration​

namestring
resaveboolean
rollingboolean
saveUninitializedboolean
secretstring
ttlnumber

ShippingMethod​

ShippingMethod: Object

Type declaration​

dataRecord<string, unknown>
option_idstringRequired
pricenumber

ShippingMethodData​

ShippingMethodData: Record<string, unknown>

ShippingMethodTotals​

ShippingMethodTotals: Object

Type declaration​

original_tax_totalnumberRequired
original_totalnumberRequired
pricenumberRequired
subtotalnumberRequired
tax_linesShippingMethodTaxLine[]Required
tax_totalnumberRequired
totalnumberRequired

ShippingMethodTotals​

ShippingMethodTotals: Object

Type declaration​

original_tax_totalnumberRequired
original_totalnumberRequired
pricenumberRequired
subtotalnumberRequired
tax_linesShippingMethodTaxLine[]Required
tax_totalnumberRequired
totalnumberRequired

ShippingMethodUpdate​

ShippingMethodUpdate: Object

Type declaration​

claim_order_idstring | null
dataany
order_idstring
pricenumber
return_idstring
swap_idstring

ShippingOptionData​

ShippingOptionData: Record<string, unknown>

ShippingOptionPricing​

ShippingOptionPricing: Object

Type declaration​

price_incl_taxnumber | nullRequired
tax_amountnumberRequired
tax_ratesTaxServiceRate[] | nullRequired

SocketConnectOpts​

SocketConnectOpts: TcpSocketConnectOpts | IpcSocketConnectOpts

SocketReadyState​

SocketReadyState: "opening" | "open" | "readOnly" | "writeOnly" | "closed"

StagedJobServiceProps​

StagedJobServiceProps: Object

Type declaration​

managerEntityManagerRequired
stagedJobRepositorytypeof StagedJobRepositoryRequired

StockLocationDTO​

StockLocationDTO: Object

Schema​

Represents a Stock Location

Type declaration​

addressStockLocationAddressDTO
address_idstringRequired
created_atstring | DateRequired
deleted_atstring | Date | nullRequired
idstringRequired
metadataRecord<string, unknown> | nullRequired
namestringRequired
updated_atstring | DateRequired

StockLocationExpandedDTO​

StockLocationExpandedDTO: StockLocationDTO & { sales_channels?: any[] }

Schema​

StockLocationExpandedDTO allOf:

  • $ref: "#/components/schemas/StockLocationDTO"
  • type: object properties: sales_channels: $ref: "#/components/schemas/SalesChannel"

Subscriber​

Subscriber<T>: (data: T, eventName: string) => Promise<void>

Type parameters​

TobjectRequired

Type declaration​

(data, eventName): Promise<void>

Parameters​
dataTRequired
eventNamestringRequired
Returns​

Promise<void>

PromisePromise<void>Required

SubscriberContext​

SubscriberContext: Object

Type declaration​

subscriberIdstringRequired

SubtotalOptions​

SubtotalOptions: Object

Options to use for subtotal calculations

Type declaration​

excludeNonDiscountsboolean

TaxLinesMaps​

TaxLinesMaps: Object

Type declaration​

lineItemsTaxLinesobjectRequired
shippingMethodsTaxLinesobjectRequired

TaxRateListByConfig​

TaxRateListByConfig: Object

Type declaration​

region_idstring

TaxServiceRate​

TaxServiceRate: Object

The tax rate object as configured in Medusa. These may have an unspecified numerical rate as they may be used for lookup purposes in the tax provider plugin.

Type declaration​

codestring | nullRequired
namestringRequired
ratenumber | null

TaxedPricing​

TaxedPricing: Object

Type declaration​

calculated_price_incl_taxnumber | nullRequired
calculated_taxnumber | nullRequired
original_price_incl_taxnumber | nullRequired
original_taxnumber | nullRequired
tax_ratesTaxServiceRate[] | nullRequired

TotalsConfig​

TotalsConfig: Object

Type declaration​

force_taxesboolean

TotalsContext​

TotalsContext: Object

Type declaration​

force_taxesboolean
includesobject
includes.returnable_itemsboolean

TotalsServiceProps​

TotalsServiceProps: Object

Type declaration​

featureFlagRouterFlagRouterRequired
managerEntityManagerRequired
newTotalsServiceNewTotalsServiceRequired
taxCalculationStrategyITaxCalculationStrategyRequired
taxProviderServiceTaxProviderServiceRequired

TransformCallback​

TransformCallback: (error?: Error | null, data?: any) => void

Type declaration​

(error?, data?): void

Parameters​
errorError | null
dataany
Returns​

void

voidvoid

Transformer​

Transformer: (item?: LineItem, quantity?: number, additional?: OrdersReturnItem) => Promise<DeepPartial<LineItem>> | DeepPartial<LineItem>

Type declaration​

(item?, quantity?, additional?): Promise<DeepPartial<LineItem>> | DeepPartial<LineItem>

Parameters​
itemLineItem
quantitynumber
additionalOrdersReturnItem
Returns​

Promise<DeepPartial<LineItem>> | DeepPartial<LineItem>

Promise<DeepPartial<LineItem\>\> \| DeepPartial<LineItem\>Promise<DeepPartial<LineItem>> | DeepPartial<LineItem>

TypedArray​

TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

UpdateAnalyticsConfig​

UpdateAnalyticsConfig: Object

Type declaration​

anonymizeboolean
opt_outboolean

UpdateClaimInput​

UpdateClaimInput: Object

Type declaration​

claim_itemsUpdateClaimItemInput[]
metadataRecord<string, unknown>
no_notificationboolean
shipping_methodsUpdateClaimShippingMethodInput[]

UpdateClaimItemImageInput​

UpdateClaimItemImageInput: Object

Type declaration​

idstring
urlstring

UpdateClaimItemInput​

UpdateClaimItemInput: Object

Type declaration​

idstringRequired
imagesUpdateClaimItemImageInput[]Required
metadataRecord<string, unknown>
notestring
reasonstring
tagsUpdateClaimItemTagInput[]Required

UpdateClaimItemTagInput​

UpdateClaimItemTagInput: Object

Type declaration​

idstring
valuestring

UpdateClaimShippingMethodInput​

UpdateClaimShippingMethodInput: Object

Type declaration​

dataRecord<string, unknown>
idstring
option_idstring
pricenumber

UpdateCurrencyInput​

UpdateCurrencyInput: Object

Type declaration​

includes_taxboolean

UpdateCustomerInput​

UpdateCustomerInput: Object

Type declaration​

billing_addressAddressPayload | string
billing_address_idstring
emailstring
first_namestring
groups{ id: string }[]
last_namestring
metadataRecord<string, unknown>
passwordstring
phonestring

UpdateDiscountInput​

UpdateDiscountInput: Object

Type declaration​

codestring
ends_atDate | null
is_disabledboolean
metadataRecord<string, unknown>
regionsstring[]
ruleUpdateDiscountRuleInput
starts_atDate
usage_limitnumber | null
valid_durationstring | null

UpdateDiscountRuleInput​

UpdateDiscountRuleInput: Object

Type declaration​

allocationAllocationType
conditionsDiscountConditionInput[]
descriptionstring
idstringRequired
valuenumber

UpdateGiftCardInput​

UpdateGiftCardInput: Object

Type declaration​

balancenumber
ends_atDate | null
is_disabledboolean
metadataRecord<string, unknown>
region_idstring

UpdateOauthInput​

UpdateOauthInput: Object

Type declaration​

dataRecord<string, unknown>Required

UpdateOrderInput​

UpdateOrderInput: Object

Type declaration​

billing_addressAddressPayload
customer_idstring
discountsobject[]
emailstring
fulfillment_statusFulfillmentStatus
itemsobject[]
metadataRecord<string, unknown>
no_notificationboolean
paymentPayment
payment_methodobject
payment_method.dataRecord<string, unknown>
payment_method.provider_idstring
payment_statusPaymentStatus
regionstring
shipping_addressAddressPayload
shipping_method{ data?: Record<string, unknown> ; items?: Record<string, unknown>[] ; price?: number ; profile_id?: string ; provider_id?: string }[]
statusOrderStatus

UpdateProductCategoryInput​

UpdateProductCategoryInput: ProductCategoryInput & { name?: string }

UpdateProductCollection​

UpdateProductCollection: Object

Type declaration​

handlestring
metadataRecord<string, unknown>
titlestring

UpdateProductInput​

UpdateProductInput: Omit<Partial<CreateProductInput>, "variants"> & { variants?: UpdateProductProductVariantDTO[] }

UpdateProductProductVariantDTO​

UpdateProductProductVariantDTO: Object

Type declaration​

allow_backorderboolean
barcodestring
eanstring
heightnumber
hs_codestring
idstring
inventory_quantitynumber
lengthnumber
manage_inventoryboolean
materialstring
metadataRecord<string, unknown>
mid_codestring
options{ option_id: string ; value: string }[]
origin_countrystring
pricesCreateProductProductVariantPriceInput[]
skustring
titlestring
upcstring
weightnumber
widthnumber

UpdateProductVariantData​

UpdateProductVariantData: Object

Type declaration​

updateDataUpdateProductVariantInputRequired
variantProductVariantRequired

UpdateProductVariantInput​

UpdateProductVariantInput: Object

Type declaration​

allow_backorderboolean
barcodestring
eanstring
heightnumber
hs_codestring
inventory_quantitynumber
lengthnumber
manage_inventoryboolean
materialstring
metadataRecord<string, unknown>
mid_codestring
optionsProductVariantOption[]
origin_countrystring
pricesProductVariantPrice[]
product_idstring
skustring
titlestring
upcstring
variant_ranknumber
weightnumber
widthnumber

UpdateRegionInput​

UpdateRegionInput: Object

Type declaration​

automatic_taxesboolean
countriesstring[]
currency_codestring
fulfillment_providersstring[]
gift_cards_taxableboolean
includes_taxboolean
metadataRecord<string, unknown>
namestring
payment_providersstring[]
tax_codestring
tax_provider_idstring | null
tax_ratenumber

UpdateReturnInput​

UpdateReturnInput: Object

Type declaration​

itemsOrdersReturnItem[]
metadataRecord<string, unknown>
no_notificationboolean
shipping_methodobject
shipping_method.option_idstringRequired
shipping_method.pricenumber

UpdateReturnReason​

UpdateReturnReason: Object

Type declaration​

descriptionstring
labelstring
metadataRecord<string, unknown>
parent_return_reason_idstring

UpdateShippingOptionInput​

UpdateShippingOptionInput: Object

Type declaration​

admin_onlyboolean
amountnumber
datastring
includes_taxboolean
is_returnboolean
metadataRecord<string, unknown>
namestring
price_typeShippingOptionPriceType
profile_idstring
provider_idstring
region_idstring
requirementsShippingOptionRequirement[]

UpdateShippingProfile​

UpdateShippingProfile: Object

Type declaration​

metadataRecord<string, unknown>
namestring
productsstring[]
shipping_optionsstring[]
typeShippingProfileType

UpdateStoreInput​

UpdateStoreInput: Object

Type declaration​

currenciesstring[]
default_currency_codestring
default_sales_channel_idstring
invite_link_templatestring
metadataRecord<string, unknown>
namestring
payment_link_templatestring
swap_link_templatestring

UpdateTaxRateInput​

UpdateTaxRateInput: Object

Type declaration​

codestring
namestring
ratenumber | null
region_idstring

UpdateVariantPricesData​

UpdateVariantPricesData: Object

Type declaration​

pricesProductVariantPrice[]Required
variantIdstringRequired

UpdateVariantRegionPriceData​

UpdateVariantRegionPriceData: Object

Type declaration​

priceobjectRequired
price.amountnumberRequired
price.currency_codestringRequired
price.region_idstringRequired
variantIdstringRequired

UploadStreamDescriptorType​

UploadStreamDescriptorType: Object

Index signature​

▪ [x: string]: unknown

Type declaration​

extstring
isPrivateboolean
namestringRequired

UpsertTagsInput​

UpsertTagsInput: Partial<ProductTag> & { value: string }[]

UpsertTypeInput​

UpsertTypeInput: Partial<ProductType> & { value: string }

UserServiceProps​

UserServiceProps: Object

Type declaration​

analyticsConfigServiceAnalyticsConfigServiceRequired
eventBusServiceEventBusServiceRequired
featureFlagRouterFlagRouterRequired
managerEntityManagerRequired
userRepositorytypeof UserRepositoryRequired

WithImplicitCoercion​

WithImplicitCoercion<T>: T | { valueOf: Method valueOf }

Type parameters​

TobjectRequired

handler​

handler: (req: Request, res: Response) => Promise<void>

Type declaration​

(req, res): Promise<void>

Parameters​
reqRequestRequired
resResponseRequired
Returns​

Promise<void>

PromisePromise<void>Required

middlewareHandlerType​

middlewareHandlerType: (options: Record<string, unknown>) => RequestHandler

Type declaration​

(options): RequestHandler

Parameters​
optionsRecord<string, unknown>Required
Returns​

RequestHandler

middlewareType​

middlewareType: Object

Type declaration​

middlewaremiddlewareHandlerTypeRequired
optionsRecord<string, unknown>Required

Variables​

AddressRepository​

Const AddressRepository: Repository

AdminGetDiscountsParams_base​

Const AdminGetDiscountsParams_base: internal

AdminGetInventoryItemsParams_base​

Const AdminGetInventoryItemsParams_base: internal

AdminGetPriceListsPriceListProductsParams_base​

Const AdminGetPriceListsPriceListProductsParams_base: internal

AdminGetProductCategoriesParams_base​

Const AdminGetProductCategoriesParams_base: internal

AdminGetReservationsParams_base​

Const AdminGetReservationsParams_base: internal

AdminGetSalesChannelsParams_base​

Const AdminGetSalesChannelsParams_base: internal

AdminGetStockLocationsParams_base​

Const AdminGetStockLocationsParams_base: internal

AnalyticsConfigRepository​

Const AnalyticsConfigRepository: Repository

BatchJobRepository​

Const BatchJobRepository: Repository

Buffer​

Buffer: BufferConstructor

CartRepository​

Const CartRepository: Repository & { findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }

ClaimRepository​

Const ClaimRepository: Repository

CountryRepository​

Const CountryRepository: Repository

CurrencyRepository​

Const CurrencyRepository: Repository

CustomShippingOptionRepository​

Const CustomShippingOptionRepository: Repository

CustomerGroupRepository​

Const CustomerGroupRepository: Repository & { addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }

CustomerRepository​

Const CustomerRepository: Repository & { listAndCount: Method listAndCount }

DiscountConditionRepository​

Const DiscountConditionRepository: Repository & { addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }

DraftOrderRepository​

Const DraftOrderRepository: Repository

FulfillmentProviderRepository​

Const FulfillmentProviderRepository: Repository

FulfillmentRepository​

Const FulfillmentRepository: Repository

GetOrderEditsParams_base​

Const GetOrderEditsParams_base: internal

GetPublishableApiKeySalesChannelsParams_base​

Const GetPublishableApiKeySalesChannelsParams_base: internal

GetPublishableApiKeysParams_base​

Const GetPublishableApiKeysParams_base: internal

GiftCardRepository​

Const GiftCardRepository: Repository & { listGiftCardsAndCount: Method listGiftCardsAndCount }

GiftCardTransactionRepository​

Const GiftCardTransactionRepository: Repository

HTTP_METHODS​

Const HTTP_METHODS: readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"]

List of all the supported HTTP methods

IdempotencyKeyRepository​

Const IdempotencyKeyRepository: Repository

ImageRepository​

Const ImageRepository: Repository & { insertBulk: Method insertBulk ; upsertImages: Method upsertImages }

LineItemAdjustmentRepository​

Const LineItemAdjustmentRepository: Repository

LineItemRepository​

Const LineItemRepository: Repository & { findByReturn: Method findByReturn }

LineItemTaxLineRepository​

Const LineItemTaxLineRepository: Repository & { deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }

MoneyAmountRepository​

Const MoneyAmountRepository: Repository & { addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }

NoteRepository​

Const NoteRepository: Repository

NotificationProviderRepository​

Const NotificationProviderRepository: Repository

NotificationRepository​

Const NotificationRepository: Repository

OauthRepository​

Const OauthRepository: Repository

OrderEditRepository​

Const OrderEditRepository: Repository

OrderItemChangeRepository​

Const OrderItemChangeRepository: Repository

OrderRepository​

Const OrderRepository: Repository & { findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }

PaymentCollectionRepository​

Const PaymentCollectionRepository: Repository & { getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId }

PaymentProviderRepository​

Const PaymentProviderRepository: Repository

PaymentRepository​

Const PaymentRepository: Repository

PaymentSessionRepository​

Const PaymentSessionRepository: Repository

PriceListRepository​

Const PriceListRepository: Repository & { listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }

ProductCategoryRepository​

Const ProductCategoryRepository: TreeRepository & { addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }

ProductCollectionRepository​

Const ProductCollectionRepository: Repository & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }

ProductOptionRepository​

Const ProductOptionRepository: Repository

ProductRepository​

Const ProductRepository: Repository & { _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }

ProductTagRepository​

Const ProductTagRepository: Repository & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }

ProductTypeRepository​

Const ProductTypeRepository: Repository & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }

ProductVariantRepository​

Const ProductVariantRepository: Repository

ReadableByteStreamController​

ReadableByteStreamController: Object

Call signature​

new ReadableByteStreamController(): ReadableByteStreamController

Returns​

ReadableByteStreamController

ReadableByteStreamController() => ReadableByteStreamControllerRequired

Type declaration​

ReadableStream​

ReadableStream: Object

Call signature​

new ReadableStream(underlyingSource, strategy?): ReadableStream<Uint8Array>

Parameters​
underlyingSourceUnderlyingByteSourceRequired
strategyQueuingStrategy<Uint8Array>
Returns​

ReadableStream<Uint8Array>

ReadableStreamReadableStream<Uint8Array>Required

new ReadableStream<R>(underlyingSource?, strategy?): ReadableStream<R>

RobjectRequired
Parameters​
underlyingSourceUnderlyingSource<R>
strategyQueuingStrategy<R>
Returns​

ReadableStream<R>

ReadableStreamReadableStream<R>Required

Type declaration​

prototypeReadableStream<any>Required

ReadableStreamDefaultController​

ReadableStreamDefaultController: Object

Call signature​

new ReadableStreamDefaultController(): ReadableStreamDefaultController<any>

Returns​

ReadableStreamDefaultController<any>

ReadableStreamDefaultControllerReadableStreamDefaultController<any>Required

Type declaration​

prototypeReadableStreamDefaultController<any>Required

ReadableStreamDefaultReader​

ReadableStreamDefaultReader: Object

Call signature​

new ReadableStreamDefaultReader<R>(stream): ReadableStreamDefaultReader<R>

RobjectRequired
Parameters​
streamReadableStream<R>Required
Returns​

ReadableStreamDefaultReader<R>

ReadableStreamDefaultReaderReadableStreamDefaultReader<R>Required

Type declaration​

prototypeReadableStreamDefaultReader<any>Required

RefundRepository​

Const RefundRepository: Repository

RegionRepository​

Const RegionRepository: Repository

ReturnItemRepository​

Const ReturnItemRepository: Repository

ReturnReasonRepository​

Const ReturnReasonRepository: Repository

ReturnRepository​

Const ReturnRepository: Repository

SalesChannelRepository​

Const SalesChannelRepository: Repository & { addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }

SharedArrayBuffer​

SharedArrayBuffer: SharedArrayBufferConstructor

ShippingMethodRepository​

Const ShippingMethodRepository: Repository

ShippingOptionRepository​

Const ShippingOptionRepository: Repository & { upsertShippingProfile: Method upsertShippingProfile }

ShippingOptionRequirementRepository​

Const ShippingOptionRequirementRepository: Repository

ShippingProfileRepository​

Const ShippingProfileRepository: Repository & { findByProducts: Method findByProducts }

StagedJobRepository​

Const StagedJobRepository: Repository & { insertBulk: Method insertBulk }

StoreGetProductCategoriesParams_base​

Const StoreGetProductCategoriesParams_base: internal

StoreRepository​

Const StoreRepository: Repository

SwapRepository​

Const SwapRepository: Repository

TaxProviderRepository​

Const TaxProviderRepository: Repository

TrackingLinkRepository​

Const TrackingLinkRepository: Repository

UserRepository​

Const UserRepository: Repository

WritableStream​

WritableStream: Object

Call signature​

new WritableStream<W>(underlyingSink?, strategy?): WritableStream<W>

WobjectRequired
Parameters​
underlyingSinkUnderlyingSink<W>
strategyQueuingStrategy<W>
Returns​

WritableStream<W>

WritableStreamWritableStream<W>Required

Type declaration​

prototypeWritableStream<any>Required

WritableStreamDefaultController​

WritableStreamDefaultController: Object

Call signature​

new WritableStreamDefaultController(): WritableStreamDefaultController

Returns​

WritableStreamDefaultController

WritableStreamDefaultController() => WritableStreamDefaultControllerRequired

Type declaration​

WritableStreamDefaultWriter​

WritableStreamDefaultWriter: Object

Call signature​

new WritableStreamDefaultWriter<W>(stream): WritableStreamDefaultWriter<W>

WobjectRequired
Parameters​
streamWritableStream<W>Required
Returns​

WritableStreamDefaultWriter<W>

WritableStreamDefaultWriterWritableStreamDefaultWriter<W>Required

Type declaration​

prototypeWritableStreamDefaultWriter<any>Required

Functions​

Error​

Error(message?): Error

Parameters​

messagestring

Returns​

Error

Error(message?: string) => ErrorRequired

Object​

Object(): any

Provides functionality common to all JavaScript objects.

Returns​

any

anyany

Object(value): any

Provides functionality common to all JavaScript objects.

Parameters​

valueanyRequired

Returns​

any

anyany
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.