Files

github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334 )

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>

2023-10-10 17:47:07 +00:00

218 KiB

Raw Blame History

displayed_sidebar

displayed_sidebar
jsClientSidebar

Namespace: internal

internal.internal

Enumerations

Classes

Interfaces

References

Address

Re-exports Address

BaseEntity

Re-exports BaseEntity

BatchJob

Re-exports BatchJob

BatchJobResultError

Re-exports BatchJobResultError

BatchJobResultStatDescriptor

Re-exports BatchJobResultStatDescriptor

BatchJobStatus

Re-exports BatchJobStatus

Cart

Re-exports Cart

CartType

Re-exports CartType

ClaimFulfillmentStatus

Re-exports ClaimFulfillmentStatus

ClaimImage

Re-exports ClaimImage

ClaimItem

Re-exports ClaimItem

ClaimOrder

Re-exports ClaimOrder

ClaimPaymentStatus

Re-exports ClaimPaymentStatus

ClaimReason

Re-exports ClaimReason

ClaimTag

Re-exports ClaimTag

ClaimType

Re-exports ClaimType

Country

Re-exports Country

Currency

Re-exports Currency

Customer

Re-exports Customer

CustomerGroup

Re-exports CustomerGroup

DateComparisonOperator

Re-exports DateComparisonOperator

Discount

Re-exports Discount

DiscountCondition

Re-exports DiscountCondition

DiscountConditionOperator

Re-exports DiscountConditionOperator

DiscountConditionType

Re-exports DiscountConditionType

DiscountRule

Re-exports DiscountRule

DiscountRuleType

Re-exports DiscountRuleType

DraftOrder

Re-exports DraftOrder

DraftOrderStatus

Re-exports DraftOrderStatus

FindPaginationParams

Re-exports FindPaginationParams

FindParams

Re-exports FindParams

Fulfillment

Re-exports Fulfillment

FulfillmentItem

Re-exports FulfillmentItem

FulfillmentProvider

Re-exports FulfillmentProvider

FulfillmentStatus

Re-exports FulfillmentStatus

GiftCard

Re-exports GiftCard

GiftCardTransaction

Re-exports GiftCardTransaction

Image

Re-exports Image

LineItem

Re-exports LineItem

LineItemAdjustment

Re-exports LineItemAdjustment

LineItemTaxLine

Re-exports LineItemTaxLine

MoneyAmount

Re-exports MoneyAmount

Order

Re-exports Order

OrderEdit

Re-exports OrderEdit

OrderEditItemChangeType

Re-exports OrderEditItemChangeType

OrderEditStatus

Re-exports OrderEditStatus

OrderItemChange

Re-exports OrderItemChange

OrderStatus

Re-exports OrderStatus

PaginatedResponse

Re-exports PaginatedResponse

Payment

Re-exports Payment

PaymentCollection

Re-exports PaymentCollection

PaymentCollectionStatus

Re-exports PaymentCollectionStatus

PaymentProvider

Re-exports PaymentProvider

PaymentSession

Re-exports PaymentSession

PaymentStatus

Re-exports PaymentStatus

PriceList

Re-exports PriceList

PriceListStatus

Re-exports PriceListStatus

PriceListType

Re-exports PriceListType

Product

Re-exports Product

ProductCategory

Re-exports ProductCategory

ProductCollection

Re-exports ProductCollection

ProductOption

Re-exports ProductOption

ProductOptionValue

Re-exports ProductOptionValue

ProductStatus

Re-exports ProductStatus

ProductTag

Re-exports ProductTag

ProductType

Re-exports ProductType

ProductVariant

Re-exports ProductVariant

ProductVariantInventoryItem

Re-exports ProductVariantInventoryItem

Refund

Re-exports Refund

Region

Re-exports Region

RequirementType

Re-exports RequirementType

Return

Re-exports Return

ReturnItem

Re-exports ReturnItem

ReturnReason

Re-exports ReturnReason

ReturnStatus

Re-exports ReturnStatus

SalesChannel

Re-exports SalesChannel

SalesChannelLocation

Re-exports SalesChannelLocation

ShippingMethod

Re-exports ShippingMethod

ShippingMethodTaxLine

Re-exports ShippingMethodTaxLine

ShippingOption

Re-exports ShippingOption

ShippingOptionPriceType

Re-exports ShippingOptionPriceType

ShippingOptionRequirement

Re-exports ShippingOptionRequirement

ShippingProfile

Re-exports ShippingProfile

ShippingProfileType

Re-exports ShippingProfileType

SoftDeletableEntity

Re-exports SoftDeletableEntity

StorePostCustomersCustomerAddressesAddressReq

Re-exports StorePostCustomersCustomerAddressesAddressReq

StorePostCustomersCustomerAddressesReq

Re-exports StorePostCustomersCustomerAddressesReq

StringComparisonOperator

Re-exports StringComparisonOperator

Swap

Re-exports Swap

SwapFulfillmentStatus

Re-exports SwapFulfillmentStatus

SwapPaymentStatus

Re-exports SwapPaymentStatus

TaxProvider

Re-exports TaxProvider

TaxRate

Re-exports TaxRate

TrackingLink

Re-exports TrackingLink

User

Re-exports User

UserRoles

Re-exports UserRoles

Type Aliases

AdminAnalyticsConfigDeleteRes

Ƭ AdminAnalyticsConfigDeleteRes: DeleteResponse

Defined in

packages/medusa/dist/api/routes/admin/analytics-configs/index.d.ts:9

AdminAnalyticsConfigRes

Ƭ AdminAnalyticsConfigRes: Object

Type declaration

Name	Type
`analytics_config`	`AnalyticsConfig`

Defined in

packages/medusa/dist/api/routes/admin/analytics-configs/index.d.ts:6

AdminCollectionsDeleteRes

Ƭ AdminCollectionsDeleteRes: DeleteResponse

Schema

AdminCollectionsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Collection object: type: string description: The type of the object that was deleted. default: product-collection deleted: type: boolean description: Whether the collection was deleted successfully or not. default: true

Defined in

packages/medusa/dist/api/routes/admin/collections/index.d.ts:55

AdminCustomerGroupsDeleteRes

Ƭ AdminCustomerGroupsDeleteRes: DeleteResponse

Schema

AdminCustomerGroupsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted customer group. object: type: string description: The type of the object that was deleted. default: customer_group deleted: type: boolean description: Whether the customer group was deleted successfully or not. default: true

Defined in

packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:38

AdminDeleteShippingProfileRes

Ƭ AdminDeleteShippingProfileRes: DeleteResponse

Schema

AdminDeleteShippingProfileRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Shipping Profile. object: type: string description: The type of the object that was deleted. default: shipping_profile deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:28

AdminDeleteUploadsRes

Ƭ AdminDeleteUploadsRes: DeleteResponse

Schema

AdminDeleteUploadsRes type: object required:

id
object
deleted properties: id: type: string description: The file key of the upload deleted object: type: string description: The type of the object that was deleted. default: file deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/uploads/index.d.ts:51

AdminDeleteUserRes

Ƭ AdminDeleteUserRes: DeleteResponse

Schema

AdminDeleteUserRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted user. object: type: string description: The type of the object that was deleted. default: user deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/users/index.d.ts:54

AdminDiscountConditionsDeleteRes

Ƭ AdminDiscountConditionsDeleteRes: DeleteResponse & { discount: Discount }

Schema

AdminDiscountConditionsDeleteRes type: object required:

id
object
deleted
discount properties: id: type: string description: The ID of the deleted Discount Condition object: type: string description: The type of the object that was deleted. default: discount-condition deleted: type: boolean description: Whether the discount condition was deleted successfully. default: true discount: description: The Discount to which the condition used to belong to. $ref: "#/components/schemas/Discount"

Defined in

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

AdminDiscountsDeleteRes

Ƭ AdminDiscountsDeleteRes: DeleteResponse

Schema

AdminDiscountsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Discount object: type: string description: The type of the object that was deleted. default: discount deleted: type: boolean description: Whether the discount was deleted successfully. default: true

Defined in

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

AdminDraftOrdersDeleteRes

Ƭ AdminDraftOrdersDeleteRes: DeleteResponse

Schema

AdminDraftOrdersDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Draft Order. object: type: string description: The type of the object that was deleted. default: draft-order deleted: type: boolean description: Whether the draft order was deleted successfully. default: true

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:114

AdminDraftOrdersListRes

Ƭ AdminDraftOrdersListRes: PaginatedResponse & { draft_orders: DraftOrder[] }

Schema

AdminDraftOrdersListRes type: object x-expanded-relations: field: draft_orders relations: - order - cart - cart.items - cart.items.adjustments required:

draft_orders
count
offset
limit properties: draft_orders: type: array description: An array of draft order's details. items: $ref: "#/components/schemas/DraftOrder" count: type: integer description: The total number of items available offset: type: integer description: The number of draft orders skipped when retrieving the draft orders. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:146

AdminDraftOrdersRes

Ƭ AdminDraftOrdersRes: Object

Schema

AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required:

draft_order properties: draft_order: description: Draft order's details. $ref: "#/components/schemas/DraftOrder"

Type declaration

Name	Type
`draft_order`	`DraftOrder`

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:91

AdminExtendedStoresRes

Ƭ AdminExtendedStoresRes: Object

Schema

AdminExtendedStoresRes type: object x-expanded-relations: field: store relations: - currencies - default_currency required:

store properties: store: description: Store details. $ref: "#/components/schemas/ExtendedStoreDTO"

Type declaration

Name	Type
`store`	`ExtendedStoreDTO`

Defined in

packages/medusa/dist/api/routes/admin/store/index.d.ts:21

AdminGetVariantsVariantInventoryRes

Ƭ AdminGetVariantsVariantInventoryRes: Object

Schema

AdminGetVariantsVariantInventoryRes type: object properties: variant: type: object description: "The product variant's." $ref: "#/components/schemas/VariantInventory"

Type declaration

Name	Type
`variant`	`VariantInventory`

Defined in

packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:134

AdminGiftCardsDeleteRes

Ƭ AdminGiftCardsDeleteRes: DeleteResponse

Schema

AdminGiftCardsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Gift Card object: type: string description: The type of the object that was deleted. default: gift-card deleted: type: boolean description: Whether the gift card was deleted successfully. default: true

Defined in

packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:49

AdminGiftCardsListRes

Ƭ AdminGiftCardsListRes: PaginatedResponse & { gift_cards: GiftCard[] }

Schema

AdminGiftCardsListRes type: object x-expanded-relations: field: gift_cards relations: - order - region eager: - region.fulfillment_providers - region.payment_providers required:

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

Defined in

packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:81

AdminGiftCardsRes

Ƭ AdminGiftCardsRes: Object

Schema

AdminGiftCardsRes type: object x-expanded-relations: field: gift_card relations: - order - region eager: - region.fulfillment_providers - region.payment_providers required:

gift_card properties: gift_card: description: "A gift card's details." $ref: "#/components/schemas/GiftCard"

Type declaration

Name	Type
`gift_card`	`GiftCard`

Defined in

packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:26

AdminInventoryItemsDeleteRes

Ƭ AdminInventoryItemsDeleteRes: DeleteResponse

Schema

AdminInventoryItemsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Inventory Item. object: type: string description: The type of the object that was deleted. format: inventory_item deleted: type: boolean description: Whether or not the Inventory Item was deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:43

AdminInventoryItemsListRes

Ƭ AdminInventoryItemsListRes: PaginatedResponse & { inventory_items: InventoryItemDTO[] }

Schema

AdminInventoryItemsListRes type: object required:

inventory_items
count
offset
limit properties: inventory_items: type: array description: an array of Inventory Item details items: $ref: "#/components/schemas/InventoryItemDTO" count: type: integer description: The total number of items available offset: type: integer description: The number of inventory items skipped when retrieving the inventory items. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:68

AdminInventoryItemsListWithVariantsAndLocationLevelsRes

Ƭ AdminInventoryItemsListWithVariantsAndLocationLevelsRes: PaginatedResponse & { inventory_items: DecoratedInventoryItemDTO[] }

Schema

AdminInventoryItemsListWithVariantsAndLocationLevelsRes type: object required:

inventory_items
count
offset
limit properties: inventory_items: type: array description: an array of Inventory Item details items: $ref: "#/components/schemas/DecoratedInventoryItemDTO" count: type: integer description: The total number of items available offset: type: integer description: The number of inventory items skipped when retrieving the inventory items. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:128

AdminInventoryItemsLocationLevelsRes

Ƭ AdminInventoryItemsLocationLevelsRes: Object

Schema

AdminInventoryItemsLocationLevelsRes type: object required:

inventory_item properties: inventory_item: type: object required:
- id
- location_levels properties: id: description: The id of the location location_levels: description: List of stock levels at a given location type: array items: $ref: "#/components/schemas/InventoryLevelDTO"

Type declaration

Name	Type
`inventory_item`	{ `id`: `any` ; `location_levels`: `InventoryLevelDTO`[] }
`inventory_item.id`	`any`
`inventory_item.location_levels`	`InventoryLevelDTO`[]

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:151

AdminInventoryItemsRes

Ƭ AdminInventoryItemsRes: Object

Schema

AdminInventoryItemsRes type: object required:

inventory_item properties: inventory_item: description: Inventory Item details $ref: "#/components/schemas/InventoryItemDTO"

Type declaration

Name	Type
`inventory_item`	`InventoryItemDTO`

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:20

AdminInviteDeleteRes

Ƭ AdminInviteDeleteRes: DeleteResponse

Schema

AdminInviteDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Invite. object: type: string description: The type of the object that was deleted. default: invite deleted: type: boolean description: Whether or not the invite was deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/invites/index.d.ts:27

AdminListInvitesRes

Ƭ AdminListInvitesRes: Object

Schema

AdminListInvitesRes type: object required:

invites properties: invites: type: array description: An array of invites items: $ref: "#/components/schemas/Invite"

Type declaration

Name	Type
`invites`	`Invite`[]

Defined in

packages/medusa/dist/api/routes/admin/invites/index.d.ts:40

AdminNotesDeleteRes

Ƭ AdminNotesDeleteRes: DeleteResponse

Schema

AdminNotesDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Note. object: type: string description: The type of the object that was deleted. default: note deleted: type: boolean description: Whether or not the Note was deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/notes/index.d.ts:39

AdminNotesListRes

Ƭ AdminNotesListRes: PaginatedResponse & { notes: Note[] }

Schema

AdminNotesListRes type: object required:

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

Defined in

packages/medusa/dist/api/routes/admin/notes/index.d.ts:64

AdminNotesRes

Ƭ AdminNotesRes: Object

Schema

AdminNotesRes type: object required:

