medusa-store/www/apps/docs/content/references/js-client/modules/internal-8.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Module: internal

Namespaces

• EventEmitter
• internal
• internal
• internal
• internal
• internal

Enumerations

• DefaultPriceType
• DiscountConditionJoinTableForeignKey
• FulfillmentStatus
• MODULE_RESOURCE_TYPE
• OrderStatus
• PaymentStatus

Classes

• AbstractEventBusModuleService
• AbstractSearchService
• AdditionalItem
• AdditionalItem
• AdditionalItem
• AdminCreateCondition
• AdminDeleteDiscountsDiscountConditionsConditionBatchReq
• AdminGetDiscountsDiscountConditionsConditionParams
• AdminGetDiscountsDiscountRuleParams
• AdminGetDiscountsParams
• AdminListOrdersSelector
• AdminPostDiscountsDiscountConditions
• AdminPostDiscountsDiscountConditionsCondition
• AdminPostDiscountsDiscountConditionsConditionBatchParams
• AdminPostDiscountsDiscountConditionsConditionBatchReq
• AdminPostDiscountsDiscountConditionsConditionParams
• AdminPostDiscountsDiscountConditionsParams
• AdminPostDiscountsDiscountDynamicCodesReq
• AdminPostDiscountsDiscountReq
• AdminPostDiscountsDiscountRule
• AdminPostDiscountsReq
• AdminPriceSelectionParams
• AdminProductCategoriesReqBase
• AdminUpdateDiscountRule
• AdminUpsertCondition
• AdminUpsertConditionsReq
• Blob
• CustomShippingOption
• CustomerGroup
• CustomerGroup
• CustomerGroupUpdate
• Discount
• Discount
• Discount
• Discount
• Duplex
• EventEmitter
• FilterableCartProps
• FilterableDiscountProps
• FilterableLineItemAdjustmentProps
• FilterableProductProps
• FilterableProductVariantProps
• FlagRouter
• FulfillmentService
• GiftCard
• GiftCard
• Image
• Item
• Item
• Item
• Item
• Item
• Item
• Item
• MedusaError
• NotificationProvider
• OptionRequirement
• OptionRequirement
• OrdersReturnItem
• PassThrough
• PaymentMethod
• PaymentService
• PriceSelectionParams
• ProductBatchProductCategory
• ProductBatchSalesChannel
• ProductOptionReq
• ProductProductCategoryReq
• ProductSalesChannelReq
• ProductTagReq
• ProductTypeReq
• ProductVariantOptionReq
• ProductVariantOptionReq
• ProductVariantOptionReq
• ProductVariantOptionReq
• ProductVariantPricesCreateReq
• ProductVariantPricesUpdateReq
• ProductVariantReq
• ProductVariantReq
• Readable
• ReadableBase
• ReturnItem
• ReturnShipping
• ReturnShipping
• ReturnShipping
• ReturnShipping
• ShippingMethod
• ShippingMethod
• ShippingMethod
• ShippingMethod
• StockLocationAddress
• StockLocationAddress
• Stream
• Tag
• Transform
• WritableBase
• internal

Interfaces

• ArrayBufferView
• ArrayLike
• AsyncGenerator
• AsyncGeneratorFunction
• AsyncIterable
• AsyncIterableIterator
• AsyncIterator
• BlobOptions
• Buffer
• BufferConstructor
• CallSite
• CreateNoteInput
• CreateUserInput
• DuplexOptions
• ErrnoException
• Error
• EventEmitter
• EventEmitterOptions
• FindConfig
• ICacheService
• IEventBusModuleService
• IEventBusService
• IFlagRouter
• IInventoryService
• ISearchService
• IStockLocationService
• ITransactionBaseService
• Iterable
• IterableIterator
• Iterator
• IteratorReturnResult
• IteratorYieldResult
• JoinerServiceConfig
• JoinerServiceConfigAlias
• Logger
• NumericalComparisonOperator
• Object
• PromiseLike
• QueuingStrategy
• QueuingStrategySize
• ReadWriteStream
• ReadableByteStreamController
• ReadableByteStreamControllerCallback
• ReadableStream
• ReadableStream
• ReadableStreamDefaultController
• ReadableStreamDefaultReadDoneResult
• ReadableStreamDefaultReadValueResult
• ReadableStreamDefaultReader
• ReadableStreamErrorCallback
• ReadableStreamGenericReader
• ReadableWritablePair
• SharedArrayBuffer
• SharedArrayBufferConstructor
• StaticEventEmitterOptions
• StreamPipeOptions
• StringComparisonOperator
• TransformOptions
• UnderlyingByteSource
• UnderlyingSink
• UnderlyingSinkAbortCallback
• UnderlyingSinkCloseCallback
• UnderlyingSinkStartCallback
• UnderlyingSinkWriteCallback
• UnderlyingSource
• UnderlyingSourceCancelCallback
• UnderlyingSourcePullCallback
• UnderlyingSourceStartCallback
• UpdateUserInput
• WritableStream
• WritableStream
• WritableStreamDefaultController
• WritableStreamDefaultWriter
• _DOMEventTarget
• _NodeEventTarget

References

Abortable

Re-exports Abortable

---

ReadableOptions

Re-exports ReadableOptions

---

WritableOptions

Re-exports WritableOptions

Enumeration Members

DEFAULT

• DEFAULT: "default"

Defined in

packages/medusa/dist/interfaces/price-selection-strategy.d.ts:45

---

EXTERNAL

• EXTERNAL: "external"

Defined in

packages/types/dist/modules-sdk/index.d.ts:11

---

INTERNAL

• INTERNAL: "internal"

Defined in

packages/types/dist/modules-sdk/index.d.ts:10

Type Aliases

AddOrderEditLineItemInput

Ƭ AddOrderEditLineItemInput: Object

Type declaration

Name	Type
metadata?	Record<string, unknown>
quantity	number
variant_id	string

Defined in

packages/medusa/dist/types/order-edit.d.ts:6

---

AdjustmentContext

Ƭ AdjustmentContext: Object

Type declaration

Name	Type
variant	{ product_id: string }
variant.product_id	string

Defined in

packages/medusa/dist/services/line-item-adjustment.d.ts:14

---

AdminDiscountConditionsRes

Ƭ AdminDiscountConditionsRes: Object

Schema

AdminDiscountConditionsRes type: object x-expanded-relations: field: discount_condition relations: - discount_rule required:

• discount_condition properties: discount_condition: description: "Discount condition details." $ref: "#/components/schemas/DiscountCondition"

Type declaration

Name	Type
discount_condition	DiscountCondition

Defined in

packages/medusa/dist/api/routes/admin/discounts/index.d.ts:48

---

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

Defined in

packages/medusa/dist/api/routes/admin/discounts/index.d.ts:129

---

AdminDiscountsRes

Ƭ AdminDiscountsRes: Object

Schema

AdminDiscountsRes type: object x-expanded-relations: field: discount relations: - parent_discount - regions - rule - rule.conditions eager: - regions.fulfillment_providers - regions.payment_providers required:

• discount properties: discount: description: "Discount details." $ref: "#/components/schemas/Discount"

Type declaration

Name	Type
discount	Discount

Defined in

packages/medusa/dist/api/routes/admin/discounts/index.d.ts:31

---

AllocationMapOptions

Ƭ AllocationMapOptions: Object

Type declaration

Name	Type
exclude_discounts?	boolean
exclude_gift_cards?	boolean

Defined in

packages/medusa/dist/services/totals.d.ts:54

---

ArrayBufferLike

Ƭ ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

Defined in

docs-util/node_modules/typescript/lib/lib.es5.d.ts:1701

---

ArrayBufferView

Ƭ ArrayBufferView: TypedArray | DataView

Defined in

packages/medusa-js/node_modules/@types/node/globals.d.ts:251

---

AuthenticateResult

Ƭ AuthenticateResult: Object

Type declaration

Name	Type
customer?	Customer
error?	string
success	boolean
user?	User

Defined in

packages/medusa/dist/types/auth.d.ts:2

---

AvailabilityContext

Ƭ AvailabilityContext: Object

Type declaration

Name	Type
inventoryLocationMap?	Map<string, InventoryLevelDTO[]>
variantInventoryMap?	Map<string, ProductVariantInventoryItem[]>

Defined in

packages/medusa/dist/services/product-variant-inventory.d.ts:19

---

BinaryLike

Ƭ BinaryLike: string | ArrayBufferView

Defined in

packages/medusa-js/node_modules/@types/node/crypto.d.ts:656

---

BufferEncoding

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

Defined in

packages/medusa-js/node_modules/@types/node/buffer.d.ts:223

---

CalculateOptionPriceInput

Ƭ CalculateOptionPriceInput: Object

Type declaration

Name	Type
data	Record<string, unknown>
provider_id	string

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:16

---

CalculationContextData

Ƭ CalculationContextData: Object

Type declaration

Name	Type
claims?	ClaimOrder[]
customer	Customer
discounts	Discount[]
items	LineItem[]
region	Region
shipping_address	Address | null
shipping_methods?	ShippingMethod[]
swaps?	Swap[]

Defined in

packages/medusa/dist/types/totals.d.ts:2

---

CalculationContextOptions

Ƭ CalculationContextOptions: Object

Type declaration

Name	Type
exclude_discounts?	boolean
exclude_gift_cards?	boolean
exclude_shipping?	boolean
is_return?	boolean

Defined in

packages/medusa/dist/services/totals.d.ts:58

---

CartCreateProps

Ƭ CartCreateProps: Object

Type declaration

Name	Type
billing_address?	Partial<AddressPayload>
billing_address_id?	string
context?	object
country_code?	string
customer_id?	string
discounts?	Discount[]
email?	string
gift_cards?	GiftCard[]
metadata?	Record<string, unknown>
region?	Region
region_id?	string
sales_channel_id?	string
shipping_address?	Partial<AddressPayload>
shipping_address_id?	string
type?	CartType

Defined in

packages/medusa/dist/types/cart.d.ts:31

---

CartUpdateProps

Ƭ CartUpdateProps: Object

Type declaration

Name	Type
billing_address?	AddressPayload | string
billing_address_id?	string
completed_at?	Date
context?	object
country_code?	string
customer_id?	string
discounts?	Discount[]
email?	string
gift_cards?	GiftCard[]
metadata?	Record<string, unknown>
payment_authorized_at?	Date | null
region_id?	string
sales_channel_id?	string
shipping_address?	AddressPayload | string
shipping_address_id?	string

Defined in

packages/medusa/dist/types/cart.d.ts:48

---

CategoryQueryParams

Ƭ CategoryQueryParams: Object

Type declaration

Name	Type
value	string[]

Defined in

packages/medusa/dist/repositories/product.d.ts:5

---

ClaimTypeValue

Ƭ ClaimTypeValue: `${ClaimType}`

Defined in

packages/medusa/dist/types/claim.d.ts:3

---

ConfigModule

Ƭ ConfigModule: Object

Type declaration

Name	Type
featureFlags	Record<string, boolean | string>
modules?	Record<string, false | string | Partial<InternalModuleDeclaration | ExternalModuleDeclaration>>
plugins	({ options: Record<string, unknown> ; resolve: string } | string)[]
projectConfig	ProjectConfigOptions

Defined in

packages/types/dist/common/config-module.d.ts:39

---

Constructor

Ƭ Constructor<T>: Object

Type parameters

Name
T

Defined in

packages/types/dist/modules-sdk/index.d.ts:5

---

CreateAnalyticsConfig

Ƭ CreateAnalyticsConfig: Object

Type declaration

Name	Type
anonymize	boolean
opt_out	boolean

Defined in

packages/medusa/dist/types/analytics-config.d.ts:1

---

CreateClaimInput

Ƭ CreateClaimInput: Object

Type declaration

Name	Type
additional_items?	CreateClaimItemAdditionalItemInput[]
claim_items	CreateClaimItemInput[]
claim_order_id?	string
metadata?	Record<string, unknown>
no_notification?	boolean
order	Order
refund_amount?	number
return_location_id?	string
return_shipping?	CreateClaimReturnShippingInput
shipping_address?	AddressPayload
shipping_address_id?	string
shipping_methods?	CreateClaimShippingMethodInput[]
type	ClaimTypeValue

Defined in

packages/medusa/dist/types/claim.d.ts:4

---

CreateClaimItemAdditionalItemInput

Ƭ CreateClaimItemAdditionalItemInput: Object

Type declaration

Name	Type
quantity	number
variant_id	string

Defined in

packages/medusa/dist/types/claim.d.ts:38

---

CreateClaimItemInput

Ƭ CreateClaimItemInput: Object

Type declaration

Name	Type
claim_order_id?	string
images?	string[]
item_id	string
note?	string
quantity	number
reason	ClaimReason
tags?	string[]

Defined in

packages/medusa/dist/types/claim.d.ts:29

---

CreateClaimReturnShippingInput

Ƭ CreateClaimReturnShippingInput: Object

Type declaration

Name	Type
option_id?	string
price?	number

Defined in

packages/medusa/dist/types/claim.d.ts:19

---

CreateClaimShippingMethodInput

Ƭ CreateClaimShippingMethodInput: Object

Type declaration

Name	Type
data?	Record<string, unknown>
id?	string
option_id?	string
price?	number

Defined in

packages/medusa/dist/types/claim.d.ts:23

---

CreateCustomShippingOptionInput

Ƭ CreateCustomShippingOptionInput: Object

Type declaration

Name	Type
cart_id?	string
metadata?	Record<string, unknown>
price	number
shipping_option_id	string

Defined in

packages/medusa/dist/types/shipping-options.d.ts:46

---

CreateCustomerInput

Ƭ CreateCustomerInput: Object

Type declaration

Name	Type
email	string
first_name?	string
has_account?	boolean
last_name?	string
metadata?	Record<string, unknown>
password?	string
password_hash?	string
phone?	string

Defined in

packages/medusa/dist/types/customers.d.ts:7

---

CreateDiscountInput

Ƭ CreateDiscountInput: Object