note properties: note: description: Note details. $ref: "#/components/schemas/Note"

Type declaration

Name	Type
`note`	`Note`

Defined in

packages/medusa/dist/api/routes/admin/notes/index.d.ts:16

AdminNotificationsListRes

Ƭ AdminNotificationsListRes: PaginatedResponse & { notifications: Notification[] }

Schema

AdminNotificationsListRes type: object x-expanded-relations: field: notifications relations: - resends required:

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

Defined in

packages/medusa/dist/api/routes/admin/notifications/index.d.ts:32

AdminNotificationsRes

Ƭ AdminNotificationsRes: Object

Schema

AdminNotificationsRes type: object x-expanded-relations: field: notification relations: - resends required:

notification properties: notification: description: Notification details $ref: "#/components/schemas/Notification"

Type declaration

Name	Type
`notification`	`Notification`

Defined in

packages/medusa/dist/api/routes/admin/notifications/index.d.ts:49

AdminOrderEditDeleteRes

Ƭ AdminOrderEditDeleteRes: DeleteResponse

Schema

AdminOrderEditDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Order Edit. object: type: string description: The type of the object that was deleted. default: order_edit deleted: type: boolean description: Whether or not the Order Edit was deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:135

AdminOrderEditItemChangeDeleteRes

Ƭ AdminOrderEditItemChangeDeleteRes: Object

Schema

AdminOrderEditItemChangeDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Order Edit Item Change. object: type: string description: The type of the object that was deleted. default: item_change deleted: type: boolean description: Whether or not the Order Edit Item Change was deleted. default: true

Type declaration

Name	Type
`deleted`	`boolean`
`id`	`string`
`object`	`"item_change"`

Defined in

packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:156

AdminOrderEditsListRes

Ƭ AdminOrderEditsListRes: PaginatedResponse & { order_edits: OrderEdit[] }

Schema

AdminOrderEditsListRes type: object x-expanded-relations: field: order_edits relations: - changes - changes.line_item - changes.line_item.variant - changes.original_line_item - changes.original_line_item.variant - items - items.adjustments - items.tax_lines - items.variant - payment_collection implicit: - items - items.tax_lines - items.adjustments - items.variant totals: - difference_due - discount_total - gift_card_tax_total - gift_card_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required:

order_edits
count
offset
limit properties: order_edits: type: array description: "An array of order edit details" items: $ref: "#/components/schemas/OrderEdit" count: type: integer description: The total number of items available offset: type: integer description: The number of order edits skipped when retrieving the order edits. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:112

AdminOrderEditsRes

Ƭ AdminOrderEditsRes: Object

Schema

AdminOrderEditsRes type: object x-expanded-relations: field: order_edit relations: - changes - changes.line_item - changes.line_item.variant - changes.original_line_item - changes.original_line_item.variant - items - items.adjustments - items.tax_lines - items.variant - payment_collection implicit: - items - items.tax_lines - items.adjustments - items.variant totals: - difference_due - discount_total - gift_card_tax_total - gift_card_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required:

order_edit properties: order_edit: description: "Order edit details" $ref: "#/components/schemas/OrderEdit"

Type declaration

Name	Type
`order_edit`	`OrderEdit`

Defined in

packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:50

AdminOrdersListRes

Ƭ AdminOrdersListRes: PaginatedResponse & { orders: Order[] }

Schema

AdminOrdersListRes type: object x-expanded-relations: field: orders relations: - billing_address - claims - claims.additional_items - claims.additional_items.variant - claims.claim_items - claims.claim_items.images - claims.claim_items.item - claims.fulfillments - claims.fulfillments.tracking_links - claims.return_order - claims.return_order.shipping_method - claims.return_order.shipping_method.tax_lines - claims.shipping_address - claims.shipping_methods - customer - discounts - discounts.rule - fulfillments - fulfillments.items - fulfillments.tracking_links - gift_card_transactions - gift_cards - items - payments - refunds - region - returns - returns.items - returns.items.reason - returns.shipping_method - returns.shipping_method.tax_lines - shipping_address - shipping_methods eager: - fulfillments.items - region.fulfillment_providers - region.payment_providers - returns.items - shipping_methods.shipping_option implicit: - claims - claims.additional_items - claims.additional_items.adjustments - claims.additional_items.refundable - claims.additional_items.tax_lines - discounts - discounts.rule - gift_card_transactions - gift_card_transactions.gift_card - gift_cards - items - items.adjustments - items.refundable - items.tax_lines - items.variant - items.variant.product - items.variant.product.profiles - refunds - region - shipping_methods - shipping_methods.tax_lines - swaps - swaps.additional_items - swaps.additional_items.adjustments - swaps.additional_items.refundable - swaps.additional_items.tax_lines totals: - discount_total - gift_card_tax_total - gift_card_total - paid_total - refundable_amount - refunded_total - shipping_total - subtotal - tax_total - total - claims.additional_items.discount_total - claims.additional_items.gift_card_total - claims.additional_items.original_tax_total - claims.additional_items.original_total - claims.additional_items.refundable - claims.additional_items.subtotal - claims.additional_items.tax_total - claims.additional_items.total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total - swaps.additional_items.discount_total - swaps.additional_items.gift_card_total - swaps.additional_items.original_tax_total - swaps.additional_items.original_total - swaps.additional_items.refundable - swaps.additional_items.subtotal - swaps.additional_items.tax_total - swaps.additional_items.total required:

orders
count
offset
limit properties: orders: type: array description: "An array of order details." items: $ref: "#/components/schemas/Order" count: type: integer description: The total number of items available offset: type: integer description: The number of orders skipped when retrieving the orders. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/orders/index.d.ts:252

AdminOrdersRes

Ƭ AdminOrdersRes: Object

Schema

AdminOrdersRes type: object x-expanded-relations: field: order relations: - billing_address - claims - claims.additional_items - claims.additional_items.variant - claims.claim_items - claims.claim_items.images - claims.claim_items.item - claims.fulfillments - claims.fulfillments.tracking_links - claims.return_order - claims.return_order.shipping_method - claims.return_order.shipping_method.tax_lines - claims.shipping_address - claims.shipping_methods - customer - discounts - discounts.rule - fulfillments - fulfillments.items - fulfillments.tracking_links - gift_card_transactions - gift_cards - items - payments - refunds - region - returns - returns.items - returns.items.reason - returns.shipping_method - returns.shipping_method.tax_lines - shipping_address - shipping_methods eager: - fulfillments.items - region.fulfillment_providers - region.payment_providers - returns.items - shipping_methods.shipping_option implicit: - claims - claims.additional_items - claims.additional_items.adjustments - claims.additional_items.refundable - claims.additional_items.tax_lines - discounts - discounts.rule - gift_card_transactions - gift_card_transactions.gift_card - gift_cards - items - items.adjustments - items.refundable - items.tax_lines - items.variant - items.variant.product - items.variant.product.profiles - refunds - region - shipping_methods - shipping_methods.tax_lines - swaps - swaps.additional_items - swaps.additional_items.adjustments - swaps.additional_items.refundable - swaps.additional_items.tax_lines totals: - discount_total - gift_card_tax_total - gift_card_total - paid_total - refundable_amount - refunded_total - shipping_total - subtotal - tax_total - total - claims.additional_items.discount_total - claims.additional_items.gift_card_total - claims.additional_items.original_tax_total - claims.additional_items.original_total - claims.additional_items.refundable - claims.additional_items.subtotal - claims.additional_items.tax_total - claims.additional_items.total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total - swaps.additional_items.discount_total - swaps.additional_items.gift_card_total - swaps.additional_items.original_tax_total - swaps.additional_items.original_total - swaps.additional_items.refundable - swaps.additional_items.subtotal - swaps.additional_items.tax_total - swaps.additional_items.total required:

order properties: order: description: "Order details." $ref: "#/components/schemas/Order"

Type declaration

Name	Type
`order`	`Order`

Defined in

packages/medusa/dist/api/routes/admin/orders/index.d.ts:121

AdminPaymentCollectionDeleteRes

Ƭ AdminPaymentCollectionDeleteRes: Object

Schema

AdminPaymentCollectionDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Payment Collection. object: type: string description: The type of the object that was deleted. default: payment_collection deleted: type: boolean description: Whether or not the Payment Collection was deleted. default: true

Type declaration

Name	Type
`deleted`	`boolean`
`id`	`string`
`object`	`"payment_collection"`

Defined in

packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:49

AdminPaymentCollectionsRes

Ƭ AdminPaymentCollectionsRes: Object

Schema

AdminPaymentCollectionsRes type: object x-expanded-relations: field: payment_collection relations: - payment_sessions - payments - region eager: - region.fulfillment_providers - region.payment_providers required:

payment_collection properties: payment_collection: description: Payment Collection details. $ref: "#/components/schemas/PaymentCollection"

Type declaration

Name	Type
`payment_collection`	`PaymentCollection`

Defined in

packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:26

AdminPaymentProvidersList

Ƭ AdminPaymentProvidersList: Object

Schema

AdminPaymentProvidersList type: object required:

payment_providers properties: payment_providers: type: array description: An array of payment providers details. items: $ref: "#/components/schemas/PaymentProvider"

Type declaration

Name	Type
`payment_providers`	`PaymentProvider`[]

Defined in

packages/medusa/dist/api/routes/admin/store/index.d.ts:64

AdminPaymentRes

Ƭ AdminPaymentRes: Object

Schema

AdminPaymentRes type: object required:

payment properties: payment: description: "Payment details" $ref: "#/components/schemas/Payment"

Type declaration

Name	Type
`payment`	`Payment`

Defined in

packages/medusa/dist/api/routes/admin/payments/index.d.ts:16

AdminPostDraftOrdersDraftOrderRegisterPaymentRes

Ƭ AdminPostDraftOrdersDraftOrderRegisterPaymentRes: Object

Schema

AdminPostDraftOrdersDraftOrderRegisterPaymentRes type: object required:

order properties: order: description: Order's details. $ref: "#/components/schemas/Order"

Type declaration

Name	Type
`order`	`Order`

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:19

AdminPriceListDeleteBatchRes

Ƭ AdminPriceListDeleteBatchRes: Object

Schema

AdminPriceListDeleteBatchRes type: object required:

ids
object
deleted properties: ids: type: array items: type: string description: The IDs of the deleted prices. object: type: string description: The type of the object that was deleted. A price is also named money-amount. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true

Type declaration

Name	Type
`deleted`	`boolean`
`ids`	`string`[]
`object`	`string`

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:49

AdminPriceListDeleteProductPricesRes

Ƭ AdminPriceListDeleteProductPricesRes: AdminPriceListDeleteBatchRes

Schema

AdminPriceListDeleteProductPricesRes type: object required:

ids
object
deleted properties: ids: type: array description: The IDs of the deleted prices. items: type: string object: type: string description: The type of the object that was deleted. A price is also named money-amount. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:76

AdminPriceListDeleteRes

Ƭ AdminPriceListDeleteRes: DeleteResponse

Schema

AdminPriceListDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Price List. object: type: string description: The type of the object that was deleted. default: price-list deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:120

AdminPriceListDeleteVariantPricesRes

Ƭ AdminPriceListDeleteVariantPricesRes: AdminPriceListDeleteBatchRes

Schema

AdminPriceListDeleteVariantPricesRes type: object required:

ids
object
deleted properties: ids: type: array description: The IDs of the deleted prices. items: type: string object: type: string description: The type of the object that was deleted. A price is also named money-amount. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:99

AdminPriceListRes

Ƭ AdminPriceListRes: Object

Schema

AdminPriceListRes type: object x-expanded-relations: field: price_list relations: - customer_groups - prices required:

price_list properties: price_list: description: "Price List details." $ref: "#/components/schemas/PriceList"

Type declaration

Name	Type
`price_list`	`PriceList`

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:24

AdminPriceListsListRes

Ƭ AdminPriceListsListRes: PaginatedResponse & { price_lists: PriceList[] }

Schema

AdminPriceListsListRes type: object required:

price_lists
count
offset
limit properties: price_lists: type: array description: "An array of price lists details." items: $ref: "#/components/schemas/PriceList" count: type: integer description: The total number of items available offset: type: integer description: The number of price lists skipped when retrieving the price lists. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:145

AdminPriceListsProductsListRes

Ƭ AdminPriceListsProductsListRes: PaginatedResponse & { products: Product[] }

Schema

AdminPriceListsProductsListRes type: object x-expanded-relations: field: products relations: - categories - collection - images - options - tags - type - variants - variants.options required:

products
count
offset
limit properties: products: type: array description: "An array of products details." items: $ref: "#/components/schemas/Product" count: type: integer description: The total number of items available offset: type: integer description: The number of price lists skipped when retrieving the price lists. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:183

AdminProductCategoriesCategoryDeleteRes

Ƭ AdminProductCategoriesCategoryDeleteRes: DeleteResponse

Schema

AdminProductCategoriesCategoryDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted product category object: type: string description: The type of the object that was deleted. default: product-category deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:53

AdminProductCategoriesCategoryRes

Ƭ AdminProductCategoriesCategoryRes: Object

Schema

AdminProductCategoriesCategoryRes type: object x-expanded-relations: field: product_category relations: - category_children - parent_category required:

product_category properties: product_category: description: "Product category details." $ref: "#/components/schemas/ProductCategory"

Type declaration

Name	Type
`product_category`	`ProductCategory`

Defined in

packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:30

AdminProductCategoriesListRes

Ƭ AdminProductCategoriesListRes: PaginatedResponse & { product_categories: ProductCategory[] }

Schema

AdminProductCategoriesListRes type: object x-expanded-relations: field: product_categories relations: - category_children - parent_category required:

product_categories
count
offset
limit properties: product_categories: type: array description: "An array of product category details." items: $ref: "#/components/schemas/ProductCategory" count: type: integer description: The total number of items available offset: type: integer description: The number of product categories skipped when retrieving the product categories. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:83

AdminProductTagsListRes

Ƭ AdminProductTagsListRes: PaginatedResponse & { product_tags: ProductTag[] }

Schema

AdminProductTagsListRes type: object required:

product_tags
count
offset
limit properties: product_tags: type: array description: "An array of product tag details." items: $ref: "#/components/schemas/ProductTag" count: type: integer description: The total number of items available offset: type: integer description: The number of product tags skipped when retrieving the product tags. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:32

AdminProductTypesListRes

Ƭ AdminProductTypesListRes: PaginatedResponse & { product_types: ProductType[] }

Schema

AdminProductTypesListRes type: object required:

product_types
count
offset
limit properties: product_types: type: array description: An array of product types details. items: $ref: "#/components/schemas/ProductType" count: type: integer description: The total number of items available offset: type: integer description: The number of product types skipped when retrieving the product types. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/product-types/index.d.ts:32

AdminProductsDeleteOptionRes

Ƭ AdminProductsDeleteOptionRes: Object

Schema

AdminProductsDeleteOptionRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required:

option_id
object
deleted
product properties: option_id: type: string description: The ID of the deleted Product Option object: type: string description: The type of the object that was deleted. default: option deleted: type: boolean description: Whether or not the items were deleted. default: true product: description: Product details. $ref: "#/components/schemas/PricedProduct"

Type declaration

Name	Type
`deleted`	`boolean`
`object`	`"option"`
`option_id`	`string`
`product`	`Product`

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:79

AdminProductsDeleteRes

Ƭ AdminProductsDeleteRes: Object

Schema

AdminProductsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Product. object: type: string description: The type of the object that was deleted. default: product deleted: type: boolean description: Whether or not the items were deleted. default: true

Type declaration

Name	Type
`deleted`	`boolean`
`id`	`string`
`object`	`"product"`

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:146

AdminProductsDeleteVariantRes

Ƭ AdminProductsDeleteVariantRes: Object

Schema

AdminProductsDeleteVariantRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required:

variant_id
object
deleted
product properties: variant_id: type: string description: The ID of the deleted Product Variant. object: type: string description: The type of the object that was deleted. default: product-variant deleted: type: boolean description: Whether or not the items were deleted. default: true product: description: Product details. $ref: "#/components/schemas/PricedProduct"

Type declaration

Name	Type
`deleted`	`boolean`
`object`	`"product-variant"`
`product`	`Product`
`variant_id`	`string`

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:120

AdminProductsListRes

Ƭ AdminProductsListRes: PaginatedResponse & { products: (PricedProduct | Product)[] }

Schema

AdminProductsListRes type: object x-expanded-relations: field: products relations: - collection - images - options - tags - type - variants - variants.options - variants.prices totals: - variants.purchasable required:

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

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:188

AdminProductsListTagsRes

Ƭ AdminProductsListTagsRes: Object

Schema

AdminProductsListTagsRes type: object required:

tags properties: tags: description: An array of product tags details. type: array items: type: object required: - id - usage_count - value properties: id: description: The ID of the tag. type: string usage_count: description: The number of products that use this tag. type: string value: description: The value of the tag. type: string

Type declaration

Name	Type
`tags`	`Pick`<`ProductTag`, `"id"` \| `"value"`> & { `usage_count`: `number` }[]

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:259

AdminProductsListTypesRes

Ƭ AdminProductsListTypesRes: Object

Schema

AdminProductsListTypesRes type: object required:

types properties: types: type: array description: An array of product types details. items: $ref: "#/components/schemas/ProductType"

Type declaration

Name	Type
`types`	`ProductType`[]

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:230

AdminProductsListVariantsRes

Ƭ AdminProductsListVariantsRes: PaginatedResponse & { variants: ProductVariant[] }

Schema

AdminProductsListVariantsRes type: object required:

variants
count
offset
limit properties: variants: type: array description: An array of product variants details. items: $ref: "#/components/schemas/ProductVariant" count: type: integer description: The total number of items available offset: type: integer description: The number of product variants skipped when retrieving the product variants. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:215

AdminProductsRes

Ƭ AdminProductsRes: Object

Schema

AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required:

product properties: product: description: Product details. $ref: "#/components/schemas/PricedProduct"

Type declaration

Name	Type
`product`	`Product`

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:285

AdminPublishableApiKeyDeleteRes

Ƭ AdminPublishableApiKeyDeleteRes: DeleteResponse

Schema

AdminPublishableApiKeyDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted publishable API key. object: type: string description: The type of the object that was deleted. default: publishable_api_key deleted: type: boolean description: Whether the publishable API key was deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:65

AdminPublishableApiKeysListRes

Ƭ AdminPublishableApiKeysListRes: PaginatedResponse & { publishable_api_keys: PublishableApiKey[] }

Schema

AdminPublishableApiKeysListRes type: object required:

publishable_api_keys
count
offset
limit properties: publishable_api_keys: type: array description: "An array of publishable API keys details." items: $ref: "#/components/schemas/PublishableApiKey" count: type: integer description: The total number of items available offset: type: integer description: The number of publishable API keys skipped when retrieving the publishable API keys. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:42

AdminPublishableApiKeysListSalesChannelsRes

Ƭ AdminPublishableApiKeysListSalesChannelsRes: Object

Schema

AdminPublishableApiKeysListSalesChannelsRes type: object required:

sales_channels properties: sales_channels: description: "An array of sales channels details." type: array items: $ref: "#/components/schemas/SalesChannel"

Type declaration

Name	Type
`sales_channels`	`SalesChannel`[]

Defined in

packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:78

AdminPublishableApiKeysRes

Ƭ AdminPublishableApiKeysRes: Object

Schema

AdminPublishableApiKeysRes type: object required:

publishable_api_key properties: publishable_api_key: description: "Publishable API key details." $ref: "#/components/schemas/PublishableApiKey"

Type declaration

Name	Type
`publishable_api_key`	`PublishableApiKey`

Defined in

packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:15

AdminRefundRes

Ƭ AdminRefundRes: Object

Schema

AdminRefundRes type: object required:

refund properties: refund: description: "Refund details" $ref: "#/components/schemas/Refund"

Type declaration

Name	Type
`refund`	`Refund`

Defined in

packages/medusa/dist/api/routes/admin/payments/index.d.ts:29

AdminRegionsDeleteRes

Ƭ AdminRegionsDeleteRes: DeleteResponse

Schema

AdminRegionsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Region. object: type: string description: The type of the object that was deleted. default: region deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/regions/index.d.ts:87

AdminRegionsListRes

Ƭ AdminRegionsListRes: PaginatedResponse & { regions: Region[] }

Schema

AdminRegionsListRes type: object x-expanded-relations: field: regions relations: - countries - fulfillment_providers - payment_providers eager: - fulfillment_providers - payment_providers required:

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

Defined in

packages/medusa/dist/api/routes/admin/regions/index.d.ts:64

AdminReservationsDeleteRes

Ƭ AdminReservationsDeleteRes: DeleteResponse

Schema

AdminReservationsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Reservation. object: type: string description: The type of the object that was deleted. default: reservation deleted: type: boolean description: Whether or not the Reservation was deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/reservations/index.d.ts:86

AdminReservationsListRes

Ƭ AdminReservationsListRes: PaginatedResponse & { reservations: ReservationItemDTO[] }

Schema

AdminReservationsListRes type: object required:

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

Defined in

packages/medusa/dist/api/routes/admin/reservations/index.d.ts:61

AdminReservationsRes

Ƭ AdminReservationsRes: Object

Schema

AdminReservationsRes type: object required:

reservation properties: reservation: description: Reservation details. $ref: "#/components/schemas/ReservationItemDTO"

Type declaration

Name	Type
`reservation`	`ReservationItemDTO`

Defined in

packages/medusa/dist/api/routes/admin/reservations/index.d.ts:16

AdminReturnReasonsDeleteRes

Ƭ AdminReturnReasonsDeleteRes: DeleteResponse

Schema

AdminReturnReasonsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted return reason object: type: string description: The type of the object that was deleted. default: return_reason deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:63

AdminReturnReasonsListRes

Ƭ AdminReturnReasonsListRes: Object

Schema

AdminReturnReasonsListRes type: object x-expanded-relations: field: return_reasons relations: - parent_return_reason - return_reason_children required:

return_reasons properties: return_reasons: type: array items: $ref: "#/components/schemas/ReturnReason"

Type declaration

Name	Type
`return_reasons`	`ReturnReason`[]

Defined in

packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:40

AdminReturnReasonsRes

Ƭ AdminReturnReasonsRes: Object

Schema

AdminReturnReasonsRes type: object x-expanded-relations: field: return_reason relations: - parent_return_reason - return_reason_children required:

return_reason properties: return_reason: $ref: "#/components/schemas/ReturnReason"

Type declaration

Name	Type
`return_reason`	`ReturnReason`

Defined in

packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:21

AdminReturnsCancelRes

Ƭ AdminReturnsCancelRes: Object

Schema

AdminReturnsCancelRes type: object x-expanded-relations: field: order relations: - billing_address - claims - claims.additional_items - claims.additional_items.variant - claims.claim_items - claims.claim_items.images - claims.claim_items.item - claims.fulfillments - claims.fulfillments.tracking_links - claims.return_order - claims.return_order.shipping_method - claims.return_order.shipping_method.tax_lines - claims.shipping_address - claims.shipping_methods - customer - discounts - discounts.rule - fulfillments - fulfillments.items - fulfillments.tracking_links - gift_card_transactions - gift_cards - items - payments - refunds - region - returns - returns.items - returns.items.reason - returns.shipping_method - returns.shipping_method.tax_lines - shipping_address - shipping_methods - swaps - swaps.additional_items - swaps.additional_items.variant - swaps.fulfillments - swaps.fulfillments.tracking_links - swaps.payment - swaps.return_order - swaps.return_order.shipping_method - swaps.return_order.shipping_method.tax_lines - swaps.shipping_address - swaps.shipping_methods - swaps.shipping_methods.tax_lines required:

order properties: order: description: Order details. $ref: "#/components/schemas/Order"

Type declaration

Name	Type
`order`	`Order`

Defined in

packages/medusa/dist/api/routes/admin/returns/index.d.ts:68

AdminReturnsListRes

Ƭ AdminReturnsListRes: PaginatedResponse & { returns: Return[] }

Schema

AdminReturnsListRes type: object x-expanded-relation: field: returns relations: - order - swap required:

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

Defined in

packages/medusa/dist/api/routes/admin/returns/index.d.ts:100

AdminReturnsRes

Ƭ AdminReturnsRes: Object

Schema

AdminReturnsRes type: object x-expanded-relation: field: return relations: - swap required:

return properties: return: description: Return details. $ref: "#/components/schemas/Return"

Type declaration

Name	Type
`return`	`Return`

Defined in

packages/medusa/dist/api/routes/admin/returns/index.d.ts:117

AdminSalesChannelsDeleteLocationRes

Ƭ AdminSalesChannelsDeleteLocationRes: DeleteResponse

Schema

AdminSalesChannelsDeleteLocationRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the removed stock location from a sales channel object: type: string description: The type of the object that was removed. default: stock-location deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:60

AdminSalesChannelsDeleteRes

Ƭ AdminSalesChannelsDeleteRes: DeleteResponse

Schema

AdminSalesChannelsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted sales channel object: type: string description: The type of the object that was deleted. default: sales-channel deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:39

AdminSalesChannelsListRes

Ƭ AdminSalesChannelsListRes: PaginatedResponse & { sales_channels: SalesChannel[] }

Schema

AdminSalesChannelsListRes type: object required:

sales_channels
count
offset
limit properties: sales_channels: type: array description: "An array of sales channels details." items: $ref: "#/components/schemas/SalesChannel" count: type: integer description: The total number of items available offset: type: integer description: The number of items skipped before the returned results limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:85

AdminSalesChannelsRes

Ƭ AdminSalesChannelsRes: Object

Schema

AdminSalesChannelsRes type: object required:

sales_channel properties: sales_channel: description: Sales Channel's details. $ref: "#/components/schemas/SalesChannel"

Type declaration

Name	Type
`sales_channel`	`SalesChannel`

Defined in

packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:16

AdminShippingOptionsDeleteRes

Ƭ AdminShippingOptionsDeleteRes: DeleteResponse

Schema

AdminShippingOptionsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Shipping Option. object: type: string description: The type of the object that was deleted. default: shipping-option deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:86

AdminShippingOptionsListRes

Ƭ AdminShippingOptionsListRes: PaginatedResponse & { shipping_options: ShippingOption[] }

Schema

AdminShippingOptionsListRes type: object x-expanded-relations: field: shipping_options relations: - profile - region - requirements eager: - region.fulfillment_providers - region.payment_providers required:

shipping_options
count
offset
limit properties: shipping_options: type: array description: "An array of shipping options details." items: $ref: "#/components/schemas/ShippingOption" count: type: integer description: The total number of items available offset: type: integer description: The number of shipping options skipped when retrieving the shipping options. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:41

AdminShippingOptionsRes

Ƭ AdminShippingOptionsRes: Object

Schema

AdminShippingOptionsRes type: object x-expanded-relations: field: shipping_option relations: - profile - region - requirements eager: - region.fulfillment_providers - region.payment_providers required:

shipping_option properties: shipping_option: description: "Shipping option details." $ref: "#/components/schemas/ShippingOption"

Type declaration

Name	Type
`shipping_option`	`ShippingOption`

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:63

AdminShippingProfilesListRes

Ƭ AdminShippingProfilesListRes: Object

Schema

AdminShippingProfilesListRes type: object required:

shipping_profiles properties: shipping_profiles: type: array description: An array of shipping profiles details. items: $ref: "#/components/schemas/ShippingProfile"

Type declaration

Name	Type
`shipping_profiles`	`ShippingProfile`[]

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:59

AdminShippingProfilesRes

Ƭ AdminShippingProfilesRes: Object

Schema

AdminShippingProfilesRes type: object x-expanded-relations: field: shipping_profile relations: - products - shipping_options required:

shipping_profile properties: shipping_profile: description: Shipping profile details. $ref: "#/components/schemas/ShippingProfile"

Type declaration

Name	Type
`shipping_profile`	`ShippingProfile`

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:44

AdminStockLocationsDeleteRes

Ƭ AdminStockLocationsDeleteRes: DeleteResponse

Schema

AdminStockLocationsDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Stock Location. object: type: string description: The type of the object that was deleted. default: stock_location deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:26

AdminStockLocationsListRes

Ƭ AdminStockLocationsListRes: PaginatedResponse & { stock_locations: StockLocationExpandedDTO[] }

Schema

AdminStockLocationsListRes type: object required:

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

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:63

AdminStockLocationsRes

Ƭ AdminStockLocationsRes: Object

Schema

AdminStockLocationsRes type: object required:

stock_location properties: stock_location: description: "Stock location details." $ref: "#/components/schemas/StockLocationExpandedDTO"

Type declaration

Name	Type
`stock_location`	`StockLocationExpandedDTO`

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:37

AdminStoresRes

Ƭ AdminStoresRes: Object

Schema

AdminStoresRes type: object required:

store properties: store: description: Store details. $ref: "#/components/schemas/Store"

Type declaration

Name	Type
`store`	`Store`

Defined in

packages/medusa/dist/api/routes/admin/store/index.d.ts:34

AdminSwapsListRes

Ƭ AdminSwapsListRes: PaginatedResponse & { swaps: Swap[] }