Type declaration

Name	Type
code	string
ends_at?	Date
is_disabled	boolean
is_dynamic	boolean
metadata?	Record<string, unknown>
regions?	string[] | Region[]
rule	CreateDiscountRuleInput
starts_at?	Date
usage_limit?	number
valid_duration?	string

Defined in

packages/medusa/dist/types/discount.d.ts:57

---

CreateDiscountRuleInput

Ƭ CreateDiscountRuleInput: Object

Type declaration

Name	Type
allocation	AllocationType
conditions?	DiscountConditionInput[]
description?	string
type	DiscountRuleType
value	number

Defined in

packages/medusa/dist/types/discount.d.ts:50

---

CreateDynamicDiscountInput

Ƭ CreateDynamicDiscountInput: Object

Type declaration

Name	Type
code	string
ends_at?	Date
metadata?	Record<string, unknown>
usage_limit	number

Defined in

packages/medusa/dist/types/discount.d.ts:87

---

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 }

Defined in

packages/medusa/dist/types/fulfillment.d.ts:15

---

CreateGiftCardInput

Ƭ CreateGiftCardInput: Object

Type declaration

Name	Type
balance?	number
ends_at?	Date
is_disabled?	boolean
metadata?	Record<string, unknown>
order_id?	string
region_id	string
tax_rate?	number | null
value?	number

Defined in

packages/medusa/dist/types/gift-card.d.ts:1

---

CreateGiftCardTransactionInput

Ƭ CreateGiftCardTransactionInput: Object

Type declaration

Name	Type
amount	number
created_at?	Date
gift_card_id	string
is_taxable?	boolean
order_id	string
tax_rate?	number | null

Defined in

packages/medusa/dist/types/gift-card.d.ts:18

---

CreateIdempotencyKeyInput

Ƭ CreateIdempotencyKeyInput: Object

Type declaration

Name	Type
idempotency_key?	string
request_method?	string
request_params?	Record<string, unknown>
request_path?	string

Defined in

packages/medusa/dist/types/idempotency-key.d.ts:1

---

CreateInventoryItemInput

Ƭ CreateInventoryItemInput: Object

Type declaration

Name	Type
description?	string
height?	number
hs_code?	string
length?	number
material?	string
metadata?	Record<string, unknown> | null
mid_code?	string
origin_country?	string
requires_shipping?	boolean
sku?	string
thumbnail?	string
title?	string
weight?	number
width?	number

Defined in

packages/types/dist/inventory/common.d.ts:213

---

CreateInventoryLevelInput

Ƭ CreateInventoryLevelInput: Object

Type declaration

Name	Type
incoming_quantity?	number
inventory_item_id	string
location_id	string
reserved_quantity?	number
stocked_quantity	number

Defined in

packages/types/dist/inventory/common.d.ts:246

---

CreateOauthInput

Ƭ CreateOauthInput: Object

Type declaration

Name	Type
application_name	string
display_name	string
install_url?	string
uninstall_url?	string

Defined in

packages/medusa/dist/types/oauth.d.ts:1

---

CreateOrderEditInput

Ƭ CreateOrderEditInput: Object

Type declaration

Name	Type
internal_note?	string
order_id	string

Defined in

packages/medusa/dist/types/order-edit.d.ts:2

---

CreateOrderEditItemChangeInput

Ƭ CreateOrderEditItemChangeInput: Object

Type declaration

Name	Type
line_item_id?	string
order_edit_id	string
original_line_item_id?	string
type	OrderEditItemChangeType

Defined in

packages/medusa/dist/types/order-edit.d.ts:11

---

CreatePaymentCollectionInput

Ƭ CreatePaymentCollectionInput: Object

Type declaration

Name	Type
amount	number
created_by	string
currency_code	string
description?	string
metadata?	any
region_id	string
type	PaymentCollectionType

Defined in

packages/medusa/dist/types/payment-collection.d.ts:2

---

CreatePaymentInput

Ƭ CreatePaymentInput: Object

Type declaration

Name	Type
amount	number
cart_id?	string
currency_code	string
payment_session	PaymentSession
provider_id?	string
resource_id?	string

Defined in

packages/medusa/dist/types/payment.d.ts:19

---

CreateProductCategoryInput

Ƭ CreateProductCategoryInput: ProductCategoryInput & { name: string }

Defined in

packages/medusa/dist/types/product-category.d.ts:11

---

CreateProductCollection

Ƭ CreateProductCollection: Object

Type declaration

Name	Type
handle?	string
metadata?	Record<string, unknown>
title	string

Defined in

packages/medusa/dist/types/product-collection.d.ts:1

---

CreateProductInput

Ƭ CreateProductInput: Object

Service Level DTOs

Type declaration

Name	Type
categories?	CreateProductProductCategoryInput[] | null
collection_id?	string
description?	string
discountable?	boolean
external_id?	string | null
handle?	string
height?	number
hs_code?	string
images?	string[]
is_giftcard?	boolean
length?	number
material?	string
metadata?	Record<string, unknown>
mid_code?	string
options?	CreateProductProductOption[]
origin_country?	string
profile_id?	string
sales_channels?	CreateProductProductSalesChannelInput[] | null
status?	ProductStatus
subtitle?	string
tags?	CreateProductProductTagInput[]
thumbnail?	string
title	string
type?	CreateProductProductTypeInput
variants?	CreateProductProductVariantInput[]
weight?	number
width?	number

Defined in

packages/medusa/dist/types/product.d.ts:38

---

CreateProductProductCategoryInput

Ƭ CreateProductProductCategoryInput: Object

Type declaration

Name	Type
id	string

Defined in

packages/medusa/dist/types/product.d.ts:74

---

CreateProductProductOption

Ƭ CreateProductProductOption: Object

Type declaration

Name	Type
title	string

Defined in

packages/medusa/dist/types/product.d.ts:129

---

CreateProductProductSalesChannelInput

Ƭ CreateProductProductSalesChannelInput: Object

Type declaration

Name	Type
id	string

Defined in

packages/medusa/dist/types/product.d.ts:71

---

CreateProductProductTagInput

Ƭ CreateProductProductTagInput: Object

Type declaration

Name	Type
id?	string
value	string

Defined in

packages/medusa/dist/types/product.d.ts:67

---

CreateProductProductTypeInput

Ƭ CreateProductProductTypeInput: Object

Type declaration

Name	Type
id?	string
value	string

Defined in

packages/medusa/dist/types/product.d.ts:77

---

CreateProductProductVariantInput

Ƭ CreateProductProductVariantInput: Object

Type declaration

Name	Type
allow_backorder?	boolean
barcode?	string
ean?	string
height?	number
hs_code?	string
inventory_quantity?	number
length?	number
manage_inventory?	boolean
material?	string
metadata?	Record<string, unknown>
mid_code?	string
options?	{ value: string }[]
origin_country?	string
prices?	CreateProductProductVariantPriceInput[]
sku?	string
title	string
upc?	string
weight?	number
width?	number

Defined in

packages/medusa/dist/types/product.d.ts:81

---

CreateProductProductVariantPriceInput

Ƭ CreateProductProductVariantPriceInput: Object

Type declaration

Name	Type
amount	number
currency_code?	string
max_quantity?	number
min_quantity?	number
region_id?	string

Defined in

packages/medusa/dist/types/product.d.ts:132

---

CreateProductVariantInput

Ƭ CreateProductVariantInput: Object

Type declaration

Name	Type
allow_backorder?	boolean
barcode?	string
ean?	string
height?	number
hs_code?	string
inventory_quantity?	number
length?	number
manage_inventory?	boolean
material?	string
metadata?	Record<string, unknown>
mid_code?	string
options	ProductVariantOption[]
origin_country?	string
prices	ProductVariantPrice[]
product_id?	string
sku?	string
title?	string
upc?	string
variant_rank?	number
weight?	number
width?	number

Defined in

packages/medusa/dist/types/product-variant.d.ts:21

---

CreateRegionInput

Ƭ CreateRegionInput: Object

Type declaration

Name	Type
countries	string[]
currency_code	string
fulfillment_providers	string[]
includes_tax?	boolean
metadata?	Record<string, unknown>
name	string
payment_providers	string[]
tax_code?	string
tax_rate	number

Defined in

packages/medusa/dist/types/region.d.ts:15

---

CreateReservationItemInput

Ƭ CreateReservationItemInput: Object

Type declaration

Name	Type
created_by?	string
description?	string
external_id?	string
inventory_item_id	string
line_item_id?	string
location_id	string
metadata?	Record<string, unknown> | null
quantity	number

Defined in

packages/types/dist/inventory/common.d.ts:229

---

CreateReturnInput

Ƭ CreateReturnInput: Object

Type declaration

Name	Type
claim_order_id?	string
items?	OrdersReturnItem[]
location_id?	string
metadata?	Record<string, unknown>
no_notification?	boolean
order_id	string
refund_amount?	number
shipping_method?	{ option_id?: string ; price?: number }
shipping_method.option_id?	string
shipping_method.price?	number
swap_id?	string

Defined in

packages/medusa/dist/types/return.d.ts:7

---

CreateReturnReason

Ƭ CreateReturnReason: Object

Type declaration

Name	Type
description?	string
label	string
metadata?	Record<string, unknown>
parent_return_reason_id?	string
value	string

Defined in

packages/medusa/dist/types/return-reason.d.ts:1

---

CreateReturnType

Ƭ CreateReturnType: Omit<Return, "beforeInsert">

Defined in

packages/medusa/dist/types/fulfillment-provider.d.ts:6

---

CreateSalesChannelInput

Ƭ CreateSalesChannelInput: Object

Type declaration

Name	Type
description?	string
is_disabled?	boolean
name	string

Defined in

packages/medusa/dist/types/sales-channels.d.ts:1

---

CreateShipmentConfig

Ƭ CreateShipmentConfig: Object

Type declaration

Name	Type
location_id?	string
metadata?	Record<string, unknown>
no_notification?	boolean

Defined in

packages/medusa/dist/types/fulfillment.d.ts:10

---

CreateShippingMethod

Ƭ CreateShippingMethod: Object

Type declaration

Name	Type
cart_id?	string
claim_order_id?	string
data?	any
draft_order_id?	string
order_id?	string
price?	number
return_id?	string
shipping_option_id?	string
swap_id?	string

Defined in

packages/medusa/dist/types/shipping-options.d.ts:17

---

CreateShippingMethodDto

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

Defined in

packages/medusa/dist/types/shipping-options.d.ts:28

---

CreateShippingOptionInput

Ƭ CreateShippingOptionInput: Object

Type declaration

Name	Type
admin_only?	boolean
amount?	number
data	Record<string, unknown>
includes_tax?	boolean
is_return?	boolean
metadata?	Record<string, unknown>
name	string
price_type	ShippingOptionPriceType
profile_id	string
provider_id	string
region_id	string
requirements?	ShippingOptionRequirement[]

Defined in

packages/medusa/dist/types/shipping-options.d.ts:32

---

CreateShippingProfile

Ƭ CreateShippingProfile: Object

Type declaration

Name	Type
metadata?	Record<string, unknown>
name	string
type	ShippingProfileType

Defined in

packages/medusa/dist/types/shipping-profile.d.ts:2

---

CreateStockLocationInput

Ƭ CreateStockLocationInput: Object

Schema

CreateStockLocationInput title: "Create Stock Location Input" description: "Represents the Input to create a Stock Location" type: object required:

• name properties: name: type: string description: The stock location name address_id: type: string description: The Stock location address ID address: description: Stock location address object allOf:
  • $ref: "#/components/schemas/StockLocationAddressInput"
  • type: object metadata: type: object description: An optional key-value map with additional details example: {car: "white"}

Type declaration

Name	Type
address?	string | StockLocationAddressInput
address_id?	string
metadata?	Record<string, unknown>
name	string

Defined in

packages/types/dist/stock-location/common.d.ts:229

---

CreateTaxRateInput

Ƭ CreateTaxRateInput: Object

Type declaration

Name	Type
code	string
name	string
rate?	number | null
region_id	string

Defined in

packages/medusa/dist/types/tax-rate.d.ts:17

---

CustomerGroupConstructorProps

Ƭ CustomerGroupConstructorProps: Object

Type declaration

Name	Type
customerGroupRepository	typeof CustomerGroupRepository
customerService	CustomerService
manager	EntityManager

Defined in

packages/medusa/dist/services/customer-group.d.ts:8

---

DefaultWithoutRelations

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

Defined in

packages/medusa/dist/repositories/customer-group.d.ts:4

---

DefaultWithoutRelations

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

Defined in

packages/medusa/dist/repositories/product.d.ts:4

---

DeleteFileType

Ƭ DeleteFileType: Object

Index signature

▪ [x: string]: unknown

Type declaration

Name	Type
fileKey	string

Defined in

packages/types/dist/file-service/index.d.ts:19

---

DeleteResponse

Ƭ DeleteResponse: Object

Type declaration

Name	Type
deleted	boolean
id	string
object	string

Defined in

packages/types/dist/common/common.d.ts:97

---

Discount

Ƭ Discount: Object

Type declaration

Name	Type
code	string

Defined in

packages/medusa/dist/types/draft-orders.d.ts:26

---

DiscountAllocation

Ƭ DiscountAllocation: Object

The amount of a discount allocated to a line item

Type declaration

Name	Type
amount	number
unit_amount	number

Defined in

packages/medusa/dist/types/totals.d.ts:18

---

DiscountConditionInput

Ƭ DiscountConditionInput: Object

Type declaration

Name	Type
customer_groups?	(string | { id: string })[]
id?	string
operator?	DiscountConditionOperator
product_collections?	(string | { id: string })[]
product_tags?	(string | { id: string })[]
product_types?	(string | { id: string })[]
products?	(string | { id: string })[]
rule_id?	string

Defined in

packages/medusa/dist/types/discount.d.ts:30

---

DiscountConditionResourceType

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

Defined in

packages/medusa/dist/repositories/discount-condition.d.ts:10

---