Schema

AdminSwapsListRes type: object required:

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

Defined in

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

AdminSwapsRes

Ƭ AdminSwapsRes: Object

Schema

AdminSwapsRes type: object x-expanded-relations: field: swap relations: - additional_items - additional_items.adjustments - cart - cart.items - cart.items.adjustments - cart.items.variant - fulfillments - order - payment - return_order - shipping_address - shipping_methods eager: - fulfillments.items - shipping_methods.shipping_option required:

swap properties: swap: description: "Swap details." $ref: "#/components/schemas/Swap"

Type declaration

Name	Type
`swap`	`Swap`

Defined in

packages/medusa/dist/api/routes/admin/swaps/index.d.ts:62

AdminTaxProvidersList

Ƭ AdminTaxProvidersList: Object

Schema

AdminTaxProvidersList type: object required:

tax_providers properties: tax_providers: type: array description: An array of tax providers details. items: $ref: "#/components/schemas/TaxProvider"

Type declaration

Name	Type
`tax_providers`	`TaxProvider`[]

Defined in

packages/medusa/dist/api/routes/admin/store/index.d.ts:49

AdminTaxRatesDeleteRes

Ƭ AdminTaxRatesDeleteRes: DeleteResponse

Schema

AdminTaxRatesDeleteRes type: object required:

id
object
deleted properties: id: type: string description: The ID of the deleted Shipping Option. object: type: string description: The type of the object that was deleted. default: tax-rate deleted: type: boolean description: Whether or not the items were deleted. default: true

Defined in

packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:27

AdminTaxRatesListRes

Ƭ AdminTaxRatesListRes: PaginatedResponse & { tax_rates: TaxRate[] }

Schema

AdminTaxRatesListRes type: object required:

tax_rates
count
offset
limit properties: tax_rates: type: array description: "An array of tax rate details." items: $ref: "#/components/schemas/TaxRate" count: type: integer description: The total number of items available offset: type: integer description: The number of tax rates to skip when retrieving the tax rates. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:52

AdminTaxRatesRes

Ƭ AdminTaxRatesRes: Object

Schema

AdminTaxRatesRes type: object required:

tax_rate properties: tax_rate: description: "Tax rate details." $ref: "#/components/schemas/TaxRate"

Type declaration

Name	Type
`tax_rate`	`TaxRate`

Defined in

packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:65

AdminUploadsDownloadUrlRes

Ƭ AdminUploadsDownloadUrlRes: Object

Schema

AdminUploadsDownloadUrlRes type: object required:

download_url properties: download_url: description: The Download URL of the file type: string

Type declaration

Name	Type
`download_url`	`string`

Defined in

packages/medusa/dist/api/routes/admin/uploads/index.d.ts:62

AdminUploadsRes

Ƭ AdminUploadsRes: Object

Schema

AdminUploadsRes type: object required:

uploads properties: uploads: type: array description: "Uploaded files details." items: type: object required: - url - key properties: url: description: The URL of the uploaded file. type: string format: uri key: description: The key of the file that is identifiable by the file service. It can be used later to retrieve or manipulate the file. type: string

Type declaration

Name	Type
`uploads`	`FileServiceUploadResult`[]

Defined in

packages/medusa/dist/api/routes/admin/uploads/index.d.ts:28

AdminUserRes

Ƭ AdminUserRes: Object

Schema

AdminUserRes type: object required:

user properties: user: description: "User details." $ref: "#/components/schemas/User"

Type declaration

Name	Type
`user`	`Omit`<`User`, `"password_hash"`>

Defined in

packages/medusa/dist/api/routes/admin/users/index.d.ts:16

AdminUsersListRes

Ƭ AdminUsersListRes: Object

Schema

AdminUsersListRes type: object required:

users properties: users: type: array description: "An array of users details." items: $ref: "#/components/schemas/User"

Type declaration

Name	Type
`users`	`Omit`<`User`, `"password_hash"`>[]

Defined in

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

AdminVariantsListRes

Ƭ AdminVariantsListRes: PaginatedResponse & { variants: PricedVariant[] }

Schema

AdminVariantsListRes type: object x-expanded-relations: field: variants relations: - options - prices - product totals: - purchasable required:

variants
count
offset
limit properties: variants: type: array description: "An array of product variant details." items: $ref: "#/components/schemas/PricedVariant" count: type: integer description: The total number of items available offset: type: integer description: The number of product variants skipped when retrieving the product variants. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/variants/index.d.ts:40

AdminVariantsRes

Ƭ AdminVariantsRes: Object

Schema

AdminVariantsRes type: object x-expanded-relations: field: variant relations: - options - prices - product required:

variant properties: variant: description: "Product variant's details." $ref: "#/components/schemas/PricedVariant"

Type declaration

Name	Type
`variant`	`PricedVariant`

Defined in

packages/medusa/dist/api/routes/admin/variants/index.d.ts:59

BatchJobCreateProps

Ƭ BatchJobCreateProps: Pick<BatchJob, "context" | "type" | "created_by" | "dry_run">

Defined in

packages/medusa/dist/types/batch-job.d.ts:36

BatchJobUpdateProps

Ƭ BatchJobUpdateProps: Partial<Pick<BatchJob, "context" | "result">>

Defined in

packages/medusa/dist/types/batch-job.d.ts:12

CartCompletionResponse

Ƭ CartCompletionResponse: Object

Type declaration

Name	Type	Description
`response_body`	`Record`<`string`, `unknown`>	The response body for the completion request
`response_code`	`number`	The response code for the completion request

Defined in

packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:4

ClassConstructor

Ƭ ClassConstructor<T>: (...args: unknown[]) => T

Type parameters

Name
`T`

Type declaration

• new ClassConstructor(...args): T

Parameters

Name	Type
`...args`	`unknown`[]

Returns

T

Defined in

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

ConfigModule

Ƭ ConfigModule: ConfigModule

Defined in

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

Constructor

Ƭ Constructor<T>: Object

Type parameters

Name
`T`

Defined in

packages/medusa/dist/types/global.d.ts:47

CreateBatchJobInput

Ƭ CreateBatchJobInput: Object

Type declaration

Name	Type
`context`	`BatchJob`[`"context"`]
`dry_run`	`boolean`
`type`	`string`

Defined in

packages/medusa/dist/types/batch-job.d.ts:13

CreatePriceListInput

Ƭ CreatePriceListInput: Object

Type declaration

Name	Type
`customer_groups?`	{ `id`: `string` }[]
`description`	`string`
`ends_at?`	`Date`
`includes_tax?`	`boolean`
`name`	`string`
`prices`	`AdminPriceListPricesCreateReq`[]
`starts_at?`	`Date`
`status?`	`PriceListStatus`
`type`	`PriceListType`

Defined in

packages/medusa/dist/types/price-list.d.ts:40

Data

Ƭ Data: Record<string, unknown>

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:3

DecoratedInventoryItemDTO

Ƭ DecoratedInventoryItemDTO: InventoryItemDTO & { location_levels?: InventoryLevelDTO[] ; reserved_quantity: number ; stocked_quantity: number ; variants?: ProductVariant[] }

Schema

DecoratedInventoryItemDTO type: object allOf:

$ref: "#/components/schemas/InventoryItemDTO"
type: object required:
- stocked_quantity
- reserved_quantity properties: location_levels: type: array description: An array of location level details items: $ref: "#/components/schemas/InventoryLevelDTO" variants: type: array description: An array of product variant details items: $ref: "#/components/schemas/ProductVariant" stocked_quantity: type: number description: The total quantity of the item in stock across levels reserved_quantity: type: number description: The total quantity of the item available across levels

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:98

DeleteResponse

Ƭ DeleteResponse: Object

Type declaration

Name	Type
`deleted`	`boolean`
`id`	`string`
`object`	`string`

Defined in

packages/medusa/dist/types/common.d.ts:75

ExtendedFindConfig

Ƭ ExtendedFindConfig<TEntity>: Omit<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/medusa/dist/types/common.d.ts:28

ExtendedRequest

Ƭ ExtendedRequest<TEntity>: Request & { resource: TEntity }

Type parameters

Name
`TEntity`

Defined in

packages/medusa/dist/types/global.d.ts:25

ExtendedReservationItem

Ƭ ExtendedReservationItem: ReservationItemDTO & { inventory_item?: InventoryItemDTO ; line_item?: LineItem }

Schema

ExtendedReservationItem type: object allOf:

$ref: "#/components/schemas/ReservationItemDTO"
type: object properties: line_item: description: The line item associated with the reservation. $ref: "#/components/schemas/LineItem" inventory_item: description: The inventory item associated with the reservation. $ref: "#/components/schemas/InventoryItemDTO"

Defined in

packages/medusa/dist/api/routes/admin/reservations/index.d.ts:33

ItemTaxCalculationLine

Ƭ ItemTaxCalculationLine: Object

A line item and the tax rates that have been configured to apply to the product contained in the line item.

Type declaration

Name	Type
`item`	`LineItem`
`rates`	`TaxServiceRate`[]

Defined in

packages/medusa/dist/interfaces/tax-service.d.ts:21

LevelWithAvailability

Ƭ LevelWithAvailability: InventoryLevelDTO & { available_quantity: number }

Defined in

packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:56

Logger

Ƭ Logger: Object

Type declaration

Name	Type
`activity`	(`message`: `string`, `config?`: `any`) => `void`
`debug`	(`message`: `any`) => `void`
`error`	(`messageOrError`: `any`, `error?`: `any`) => `void`
`failure`	(`activityId`: `any`, `message`: `any`) => `void`
`info`	(`message`: `any`) => `void`
`log`	(...`args`: `any`[]) => `void`
`panic`	(`data`: `any`) => `void`
`progress`	(`activityId`: `any`, `message`: `any`) => `void`
`setLogLevel`	(`level`: `string`) => `void`
`shouldLog`	(`level`: `string`) => `void`
`success`	(`activityId`: `any`, `message`: `any`) => `void`
`unsetLogLevel`	() => `void`
`warn`	(`message`: `any`) => `void`

Defined in

packages/medusa/dist/types/global.d.ts:32

MedusaContainer

Ƭ MedusaContainer: MedusaContainer

Defined in

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

PartialPick

Ƭ PartialPick<T, K>: { [P in K]?: T[P] }

Type parameters

Name	Type
`T`	`T`
`K`	extends keyof `T`

Defined in

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

PaymentContext

Ƭ PaymentContext: Object

Type declaration

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

Defined in

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

PaymentData

Ƭ PaymentData: Data

Defined in

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

PaymentProcessorContext

Ƭ PaymentProcessorContext: Object

Type declaration

Name	Type
`amount`	`number`
`billing_address?`	`Address` \| `null`
`context`	`Record`<`string`, `unknown`>
`currency_code`	`string`
`customer?`	`Customer`
`email`	`string`
`paymentSessionData`	`Record`<`string`, `unknown`>
`resource_id`	`string`

Defined in

packages/medusa/dist/interfaces/payment-processor.d.ts:3

PaymentProcessorSessionResponse

Ƭ PaymentProcessorSessionResponse: Object

Type declaration

Name	Type
`session_data`	`Record`<`string`, `unknown`>
`update_requests?`	{ `customer_metadata?`: `Record`<`string`, `unknown`> }
`update_requests.customer_metadata?`	`Record`<`string`, `unknown`>

Defined in

packages/medusa/dist/interfaces/payment-processor.d.ts:13

PaymentSessionData

Ƭ PaymentSessionData: Data

Defined in

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

PaymentSessionResponse

Ƭ PaymentSessionResponse: Object

Type declaration

Name	Type
`session_data`	`Record`<`string`, `unknown`>
`update_requests`	{ `customer_metadata`: `Record`<`string`, `unknown`> }
`update_requests.customer_metadata`	`Record`<`string`, `unknown`>

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:21

PriceListLoadConfig

Ƭ PriceListLoadConfig: Object

Type declaration

Name	Type
`cart_id?`	`string`
`currency_code?`	`string`
`customer_id?`	`string`
`include_discount_prices?`	`boolean`
`region_id?`	`string`

Defined in

packages/medusa/dist/types/price-list.d.ts:76

PriceListPriceCreateInput

Ƭ PriceListPriceCreateInput: Object

Type declaration

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

Defined in

packages/medusa/dist/types/price-list.d.ts:68

PriceListPriceUpdateInput

Ƭ PriceListPriceUpdateInput: Object

Type declaration

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

Defined in

packages/medusa/dist/types/price-list.d.ts:59

PriceSelectionContext

Ƭ PriceSelectionContext: Object

Type declaration

Name	Type
`cart_id?`	`string`
`currency_code?`	`string`
`customer_id?`	`string`
`ignore_cache?`	`boolean`
`include_discount_prices?`	`boolean`
`quantity?`	`number`
`region_id?`	`string`
`tax_rates?`	`TaxServiceRate`[]

Defined in

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

PriceSelectionResult

Ƭ PriceSelectionResult: Object

Type declaration

Name	Type
`calculatedPrice`	`number` \| `null`
`calculatedPriceIncludesTax?`	`boolean` \| `null`
`calculatedPriceType?`	`PriceType`
`originalPrice`	`number` \| `null`
`originalPriceIncludesTax?`	`boolean` \| `null`
`prices`	`MoneyAmount`[]

Defined in

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

PriceType

Ƭ PriceType: DefaultPriceType | PriceListType

Defined in

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

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

QueryConfig

Ƭ QueryConfig<TEntity>: Object

Type parameters

Name	Type
`TEntity`	extends `BaseEntity`

Type declaration

Name	Type
`allowedFields?`	`string`[]
`allowedRelations?`	`string`[]
`defaultFields?`	(keyof `TEntity` \| `string`)[]
`defaultLimit?`	`number`
`defaultRelations?`	`string`[]
`isList?`	`boolean`

Defined in

packages/medusa/dist/types/common.d.ts:55

QuerySelector

Ƭ QuerySelector<TEntity>: Selector<TEntity> & { q?: string }

Type parameters

Name
`TEntity`

Defined in

packages/medusa/dist/types/common.d.ts:36

RequestQueryFields

Ƭ RequestQueryFields: Object

Type declaration

Name	Type
`expand?`	`string`
`fields?`	`string`
`limit?`	`number`
`offset?`	`number`
`order?`	`string`

Defined in

packages/medusa/dist/types/common.d.ts:63

ResponseInventoryItem

Ƭ ResponseInventoryItem: Partial<InventoryItemDTO> & { location_levels?: LevelWithAvailability[] }

Schema

ResponseInventoryItem allOf:

$ref: "#/components/schemas/InventoryItemDTO"
type: object properties: location_levels: type: array description: The inventory's location levels. items: allOf: - $ref: "#/components/schemas/InventoryItemDTO" - type: object required: - available_quantity properties: available_quantity: description: The available quantity in the inventory location. type: number

Defined in

packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:79

Selector

Ƭ Selector<TEntity>: { [key in keyof TEntity]?: TEntity[key] | TEntity[key][] | DateComparisonOperator | StringComparisonOperator | NumericalComparisonOperator | FindOperator<TEntity[key][] | string | string[]> }

Type parameters

Name
`TEntity`

Defined in

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

ShippingTaxCalculationLine

Ƭ ShippingTaxCalculationLine: Object

A shipping method and the tax rates that have been configured to apply to the shipping method.

Type declaration

Name	Type
`rates`	`TaxServiceRate`[]
`shipping_method`	`ShippingMethod`

Defined in

packages/medusa/dist/interfaces/tax-service.d.ts:13

StoreAuthRes

Ƭ StoreAuthRes: Object

Schema

StoreAuthRes type: object x-expanded-relations: field: customer relations: - orders - orders.items - shipping_addresses required:

customer properties: customer: description: "Customer's details." $ref: "#/components/schemas/Customer"

Type declaration

Name	Type
`customer`	`Customer`

Defined in

packages/medusa/dist/api/routes/store/auth/index.d.ts:21

StoreBearerAuthRes

Ƭ StoreBearerAuthRes: Object

Schema

StoreBearerAuthRes type: object properties: accessToken: description: Access token for subsequent authorization. type: string

Type declaration

Name	Type
`access_token`	`string`

Defined in

packages/medusa/dist/api/routes/store/auth/index.d.ts:32

StoreCartShippingOptionsListRes

Ƭ StoreCartShippingOptionsListRes: Object

Schema

StoreCartShippingOptionsListRes type: object x-expanded-relations: field: shipping_options implicit: - profile - requirements required:

shipping_options properties: shipping_options: type: array description: "An array of shipping options details." items: $ref: "#/components/schemas/PricedShippingOption"

Type declaration

Name	Type
`shipping_options`	`PricedShippingOption`[]

Defined in

packages/medusa/dist/api/routes/store/shipping-options/index.d.ts:41

StoreCartsRes

Ƭ StoreCartsRes: Object

Schema

StoreCartsRes type: object x-expanded-relations: field: cart relations: - billing_address - discounts - discounts.rule - gift_cards - items - items.adjustments - items.variant - payment - payment_sessions - region - region.countries - region.payment_providers - shipping_address - shipping_methods eager: - region.fulfillment_providers - region.payment_providers - shipping_methods.shipping_option implicit: - items - items.variant - items.variant.product - items.variant.product.profiles - items.tax_lines - items.adjustments - gift_cards - discounts - discounts.rule - shipping_methods - shipping_methods.tax_lines - shipping_address - region - region.tax_rates totals: - discount_total - gift_card_tax_total - gift_card_total - item_tax_total - refundable_amount - refunded_total - shipping_tax_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required:

cart properties: cart: description: "Cart details." $ref: "#/components/schemas/Cart"

Type declaration

Name	Type
`cart`	`Omit`<`Cart`, `"refundable_amount"` \| `"refunded_total"`>

Defined in

packages/medusa/dist/api/routes/store/carts/index.d.ts:73

StoreCollectionsListRes

Ƭ StoreCollectionsListRes: PaginatedResponse & { collections: ProductCollection[] }

Schema

StoreCollectionsListRes type: object required:

collections
count
offset
limit properties: collections: type: array description: "An array of product collections details" items: $ref: "#/components/schemas/ProductCollection" count: type: integer description: The total number of items available offset: type: integer description: The number of product collections skipped when retrieving the product collections. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/store/collections/index.d.ts:31

StoreCollectionsRes

Ƭ StoreCollectionsRes: Object

Schema

StoreCollectionsRes type: object required:

collection properties: collection: description: "Product collection details." $ref: "#/components/schemas/ProductCollection"

Type declaration

Name	Type
`collection`	`ProductCollection`

Defined in

packages/medusa/dist/api/routes/store/collections/index.d.ts:44

StoreCompleteCartRes

Ƭ StoreCompleteCartRes: { data: Cart ; type: "cart" } | { data: Order ; type: "order" } | { data: Swap ; type: "swap" }

Schema

StoreCompleteCartRes type: object required:

type
data properties: type: type: string description: "The type of the data property. If the cart completion fails, type will be cart and the data object will be the cart's details. If the cart completion is successful and the cart is used for checkout, type will be order and the data object will be the order's details. If the cart completion is successful and the cart is used for swap creation, type will be swap and the data object will be the swap's details." enum: [order, cart, swap] data: type: object description: The data of the result object. Its type depends on the type field. oneOf:
- type: object allOf:
  - description: Cart was successfully authorized and order was placed successfully.
  - $ref: "#/components/schemas/Order"
- type: object allOf:
  - description: Cart was successfully authorized but requires further actions.
  - $ref: "#/components/schemas/Cart"
- type: object allOf:
  - description: Cart was used for a swap and it has been completed successfully.
  - $ref: "#/components/schemas/Swap"

Defined in

packages/medusa/dist/api/routes/store/carts/index.d.ts:106

StoreCustomersListOrdersRes

Ƭ StoreCustomersListOrdersRes: PaginatedResponse & { orders: Order[] }

Schema

StoreCustomersListOrdersRes type: object x-expanded-relations: field: orders relations: - customer - discounts - discounts.rule - fulfillments - fulfillments.tracking_links - items - items.variant - payments - region - shipping_address - shipping_methods eager: - region.fulfillment_providers - region.payment_providers - shipping_methods.shipping_option implicit: - claims - claims.additional_items - claims.additional_items.adjustments - claims.additional_items.refundable - claims.additional_items.tax_lines - customer - discounts - discounts.rule - gift_card_transactions - gift_card_transactions.gift_card - gift_cards - items - items.adjustments - items.refundable - items.tax_lines - items.variant - items.variant.product - items.variant.product.profiles - refunds - region - shipping_address - shipping_methods - shipping_methods.tax_lines - swaps - swaps.additional_items - swaps.additional_items.adjustments - swaps.additional_items.refundable - swaps.additional_items.tax_lines totals: - discount_total - gift_card_tax_total - gift_card_total - paid_total - refundable_amount - refunded_total - shipping_total - subtotal - tax_total - total - claims.additional_items.discount_total - claims.additional_items.gift_card_total - claims.additional_items.original_tax_total - claims.additional_items.original_total - claims.additional_items.refundable - claims.additional_items.subtotal - claims.additional_items.tax_total - claims.additional_items.total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total - swaps.additional_items.discount_total - swaps.additional_items.gift_card_total - swaps.additional_items.original_tax_total - swaps.additional_items.original_total - swaps.additional_items.refundable - swaps.additional_items.subtotal - swaps.additional_items.tax_total - swaps.additional_items.total required:

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

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:146

StoreCustomersListPaymentMethodsRes

Ƭ StoreCustomersListPaymentMethodsRes: Object

Schema

StoreCustomersListPaymentMethodsRes type: object required:

payment_methods properties: payment_methods: type: array description: "An array of saved payment method details." items: type: object required: - provider_id - data properties: provider_id: description: The ID of the Payment Provider where the payment method is saved. type: string data: description: The data needed for the Payment Provider to use the saved payment method. type: object

Type declaration

Name	Type
`payment_methods`	{ `data`: `object` ; `provider_id`: `string` }[]

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:171

StoreCustomersRes

Ƭ StoreCustomersRes: Object

Schema

StoreCustomersRes type: object x-expanded-relations: field: customer relations: - billing_address - shipping_addresses required:

customer properties: customer: description: "Customer details." $ref: "#/components/schemas/Customer"

Type declaration

Name	Type
`customer`	`Omit`<`Customer`, `"password_hash"`>

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:24

StoreCustomersResetPasswordRes

Ƭ StoreCustomersResetPasswordRes: Object

Schema

StoreCustomersResetPasswordRes type: object required:

customer properties: customer: description: "Customer details." $ref: "#/components/schemas/Customer"

Type declaration

Name	Type
`customer`	`Omit`<`Customer`, `"password_hash"`>

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:37

StoreGetAuthEmailRes

Ƭ StoreGetAuthEmailRes: Object

Schema

StoreGetAuthEmailRes type: object required:

exists properties: exists: description: Whether email exists or not. type: boolean

Type declaration

Name	Type
`exists`	`boolean`

Defined in

packages/medusa/dist/api/routes/store/auth/index.d.ts:45

StoreGetProductCategoriesCategoryRes

Ƭ StoreGetProductCategoriesCategoryRes: Object

Schema

StoreGetProductCategoriesCategoryRes type: object x-expanded-relations: field: product_category relations: - category_children - parent_category required:

product_category properties: product_category: description: "Product category details." $ref: "#/components/schemas/ProductCategory"

Type declaration

Name	Type
`product_category`	`ProductCategory`

Defined in

packages/medusa/dist/api/routes/store/product-categories/index.d.ts:27

StoreGetProductCategoriesRes

Ƭ StoreGetProductCategoriesRes: PaginatedResponse & { product_categories: ProductCategory[] }

Schema

StoreGetProductCategoriesRes type: object x-expanded-relations: field: product_categories relations: - category_children - parent_category required:

product_categories
count
offset
limit properties: product_categories: type: array description: "An array of product categories details." items: $ref: "#/components/schemas/ProductCategory" count: type: integer description: The total number of items available offset: type: integer description: The number of product categories skipped when retrieving the product categories. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/store/product-categories/index.d.ts:59

StoreGiftCardsRes

Ƭ StoreGiftCardsRes: Object

Schema

StoreGiftCardsRes type: object required:

gift_card properties: gift_card: description: "Gift card details." $ref: "#/components/schemas/GiftCard"

Type declaration

Name	Type
`gift_card`	`GiftCard`

Defined in

packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:18

StoreOrderEditsRes

Ƭ StoreOrderEditsRes: Object

Schema

StoreOrderEditsRes type: object x-expanded-relations: field: order_edit relations: - changes - changes.line_item - changes.line_item.variant - changes.original_line_item - changes.original_line_item.variant - items - items.adjustments - items.tax_lines - items.variant - payment_collection implicit: - items - items.tax_lines - items.adjustments - items.variant totals: - difference_due - discount_total - gift_card_tax_total - gift_card_total - shipping_total - subtotal - tax_total - total - items.discount_total - items.gift_card_total - items.original_tax_total - items.original_total - items.refundable - items.subtotal - items.tax_total - items.total required:

order_edit properties: order_edit: description: "Order edit details." $ref: "#/components/schemas/OrderEdit"

Type declaration

Name	Type
`order_edit`	`Omit`<`OrderEdit`, `"internal_note"` \| `"created_by"` \| `"confirmed_by"` \| `"canceled_by"`>

Defined in

packages/medusa/dist/api/routes/store/order-edits/index.d.ts:49

StoreOrdersRes

Ƭ StoreOrdersRes: Object

Schema

StoreOrdersRes type: object required:

order x-expanded-relations: field: order relations:
- customer
- discounts
- discounts.rule
- fulfillments
- fulfillments.tracking_links
- items
- items.variant
- payments
- region
- shipping_address
- shipping_methods eager:
- fulfillments.items
- region.fulfillment_providers
- region.payment_providers
- shipping_methods.shipping_option implicit:
- claims
- claims.additional_items
- claims.additional_items.adjustments
- claims.additional_items.refundable
- claims.additional_items.tax_lines
- discounts
- discounts.rule
- gift_card_transactions
- gift_card_transactions.gift_card
- gift_cards
- items
- items.adjustments
- items.refundable
- items.tax_lines
- items.variant
- items.variant.product
- items.variant.product.profiles
- refunds
- region
- shipping_methods
- shipping_methods.tax_lines
- swaps
- swaps.additional_items
- swaps.additional_items.adjustments
- swaps.additional_items.refundable
- swaps.additional_items.tax_lines totals:
- discount_total
- gift_card_tax_total
- gift_card_total
- paid_total
- refundable_amount
- refunded_total
- shipping_total
- subtotal
- tax_total
- total
- claims.additional_items.discount_total
- claims.additional_items.gift_card_total
- claims.additional_items.original_tax_total
- claims.additional_items.original_total
- claims.additional_items.refundable
- claims.additional_items.subtotal
- claims.additional_items.tax_total
- claims.additional_items.total
- items.discount_total
- items.gift_card_total
- items.original_tax_total
- items.original_total
- items.refundable
- items.subtotal
- items.tax_total
- items.total
- swaps.additional_items.discount_total
- swaps.additional_items.gift_card_total
- swaps.additional_items.original_tax_total
- swaps.additional_items.original_total
- swaps.additional_items.refundable
- swaps.additional_items.subtotal
- swaps.additional_items.tax_total
- swaps.additional_items.total properties: order: description: "Order details." $ref: "#/components/schemas/Order"

Type declaration

Name	Type
`order`	`Order`

Defined in

packages/medusa/dist/api/routes/store/orders/index.d.ts:100

StorePaymentCollectionsRes

Ƭ StorePaymentCollectionsRes: Object

Schema

StorePaymentCollectionsRes type: object x-expanded-relations: field: payment_collection relations: - payment_sessions - region eager: - region.fulfillment_providers - region.payment_providers required:

payment_collection properties: payment_collection: description: "Payment collection's details." $ref: "#/components/schemas/PaymentCollection"

Type declaration

Name	Type
`payment_collection`	`PaymentCollection`

Defined in

packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:25

StorePaymentCollectionsSessionRes

Ƭ StorePaymentCollectionsSessionRes: Object

Schema

StorePaymentCollectionsSessionRes type: object required:

payment_session properties: payment_session: description: "Payment session's details." $ref: "#/components/schemas/PaymentSession"

Type declaration

Name	Type
`payment_session`	`PaymentSession`

Defined in

packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:38

StorePostSearchRes

Ƭ StorePostSearchRes: { hits: unknown[] } & Record<string, unknown>

Schema

StorePostSearchRes allOf:

type: object required:
- hits properties: hits: description: "Array of search results. The format of the items depends on the search engine installed on the Medusa backend." type: array
type: object

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:86

StoreProductTagsListRes

Ƭ StoreProductTagsListRes: PaginatedResponse & { product_tags: ProductTag[] }

Schema

StoreProductTagsListRes type: object required:

product_tags
count
offset
limit properties: product_tags: type: array description: "An array of product tags details." items: $ref: "#/components/schemas/ProductTag" count: type: integer description: The total number of items available offset: type: integer description: The number of product tags skipped when retrieving the product tags. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/store/product-tags/index.d.ts:33