DraftOrderCreateProps

Ƭ DraftOrderCreateProps: Object

Type declaration

Name	Type
billing_address?	Partial<AddressPayload>
billing_address_id?	string
customer_id?	string
discounts?	Discount[]
email	string
idempotency_key?	string
items?	Item[]
metadata?	Record<string, unknown>
no_notification_order?	boolean
region_id	string
shipping_address?	Partial<AddressPayload>
shipping_address_id?	string
shipping_methods	ShippingMethod[]
status?	string

Defined in

packages/medusa/dist/types/draft-orders.d.ts:5

---

EmitData

Ƭ EmitData<T>: Object

Type parameters

Name	Type
T	unknown

Type declaration

Name	Type
data	T
eventName	string
options?	Record<string, unknown>

Defined in

packages/types/dist/event-bus/common.d.ts:10

---

ExtendedFindConfig

Ƭ ExtendedFindConfig<TEntity>: Omit<FindOneOptions<TEntity>, "where" | "relations" | "select"> | Omit<FindManyOptions<TEntity>, "where" | "relations" | "select"> & { order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> | FindOptionsWhere<TEntity>[] }

Type parameters

Name
TEntity

Defined in

packages/types/dist/common/common.d.ts:50

---

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"

Defined in

packages/medusa/dist/types/store.d.ts:52

---

ExternalModuleDeclaration

Ƭ ExternalModuleDeclaration: Object

Type declaration

Name	Type	Description
alias?	string	If multiple modules are registered with the same key, the alias can be used to differentiate them
definition?	ModuleDefinition	-
main?	boolean	If the module is the main module for the key when multiple ones are registered
options?	Record<string, unknown>	-
scope	EXTERNAL	-
server?	{ keepAlive: boolean ; type: "http" ; url: string }	-
server.keepAlive	boolean	-
server.type	"http"	-
server.url	string	-

Defined in

packages/types/dist/modules-sdk/index.d.ts:33

---

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

Defined in

packages/medusa/dist/types/feature-flags.d.ts:21

---

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

Defined in

packages/types/dist/feature-flag/common.d.ts:21

---

FileServiceGetUploadStreamResult

Ƭ FileServiceGetUploadStreamResult: Object

Index signature

▪ [x: string]: unknown

Type declaration

Name	Type
fileKey	string
promise	Promise<any>
url	string
writeStream	PassThrough

Defined in

packages/types/dist/file-service/index.d.ts:7

---

FileServiceUploadResult

Ƭ FileServiceUploadResult: Object

Type declaration

Name	Type
key	string
url	string

Defined in

packages/types/dist/file-service/index.d.ts:3

---

FilterableInventoryItemProps

Ƭ FilterableInventoryItemProps: Object

Type declaration

Name	Type
hs_code?	string | string[] | StringComparisonOperator
id?	string | string[]
location_id?	string | string[]
origin_country?	string | string[]
q?	string
requires_shipping?	boolean
sku?	string | string[] | StringComparisonOperator

Defined in

packages/types/dist/inventory/common.d.ts:204

---

FilterableInventoryLevelProps

Ƭ FilterableInventoryLevelProps: Object

Type declaration

Name	Type
incoming_quantity?	number | NumericalComparisonOperator
inventory_item_id?	string | string[]
location_id?	string | string[]
reserved_quantity?	number | NumericalComparisonOperator
stocked_quantity?	number | NumericalComparisonOperator

Defined in

packages/types/dist/inventory/common.d.ts:239

---

FilterableReservationItemProps

Ƭ FilterableReservationItemProps: Object

Type declaration

Name	Type
created_by?	string | string[]
description?	string | StringComparisonOperator
id?	string | string[]
inventory_item_id?	string | string[]
line_item_id?	string | string[]
location_id?	string | string[]
quantity?	number | NumericalComparisonOperator
type?	string | string[]

Defined in

packages/types/dist/inventory/common.d.ts:194

---

FilterableStockLocationProps

Ƭ FilterableStockLocationProps: Object

Type declaration

Name	Type
id?	string | string[]
name?	string | string[] | StringComparisonOperator

Defined in

packages/types/dist/stock-location/common.d.ts:149

---

FilterableTaxRateProps

Ƭ FilterableTaxRateProps: Object

Type declaration

Name	Type
code?	string | string[] | StringComparisonOperator
created_at?	Date | DateComparisonOperator
deleted_at?	Date | DateComparisonOperator
name?	string | string[]
rate?	number | NumericalComparisonOperator
region_id?	string | string[]
updated_at?	Date | DateComparisonOperator

Defined in

packages/medusa/dist/types/tax-rate.d.ts:2

---

FilterableUserProps

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

Defined in

packages/medusa/dist/types/user.d.ts:26

---

FindProductConfig

Ƭ FindProductConfig: FindConfig<Product> & PriceListLoadConfig

Defined in

packages/medusa/dist/types/product.d.ts:146

---

FindWithRelationsOptions

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

Defined in

packages/medusa/dist/repositories/product-variant.d.ts:4

---

FindWithoutRelationsOptions

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

Defined in

packages/medusa/dist/repositories/customer-group.d.ts:5

---

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> } }

Defined in

packages/medusa/dist/repositories/product.d.ts:8

---

FulFillmentItemType

Ƭ FulFillmentItemType: Object

Type declaration

Name	Type
item_id	string
quantity	number

Defined in

packages/medusa/dist/types/fulfillment.d.ts:2

---

FulfillmentItemPartition

Ƭ FulfillmentItemPartition: Object

Type declaration

Name	Type
items	LineItem[]
shipping_method	ShippingMethod

Defined in

packages/medusa/dist/types/fulfillment.d.ts:6

---

FulfillmentOptions

Ƭ FulfillmentOptions: Object

Type declaration

Name	Type
options	Record<string, unknown>[]
provider_id	string

Defined in

packages/medusa/dist/types/fulfillment-provider.d.ts:2

---

FulfillmentProviderContainer

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

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:10

---

FulfillmentProviderData

Ƭ FulfillmentProviderData: Record<string, unknown>

Defined in

packages/medusa/dist/interfaces/fulfillment-service.d.ts:4

---

FulfillmentProviderKey

Ƭ FulfillmentProviderKey: `fp_${string}`

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:9

---

GenerateInputData

Ƭ GenerateInputData: Object

Type declaration

Name	Type
metadata?	Record<string, unknown>
quantity	number
unit_price?	number
variantId	string

Defined in

packages/medusa/dist/types/line-item.d.ts:2

---

GenerateLineItemContext

Ƭ GenerateLineItemContext: Object

Type declaration

Name	Type
cart?	CalculationContextData
customer_id?	string
includes_tax?	boolean
metadata?	Record<string, unknown>
order_edit_id?	string
region_id?	string
unit_price?	number

Defined in

packages/medusa/dist/types/line-item.d.ts:8

---

GeneratedAdjustment

Ƭ GeneratedAdjustment: Object

Type declaration

Name	Type
amount	number
description	string
discount_id	string

Defined in

packages/medusa/dist/services/line-item-adjustment.d.ts:19

---

GetLineItemTotalOptions

Ƭ GetLineItemTotalOptions: Object

Type declaration

Name	Type
exclude_discounts?	boolean
include_tax?	boolean

Defined in

packages/medusa/dist/services/totals.d.ts:39

---

GetRegionPriceContext

Ƭ GetRegionPriceContext: Object

Type declaration

Name	Type
customer_id?	string
include_discount_prices?	boolean
quantity?	number
regionId	string

Defined in

packages/medusa/dist/types/product-variant.d.ts:11

---

GetShippingMethodTotalsOptions

Ƭ GetShippingMethodTotalsOptions: Object

Type declaration

Name	Type
calculation_context?	TaxCalculationContext
include_tax?	boolean
use_tax_lines?	boolean

Defined in

packages/medusa/dist/services/totals.d.ts:16

---

GetTotalsOptions

Ƭ GetTotalsOptions: Object

Type declaration

Name	Type
exclude_gift_cards?	boolean
force_taxes?	boolean

Defined in

packages/medusa/dist/services/totals.d.ts:50

---

GetUploadedFileType

Ƭ GetUploadedFileType: Object

Index signature

▪ [x: string]: unknown

Type declaration

Name	Type
fileKey	string
isPrivate?	boolean

Defined in

packages/types/dist/file-service/index.d.ts:14

---

GiftCardAllocation

Ƭ GiftCardAllocation: Object

The amount of a gift card allocated to a line item

Type declaration

Name	Type
amount	number
unit_amount	number

Defined in

packages/medusa/dist/types/totals.d.ts:13

---

GiftCardTransaction

Ƭ GiftCardTransaction: Object

Type declaration

Name	Type
amount	number
gift_card	GiftCard
is_taxable	boolean | null
tax_rate	number | null

Defined in

packages/medusa/dist/services/new-totals.d.ts:19

---

HttpCompressionOptions

Ƭ HttpCompressionOptions: Object

Type declaration

Name	Type
enabled?	boolean
level?	number
memLevel?	number
threshold?	number | string

Defined in

packages/types/dist/common/config-module.d.ts:12

---

IdempotencyCallbackResult

Ƭ IdempotencyCallbackResult: Object

Type declaration

Name	Type
recovery_point?	string
response_body?	Record<string, unknown>
response_code?	number

Defined in

packages/medusa/dist/types/idempotency-key.d.ts:7

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
analyticsConfigRepository	typeof AnalyticsConfigRepository
manager	EntityManager

Defined in

packages/medusa/dist/services/analytics-config.d.ts:7

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
customerService	CustomerService
manager	EntityManager
userService	UserService

Defined in

packages/medusa/dist/services/auth.d.ts:6

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
batchJobRepository	typeof BatchJobRepository
eventBusService	EventBusService
manager	EntityManager
strategyResolverService	StrategyResolverService

Defined in

packages/medusa/dist/services/batch-job.d.ts:10

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
addressRepository	typeof AddressRepository
cartRepository	typeof CartRepository
customShippingOptionService	CustomShippingOptionService
customerService	CustomerService
discountService	DiscountService
eventBusService	EventBusService
featureFlagRouter	FlagRouter
giftCardService	GiftCardService
lineItemAdjustmentService	LineItemAdjustmentService
lineItemRepository	typeof LineItemRepository
lineItemService	LineItemService
manager	EntityManager
newTotalsService	NewTotalsService
paymentProviderService	PaymentProviderService
paymentSessionRepository	typeof PaymentSessionRepository
priceSelectionStrategy	IPriceSelectionStrategy
pricingService	PricingService
productService	ProductService
productVariantInventoryService	ProductVariantInventoryService
productVariantService	ProductVariantService
regionService	RegionService
salesChannelService	SalesChannelService
shippingMethodRepository	typeof ShippingMethodRepository
shippingOptionService	ShippingOptionService
shippingProfileService	ShippingProfileService
storeService	StoreService
taxProviderService	TaxProviderService
totalsService	TotalsService

Defined in

packages/medusa/dist/services/cart.d.ts:13

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
addressRepository	typeof AddressRepository
claimItemService	ClaimItemService
claimRepository	typeof ClaimRepository
eventBusService	EventBusService
fulfillmentProviderService	FulfillmentProviderService
fulfillmentService	FulfillmentService
lineItemRepository	typeof LineItemRepository
lineItemService	LineItemService
manager	EntityManager
paymentProviderService	PaymentProviderService
productVariantInventoryService	ProductVariantInventoryService
regionService	RegionService
returnService	ReturnService
shippingMethodRepository	typeof ShippingMethodRepository
shippingOptionService	ShippingOptionService
taxProviderService	TaxProviderService
totalsService	TotalsService

Defined in

packages/medusa/dist/services/claim.d.ts:22

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
currencyRepository	typeof CurrencyRepository
eventBusService	EventBusService
featureFlagRouter	FlagRouter
manager	EntityManager

Defined in

packages/medusa/dist/services/currency.d.ts:9

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
customShippingOptionRepository	typeof CustomShippingOptionRepository
manager	EntityManager

Defined in

packages/medusa/dist/services/custom-shipping-option.d.ts:7

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
addressRepository	typeof AddressRepository
customerRepository	typeof CustomerRepository
eventBusService	EventBusService
manager	EntityManager

Defined in

packages/medusa/dist/services/customer.d.ts:10

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
discountConditionRepository	typeof DiscountConditionRepository
eventBusService	EventBusService
manager	EntityManager

Defined in

packages/medusa/dist/services/discount-condition.d.ts:8

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
cartService	CartService
customShippingOptionService	CustomShippingOptionService
draftOrderRepository	typeof DraftOrderRepository
eventBusService	EventBusService
lineItemService	LineItemService
manager	EntityManager
orderRepository	typeof OrderRepository
paymentRepository	typeof PaymentRepository
productVariantService	ProductVariantService
shippingOptionService	ShippingOptionService

Defined in

packages/medusa/dist/services/draft-order.d.ts:15

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusModuleService	AbstractEventBusModuleService
logger	Logger
stagedJobService	StagedJobService

Defined in

packages/medusa/dist/services/event-bus.d.ts:9

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
giftCardRepository	typeof GiftCardRepository
giftCardTransactionRepository	typeof GiftCardTransactionRepository
manager	EntityManager
regionService	RegionService

Defined in

packages/medusa/dist/services/gift-card.d.ts:10

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
idempotencyKeyRepository	typeof IdempotencyKeyRepository
manager	EntityManager

Defined in

packages/medusa/dist/services/idempotency-key.d.ts:7

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
cartRepository	typeof CartRepository
featureFlagRouter	FlagRouter
lineItemAdjustmentService	LineItemAdjustmentService
lineItemRepository	typeof LineItemRepository
lineItemTaxLineRepository	typeof LineItemTaxLineRepository
manager	EntityManager
pricingService	PricingService
productService	ProductService
productVariantService	ProductVariantService
regionService	RegionService
taxProviderService	TaxProviderService

Defined in

packages/medusa/dist/services/line-item.d.ts:14

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
featureFlagRouter	FlagRouter
manager	EntityManager
taxCalculationStrategy	ITaxCalculationStrategy
taxProviderService	TaxProviderService

Defined in

packages/medusa/dist/services/new-totals.d.ts:34

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
manager	EntityManager
noteRepository	typeof NoteRepository

Defined in

packages/medusa/dist/services/note.d.ts:8

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
logger	Logger
manager	EntityManager
notificationProviderRepository	typeof NotificationProviderRepository
notificationRepository	typeof NotificationRepository

Defined in

packages/medusa/dist/services/notification.d.ts:8

---

InjectedDependencies

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

Defined in

packages/medusa/dist/services/oauth.d.ts:9

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
addressRepository	typeof AddressRepository
cartService	CartService
customerService	CustomerService
discountService	DiscountService
draftOrderService	DraftOrderService
eventBusService	EventBusService
featureFlagRouter	FlagRouter
fulfillmentProviderService	FulfillmentProviderService
fulfillmentService	FulfillmentService
giftCardService	GiftCardService
inventoryService	IInventoryService
lineItemService	LineItemService
manager	EntityManager
newTotalsService	NewTotalsService
orderRepository	typeof OrderRepository
paymentProviderService	PaymentProviderService
productVariantInventoryService	ProductVariantInventoryService
regionService	RegionService
shippingOptionService	ShippingOptionService
shippingProfileService	ShippingProfileService
taxProviderService	TaxProviderService
totalsService	TotalsService

Defined in

packages/medusa/dist/services/order.d.ts:15

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
inventoryService?	IInventoryService
lineItemAdjustmentService	LineItemAdjustmentService
lineItemService	LineItemService
manager	EntityManager
newTotalsService	NewTotalsService
orderEditItemChangeService	OrderEditItemChangeService
orderEditRepository	typeof OrderEditRepository
orderService	OrderService
taxProviderService	TaxProviderService
totalsService	TotalsService

Defined in

packages/medusa/dist/services/order-edit.d.ts:10

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	IEventBusService
lineItemService	LineItemService
manager	EntityManager
orderItemChangeRepository	typeof OrderItemChangeRepository
taxProviderService	TaxProviderService

Defined in

packages/medusa/dist/services/order-edit-item-change.d.ts:10

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
customerService	CustomerService
eventBusService	EventBusService
manager	EntityManager
paymentCollectionRepository	typeof PaymentCollectionRepository
paymentProviderService	PaymentProviderService

Defined in

packages/medusa/dist/services/payment-collection.d.ts:9

---

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 }

Defined in

packages/medusa/dist/services/payment-provider.d.ts:16

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
featureFlagRouter	FlagRouter
manager	EntityManager
priceSelectionStrategy	IPriceSelectionStrategy
productVariantService	ProductVariantService
regionService	RegionService
taxProviderService	TaxProviderService

Defined in

packages/medusa/dist/services/pricing.d.ts:9

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
featureFlagRouter	FlagRouter
imageRepository	typeof ImageRepository
manager	EntityManager
productCategoryRepository	typeof ProductCategoryRepository
productOptionRepository	typeof ProductOptionRepository
productRepository	typeof ProductRepository
productTagRepository	typeof ProductTagRepository
productTypeRepository	typeof ProductTypeRepository
productVariantRepository	typeof ProductVariantRepository
productVariantService	ProductVariantService
searchService	SearchService

Defined in

packages/medusa/dist/services/product.d.ts:16

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
manager	EntityManager
productCategoryRepository	typeof ProductCategoryRepository

Defined in

packages/medusa/dist/services/product-category.d.ts:8

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
manager	EntityManager
productCollectionRepository	typeof ProductCollectionRepository
productRepository	typeof ProductRepository

Defined in

packages/medusa/dist/services/product-collection.d.ts:9

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	IEventBusService
inventoryService	IInventoryService
manager	EntityManager
productVariantService	ProductVariantService
salesChannelInventoryService	SalesChannelInventoryService
salesChannelLocationService	SalesChannelLocationService
stockLocationService	IStockLocationService

Defined in

packages/medusa/dist/services/product-variant-inventory.d.ts:10

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
countryRepository	typeof CountryRepository
currencyRepository	typeof CurrencyRepository
eventBusService	EventBusService
featureFlagRouter	FlagRouter
fulfillmentProviderRepository	typeof FulfillmentProviderRepository
fulfillmentProviderService	FulfillmentProviderService
manager	EntityManager
paymentProviderRepository	typeof PaymentProviderRepository
paymentProviderService	PaymentProviderService
regionRepository	typeof RegionRepository
storeService	StoreService
taxProviderRepository	typeof TaxProviderRepository

Defined in

packages/medusa/dist/services/region.d.ts:17

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
featureFlagRouter	FlagRouter
fulfillmentProviderService	FulfillmentProviderService
lineItemService	LineItemService
manager	EntityManager
orderService	OrderService
productVariantInventoryService	ProductVariantInventoryService
returnItemRepository	typeof ReturnItemRepository
returnReasonService	ReturnReasonService
returnRepository	typeof ReturnRepository
shippingOptionService	ShippingOptionService
taxProviderService	TaxProviderService
totalsService	TotalsService

Defined in

packages/medusa/dist/services/return.d.ts:11

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
manager	EntityManager
returnReasonRepository	typeof ReturnReasonRepository

Defined in

packages/medusa/dist/services/return-reason.d.ts:7

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
manager	EntityManager
salesChannelRepository	typeof SalesChannelRepository
storeService	StoreService

Defined in

packages/medusa/dist/services/sales-channel.d.ts:9

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	IEventBusService
inventoryService	IInventoryService
manager	EntityManager
salesChannelLocationService	SalesChannelLocationService

Defined in

packages/medusa/dist/services/sales-channel-inventory.d.ts:5

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	IEventBusService
manager	EntityManager
salesChannelService	SalesChannelService
stockLocationService	IStockLocationService

Defined in

packages/medusa/dist/services/sales-channel-location.d.ts:5

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
logger	Logger
manager	EntityManager

Defined in

packages/medusa/dist/services/search.d.ts:4

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
featureFlagRouter	FlagRouter
fulfillmentProviderService	FulfillmentProviderService
manager	EntityManager
regionService	RegionService
shippingMethodRepository	typeof ShippingMethodRepository
shippingOptionRepository	typeof ShippingOptionRepository
shippingOptionRequirementRepository	typeof ShippingOptionRequirementRepository

Defined in

packages/medusa/dist/services/shipping-option.d.ts:12

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
customShippingOptionService	CustomShippingOptionService
featureFlagRouter	FlagRouter
manager	EntityManager
productRepository	typeof ProductRepository
productService	ProductService
shippingOptionService	ShippingOptionService
shippingProfileRepository	typeof ShippingProfileRepository

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:12

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
currencyRepository	typeof CurrencyRepository
eventBusService	EventBusService
manager	EntityManager
storeRepository	typeof StoreRepository

Defined in

packages/medusa/dist/services/store.d.ts:9

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Index signature

▪ [key: string]: unknown

Type declaration

Name	Type
manager	EntityManager

Defined in

packages/medusa/dist/services/strategy-resolver.d.ts:3

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
configModule	ConfigModule

Defined in

packages/medusa/dist/services/token.d.ts:4

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
fulfillmentProviderService	FulfillmentProviderService
fulfillmentRepository	typeof FulfillmentRepository
lineItemRepository	typeof LineItemRepository
lineItemService	LineItemService
manager	EntityManager
productVariantInventoryService	ProductVariantInventoryService
shippingProfileService	ShippingProfileService
totalsService	TotalsService
trackingLinkRepository	typeof TrackingLinkRepository

Defined in

packages/medusa/dist/services/fulfillment.d.ts:13

---

InjectedDependencies

Ƭ InjectedDependencies: Object

Type declaration

Name	Type
eventBusService	EventBusService
manager	EntityManager
paymentProviderService	PaymentProviderService
paymentRepository	typeof PaymentRepository

Defined in

packages/medusa/dist/services/payment.d.ts:8

---

InjectedProps

Ƭ InjectedProps: Object

Type declaration

Name	Type
cartService	CartService
customShippingOptionService	CustomShippingOptionService
eventBusService	EventBusService
fulfillmentService	FulfillmentService
lineItemAdjustmentService	LineItemAdjustmentService
lineItemService	LineItemService
manager	EntityManager
orderService	OrderService
paymentProviderService	PaymentProviderService
productVariantInventoryService	ProductVariantInventoryService
returnService	ReturnService
shippingOptionService	ShippingOptionService
swapRepository	typeof SwapRepository
totalsService	TotalsService

Defined in

packages/medusa/dist/services/swap.d.ts:8

---

InternalModuleDeclaration

Ƭ InternalModuleDeclaration: Object

Type declaration

Name	Type	Description
alias?	string	If multiple modules are registered with the same key, the alias can be used to differentiate them
definition?	ModuleDefinition	-
dependencies?	string[]	-
main?	boolean	If the module is the main module for the key when multiple ones are registered
options?	Record<string, unknown>	-
resolve?	string	-
resources	MODULE_RESOURCE_TYPE	-
scope	INTERNAL	-

Defined in

packages/types/dist/modules-sdk/index.d.ts:17

---

InventoryItemDTO

Ƭ InventoryItemDTO: Object

Schema

InventoryItemDTO type: object required:

• sku properties: sku: description: The Stock Keeping Unit (SKU) code of the Inventory Item. type: string hs_code: description: The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string origin_country: description: The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string mid_code: description: The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string title: description: "Title of the inventory item" type: string description: description: "Description of the inventory item" type: string thumbnail: description: "Thumbnail for the inventory item" type: string material: description: The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string weight: description: The weight of the Inventory Item. May be used in shipping rate calculations. type: number height: description: The height of the Inventory Item. May be used in shipping rate calculations. type: number width: description: The width of the Inventory Item. May be used in shipping rate calculations. type: number length: description: The length of the Inventory Item. May be used in shipping rate calculations. type: number requires_shipping: description: Whether the item requires shipping. type: boolean metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time

Type declaration

Name	Type
created_at	string | Date
deleted_at	string | Date | null
description?	string | null
height?	number | null
hs_code?	string | null
id	string
length?	number | null
material?	string | null
metadata?	Record<string, unknown> | null
mid_code?	string | null
origin_country?	string | null
requires_shipping	boolean
sku?	string | null
thumbnail?	string | null
title?	string | null
updated_at	string | Date
weight?	number | null
width?	number | null

Defined in

packages/types/dist/inventory/common.d.ts:64

---

InventoryLevelDTO

Ƭ InventoryLevelDTO: Object

Schema

InventoryLevelDTO type: object required:

• inventory_item_id
• location_id
• stocked_quantity
• reserved_quantity
• incoming_quantity properties: location_id: description: the item location ID type: string stocked_quantity: description: the total stock quantity of an inventory item at the given location ID type: number reserved_quantity: description: the reserved stock quantity of an inventory item at the given location ID type: number incoming_quantity: description: the incoming stock quantity of an inventory item at the given location ID type: number metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time

Type declaration

Name	Type
created_at	string | Date
deleted_at	string | Date | null
id	string
incoming_quantity	number
inventory_item_id	string
location_id	string
metadata	Record<string, unknown> | null
reserved_quantity	number
stocked_quantity	number
updated_at	string | Date

Defined in

packages/types/dist/inventory/common.d.ts:182

---

Item

Ƭ Item: Object

Type declaration

Name	Type
metadata?	Record<string, unknown>
quantity	number
title?	string
unit_price?	number
variant_id?	string

Defined in

packages/medusa/dist/types/draft-orders.d.ts:29

---

IteratorResult

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

Type parameters

Name	Type
T	T
TReturn	any

Defined in

docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:39

---

JoinerRelationship

Ƭ JoinerRelationship: Object

Type declaration

Name	Type	Description
alias	string	-
args?	Record<string, any>	Extra arguments to pass to the remoteFetchData callback
foreignKey	string	-
inverse?	boolean	In an inverted relationship the foreign key is on the other service and the primary key is on the current service
isInternalService?	boolean	If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more "internal" services
isList?	boolean	Force the relationship to return a list
primaryKey	string	-
serviceName	string	-

Defined in

packages/types/dist/joiner/index.d.ts:1

---

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 }

Defined in

packages/medusa/dist/types/totals.d.ts:26

---

LineDiscount

Ƭ LineDiscount: Object

Associates a line item and discount allocation.

Type declaration

Name	Type
amount	number
lineItem	LineItem
variant	string

Defined in

packages/medusa/dist/types/totals.d.ts:41

---

LineDiscountAmount

Ƭ LineDiscountAmount: Object

Associates a line item and discount allocation.

Type declaration

Name	Type
amount	number
customAdjustmentsAmount	number
item	LineItem

Defined in

packages/medusa/dist/types/totals.d.ts:49

---

LineItemAdjustmentServiceProps

Ƭ LineItemAdjustmentServiceProps: Object

Type declaration

Name	Type
discountService	DiscountService
lineItemAdjustmentRepository	typeof LineItemAdjustmentRepository
manager	EntityManager

Defined in

packages/medusa/dist/services/line-item-adjustment.d.ts:9

---

LineItemTotals

Ƭ LineItemTotals: Object

Type declaration

Name	Type
discount_total	number
original_tax_total	number
original_total	number
quantity	number
raw_discount_total	number
subtotal	number
tax_lines	LineItemTaxLine[]
tax_total	number
total	number
unit_price	number

Defined in

packages/medusa/dist/services/new-totals.d.ts:7

---

LineItemTotals

Ƭ LineItemTotals: Object

Type declaration

Name	Type
discount_total	number
original_tax_total	number
original_total	number
quantity	number
raw_discount_total	number
subtotal	number
tax_lines	LineItemTaxLine[]
tax_total	number
total	number
unit_price	number

Defined in

packages/medusa/dist/services/totals.d.ts:21

---

LineItemTotalsOptions

Ƭ LineItemTotalsOptions: Object

Type declaration