StoreProductTypesListRes

Ƭ StoreProductTypesListRes: PaginatedResponse & { product_types: ProductType[] }

Schema

StoreProductTypesListRes type: object required:

product_types
count
offset
limit properties: product_types: type: array description: "An array of product types details." items: $ref: "#/components/schemas/ProductType" count: type: integer description: The total number of items available offset: type: integer description: The number of product types skipped when retrieving the product types. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/store/product-types/index.d.ts:33

StoreProductsListRes

Ƭ StoreProductsListRes: PaginatedResponse & { products: PricedProduct[] }

Schema

StoreProductsListRes type: object x-expanded-relations: field: products relations: - collection - images - options - options.values - tags - type - variants - variants.options - variants.prices totals: - variants.purchasable required:

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

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:127

StoreProductsRes

Ƭ StoreProductsRes: Object

Schema

StoreProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - options.values - tags - type - variants - variants.options - variants.prices totals: - variants.purchasable required:

product properties: product: description: "Product details." $ref: "#/components/schemas/PricedProduct"

Type declaration

Name	Type
`product`	`PricedProduct`

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:71

StoreRegionsListRes

Ƭ StoreRegionsListRes: PaginatedResponse & { regions: Region[] }

Schema

StoreRegionsListRes type: object x-expanded-relations: field: regions relations: - countries - payment_providers - fulfillment_providers eager: - payment_providers - fulfillment_providers required:

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

Defined in

packages/medusa/dist/api/routes/store/regions/index.d.ts:36

StoreRegionsRes

Ƭ StoreRegionsRes: Object

Schema

StoreRegionsRes type: object x-expanded-relations: field: region relations: - countries - payment_providers - fulfillment_providers eager: - payment_providers - fulfillment_providers required:

region properties: region: description: "Region details." $ref: "#/components/schemas/Region"

Type declaration

Name	Type
`region`	`Region`

Defined in

packages/medusa/dist/api/routes/store/regions/index.d.ts:58

StoreReturnReasonsListRes

Ƭ StoreReturnReasonsListRes: Object

Schema

StoreReturnReasonsListRes type: object x-expanded-relations: field: return_reasons relations: - parent_return_reason - return_reason_children required:

return_reasons properties: return_reasons: type: array description: "An array of return reasons details." items: $ref: "#/components/schemas/ReturnReason"

Type declaration

Name	Type
`return_reasons`	`ReturnReason`[]

Defined in

packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:23

StoreReturnReasonsRes

Ƭ StoreReturnReasonsRes: Object

Schema

StoreReturnReasonsRes type: object x-expanded-relations: field: return_reason relations: - parent_return_reason - return_reason_children required:

return_reason properties: return_reason: description: "Return reason details." $ref: "#/components/schemas/ReturnReason"

Type declaration

Name	Type
`return_reason`	`ReturnReason`

Defined in

packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:41

StoreReturnsRes

Ƭ StoreReturnsRes: Object

Schema

StoreReturnsRes type: object x-expanded-relations: field: return relations: - items - items.reason eager: - items required:

return properties: return: description: "Return details." $ref: "#/components/schemas/Return"

Type declaration

Name	Type
`return`	`Return`

Defined in

packages/medusa/dist/api/routes/store/returns/index.d.ts:22

StoreShippingOptionsListRes

Ƭ StoreShippingOptionsListRes: Object

Schema

StoreShippingOptionsListRes type: object x-expanded-relations: field: shipping_options relations: - requirements required:

shipping_options properties: shipping_options: type: array description: "An array of shipping options details." items: $ref: "#/components/schemas/PricedShippingOption"

Type declaration

Name	Type
`shipping_options`	`PricedShippingOption`[]

Defined in

packages/medusa/dist/api/routes/store/shipping-options/index.d.ts:21

StoreSwapsRes

Ƭ StoreSwapsRes: Object

Schema

StoreSwapsRes type: object x-expanded-relations: field: swap relations: - additional_items - additional_items.variant - cart - fulfillments - order - payment - return_order - return_order.shipping_method - shipping_address - shipping_methods eager: - fulfillments.items required:

swap properties: swap: description: "Swap details." $ref: "#/components/schemas/Swap"

Type declaration

Name	Type
`swap`	`Swap`

Defined in

packages/medusa/dist/api/routes/store/swaps/index.d.ts:32

StoreVariantsListRes

Ƭ StoreVariantsListRes: Object

Schema

StoreVariantsListRes type: object x-expanded-relations: field: variants relations: - prices - options - product totals: - purchasable required:

variants properties: variants: type: array description: "An array of product variant descriptions." items: $ref: "#/components/schemas/PricedVariant"

Type declaration

Name	Type
`variants`	`PricedVariant`[]

Defined in

packages/medusa/dist/api/routes/store/variants/index.d.ts:47

StoreVariantsRes

Ƭ StoreVariantsRes: Object

Schema

StoreVariantsRes type: object x-expanded-relations: field: variant relations: - prices - options - product totals: - purchasable required:

variant properties: variant: description: "Product variant description." $ref: "#/components/schemas/PricedVariant"

Type declaration

Name	Type
`variant`	`PricedVariant`

Defined in

packages/medusa/dist/api/routes/store/variants/index.d.ts:24

TaxCalculationContext

Ƭ TaxCalculationContext: Object

Information relevant to a tax calculation, such as the shipping address where the items are going.

Type declaration

Name	Type
`allocation_map`	`LineAllocationsMap`
`customer`	`Customer`
`is_return`	`boolean`
`region`	`Region`
`shipping_address`	`Address` \| `null`
`shipping_methods`	`ShippingMethod`[]

Defined in

packages/medusa/dist/interfaces/tax-service.d.ts:29

TotalField

Defined in

packages/medusa/dist/types/common.d.ts:45

TreeQuerySelector

Ƭ TreeQuerySelector<TEntity>: QuerySelector<TEntity> & { include_descendants_tree?: boolean }

Type parameters

Name
`TEntity`

Defined in

packages/medusa/dist/types/common.d.ts:39

UpdatePriceListInput

Ƭ UpdatePriceListInput: Partial<Pick<PriceList, "name" | "description" | "starts_at" | "ends_at" | "status" | "type" | "includes_tax">> & { customer_groups?: { id: string }[] ; prices?: AdminPriceListPricesUpdateReq[] }

Defined in

packages/medusa/dist/types/price-list.d.ts:53

VariantInventory

Ƭ VariantInventory: Object

Schema

VariantInventory type: object required:

id
inventory
sales_channel_availability properties: id: description: the ID of the variant type: string inventory: description: The inventory details. $ref: "#/components/schemas/ResponseInventoryItem" sales_channel_availability: type: array description: An array of details about the variant's inventory availability in sales channels. items: type: object required: - channel_name - channel_id - available_quantity properties: channel_name: description: Sales channel's name type: string channel_id: description: Sales channel's ID type: string available_quantity: description: Available quantity in the sales channel type: number

Type declaration

Name	Type
`id`	`string`
`inventory`	`ResponseInventoryItem`[]
`sales_channel_availability`	{ `available_quantity`: `number` ; `channel_id`: `string` ; `channel_name`: `string` }[]

Defined in

packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:116

WithRequiredProperty

Ƭ WithRequiredProperty<T, K>: T & { [Property in K]-?: T[Property] }

Utility type used to remove some optional attributes (coming from K) from a type T

Type parameters

Name	Type
`T`	`T`
`K`	extends keyof `T`

Defined in

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

Writable

Ƭ Writable<T>: { -readonly [key in keyof T]: T[key] | FindOperator<T[key]> | FindOperator<T[key][]> | FindOperator<string[]> }

Type parameters

Name
`T`

Defined in

packages/medusa/dist/types/common.d.ts:16

payload

Ƭ payload: Object

Type declaration

Name	Type
`email`	`string`
`password`	`string`
`user_id`	`string`

Defined in

packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:68

Variables

AvailableOrderIncludes

• Const AvailableOrderIncludes: Object

Type declaration

Name	Type
`RETURNABLE_ITEMS`	`string`

Defined in

packages/medusa/dist/api/routes/admin/orders/index.d.ts:256

PriceType

• PriceType: Object

Type declaration

Name	Type
`DEFAULT`	`DEFAULT`
`OVERRIDE`	`OVERRIDE`
`SALE`	`SALE`

Defined in

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

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

allowedAdminProductCategoryRelations

• Const allowedAdminProductCategoryRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:13

allowedFields

• Const allowedFields: string[]

Defined in

packages/medusa/dist/api/routes/store/collections/index.d.ts:6

allowedOrderIncludes

• Const allowedOrderIncludes: string[]

Defined in

packages/medusa/dist/api/routes/admin/orders/index.d.ts:259

allowedStoreCustomersFields

• Const allowedStoreCustomersFields: string[]

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:8

allowedStoreCustomersRelations

• Const allowedStoreCustomersRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:7

allowedStoreGiftCardFields

• Const allowedStoreGiftCardFields: string[]

Defined in

packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:7

allowedStoreGiftCardRelations

• Const allowedStoreGiftCardRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:6

allowedStoreOrdersFields

• Const allowedStoreOrdersFields: string[]

Defined in

packages/medusa/dist/api/routes/store/orders/index.d.ts:8

allowedStoreOrdersRelations

• Const allowedStoreOrdersRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/orders/index.d.ts:6

allowedStoreProductCategoryFields

• Const allowedStoreProductCategoryFields: string[]

Defined in

packages/medusa/dist/api/routes/store/product-categories/index.d.ts:11

allowedStoreProductTagFields

• Const allowedStoreProductTagFields: string[]

Defined in

packages/medusa/dist/api/routes/store/product-tags/index.d.ts:7

allowedStoreProductTypeFields

• Const allowedStoreProductTypeFields: string[]

Defined in

packages/medusa/dist/api/routes/store/product-types/index.d.ts:6

allowedStoreProductsFields

• Const allowedStoreProductsFields: string[]

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:10

allowedStoreProductsRelations

• Const allowedStoreProductsRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:11

allowedStoreVariantRelations

• Const allowedStoreVariantRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/variants/index.d.ts:5

defaulPaymentCollectionRelations

• Const defaulPaymentCollectionRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:6

defaultAdminBatchFields

• Const defaultAdminBatchFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/batch/index.d.ts:45

defaultAdminCollectionsFields

• Const defaultAdminCollectionsFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/collections/index.d.ts:6

defaultAdminCollectionsRelations

• Const defaultAdminCollectionsRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/collections/index.d.ts:7

defaultAdminCustomerGroupsRelations

• Const defaultAdminCustomerGroupsRelations: never[]

Defined in

packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:66

defaultAdminCustomersRelations

• Const defaultAdminCustomersRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/customers/index.d.ts:50

defaultAdminDiscountConditionFields

• Const defaultAdminDiscountConditionFields: keyof DiscountCondition[]

Defined in

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

defaultAdminDiscountConditionRelations

• Const defaultAdminDiscountConditionRelations: string[]

Defined in

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

defaultAdminDiscountsFields

• Const defaultAdminDiscountsFields: keyof Discount[]

Defined in

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

defaultAdminDiscountsRelations

• Const defaultAdminDiscountsRelations: string[]

Defined in

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

defaultAdminDraftOrdersCartFields

• Const defaultAdminDraftOrdersCartFields: keyof Cart[]

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:7

defaultAdminDraftOrdersCartRelations

• Const defaultAdminDraftOrdersCartRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:6

defaultAdminDraftOrdersFields

• Const defaultAdminDraftOrdersFields: keyof DraftOrder[]

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:8

defaultAdminDraftOrdersRelations

• Const defaultAdminDraftOrdersRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:5

defaultAdminGetProductsVariantsFields

• Const defaultAdminGetProductsVariantsFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:10

defaultAdminGiftCardFields

• Const defaultAdminGiftCardFields: keyof GiftCard[]

Defined in

packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:6

defaultAdminGiftCardRelations

• Const defaultAdminGiftCardRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:7

defaultAdminInventoryItemFields

• Const defaultAdminInventoryItemFields: keyof InventoryItemDTO[]

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:7

defaultAdminInventoryItemRelations

• Const defaultAdminInventoryItemRelations: never[]

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:9

defaultAdminLocationLevelFields

• Const defaultAdminLocationLevelFields: keyof InventoryLevelDTO[]

Defined in

packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:8

defaultAdminNotificationsFields

• Const defaultAdminNotificationsFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/notifications/index.d.ts:6

defaultAdminNotificationsRelations

• Const defaultAdminNotificationsRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/notifications/index.d.ts:5

defaultAdminPriceListFields

• Const defaultAdminPriceListFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:7

defaultAdminPriceListRelations

• Const defaultAdminPriceListRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:8

defaultAdminProductCategoryRelations

• Const defaultAdminProductCategoryRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:12

defaultAdminProductFields

• Const defaultAdminProductFields: keyof Product[]

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:9

defaultAdminProductRelations

• Const defaultAdminProductRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:8

defaultAdminProductRemoteQueryObject

• Const defaultAdminProductRemoteQueryObject: Object

This is temporary.

Type declaration

Name	Type
`collection`	{ `fields`: `string`[] }
`collection.fields`	`string`[]
`fields`	keyof `Product`[]
`images`	{ `fields`: `string`[] }
`images.fields`	`string`[]
`options`	{ `fields`: `string`[] ; `values`: { `fields`: `string`[] } }
`options.fields`	`string`[]
`options.values`	{ `fields`: `string`[] }
`options.values.fields`	`string`[]
`profile`	{ `fields`: `string`[] }
`profile.fields`	`string`[]
`tags`	{ `fields`: `string`[] }
`tags.fields`	`string`[]
`type`	{ `fields`: `string`[] }
`type.fields`	`string`[]
`variants`	{ `fields`: `string`[] ; `options`: { `fields`: `string`[] } }
`variants.fields`	`string`[]
`variants.options`	{ `fields`: `string`[] }
`variants.options.fields`	`string`[]

Defined in

packages/medusa/dist/api/routes/admin/products/index.d.ts:14

defaultAdminProductTagsFields

• Const defaultAdminProductTagsFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:6

defaultAdminProductTagsRelations

• Const defaultAdminProductTagsRelations: never[]

Defined in

packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:7

defaultAdminProductTypeFields

• Const defaultAdminProductTypeFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/product-types/index.d.ts:6

defaultAdminProductTypeRelations

• Const defaultAdminProductTypeRelations: never[]

Defined in

packages/medusa/dist/api/routes/admin/product-types/index.d.ts:7

defaultAdminRegionFields

• Const defaultAdminRegionFields: keyof Region[]

Defined in

packages/medusa/dist/api/routes/admin/regions/index.d.ts:7