Name	Type
calculation_context?	TaxCalculationContext
exclude_gift_cards?	boolean
include_tax?	boolean
use_tax_lines?	boolean

Defined in

packages/medusa/dist/services/totals.d.ts:33

---

LineItemUpdate

Ƭ LineItemUpdate: Object

Type declaration

Name	Type
metadata?	Record<string, unknown>
quantity?	number
region_id?	string
should_calculate_prices?	boolean
title?	string
unit_price?	number
variant_id?	string

Defined in

packages/medusa/dist/types/cart.d.ts:10

---

LineItemValidateData

Ƭ LineItemValidateData: Object

Type declaration

Name	Type
variant?	{ product_id: string }
variant.product_id	string
variant_id	string

Defined in

packages/medusa/dist/types/cart.d.ts:19

---

ListAndCountSelector

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

Defined in

packages/medusa/dist/services/product-collection.d.ts:15

---

MedusaContainer

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

Defined in

packages/types/dist/common/medusa-container.d.ts:2

---

MedusaContainer

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

Defined in

packages/medusa-core-utils/dist/medusa-container.d.ts:2

---

ModuleDefinition

Ƭ ModuleDefinition: Object

Type declaration

Name	Type	Description
canOverride?	boolean	Deprecated property will be removed in future versions
defaultModuleDeclaration	InternalModuleDeclaration | ExternalModuleDeclaration	-
defaultPackage	string | false	-
dependencies?	string[]	-
isLegacy?	boolean	-
isQueryable?	boolean	-
isRequired?	boolean	Deprecated property will be removed in future versions
key	string	-
label	string	-
registrationName	string	-

Defined in

packages/types/dist/modules-sdk/index.d.ts:59

---

ModuleJoinerConfig

Ƭ ModuleJoinerConfig: Omit<JoinerServiceConfig, "serviceName" | "primaryKeys" | "relationships" | "extends"> & { databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: "date" | "time" | "datetime" | "bigint" | "blob" | "uint8array" | "array" | "enumArray" | "enum" | "json" | "integer" | "smallint" | "tinyint" | "mediumint" | "float" | "double" | "boolean" | "decimal" | "string" | "uuid" | "text" }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string | { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: ModuleJoinerRelationship ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: ModuleJoinerRelationship[] ; schema?: string ; serviceName?: string }

Defined in

packages/types/dist/modules-sdk/index.d.ts:104

---

ModuleJoinerRelationship

Ƭ ModuleJoinerRelationship: JoinerRelationship & { deleteCascade?: boolean ; isInternalService?: boolean }

Defined in

packages/types/dist/modules-sdk/index.d.ts:152

---

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

Defined in

packages/medusa/dist/types/store.d.ts:30

---

ModulesResponse

Ƭ ModulesResponse: { module: string ; resolution: string | false }[]

Defined in

packages/types/dist/modules-sdk/index.d.ts:100

---

OrdersReturnItem

Ƭ OrdersReturnItem: Object

Type declaration

Name	Type
item_id	string
note?	string
quantity	number
reason_id?	string

Defined in

packages/medusa/dist/types/return.d.ts:1

---

PaginatedResponse

Ƭ PaginatedResponse: Object

Type declaration

Name	Type
count	number
limit	number
offset	number

Defined in

packages/types/dist/common/common.d.ts:92

---

Partial

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

Make all properties in T optional

Type parameters

Name
T

Defined in

docs-util/node_modules/typescript/lib/lib.es5.d.ts:1571

---

PaymentCollectionsSessionsBatchInput

Ƭ PaymentCollectionsSessionsBatchInput: Object

Type declaration

Name	Type
amount	number
provider_id	string
session_id?	string

Defined in

packages/medusa/dist/types/payment-collection.d.ts:11

---

PaymentCollectionsSessionsInput

Ƭ PaymentCollectionsSessionsInput: Object

Type declaration

Name	Type
provider_id	string

Defined in

packages/medusa/dist/types/payment-collection.d.ts:16

---

PaymentDataInput

Ƭ PaymentDataInput: Object

Type declaration

Name	Type
amount	number
currency_code	string
data	Record<string, unknown>
provider_id	string

Defined in

packages/medusa/dist/services/payment.d.ts:14

---

PaymentProviderKey

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

Defined in

packages/medusa/dist/services/payment-provider.d.ts:15

---

PaymentSessionInput

Ƭ PaymentSessionInput: Object

Type declaration

Name	Type
amount	number
cart	Cart | { billing_address?: Address | null ; context: Record<string, unknown> ; email: string ; id: string ; shipping_address: Address | null ; shipping_methods: ShippingMethod[] }
currency_code	string
customer?	Customer | null
paymentSessionData?	Record<string, unknown>
payment_session_id?	string
provider_id	string
resource_id?	string

Defined in

packages/medusa/dist/types/payment.d.ts:2

---

Price

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

Defined in

packages/medusa/dist/repositories/money-amount.d.ts:5

---

PriceListConstructorProps

Ƭ PriceListConstructorProps: Object

Type declaration

Name	Type
customerGroupService	CustomerGroupService
featureFlagRouter	FlagRouter
manager	EntityManager
moneyAmountRepository	typeof MoneyAmountRepository
priceListRepository	typeof PriceListRepository
productService	ProductService
productVariantRepository	typeof ProductVariantRepository
productVariantService	ProductVariantService
regionService	RegionService

Defined in

packages/medusa/dist/services/price-list.d.ts:16

---

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"

Defined in

packages/medusa/dist/types/pricing.d.ts:115

---

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.

Defined in

packages/medusa/dist/types/pricing.d.ts:58

---

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

Defined in

packages/medusa/dist/types/pricing.d.ts:101

---

PricingContext

Ƭ PricingContext: Object

Type declaration

Name	Type
automatic_taxes	boolean
price_selection	PriceSelectionContext
tax_rate	number | null

Defined in

packages/medusa/dist/types/pricing.d.ts:19

---

ProductCategoryInput

Ƭ ProductCategoryInput: Object

Type declaration

Name	Type
handle?	string
is_active?	boolean
is_internal?	boolean
parent_category?	ProductCategory | null
parent_category_id?	string | null
rank?	number

Defined in

packages/medusa/dist/types/product-category.d.ts:3

---

ProductOptionInput

Ƭ ProductOptionInput: Object

Type declaration

Name	Type
title	string
values?	ProductOptionValue[]

Defined in

packages/medusa/dist/types/product.d.ts:142

---

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> }

Defined in

packages/medusa/dist/types/product.d.ts:28

---

ProductVariantOption

Ƭ ProductVariantOption: Object

Type declaration

Name	Type
option_id	string
value	string

Defined in

packages/medusa/dist/types/product-variant.d.ts:17

---

ProductVariantPrice

Ƭ ProductVariantPrice: Object

Type declaration

Name	Type
amount	number
currency_code?	string
id?	string
max_quantity?	number
min_quantity?	number
region_id?	string

Defined in

packages/medusa/dist/types/product-variant.d.ts:3

---

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

Defined in

packages/medusa/dist/types/pricing.d.ts:4

---

ProjectConfigOptions

Ƭ ProjectConfigOptions: Object

Type declaration

Name	Type
admin_cors?	string
cookie_secret?	string
database_database?	string
database_extra?	Record<string, unknown> & { ssl: { rejectUnauthorized: false } }
database_logging	LoggerOptions
database_schema?	string
database_type?	string
database_url?	string
http_compression?	HttpCompressionOptions
jwt_secret?	string
redis_options?	RedisOptions
redis_prefix?	string
redis_url?	string
session_options?	SessionOptions
store_cors?	string

Defined in

packages/types/dist/common/config-module.d.ts:18

---

PropertyDecorator

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

Type declaration

▸ (target, propertyKey): void

Parameters

Name	Type
target	Object
propertyKey	string | symbol

Returns

void

Defined in

docs-util/node_modules/typescript/lib/lib.decorators.legacy.d.ts:20

---

PropertyKey

Ƭ PropertyKey: string | number | symbol

Defined in

docs-util/node_modules/typescript/lib/lib.es5.d.ts:108

---

ProviderLineItemTaxLine

Ƭ ProviderLineItemTaxLine: Object

The tax line properties for a given line item.

Type declaration

Name	Type
code	string | null
item_id	string
metadata?	Record<string, unknown>
name	string
rate	number

Defined in

packages/medusa/dist/types/tax-service.d.ts:33

---

ProviderShippingMethodTaxLine

Ƭ ProviderShippingMethodTaxLine: Object

The tax line properties for a given shipping method.

Type declaration

Name	Type
code	string | null
metadata?	Record<string, unknown>
name	string
rate	number
shipping_method_id	string

Defined in

packages/medusa/dist/types/tax-service.d.ts:23

---

ProviderTaxLine

Ƭ ProviderTaxLine: ProviderLineItemTaxLine | ProviderShippingMethodTaxLine

A union type of the possible provider tax lines.

Defined in

packages/medusa/dist/types/tax-service.d.ts:43

---

ReadableStreamController

Ƭ ReadableStreamController<T>: ReadableStreamDefaultController<T>

Type parameters

Name
T

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:76

---

ReadableStreamDefaultReadResult

Ƭ ReadableStreamDefaultReadResult<T>: ReadableStreamDefaultReadValueResult<T> | ReadableStreamDefaultReadDoneResult

Type parameters

Name
T

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:77

---

RegionDetails

Ƭ RegionDetails: Object

Type declaration

Name	Type
id	string
tax_rate	number | null

Defined in

packages/medusa/dist/services/tax-provider.d.ts:10

---

ReorderConditions

Ƭ ReorderConditions: Object

Type declaration

Name	Type
originalParentId	string | null
originalRank	number
shouldChangeParent	boolean
shouldChangeRank	boolean
shouldDeleteElement	boolean
shouldIncrementRank	boolean
targetCategoryId	string
targetParentId	string | null | undefined
targetRank	number | undefined

Defined in

packages/medusa/dist/types/product-category.d.ts:27

---

RequestContext

Ƭ RequestContext: Object

Type declaration

Name	Type
ip	string

Defined in

packages/medusa/dist/types/request.d.ts:1

---

ReservationItemDTO

Ƭ ReservationItemDTO: Object

Schema

ReservationItemDTO title: "Reservation item" description: "Represents a reservation of an inventory item at a stock location" type: object required:

• id
• location_id
• inventory_item_id
• quantity properties: id: description: "The id of the reservation item" type: string location_id: description: "The id of the location of the reservation" type: string inventory_item_id: description: "The id of the inventory item the reservation relates to" type: string description: description: "Description of the reservation item" type: string created_by: description: "UserId of user who created the reservation item" type: string quantity: description: "The id of the reservation item" type: number metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time

Type declaration

Name	Type
created_at	string | Date
created_by?	string | null
deleted_at	string | Date | null
description?	string | null
id	string
inventory_item_id	string
line_item_id?	string | null
location_id	string
metadata	Record<string, unknown> | null
quantity	number
updated_at	string | Date

Defined in

packages/types/dist/inventory/common.d.ts:130

---

ReserveQuantityContext

Ƭ ReserveQuantityContext: Object

Type declaration

Name	Type
lineItemId?	string
locationId?	string
salesChannelId?	string | null

Defined in

packages/types/dist/inventory/common.d.ts:267

---

ReturnedData

Ƭ ReturnedData: Object

Type declaration

Name	Type
data	Record<string, unknown>
status	string
to	string

Defined in

packages/medusa/dist/interfaces/notification-service.d.ts:2

---

SessionOptions

Ƭ SessionOptions: Object

Type declaration

Name	Type
name?	string
resave?	boolean
rolling?	boolean
saveUninitialized?	boolean
secret?	string
ttl?	number

Defined in

packages/types/dist/common/config-module.d.ts:4

---

SharedContext

Ƭ SharedContext: Object

Type declaration

Name	Type
manager?	EntityManager
transactionManager?	EntityManager

Defined in

packages/types/dist/shared-context.d.ts:2

---

ShippingMethod

Ƭ ShippingMethod: Object

Type declaration

Name	Type
data?	Record<string, unknown>
option_id	string
price?	number

Defined in

packages/medusa/dist/types/draft-orders.d.ts:21

---

ShippingMethodData

Ƭ ShippingMethodData: Record<string, unknown>

Defined in

packages/medusa/dist/interfaces/fulfillment-service.d.ts:6

---

ShippingMethodTotals

Ƭ ShippingMethodTotals: Object

Type declaration

Name	Type
original_tax_total	number
original_total	number
price	number
subtotal	number
tax_lines	ShippingMethodTaxLine[]
tax_total	number
total	number

Defined in

packages/medusa/dist/services/new-totals.d.ts:25

---

ShippingMethodTotals

Ƭ ShippingMethodTotals: Object

Type declaration

Name	Type
original_tax_total	number
original_total	number
price	number
subtotal	number
tax_lines	ShippingMethodTaxLine[]
tax_total	number
total	number

Defined in

packages/medusa/dist/services/totals.d.ts:7

---

ShippingMethodUpdate

Ƭ ShippingMethodUpdate: Object

Type declaration

Name	Type
claim_order_id?	string | null
data?	any
order_id?	string
price?	number
return_id?	string
swap_id?	string

Defined in

packages/medusa/dist/types/shipping-options.d.ts:9

---

ShippingOptionData

Ƭ ShippingOptionData: Record<string, unknown>

Defined in

packages/medusa/dist/interfaces/fulfillment-service.d.ts:5

---

ShippingOptionPricing

Ƭ ShippingOptionPricing: Object

Type declaration

Name	Type
price_incl_tax	number | null
tax_amount	number
tax_rates	TaxServiceRate[] | null

Defined in

packages/medusa/dist/types/pricing.d.ts:24

---

StagedJobServiceProps

Ƭ StagedJobServiceProps: Object

Type declaration

Name	Type
manager	EntityManager
stagedJobRepository	typeof StagedJobRepository

Defined in

packages/medusa/dist/services/staged-job.d.ts:7

---

StockLocationAddressDTO

Ƭ StockLocationAddressDTO: Object

Schema

StockLocationAddressDTO title: "Stock Location Address" description: "Represents a Stock Location Address" type: object required:

• address_1
• country_code
• created_at
• updated_at properties: id: type: string description: The stock location address' ID example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 address_1: type: string description: Stock location address example: 35, Jhon Doe Ave address_2: type: string description: Stock location address' complement example: apartment 4432 company: type: string description: Stock location company' name example: Medusa city: type: string description: Stock location address' city example: Mexico city country_code: type: string description: Stock location address' country example: MX phone: type: string description: Stock location address' phone number example: +1 555 61646 postal_code: type: string description: Stock location address' postal code example: HD3-1G8 province: type: string description: Stock location address' province example: Sinaloa created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time metadata: type: object description: An optional key-value map with additional details example: {car: "white"}

Type declaration

Name	Type
address_1	string
address_2?	string | null
city?	string | null
company?	string | null
country_code	string
created_at	string | Date
deleted_at	string | Date | null
id?	string
metadata?	Record<string, unknown> | null
phone?	string | null
postal_code?	string | null
province?	string | null
updated_at	string | Date

Defined in

packages/types/dist/stock-location/common.d.ts:66

---

StockLocationAddressInput

Ƭ StockLocationAddressInput: Object

Schema

StockLocationAddressInput title: "Stock Location Address Input" description: "Represents a Stock Location Address Input" type: object required:

• address_1
• country_code properties: address_1: type: string description: Stock location address example: 35, Jhon Doe Ave address_2: type: string description: Stock location address' complement example: apartment 4432 city: type: string description: Stock location address' city example: Mexico city country_code: type: string description: Stock location address' country example: MX phone: type: string description: Stock location address' phone number example: +1 555 61646 postal_code: type: string description: Stock location address' postal code example: HD3-1G8 province: type: string description: Stock location address' province example: Sinaloa metadata: type: object description: An optional key-value map with additional details example: {car: "white"}

Type declaration

Name	Type
address_1	string
address_2?	string
city?	string
country_code	string
metadata?	Record<string, unknown>
phone?	string
postal_code?	string
province?	string

Defined in

packages/types/dist/stock-location/common.d.ts:195

---

StockLocationDTO

Ƭ StockLocationDTO: Object

Schema

StockLocationDTO title: "Stock Location" description: "Represents a Stock Location" type: object required:

• id
• name
• address_id
• created_at
• updated_at properties: id: type: string description: The stock location's ID example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 address_id: type: string description: Stock location address' ID example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 name: type: string description: The name of the stock location example: Main Warehouse address: description: "The Address of the Stock Location" allOf:
  • $ref: "#/components/schemas/StockLocationAddressDTO"
  • type: object metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time

Type declaration

Name	Type
address?	StockLocationAddressDTO
address_id	string
created_at	string | Date
deleted_at	string | Date | null
id	string
metadata	Record<string, unknown> | null
name	string
updated_at	string | Date

Defined in

packages/types/dist/stock-location/common.d.ts:127

---

StockLocationExpandedDTO

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

Schema

StockLocationExpandedDTO allOf:

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

Defined in

packages/types/dist/stock-location/common.d.ts:146

---

Subscriber

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

Type parameters

Name	Type
T	unknown

Type declaration

▸ (data, eventName): Promise<void>

Parameters

Name	Type
data	T
eventName	string

Returns

Promise<void>

Defined in

packages/types/dist/event-bus/common.d.ts:1

---

SubscriberContext

Ƭ SubscriberContext: Object

Type declaration

Name	Type
subscriberId	string

Defined in

packages/types/dist/event-bus/common.d.ts:2

---

SubscriberDescriptor

Ƭ SubscriberDescriptor: Object

Type declaration

Name	Type
id	string
subscriber	Subscriber

Defined in

packages/types/dist/event-bus/common.d.ts:5

---

SubtotalOptions

Ƭ SubtotalOptions: Object

Options to use for subtotal calculations

Type declaration

Name	Type
excludeNonDiscounts?	boolean

Defined in

packages/medusa/dist/types/totals.d.ts:35

---

TaxLinesMaps

Ƭ TaxLinesMaps: Object

Type declaration

Name	Type
lineItemsTaxLines	{ [lineItemId: string]: LineItemTaxLine[]; }
shippingMethodsTaxLines	{ [shippingMethodId: string]: ShippingMethodTaxLine[]; }

Defined in

packages/medusa/dist/types/tax-service.d.ts:2

---

TaxRateListByConfig

Ƭ TaxRateListByConfig: Object

Type declaration

Name	Type
region_id?	string

Defined in

packages/medusa/dist/types/tax-rate.d.ts:23

---

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

Name	Type
code	string | null
name	string
rate?	number | null

Defined in

packages/medusa/dist/types/tax-service.d.ts:15

---

TaxedPricing

Ƭ TaxedPricing: Object

Type declaration

Name	Type
calculated_price_incl_tax	number | null
calculated_tax	number | null
original_price_incl_tax	number | null
original_tax	number | null
tax_rates	TaxServiceRate[] | null

Defined in

packages/medusa/dist/types/pricing.d.ts:12

---

TotalsConfig

Ƭ TotalsConfig: Object

Type declaration

Name	Type
force_taxes?	boolean

Defined in

packages/medusa/dist/services/cart.d.ts:43

---

TotalsContext

Ƭ TotalsContext: Object

Type declaration

Name	Type
force_taxes?	boolean
includes?	{ returnable_items?: boolean }
includes.returnable_items?	boolean

Defined in

packages/medusa/dist/types/orders.d.ts:4

---

TotalsServiceProps

Ƭ TotalsServiceProps: Object

Type declaration

Name	Type
featureFlagRouter	FlagRouter
manager	EntityManager
newTotalsService	NewTotalsService
taxCalculationStrategy	ITaxCalculationStrategy
taxProviderService	TaxProviderService

Defined in

packages/medusa/dist/services/totals.d.ts:43

---

TransformCallback

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

Type declaration

▸ (error?, data?): void

Parameters

Name	Type
error?	Error | null
data?	any

Returns

void

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:1044

---

Transformer

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

Type declaration

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

Parameters

Name	Type
item?	LineItem
quantity?	number
additional?	OrdersReturnItem

Returns

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

Defined in

packages/medusa/dist/services/return.d.ts:25

---

TypedArray

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

Defined in

packages/medusa-js/node_modules/@types/node/globals.d.ts:239

---

UpdateAnalyticsConfig

Ƭ UpdateAnalyticsConfig: Object

Type declaration

Name	Type
anonymize?	boolean
opt_out?	boolean

Defined in

packages/medusa/dist/types/analytics-config.d.ts:5

---

UpdateClaimInput

Ƭ UpdateClaimInput: Object

Type declaration

Name	Type
claim_items?	UpdateClaimItemInput[]
metadata?	Record<string, unknown>
no_notification?	boolean
shipping_methods?	UpdateClaimShippingMethodInput[]

Defined in

packages/medusa/dist/types/claim.d.ts:42

---

UpdateClaimItemImageInput

Ƭ UpdateClaimItemImageInput: Object

Type declaration

Name	Type
id?	string
url?	string

Defined in

packages/medusa/dist/types/claim.d.ts:62

---

UpdateClaimItemInput

Ƭ UpdateClaimItemInput: Object

Type declaration

Name	Type
id	string
images	UpdateClaimItemImageInput[]
metadata?	Record<string, unknown>
note?	string
reason?	string
tags	UpdateClaimItemTagInput[]

Defined in

packages/medusa/dist/types/claim.d.ts:54

---

UpdateClaimItemTagInput

Ƭ UpdateClaimItemTagInput: Object

Type declaration

Name	Type
id?	string
value?	string

Defined in

packages/medusa/dist/types/claim.d.ts:66

---

UpdateClaimShippingMethodInput

Ƭ UpdateClaimShippingMethodInput: Object

Type declaration

Name	Type
data?	Record<string, unknown>
id?	string
option_id?	string
price?	number

Defined in

packages/medusa/dist/types/claim.d.ts:48

---

UpdateCurrencyInput

Ƭ UpdateCurrencyInput: Object

Type declaration

Name	Type
includes_tax?	boolean

Defined in

packages/medusa/dist/types/currency.d.ts:1

---

UpdateCustomerInput

Ƭ UpdateCustomerInput: Object

Type declaration

Name	Type
billing_address?	AddressPayload | string
billing_address_id?	string
email?	string
first_name?	string
groups?	{ id: string }[]
last_name?	string
metadata?	Record<string, unknown>
password?	string
phone?	string

Defined in

packages/medusa/dist/types/customers.d.ts:17

---

UpdateDiscountInput

Ƭ UpdateDiscountInput: Object

Type declaration

Name	Type
code?	string
ends_at?	Date | null
is_disabled?	boolean
metadata?	Record<string, unknown>
regions?	string[]
rule?	UpdateDiscountRuleInput
starts_at?	Date
usage_limit?	number | null
valid_duration?	string | null

Defined in

packages/medusa/dist/types/discount.d.ts:76

---

UpdateDiscountRuleInput

Ƭ UpdateDiscountRuleInput: Object

Type declaration

Name	Type
allocation?	AllocationType
conditions?	DiscountConditionInput[]
description?	string
id	string
value?	number

Defined in

packages/medusa/dist/types/discount.d.ts:69

---

UpdateGiftCardInput

Ƭ UpdateGiftCardInput: Object

Type declaration

Name	Type
balance?	number
ends_at?	Date | null
is_disabled?	boolean
metadata?	Record<string, unknown>
region_id?	string

Defined in

packages/medusa/dist/types/gift-card.d.ts:11

---

UpdateInventoryLevelInput

Ƭ UpdateInventoryLevelInput: Object

Type declaration

Name	Type
incoming_quantity?	number
stocked_quantity?	number

Defined in

packages/types/dist/inventory/common.d.ts:253

---

UpdateOauthInput

Ƭ UpdateOauthInput: Object

Type declaration

Name	Type
data	Record<string, unknown>

Defined in

packages/medusa/dist/types/oauth.d.ts:7

---

UpdateOrderInput

Ƭ UpdateOrderInput: Object

Type declaration

Name	Type
billing_address?	AddressPayload
customer_id?	string
discounts?	object[]
email?	string
fulfillment_status?	FulfillmentStatus
items?	object[]
metadata?	Record<string, unknown>
no_notification?	boolean
payment?	Payment
payment_method?	{ data?: Record<string, unknown> ; provider_id?: string }
payment_method.data?	Record<string, unknown>
payment_method.provider_id?	string
payment_status?	PaymentStatus
region?	string
shipping_address?	AddressPayload
shipping_method?	{ data?: Record<string, unknown> ; items?: Record<string, unknown>[] ; price?: number ; profile_id?: string ; provider_id?: string }[]
status?	OrderStatus

Defined in

packages/medusa/dist/types/orders.d.ts:59

---

UpdateProductCategoryInput

Ƭ UpdateProductCategoryInput: ProductCategoryInput & { name?: string }

Defined in

packages/medusa/dist/types/product-category.d.ts:14

---

UpdateProductCollection

Ƭ UpdateProductCollection: Object

Type declaration

Name	Type
handle?	string
metadata?	Record<string, unknown>
title?	string

Defined in

packages/medusa/dist/types/product-collection.d.ts:6

---

UpdateProductInput

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

Defined in

packages/medusa/dist/types/product.d.ts:139

---

UpdateProductProductVariantDTO

Ƭ UpdateProductProductVariantDTO: Object

Type declaration

Name	Type
allow_backorder?	boolean
barcode?	string
ean?	string
height?	number
hs_code?	string
id?	string
inventory_quantity?	number
length?	number
manage_inventory?	boolean
material?	string
metadata?	Record<string, unknown>
mid_code?	string
options?	{ option_id: string ; value: string }[]
origin_country?	string
prices?	CreateProductProductVariantPriceInput[]
sku?	string
title?	string
upc?	string
weight?	number
width?	number

Defined in

packages/medusa/dist/types/product.d.ts:104

---

UpdateProductVariantData

Ƭ UpdateProductVariantData: Object

Type declaration

Name	Type
updateData	UpdateProductVariantInput
variant	ProductVariant

Defined in

packages/medusa/dist/types/product-variant.d.ts:67

---

UpdateProductVariantInput

Ƭ UpdateProductVariantInput: Object

Type declaration

Name	Type
allow_backorder?	boolean
barcode?	string
ean?	string
height?	number
hs_code?	string
inventory_quantity?	number
length?	number
manage_inventory?	boolean
material?	string
metadata?	Record<string, unknown>
mid_code?	string
options?	ProductVariantOption[]
origin_country?	string
prices?	ProductVariantPrice[]
product_id?	string
sku?	string
title?	string
upc?	string
variant_rank?	number
weight?	number
width?	number

Defined in

packages/medusa/dist/types/product-variant.d.ts:44

---

UpdateRegionInput

Ƭ UpdateRegionInput: Object

Type declaration

Name	Type
automatic_taxes?	boolean
countries?	string[]
currency_code?	string
fulfillment_providers?	string[]
gift_cards_taxable?	boolean
includes_tax?	boolean
metadata?	Record<string, unknown>
name?	string
payment_providers?	string[]
tax_code?	string
tax_provider_id?	string | null
tax_rate?	number

Defined in

packages/medusa/dist/types/region.d.ts:1

---

UpdateReservationItemInput

Ƭ UpdateReservationItemInput: Object

Type declaration

Name	Type
description?	string
location_id?	string
metadata?	Record<string, unknown> | null
quantity?	number

Defined in

packages/types/dist/inventory/common.d.ts:261

---

UpdateReturnInput

Ƭ UpdateReturnInput: Object

Type declaration

Name	Type
items?	OrdersReturnItem[]
metadata?	Record<string, unknown>
no_notification?	boolean
shipping_method?	{ option_id: string ; price?: number }
shipping_method.option_id	string
shipping_method.price?	number

Defined in