defaultAdminRegionRelations

• Const defaultAdminRegionRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/regions/index.d.ts:8

defaultAdminReservationRelations

• Const defaultAdminReservationRelations: never[]

Defined in

packages/medusa/dist/api/routes/admin/reservations/index.d.ts:64

defaultAdminReturnReasonsFields

• Const defaultAdminReturnReasonsFields: keyof ReturnReason[]

Defined in

packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:5

defaultAdminReturnReasonsRelations

• Const defaultAdminReturnReasonsRelations: keyof ReturnReason[]

Defined in

packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:6

defaultAdminShippingProfilesFields

• Const defaultAdminShippingProfilesFields: keyof ShippingProfile[]

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:6

defaultAdminShippingProfilesRelations

• Const defaultAdminShippingProfilesRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:7

defaultAdminStockLocationFields

• Const defaultAdminStockLocationFields: keyof StockLocationDTO[]

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:4

defaultAdminStockLocationRelations

• Const defaultAdminStockLocationRelations: never[]

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:5

defaultAdminSwapFields

• Const defaultAdminSwapFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/swaps/index.d.ts:6

defaultAdminSwapRelations

• Const defaultAdminSwapRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/swaps/index.d.ts:5

defaultAdminTaxRatesFields

• Const defaultAdminTaxRatesFields: keyof TaxRate[]

Defined in

packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:6

defaultAdminTaxRatesRelations

• Const defaultAdminTaxRatesRelations: never[]

Defined in

packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:5

defaultAdminVariantFields

• Const defaultAdminVariantFields: keyof ProductVariant[]

Defined in

packages/medusa/dist/api/routes/admin/variants/index.d.ts:7

defaultAdminVariantRelations

• Const defaultAdminVariantRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/variants/index.d.ts:6

defaultFields

• Const defaultFields: keyof ShippingOption[]

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:6

defaultPaymentCollectionFields

• Const defaultPaymentCollectionFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:5

defaultPaymentCollectionRelations

• Const defaultPaymentCollectionRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:6

defaultPaymentFields

• Const defaultPaymentFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/payments/index.d.ts:5

defaultProductCategoryFields

• Const defaultProductCategoryFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:14

defaultRelations

• Const defaultRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/returns/index.d.ts:6

defaultRelationsExtended

• Const defaultRelationsExtended: string[]

Defined in

packages/medusa/dist/api/routes/admin/store/index.d.ts:5

defaultRelationsList

• Const defaultRelationsList: string[]

Defined in

packages/medusa/dist/api/routes/admin/returns/index.d.ts:7

defaultReservationFields

• Const defaultReservationFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/reservations/index.d.ts:65

defaultReturnCancelFields

• Const defaultReturnCancelFields: keyof Order[]

Defined in

packages/medusa/dist/api/routes/admin/returns/index.d.ts:9

defaultReturnCancelRelations

• Const defaultReturnCancelRelations: string[]

Defined in

packages/medusa/dist/api/routes/admin/returns/index.d.ts:8

defaultStoreCartFields

• Const defaultStoreCartFields: keyof Cart[]

Defined in

packages/medusa/dist/api/routes/store/carts/index.d.ts:5

defaultStoreCartRelations

• Const defaultStoreCartRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/carts/index.d.ts:6

defaultStoreCategoryScope

• Const defaultStoreCategoryScope: Object

Type declaration

Name	Type
`is_active`	`boolean`
`is_internal`	`boolean`

Defined in

packages/medusa/dist/api/routes/store/product-categories/index.d.ts:6

defaultStoreCollectionRelations

• Const defaultStoreCollectionRelations: never[]

Defined in

packages/medusa/dist/api/routes/store/collections/index.d.ts:5

defaultStoreCustomersFields

• Const defaultStoreCustomersFields: keyof Customer[]

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:6

defaultStoreCustomersRelations

• Const defaultStoreCustomersRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/customers/index.d.ts:5

defaultStoreGiftCardFields

• Const defaultStoreGiftCardFields: keyof GiftCard[]

Defined in

packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:5

defaultStoreGiftCardRelations

• Const defaultStoreGiftCardRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:4

defaultStoreOrdersFields

• Const defaultStoreOrdersFields: keyof Order[]

Defined in

packages/medusa/dist/api/routes/store/orders/index.d.ts:7

defaultStoreOrdersRelations

• Const defaultStoreOrdersRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/orders/index.d.ts:5

defaultStoreProductCategoryFields

• Const defaultStoreProductCategoryFields: string[]

Defined in

packages/medusa/dist/api/routes/store/product-categories/index.d.ts:10

defaultStoreProductCategoryRelations

• Const defaultStoreProductCategoryRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/product-categories/index.d.ts:5

defaultStoreProductRemoteQueryObject

• Const defaultStoreProductRemoteQueryObject: Object

This is temporary.

Type declaration

Name	Type
`collection`	{ `fields`: `string`[] }
`collection.fields`	`string`[]
`fields`	keyof `Product`[]
`images`	{ `fields`: `string`[] }
`images.fields`	`string`[]
`options`	{ `fields`: `string`[] ; `values`: { `fields`: `string`[] } }
`options.fields`	`string`[]
`options.values`	{ `fields`: `string`[] }
`options.values.fields`	`string`[]
`profile`	{ `fields`: `string`[] }
`profile.fields`	`string`[]
`tags`	{ `fields`: `string`[] }
`tags.fields`	`string`[]
`type`	{ `fields`: `string`[] }
`type.fields`	`string`[]
`variants`	{ `fields`: `string`[] ; `options`: { `fields`: `string`[] } }
`variants.fields`	`string`[]
`variants.options`	{ `fields`: `string`[] }
`variants.options.fields`	`string`[]

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:15

defaultStoreProductTagFields

• Const defaultStoreProductTagFields: string[]

Defined in

packages/medusa/dist/api/routes/store/product-tags/index.d.ts:6

defaultStoreProductTagRelations

• Const defaultStoreProductTagRelations: never[]

Defined in

packages/medusa/dist/api/routes/store/product-tags/index.d.ts:8

defaultStoreProductTypeFields

• Const defaultStoreProductTypeFields: string[]

Defined in

packages/medusa/dist/api/routes/store/product-types/index.d.ts:7

defaultStoreProductTypeRelations

• Const defaultStoreProductTypeRelations: never[]

Defined in

packages/medusa/dist/api/routes/store/product-types/index.d.ts:8

defaultStoreProductsFields

• Const defaultStoreProductsFields: keyof Product[]

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:9

defaultStoreProductsRelations

• Const defaultStoreProductsRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/products/index.d.ts:8

defaultStoreReturnReasonFields

• Const defaultStoreReturnReasonFields: keyof ReturnReason[]

Defined in

packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:4

defaultStoreReturnReasonRelations

• Const defaultStoreReturnReasonRelations: keyof ReturnReason[]

Defined in

packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:5

defaultStoreSwapFields

• Const defaultStoreSwapFields: FindConfig<Swap>["select"]

Defined in

packages/medusa/dist/api/routes/store/swaps/index.d.ts:6

defaultStoreSwapRelations

• Const defaultStoreSwapRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/swaps/index.d.ts:5

defaultStoreVariantRelations

• Const defaultStoreVariantRelations: string[]

Defined in

packages/medusa/dist/api/routes/store/variants/index.d.ts:4

filterableAdminOrdersFields

• Const filterableAdminOrdersFields: string[]

Defined in

packages/medusa/dist/api/routes/admin/orders/index.d.ts:255

Functions

DbAwareColumn

▸ DbAwareColumn(columnOptions): PropertyDecorator

Parameters

Name	Type
`columnOptions`	`ColumnOptions`

Returns

PropertyDecorator

Defined in

packages/medusa/dist/utils/db-aware-column.d.ts:4

IsType

▸ IsType(types, validationOptions?): (object: Object, propertyName: string) => void

Parameters

Name	Type
`types`	`any`[]
`validationOptions?`	`ValidationOptions`

Returns

fn

▸ (object, propertyName): void

Parameters

Name	Type
`object`	`Object`
`propertyName`	`string`

Returns

void

Defined in

packages/medusa/dist/utils/validators/is-type.d.ts:2

addOrderToSelect

▸ addOrderToSelect<TEntity>(order, select): void

Type parameters

Name
`TEntity`

Parameters

Name	Type
`order`	`FindOptionsOrder`<`TEntity`>
`select`	`FindOptionsSelect`<`TEntity`>

Returns

void

Defined in

packages/medusa/dist/utils/build-query.d.ts:29

adjustInventoryForCancelledFulfillment

▸ adjustInventoryForCancelledFulfillment(fulfillment, context): Promise<void>

Parameters

Name	Type
`fulfillment`	`Fulfillment`
`context`	`Object`
`context.productVariantInventoryService`	`ProductVariantInventoryService`

Returns

Promise<void>

Defined in

packages/medusa/dist/api/routes/admin/orders/cancel-fulfillment.d.ts:62

authenticate

▸ authenticate(): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Returns

RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Defined in

packages/medusa/dist/api/middlewares/authenticate.d.ts:2

authenticateCustomer

▸ authenticateCustomer(): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Returns

RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Defined in

packages/medusa/dist/api/middlewares/authenticate-customer.d.ts:2

buildLegacyFieldsListFrom

▸ buildLegacyFieldsListFrom<TEntity>(input?): keyof TEntity[]

Revert new object structure of find options to the legacy structure of previous version

Type parameters

Name
`TEntity`

Parameters

Name	Type
`input?`	`FindOptionsWhere`<`TEntity`> \| `FindOptionsSelect`<`TEntity`> \| `FindOptionsOrder`<`TEntity`> \| `FindOptionsRelations`<`TEntity`>

Returns

keyof TEntity[]

Deprecated

in favor of import { objectToStringPath } from "@medusajs/utils"

Example

input: {
  test: {
    test1: true,
    test2: true,
    test3: {
      test4: true
    },
  },
  test2: true
}
output: ['test.test1', 'test.test2', 'test.test3.test4', 'test2']

Defined in

packages/medusa/dist/utils/build-query.d.ts:28

buildQuery

▸ buildQuery<TWhereKeys, TEntity>(selector, config?): ExtendedFindConfig<TEntity>

Used to build TypeORM queries.

Type parameters

Name	Type
`TWhereKeys`	extends `object`
`TEntity`	`unknown`

Parameters

Name	Type	Description
`selector`	`TWhereKeys`	The selector
`config?`	`FindConfig`<`TEntity`>	The config

Returns

ExtendedFindConfig<TEntity>

The QueryBuilderConfig

Defined in

packages/medusa/dist/utils/build-query.d.ts:10

calculatePriceTaxAmount

▸ calculatePriceTaxAmount(«destructured»): number

Return the tax amount that

is includes in the price if it is tax inclusive
will be applied on to the price if it is tax exclusive

Parameters

Name	Type
`«destructured»`	`Object`
› `includesTax?`	`boolean`
› `price`	`number`
› `taxRate`	`number`

Returns

number

Defined in

packages/medusa/dist/utils/calculate-price-tax-amount.d.ts:9

canAccessBatchJob

▸ canAccessBatchJob(req, res, next): Promise<any>

Parameters

Name	Type
`req`	`any`
`res`	`any`
`next`	`any`

Returns

Promise<any>

Defined in

packages/medusa/dist/api/middlewares/batch-job/can-access-batch-job.d.ts:1

categoryMatchesScope

▸ categoryMatchesScope(category, query): boolean

Parameters

Name	Type
`category`	`ProductCategory`
`query`	`FindOptionsWhere`<`ProductCategory`>

Returns

boolean

Defined in

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

cleanResponseData

▸ cleanResponseData<T>(data, fields): T extends [] ? Partial<T>[] : Partial<T>

Filter response data to contain props specified in the allowedProperties. You can read more in the transformQuery middleware utility methods.

Type parameters

Name	Type
`T`	extends `unknown`

Parameters

Name	Type	Description
`data`	`T`	record or an array of records in the response
`fields`	`string`[]	record props allowed in the response

Returns

T extends [] ? Partial<T>[] : Partial<T>

Defined in

packages/medusa/dist/utils/clean-response-data.d.ts:8

csvCellContentFormatter

▸ csvCellContentFormatter(str): string

Parameters

Name	Type
`str`	`string`

Returns

string

Defined in

packages/medusa/dist/utils/csv-cell-content-formatter.d.ts:1

csvRevertCellContentFormatter

▸ csvRevertCellContentFormatter(str): string

Parameters

Name	Type
`str`	`string`

Returns

string

Defined in

packages/medusa/dist/utils/csv-cell-content-formatter.d.ts:2

doesConditionBelongToDiscount

▸ doesConditionBelongToDiscount(req, res, next): Promise<any>

Parameters

Name	Type
`req`	`any`
`res`	`any`
`next`	`any`

Returns

Promise<any>

Defined in

packages/medusa/dist/api/middlewares/discount/does-condition-belong-to-discount.d.ts:1

errorHandler