packages/medusa/dist/types/return.d.ts:21

---

UpdateReturnReason

Ƭ UpdateReturnReason: Object

Type declaration

Name	Type
description?	string
label?	string
metadata?	Record<string, unknown>
parent_return_reason_id?	string

Defined in

packages/medusa/dist/types/return-reason.d.ts:8

---

UpdateShippingOptionInput

Ƭ UpdateShippingOptionInput: Object

Type declaration

Name	Type
admin_only?	boolean
amount?	number
data?	string
includes_tax?	boolean
is_return?	boolean
metadata?	Record<string, unknown>
name?	string
price_type?	ShippingOptionPriceType
profile_id?	string
provider_id?	string
region_id?	string
requirements?	ShippingOptionRequirement[]

Defined in

packages/medusa/dist/types/shipping-options.d.ts:52

---

UpdateShippingProfile

Ƭ UpdateShippingProfile: Object

Type declaration

Name	Type
metadata?	Record<string, unknown>
name?	string
products?	string[]
shipping_options?	string[]
type?	ShippingProfileType

Defined in

packages/medusa/dist/types/shipping-profile.d.ts:7

---

UpdateStockLocationInput

Ƭ UpdateStockLocationInput: Object

Schema

UpdateStockLocationInput title: "Update Stock Location Input" description: "Represents the Input to update a Stock Location" type: object properties: name: type: string description: The stock location name address_id: type: string description: The Stock location address ID address: description: Stock location address object allOf: - $ref: "#/components/schemas/StockLocationAddressInput" - type: object metadata: type: object description: An optional key-value map with additional details example: {car: "white"}

Type declaration

Name	Type
address?	StockLocationAddressInput
address_id?	string
metadata?	Record<string, unknown>
name?	string

Defined in

packages/types/dist/stock-location/common.d.ts:257

---

UpdateStoreInput

Ƭ UpdateStoreInput: Object

Type declaration

Name	Type
currencies?	string[]
default_currency_code?	string
default_sales_channel_id?	string
invite_link_template?	string
metadata?	Record<string, unknown>
name?	string
payment_link_template?	string
swap_link_template?	string

Defined in

packages/medusa/dist/types/store.d.ts:4

---

UpdateTaxRateInput

Ƭ UpdateTaxRateInput: Object

Type declaration

Name	Type
code?	string
name?	string
rate?	number | null
region_id?	string

Defined in

packages/medusa/dist/types/tax-rate.d.ts:11

---

UpdateVariantPricesData

Ƭ UpdateVariantPricesData: Object

Type declaration

Name	Type
prices	ProductVariantPrice[]
variantId	string

Defined in

packages/medusa/dist/types/product-variant.d.ts:71

---

UpdateVariantRegionPriceData

Ƭ UpdateVariantRegionPriceData: Object

Type declaration

Name	Type
price	{ amount: number ; currency_code: string ; region_id: string }
price.amount	number
price.currency_code	string
price.region_id	string
variantId	string

Defined in

packages/medusa/dist/types/product-variant.d.ts:75

---

UploadStreamDescriptorType

Ƭ UploadStreamDescriptorType: Object

Index signature

▪ [x: string]: unknown

Type declaration

Name	Type
ext?	string
isPrivate?	boolean
name	string

Defined in

packages/types/dist/file-service/index.d.ts:23

---

UpsertTagsInput

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

Defined in

packages/medusa/dist/repositories/product-tag.d.ts:4

---

UpsertTypeInput

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

Defined in

packages/medusa/dist/repositories/product-type.d.ts:3

---

UserServiceProps

Ƭ UserServiceProps: Object

Type declaration

Name	Type
analyticsConfigService	AnalyticsConfigService
eventBusService	EventBusService
featureFlagRouter	FlagRouter
manager	EntityManager
userRepository	typeof UserRepository

Defined in

packages/medusa/dist/services/user.d.ts:10

---

WithImplicitCoercion

Ƭ WithImplicitCoercion<T>: T | { valueOf: () => T }

Type parameters

Name
T

Defined in

packages/medusa-js/node_modules/@types/node/buffer.d.ts:235

---

handler

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

Type declaration

▸ (req, res): Promise<void>

Parameters

Name	Type
req	Request
res	Response

Returns

Promise<void>

Defined in

packages/medusa/dist/api/middlewares/await-middleware.d.ts:2

---

middlewareHandlerType

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

Type declaration

▸ (options): RequestHandler

Parameters

Name	Type
options	Record<string, unknown>

Returns

RequestHandler

Defined in

packages/medusa/dist/services/middleware.d.ts:2

---

middlewareType

Ƭ middlewareType: Object

Type declaration

Name	Type
middleware	middlewareHandlerType
options	Record<string, unknown>

Defined in

packages/medusa/dist/services/middleware.d.ts:3

Variables

AddressRepository

• Const AddressRepository: Repository

Defined in

packages/medusa/dist/repositories/address.d.ts:2

---

AdminGetDiscountsParams_base

• Const AdminGetDiscountsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:77

---

AdminGetInventoryItemsParams_base

• Const AdminGetInventoryItemsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:94

---

AdminGetPriceListsPriceListProductsParams_base

• Const AdminGetPriceListsPriceListProductsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:165

---

AdminGetProductCategoriesParams_base

• Const AdminGetProductCategoriesParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:67

---

AdminGetReservationsParams_base

• Const AdminGetReservationsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:146

---

AdminGetSalesChannelsParams_base

• Const AdminGetSalesChannelsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:132

---

AdminGetStockLocationsParams_base

• Const AdminGetStockLocationsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts:129

---

AnalyticsConfigRepository

• Const AnalyticsConfigRepository: Repository

Defined in

packages/medusa/dist/repositories/analytics-config.d.ts:2

---

BatchJobRepository

• Const BatchJobRepository: Repository

Defined in

packages/medusa/dist/repositories/batch-job.d.ts:2

---

Buffer

• Buffer: BufferConstructor

Defined in

packages/medusa-js/node_modules/@types/node/buffer.d.ts:622

packages/medusa-js/node_modules/@types/node/buffer.d.ts:2305

---

CartRepository

• Const CartRepository: Repository & { findOneWithRelations: (relations?: FindOptionsRelations<Cart>, optionsWithoutRelations?: Omit<FindManyOptions<Cart>, "relations">) => Promise<Cart> ; findWithRelations: (relations?: FindOptionsRelations<Cart>, optionsWithoutRelations?: Omit<FindManyOptions<Cart>, "relations">) => Promise<Cart[]> }

Defined in

packages/medusa/dist/repositories/cart.d.ts:3

---

ClaimRepository

• Const ClaimRepository: Repository

Defined in

packages/medusa/dist/repositories/claim.d.ts:2

---

CountryRepository

• Const CountryRepository: Repository

Defined in

packages/medusa/dist/repositories/country.d.ts:2

---

CurrencyRepository

• Const CurrencyRepository: Repository

Defined in

packages/medusa/dist/repositories/currency.d.ts:2

---

CustomShippingOptionRepository

• Const CustomShippingOptionRepository: Repository

Defined in

packages/medusa/dist/repositories/custom-shipping-option.d.ts:2

---

CustomerGroupRepository

• Const CustomerGroupRepository: Repository & { addCustomers: (groupId: string, customerIds: string[]) => Promise<CustomerGroup> ; findWithRelationsAndCount: (relations?: FindOptionsRelations<CustomerGroup>, idsOrOptionsWithoutRelations?: string[] | FindWithoutRelationsOptions) => Promise<[CustomerGroup[], number]> ; removeCustomers: (groupId: string, customerIds: string[]) => Promise<DeleteResult> }

Defined in

packages/medusa/dist/repositories/customer-group.d.ts:10

---

CustomerRepository

• Const CustomerRepository: Repository & { listAndCount: (query: Object, q?: string) => Promise<[Customer[], number]> }

Defined in

packages/medusa/dist/repositories/customer.d.ts:4

---

DiscountConditionRepository

• Const DiscountConditionRepository: Repository & { addConditionResources: (conditionId: string, resourceIds: (string | { id: string })[], type: DiscountConditionType, overrideExisting?: boolean) => Promise<(DiscountConditionCustomerGroup | DiscountConditionProduct | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionProductType)[]> ; canApplyForCustomer: (discountRuleId: string, customerId: string) => Promise<boolean> ; findOneWithDiscount: (conditionId: string, discountId: string) => Promise<undefined | DiscountCondition & { discount: Discount }> ; getJoinTableResourceIdentifiers: (type: string) => { conditionTable: DiscountConditionResourceType ; joinTable: string ; joinTableForeignKey: DiscountConditionJoinTableForeignKey ; joinTableKey: string ; relatedTable: string ; resourceKey: string } ; isValidForProduct: (discountRuleId: string, productId: string) => Promise<boolean> ; queryConditionTable: (__namedParameters: { conditionId: any ; resourceId: any ; type: any }) => Promise<number> ; removeConditionResources: (id: string, type: DiscountConditionType, resourceIds: (string | { id: string })[]) => Promise<void | DeleteResult> }

Defined in

packages/medusa/dist/repositories/discount-condition.d.ts:11

---

DraftOrderRepository

• Const DraftOrderRepository: Repository

Defined in

packages/medusa/dist/repositories/draft-order.d.ts:2

---

FulfillmentProviderRepository

• Const FulfillmentProviderRepository: Repository

Defined in

packages/medusa/dist/repositories/fulfillment-provider.d.ts:2

---

FulfillmentRepository

• Const FulfillmentRepository: Repository

Defined in

packages/medusa/dist/repositories/fulfillment.d.ts:2

---

GetOrderEditsParams_base

• Const GetOrderEditsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:62

---

GetPublishableApiKeySalesChannelsParams_base

• Const GetPublishableApiKeySalesChannelsParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.d.ts:58

---

GetPublishableApiKeysParams_base

• Const GetPublishableApiKeysParams_base: internal

Defined in

packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:61

---

GiftCardRepository

• Const GiftCardRepository: Repository & { listGiftCardsAndCount: (query: ExtendedFindConfig<GiftCard>, q?: string) => Promise<[GiftCard[], number]> }

Defined in

packages/medusa/dist/repositories/gift-card.d.ts:3

---

GiftCardTransactionRepository

• Const GiftCardTransactionRepository: Repository

Defined in

packages/medusa/dist/repositories/gift-card-transaction.d.ts:2

---

IdempotencyKeyRepository

• Const IdempotencyKeyRepository: Repository

Defined in

packages/medusa/dist/repositories/idempotency-key.d.ts:2

---

ImageRepository

• Const ImageRepository: Repository & { insertBulk: (data: _QueryDeepPartialEntity<Image>[]) => Promise<Image[]> ; upsertImages: (imageUrls: string[]) => Promise<Image[]> }

Defined in

packages/medusa/dist/repositories/image.d.ts:3

---

LineItemAdjustmentRepository

• Const LineItemAdjustmentRepository: Repository

Defined in

packages/medusa/dist/repositories/line-item-adjustment.d.ts:2

---

LineItemRepository

• Const LineItemRepository: Repository & { findByReturn: (returnId: string) => Promise<LineItem & { return_item: ReturnItem }[]> }

Defined in

packages/medusa/dist/repositories/line-item.d.ts:3

---

LineItemTaxLineRepository

• Const LineItemTaxLineRepository: Repository & { deleteForCart: (cartId: string) => Promise<void> ; upsertLines: (lines: LineItemTaxLine[]) => Promise<LineItemTaxLine[]> }

Defined in

packages/medusa/dist/repositories/line-item-tax-line.d.ts:2

---

MoneyAmountRepository

• Const MoneyAmountRepository: Repository & { addPriceListPrices: (priceListId: string, prices: PriceListPriceCreateInput[], overrideExisting?: boolean) => Promise<MoneyAmount[]> ; createProductVariantMoneyAmounts: (toCreate: { money_amount_id: string ; variant_id: string }[]) => Promise<InsertResult> ; deletePriceListPrices: (priceListId: string, moneyAmountIds: string[]) => Promise<void> ; deleteVariantPricesNotIn: (variantIdOrData: string | { prices: ProductVariantPrice[] ; variantId: string }[], prices?: Price[]) => Promise<void> ; findCurrencyMoneyAmounts: (where: { currency_code: string ; variant_id: string }[]) => Promise<{ amount: number ; created_at: Date ; currency?: internal ; currency_code: string ; deleted_at: Date | null ; id: string ; max_quantity: number | null ; min_quantity: number | null ; price_list: internal | null ; price_list_id: string | null ; region?: internal ; region_id: string ; updated_at: Date ; variant: ProductVariant ; variant_id: any ; variants: ProductVariant[] }[]> ; findManyForVariantInPriceList: (variant_id: string, price_list_id: string, requiresPriceList?: boolean) => Promise<[MoneyAmount[], number]> ; findManyForVariantInRegion: (variant_id: string, region_id?: string, currency_code?: string, customer_id?: string, include_discount_prices?: boolean, include_tax_inclusive_pricing?: boolean) => Promise<[MoneyAmount[], number]> ; findManyForVariantsInRegion: (variant_ids: string | string[], region_id?: string, currency_code?: string, customer_id?: string, include_discount_prices?: boolean, include_tax_inclusive_pricing?: boolean) => Promise<[Record<string, MoneyAmount[]>, number]> ; findRegionMoneyAmounts: (where: { region_id: string ; variant_id: string }[]) => Promise<{ amount: number ; created_at: Date ; currency?: internal ; currency_code: string ; deleted_at: Date | null ; id: string ; max_quantity: number | null ; min_quantity: number | null ; price_list: internal | null ; price_list_id: string | null ; region?: internal ; region_id: string ; updated_at: Date ; variant: ProductVariant ; variant_id: any ; variants: ProductVariant[] }[]> ; findVariantPricesNotIn: (variantId: string, prices: Price[]) => Promise<MoneyAmount[]> ; getPricesForVariantInRegion: (variantId: string, regionId: undefined | string) => Promise<MoneyAmount[]> ; insertBulk: (data: _QueryDeepPartialEntity<MoneyAmount>[]) => Promise<MoneyAmount[]> ; updatePriceListPrices: (priceListId: string, updates: PriceListPriceUpdateInput[]) => Promise<MoneyAmount[]> ; upsertVariantCurrencyPrice: (variantId: string, price: Price) => Promise<MoneyAmount> }

Defined in

packages/medusa/dist/repositories/money-amount.d.ts:8

---

NoteRepository

• Const NoteRepository: Repository

Defined in

packages/medusa/dist/repositories/note.d.ts:2

---

NotificationProviderRepository

• Const NotificationProviderRepository: Repository

Defined in

packages/medusa/dist/repositories/notification-provider.d.ts:2

---

NotificationRepository

• Const NotificationRepository: Repository

Defined in

packages/medusa/dist/repositories/notification.d.ts:2

---

OauthRepository

• Const OauthRepository: Repository

Defined in

packages/medusa/dist/repositories/oauth.d.ts:2

---

OrderEditRepository

• Const OrderEditRepository: Repository

Defined in

packages/medusa/dist/repositories/order-edit.d.ts:2

---

OrderItemChangeRepository

• Const OrderItemChangeRepository: Repository

Defined in

packages/medusa/dist/repositories/order-item-change.d.ts:2

---

OrderRepository

• Const OrderRepository: Repository & { findOneWithRelations: (relations?: FindOptionsRelations<Order>, optionsWithoutRelations?: Omit<FindManyOptions<Order>, "relations">) => Promise<Order> ; findWithRelations: (relations?: FindOptionsRelations<Order>, optionsWithoutRelations?: Omit<FindManyOptions<Order>, "relations">) => Promise<Order[]> }

Defined in

packages/medusa/dist/repositories/order.d.ts:3

---

PaymentCollectionRepository

• Const PaymentCollectionRepository: Repository & { getPaymentCollectionIdByPaymentId: (paymentId: string, config?: FindManyOptions<PaymentCollection>) => Promise<PaymentCollection> ; getPaymentCollectionIdBySessionId: (sessionId: string, config?: FindManyOptions<PaymentCollection>) => Promise<PaymentCollection> }

Defined in

packages/medusa/dist/repositories/payment-collection.d.ts:3

---

PaymentProviderRepository

• Const PaymentProviderRepository: Repository

Defined in

packages/medusa/dist/repositories/payment-provider.d.ts:2

---

PaymentRepository

• Const PaymentRepository: Repository

Defined in

packages/medusa/dist/repositories/payment.d.ts:2

---

PaymentSessionRepository

• Const PaymentSessionRepository: Repository

Defined in

packages/medusa/dist/repositories/payment-session.d.ts:2

---

PriceListRepository

• Const PriceListRepository: Repository & { listAndCount: (query: ExtendedFindConfig<PriceList>, q?: string) => Promise<[PriceList[], number]> ; listPriceListsVariantIdsMap: (priceListIds: string | string[]) => Promise<{ [priceListId: string]: string[]; }> }

Defined in

packages/medusa/dist/repositories/price-list.d.ts:3

---

ProductCategoryRepository

• Const ProductCategoryRepository: TreeRepository & { addProducts: (productCategoryId: string, productIds: string[]) => Promise<void> ; findOneWithDescendants: (query: FindOneOptions<ProductCategory>, treeScope?: QuerySelector<ProductCategory>) => Promise<null | ProductCategory> ; getFreeTextSearchResultsAndCount: (options?: ExtendedFindConfig<ProductCategory>, q?: string, treeScope?: QuerySelector<ProductCategory>, includeTree?: boolean) => Promise<[ProductCategory[], number]> ; removeProducts: (productCategoryId: string, productIds: string[]) => Promise<DeleteResult> }

Defined in

packages/medusa/dist/repositories/product-category.d.ts:4

---

ProductCollectionRepository

• Const ProductCollectionRepository: Repository & { findAndCountByDiscountConditionId: (conditionId: string, query: ExtendedFindConfig<ProductCollection>) => Promise<[ProductCollection[], number]> }

Defined in

packages/medusa/dist/repositories/product-collection.d.ts:3

---

ProductOptionRepository

• Const ProductOptionRepository: Repository

Defined in

packages/medusa/dist/repositories/product-option.d.ts:2

---

ProductRepository

• Const ProductRepository: Repository & { _applyCategoriesQuery: (qb: SelectQueryBuilder<Product>, __namedParameters: { alias: any ; categoryAlias: any ; joinName: any ; where: any }) => SelectQueryBuilder<Product> ; _findWithRelations: (__namedParameters: { idsOrOptionsWithoutRelations: string[] | FindWithoutRelationsOptions ; relations: string[] ; shouldCount: boolean ; withDeleted: boolean }) => Promise<[Product[], number]> ; bulkAddToCollection: (productIds: string[], collectionId: string) => Promise<Product[]> ; bulkRemoveFromCollection: (productIds: string[], collectionId: string) => Promise<Product[]> ; findOneWithRelations: (relations?: string[], optionsWithoutRelations?: FindWithoutRelationsOptions) => Promise<Product> ; findWithRelations: (relations?: string[], idsOrOptionsWithoutRelations?: string[] | FindWithoutRelationsOptions, withDeleted?: boolean) => Promise<Product[]> ; findWithRelationsAndCount: (relations?: string[], idsOrOptionsWithoutRelations?: FindWithoutRelationsOptions) => Promise<[Product[], number]> ; getCategoryIdsFromInput: (categoryId?: CategoryQueryParams, includeCategoryChildren?: boolean) => Promise<string[]> ; getCategoryIdsRecursively: (productCategory: ProductCategory) => string[] ; getFreeTextSearchResultsAndCount: (q: string, options?: FindWithoutRelationsOptions, relations?: string[]) => Promise<[Product[], number]> ; isProductInSalesChannels: (id: string, salesChannelIds: string[]) => Promise<boolean> ; queryProducts: (optionsWithoutRelations: FindWithoutRelationsOptions, shouldCount?: boolean) => Promise<[Product[], number]> ; queryProductsWithIds: (__namedParameters: { entityIds: string[] ; groupedRelations: { [toplevel: string]: string[]; } ; order?: { [column: string]: "ASC" | "DESC"; } ; select?: keyof Product[] ; where?: FindOptionsWhere<Product> ; withDeleted?: boolean }) => Promise<Product[]> }

Defined in

packages/medusa/dist/repositories/product.d.ts:19

---

ProductTagRepository

• Const ProductTagRepository: Repository & { findAndCountByDiscountConditionId: (conditionId: string, query: ExtendedFindConfig<ProductTag>) => Promise<[ProductTag[], number]> ; insertBulk: (data: _QueryDeepPartialEntity<ProductTag>[]) => Promise<ProductTag[]> ; listTagsByUsage: (take?: number) => Promise<ProductTag[]> ; upsertTags: (tags: UpsertTagsInput) => Promise<ProductTag[]> }

Defined in

packages/medusa/dist/repositories/product-tag.d.ts:13

---

ProductTypeRepository

• Const ProductTypeRepository: Repository & { findAndCountByDiscountConditionId: (conditionId: string, query: ExtendedFindConfig<ProductType>) => Promise<[ProductType[], number]> ; upsertType: (type?: UpsertTypeInput) => Promise<null | ProductType> }

Defined in

packages/medusa/dist/repositories/product-type.d.ts:6

---

ProductVariantRepository

• Const ProductVariantRepository: Repository

Defined in

packages/medusa/dist/repositories/product-variant.d.ts:8

---

ReadableByteStreamController

• ReadableByteStreamController: Object

Call signature

• new ReadableByteStreamController(): ReadableByteStreamController

Returns

ReadableByteStreamController

Type declaration

Name	Type
prototype	ReadableByteStreamController

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:160

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:167

---

ReadableStream

• ReadableStream: Object

Call signature

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

Parameters

Name	Type
underlyingSource	UnderlyingByteSource
strategy?	QueuingStrategy<Uint8Array>

Returns

ReadableStream<Uint8Array>

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

Type parameters

Name	Type
R	any

Parameters

Name	Type
underlyingSource?	UnderlyingSource<R>
strategy?	QueuingStrategy<R>

Returns

ReadableStream<R>

Type declaration

Name	Type
prototype	ReadableStream<any>

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:135

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:145

---

ReadableStreamDefaultController

• ReadableStreamDefaultController: Object

Call signature

• new ReadableStreamDefaultController(): ReadableStreamDefaultController<any>

Returns

ReadableStreamDefaultController<any>

Type declaration

Name	Type
prototype	ReadableStreamDefaultController<any>

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:171

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:177

---

ReadableStreamDefaultReader

• ReadableStreamDefaultReader: Object

Call signature

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

Type parameters

Name	Type
R	any

Parameters

Name	Type
stream	ReadableStream<R>

Returns

ReadableStreamDefaultReader<R>

Type declaration

Name	Type
prototype	ReadableStreamDefaultReader<any>

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:150

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:154

---

RefundRepository

• Const RefundRepository: Repository

Defined in

packages/medusa/dist/repositories/refund.d.ts:2

---

RegionRepository

• Const RegionRepository: Repository

Defined in

packages/medusa/dist/repositories/region.d.ts:2

---

ReturnItemRepository

• Const ReturnItemRepository: Repository

Defined in

packages/medusa/dist/repositories/return-item.d.ts:2

---

ReturnReasonRepository

• Const ReturnReasonRepository: Repository

Defined in

packages/medusa/dist/repositories/return-reason.d.ts:2

---

ReturnRepository

• Const ReturnRepository: Repository

Defined in

packages/medusa/dist/repositories/return.d.ts:2

---

SalesChannelRepository

• Const SalesChannelRepository: Repository & { addProducts: (salesChannelId: string, productIds: string[]) => Promise<void> ; getFreeTextSearchResultsAndCount: (q: string, options?: ExtendedFindConfig<SalesChannel>) => Promise<[SalesChannel[], number]> ; listProductIdsBySalesChannelIds: (salesChannelIds: string | string[]) => Promise<{ [salesChannelId: string]: string[]; }> ; removeProducts: (salesChannelId: string, productIds: string[]) => Promise<DeleteResult> }

Defined in

packages/medusa/dist/repositories/sales-channel.d.ts:4

---

SharedArrayBuffer

• SharedArrayBuffer: SharedArrayBufferConstructor

Defined in

docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:22

docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:40

---

ShippingMethodRepository

• Const ShippingMethodRepository: Repository

Defined in

packages/medusa/dist/repositories/shipping-method.d.ts:2

---

ShippingOptionRepository

• Const ShippingOptionRepository: Repository & { upsertShippingProfile: (shippingOptionIds: string[], shippingProfileId: string) => Promise<ShippingOption[]> }

Defined in

packages/medusa/dist/repositories/shipping-option.d.ts:2

---

ShippingOptionRequirementRepository

• Const ShippingOptionRequirementRepository: Repository

Defined in

packages/medusa/dist/repositories/shipping-option-requirement.d.ts:2

---

ShippingProfileRepository

• Const ShippingProfileRepository: Repository & { findByProducts: (productIds: string | string[]) => Promise<{ [product_id: string]: ShippingProfile[]; }> }

Defined in

packages/medusa/dist/repositories/shipping-profile.d.ts:2

---

StagedJobRepository

• Const StagedJobRepository: Repository & { insertBulk: (jobToCreates: _QueryDeepPartialEntity<StagedJob>[]) => Promise<StagedJob[]> }

Defined in

packages/medusa/dist/repositories/staged-job.d.ts:3

---

StoreGetProductCategoriesParams_base

• Const StoreGetProductCategoriesParams_base: internal

Defined in

packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts:67

---

StoreRepository

• Const StoreRepository: Repository

Defined in

packages/medusa/dist/repositories/store.d.ts:2

---

SwapRepository

• Const SwapRepository: Repository

Defined in

packages/medusa/dist/repositories/swap.d.ts:2

---

TaxProviderRepository

• Const TaxProviderRepository: Repository

Defined in

packages/medusa/dist/repositories/tax-provider.d.ts:2

---

TrackingLinkRepository

• Const TrackingLinkRepository: Repository

Defined in

packages/medusa/dist/repositories/tracking-link.d.ts:2

---

UserRepository

• Const UserRepository: Repository

Defined in

packages/medusa/dist/repositories/user.d.ts:2

---

WritableStream

• WritableStream: Object

Call signature

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

Type parameters

Name	Type
W	any

Parameters

Name	Type
underlyingSink?	UnderlyingSink<W>
strategy?	QueuingStrategy<W>

Returns

WritableStream<W>

Type declaration

Name	Type
prototype	WritableStream<any>

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:211

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:217

---

WritableStreamDefaultController

• WritableStreamDefaultController: Object

Call signature

• new WritableStreamDefaultController(): WritableStreamDefaultController

Returns

WritableStreamDefaultController

Type declaration

Name	Type
prototype	WritableStreamDefaultController

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:246

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:249

---

WritableStreamDefaultWriter

• WritableStreamDefaultWriter: Object

Call signature

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

Type parameters

Name	Type
W	any

Parameters

Name	Type
stream	WritableStream<W>

Returns

WritableStreamDefaultWriter<W>

Type declaration

Name	Type
prototype	WritableStreamDefaultWriter<any>

Defined in

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:227

packages/medusa-js/node_modules/@types/node/stream/web.d.ts:236

Functions

Error

▸ Error(message?): Error

Parameters

Name	Type
message?	string

Returns

Error

Defined in

docs-util/node_modules/typescript/lib/lib.es5.d.ts:1074

---

Object

▸ Object(): any

Provides functionality common to all JavaScript objects.

Returns

any

Defined in

docs-util/node_modules/typescript/lib/lib.es5.d.ts:157

▸ Object(value): any

Provides functionality common to all JavaScript objects.

Parameters

Name	Type
value	any

Returns

any

Defined in

docs-util/node_modules/typescript/lib/lib.es5.d.ts:158