▸ errorHandler(): (err: MedusaError, req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

Returns

fn

▸ (err, req, res, next): void

Parameters

Name	Type
`err`	`MedusaError`
`req`	`Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`>>
`res`	`Response`<`any`, `Record`<`string`, `any`>>
`next`	`NextFunction`

Returns

void

Defined in

packages/medusa/dist/api/middlewares/error-handler.d.ts:3

extendedFindParamsMixin

▸ extendedFindParamsMixin(«destructured»?): ClassConstructor<FindParams & FindPaginationParams>

Parameters

Name	Type
`«destructured»`	`Object`
› `limit?`	`number`
› `offset?`	`number`

Returns

ClassConstructor<FindParams & FindPaginationParams>

Defined in

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

fetchCategoryDescendantsIds

▸ fetchCategoryDescendantsIds(productCategory, query): string[]

Parameters

Name	Type
`productCategory`	`ProductCategory`
`query`	`FindOptionsWhere`<`ProductCategory`>

Returns

string[]

Defined in

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

formatException

▸ formatException(err): MedusaError

Parameters

Name	Type
`err`	`any`

Returns

MedusaError

Defined in

packages/medusa/dist/utils/exception-formatter.d.ts:8

generateEntityId

▸ generateEntityId(idProperty, prefix?): string

Generate a composed id based on the input parameters and return either the is if it exists or the generated one.

Parameters

Name	Type
`idProperty`	`string`
`prefix?`	`string`

Returns

string

Defined in

packages/medusa/dist/utils/generate-entity-id.d.ts:6

getRequestedBatchJob

▸ getRequestedBatchJob(req, res, next): Promise<any>

Parameters

Name	Type
`req`	`any`
`res`	`any`
`next`	`any`

Returns

Promise<any>

Defined in

packages/medusa/dist/api/middlewares/batch-job/get-requested-batch-job.d.ts:1

hasChanges

▸ hasChanges<T1, T2>(obj1, obj2): boolean

Compare two objects and return true if there is changes detected from obj2 compared to obj1

Type parameters

Name	Type
`T1`	extends `Object`
`T2`	extends `Object`

Parameters

Name	Type
`obj1`	`T1`
`obj2`	`T2`

Returns

boolean

Defined in

packages/medusa/dist/utils/has-changes.d.ts:6

isBatchJobStrategy

▸ isBatchJobStrategy(object): object is IBatchJobStrategy

Parameters

Name	Type
`object`	`unknown`

Returns

object is IBatchJobStrategy

Defined in

packages/medusa/dist/interfaces/batch-job-strategy.d.ts:34

isCartCompletionStrategy

▸ isCartCompletionStrategy(obj): boolean

Parameters

Name	Type
`obj`	`unknown`

Returns

boolean

Defined in

packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:24

isDate

▸ isDate(value): value is Date

Parameters

Name	Type
`value`	`any`

Returns

value is Date

Defined in

packages/medusa/dist/utils/is-date.d.ts:1

isFileService

▸ isFileService(object): boolean

Parameters

Name	Type
`object`	`unknown`

Returns

boolean

Defined in

packages/medusa/dist/interfaces/file-service.d.ts:48

isNotificationService

▸ isNotificationService(obj): boolean

Parameters

Name	Type
`obj`	`unknown`

Returns

boolean

Defined in

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

isObject

▸ isObject(obj): obj is object

Parameters

Name	Type
`obj`	`any`

Returns

obj is object

Defined in

packages/medusa/dist/utils/is-object.d.ts:1

isPaymentProcessor

▸ isPaymentProcessor(obj): boolean

Return if the input object is AbstractPaymentProcessor

Parameters

Name	Type
`obj`	`unknown`

Returns

boolean

Defined in

packages/medusa/dist/interfaces/payment-processor.d.ts:110

isPaymentProcessorError

▸ isPaymentProcessorError(obj): obj is PaymentProcessorError

Utility function to determine if an object is a processor error

Parameters

Name	Type
`obj`	`any`

Returns

obj is PaymentProcessorError

Defined in

packages/medusa/dist/interfaces/payment-processor.d.ts:115

isPaymentService

▸ isPaymentService(obj): boolean

Return if the input object is one of AbstractPaymentService or PaymentService or AbstractPaymentPluginService

Parameters

Name	Type
`obj`	`unknown`

Returns

boolean

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:185

isPriceSelectionStrategy

▸ isPriceSelectionStrategy(object): object is IPriceSelectionStrategy

Parameters

Name	Type
`object`	`any`

Returns

object is IPriceSelectionStrategy

Defined in

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

isString

▸ isString(val): val is string

Parameters

Name	Type
`val`	`any`

Returns

val is string

Defined in

packages/medusa/dist/utils/is-string.d.ts:1

isTaxCalculationStrategy

▸ isTaxCalculationStrategy(object): object is ITaxCalculationStrategy

Parameters

Name	Type
`object`	`any`

Returns

object is ITaxCalculationStrategy

Defined in

packages/medusa/dist/interfaces/tax-calculation-strategy.d.ts:16

normalizeQuery

▸ normalizeQuery(): (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void

Normalize an input query, especially from array like query params to an array type e.g: /admin/orders/?fields[]=id,status,cart_id becomes { fields: ["id", "status", "cart_id"] }

Returns

fn

▸ (req, res, next): void

Parameters

Name	Type
`req`	`Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`>>
`res`	`Response`<`any`, `Record`<`string`, `any`>>
`next`	`NextFunction`

Returns

void

Defined in

packages/medusa/dist/api/middlewares/normalized-query.d.ts:6

nullableValue

▸ nullableValue(value): FindOperator<any>

Parameters

Name	Type
`value`	`any`

Returns

FindOperator<any>

Defined in

packages/medusa/dist/utils/build-query.d.ts:30

omitDeep

▸ omitDeep<T>(input, excludes): T

Type parameters

Name	Type
`T`	extends `object` = `object`

Parameters

Name	Type
`input`	`object`
`excludes`	(`string` \| `number`)[]

Returns

T

Defined in

packages/medusa/dist/utils/omit-deep.d.ts:1

registerOverriddenValidators

▸ registerOverriddenValidators(extendedValidator): void

When overriding a validator, you can register it to be used instead of the original one. For example, the place where you are overriding the core validator, you can call this function

Parameters

Name	Type
`extendedValidator`	`Constructor`<`any`>

Returns

void

Example

// /src/api/routes/admin/products/create-product.ts
import { registerOverriddenValidators } from "@medusajs/medusa"
import { AdminPostProductsReq as MedusaAdminPostProductsReq } from "@medusajs/medusa/dist/api/routes/admin/products/create-product"
import { IsString } from "class-validator"

class AdminPostProductsReq extends MedusaAdminPostProductsReq {
   @IsString()
   test: string
}

registerOverriddenValidators(AdminPostProductsReq)

Defined in

packages/medusa/dist/utils/validator.d.ts:23

remoteQueryFetchData

▸ remoteQueryFetchData(container): (expand: any, keyField: any, ids: any, relationship: any) => Promise<any>

Parameters

Name	Type
`container`	`MedusaContainer`

Returns

fn

▸ (expand, keyField, ids, relationship): Promise<any>

Parameters

Name	Type
`expand`	`any`
`keyField`	`any`
`ids`	`any`
`relationship`	`any`

Returns

Promise<any>

Defined in

packages/medusa/dist/utils/remote-query-fetch-data.d.ts:2

removeUndefinedProperties

▸ removeUndefinedProperties<T>(inputObj): T

Type parameters

Name	Type
`T`	extends `object`

Parameters

Name	Type
`inputObj`	`T`

Returns

T

Defined in

packages/medusa/dist/utils/remove-undefined-properties.d.ts:1

requireCustomerAuthentication

▸ requireCustomerAuthentication(): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Returns

RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Defined in

packages/medusa/dist/api/middlewares/require-customer-authentication.d.ts:2

reserveQuantityForDraftOrder

▸ reserveQuantityForDraftOrder(order, context): Promise<void>

Parameters

Name	Type
`order`	`Order`
`context`	`Object`
`context.locationId?`	`string`
`context.productVariantInventoryService`	`ProductVariantInventoryService`

Returns

Promise<void>

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/register-payment.d.ts:58

resolveDbGenerationStrategy

▸ resolveDbGenerationStrategy(pgSqlType): "increment" | "uuid" | "rowid"

Parameters

Name	Type
`pgSqlType`	`"uuid"` \| `"rowid"` \| `"increment"`

Returns

"increment" | "uuid" | "rowid"

Defined in

packages/medusa/dist/utils/db-aware-column.d.ts:3

resolveDbType

▸ resolveDbType(pgSqlType): ColumnType

Parameters

Name	Type
`pgSqlType`	`ColumnType`

Returns

ColumnType

Defined in

packages/medusa/dist/utils/db-aware-column.d.ts:2

setMetadata

▸ setMetadata(obj, metadata): Record<string, unknown>

Dedicated method to set metadata.

Parameters

Name	Type	Description
`obj`	`undefined` \| `null` \| { `metadata`: `null` \| `Record`<`string`, `unknown`> }	the entity to apply metadata to.
`metadata`	`Record`<`string`, `unknown`>	the metadata to set

Returns

Record<string, unknown>

resolves to the updated result.

Defined in

packages/medusa/dist/utils/set-metadata.d.ts:7

transformBody

▸ transformBody<T>(plainToClass, config?): (req: Request, res: Response, next: NextFunction) => Promise<void>

Type parameters

Name
`T`

Parameters

Name	Type
`plainToClass`	`ClassConstructor`<`T`>
`config?`	`ValidatorOptions`

Returns

fn

▸ (req, res, next): Promise<void>

Parameters

Name	Type
`req`	`Request`
`res`	`Response`
`next`	`NextFunction`

Returns

Promise<void>

Defined in

packages/medusa/dist/api/middlewares/transform-body.d.ts:4

transformIncludesOptions

▸ transformIncludesOptions(allowedIncludes?, expectedIncludes?): (req: Request, res: Response, next: NextFunction) => void

Retrieve the includes options from the fields query param. If the include option is present then assigned it to includes on req

Parameters

Name	Type	Description
`allowedIncludes?`	`string`[]	The list of fields that can be passed and assign to req.includes
`expectedIncludes?`	`string`[]	The list of fields that the consumer can pass to the end point using this middleware. It is a subset of `allowedIncludes`

Returns

fn

▸ (req, res, next): void

Parameters

Name	Type
`req`	`Request`
`res`	`Response`
`next`	`NextFunction`

Returns

void

Defined in

packages/medusa/dist/api/middlewares/transform-includes-options.d.ts:8

transformQuery

▸ transformQuery<T, TEntity>(plainToClass, queryConfig?, config?): (req: Request, res: Response, next: NextFunction) => Promise<void>

Middleware that transform the query input for the admin end points

Type parameters

Name	Type
`T`	extends `RequestQueryFields`
`TEntity`	extends `BaseEntity`

Parameters

Name	Type
`plainToClass`	`ClassConstructor`<`T`>
`queryConfig?`	`Omit`<`QueryConfig`<`TEntity`>, `"allowedRelations"` \| `"allowedFields"`>
`config?`	`ValidatorOptions`

Returns

fn

▸ (req, res, next): Promise<void>

Parameters

Name	Type
`req`	`Request`
`res`	`Response`
`next`	`NextFunction`

Returns

Promise<void>

Defined in

packages/medusa/dist/api/middlewares/transform-query.d.ts:12

transformStoreQuery

▸ transformStoreQuery<T, TEntity>(plainToClass, queryConfig?, config?): (req: Request, res: Response, next: NextFunction) => Promise<void>

Middleware that transform the query input for the store endpoints

Type parameters

Name	Type
`T`	extends `RequestQueryFields`
`TEntity`	extends `BaseEntity`

Parameters

Name	Type
`plainToClass`	`ClassConstructor`<`T`>
`queryConfig?`	`QueryConfig`<`TEntity`>
`config?`	`ValidatorOptions`

Returns

fn

▸ (req, res, next): Promise<void>

Parameters

Name	Type
`req`	`Request`
`res`	`Response`
`next`	`NextFunction`

Returns

Promise<void>

Defined in

packages/medusa/dist/api/middlewares/transform-query.d.ts:19

unauthenticatedInviteRoutes

▸ unauthenticatedInviteRoutes(app): void

Parameters

Name	Type
`app`	`any`

Returns

void

Defined in

packages/medusa/dist/api/routes/admin/invites/index.d.ts:4

unauthenticatedUserRoutes

▸ unauthenticatedUserRoutes(app): void

Parameters

Name	Type
`app`	`any`

Returns

void

Defined in

packages/medusa/dist/api/routes/admin/users/index.d.ts:3

updateInventoryAndReservations

▸ updateInventoryAndReservations(fulfillments, context): Promise<void>

Parameters

Name	Type
`fulfillments`	`Fulfillment`[]
`context`	`Object`
`context.inventoryService`	`ProductVariantInventoryService`
`context.locationId`	`string`

Returns

Promise<void>

Defined in

packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:85

validateId

▸ validateId(rawId, config?): string

Parameters

Name	Type
`rawId`	`string`
`config?`	`Object`
`config.length?`	`number`
`config.prefix?`	`string`

Returns

string

Defined in

packages/medusa/dist/utils/validate-id.d.ts:1

validator

▸ validator<T, V>(typedClass, plain, config?): Promise<T>

Type parameters

Name
`T`
`V`

Parameters

Name	Type
`typedClass`	`ClassConstructor`<`T`>
`plain`	`V`
`config?`	`ValidatorOptions`

Returns

Promise<T>

Defined in

packages/medusa/dist/utils/validator.d.ts:24

wrapHandler

▸ wrapHandler(fn): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Parameters

Name	Type
`fn`	`handler`

Returns

RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Defined in

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

218 KiB Raw Blame History

Namespace: internal

Enumerations

Classes

Interfaces

References

Address

AddressCreatePayload

AddressPayload

AdminAuthRes

AdminBatchJobListRes

AdminBatchJobRes

AdminBearerAuthRes

AdminCollectionsListRes

AdminCollectionsRes

AdminCreateCondition

AdminCurrenciesListRes

AdminCurrenciesRes

AdminCustomerGroupsListRes

AdminCustomerGroupsRes

AdminCustomersListRes

AdminCustomersRes

AdminDeleteCustomerGroupsGroupCustomerBatchReq

AdminDeleteDiscountsDiscountConditionsConditionBatchReq

AdminDeleteProductsFromCollectionReq

AdminDeleteProductsFromCollectionRes

AdminDiscountConditionsRes

AdminDiscountsListRes

AdminDiscountsRes

AdminGetBatchPaginationParams

AdminGetBatchParams

AdminGetCollectionsPaginationParams

AdminGetCollectionsParams

AdminGetCurrenciesParams

AdminGetCustomerGroupsGroupParams

AdminGetCustomerGroupsParams

AdminGetCustomersParams

AdminGetDiscountsDiscountConditionsConditionParams

AdminGetDiscountsParams

AdminPostAuthReq

AdminPostBatchesReq

AdminPostCollectionsCollectionReq

AdminPostCollectionsReq

AdminPostCurrenciesCurrencyReq

AdminPostCustomerGroupsGroupCustomersBatchReq

AdminPostCustomerGroupsGroupReq

AdminPostCustomerGroupsReq

AdminPostCustomersCustomerReq

AdminPostCustomersReq

AdminPostDiscountsDiscountConditions

AdminPostDiscountsDiscountConditionsCondition

AdminPostDiscountsDiscountConditionsConditionBatchParams

AdminPostDiscountsDiscountConditionsConditionBatchReq

AdminPostDiscountsDiscountConditionsConditionParams

AdminPostDiscountsDiscountConditionsParams

AdminPostDiscountsDiscountDynamicCodesReq

AdminPostDiscountsDiscountReq

AdminPostDiscountsDiscountRule

AdminPostDiscountsReq

AdminPostProductsToCollectionReq

AdminUpdateDiscountRule

AdminUpsertCondition

AllocationType

BaseEntity

BatchJob

BatchJobResultError

BatchJobResultStatDescriptor

BatchJobStatus

Cart

CartType

ClaimFulfillmentStatus

ClaimImage

ClaimItem

ClaimOrder

ClaimPaymentStatus

ClaimReason

ClaimTag

ClaimType

Country

Currency

218 KiB

Raw Blame History