Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

BaseProduct

Properties#

idstring
The product's ID.
titlestring
The product's title.
handlestring
The product's handle.
subtitlenull | string
The product's subtitle.
descriptionnull | string
The product's description.
is_giftcardboolean
Whether the product is a gift card.
statusProductStatus
The product's status.
thumbnailnull | string
The product's thumbnail.
widthnull | number
The product's width.
weightnull | number
The product's weight.
lengthnull | number
The product's length.
heightnull | number
The product's height.
origin_countrynull | string
The product's origin country.
hs_codenull | string
The product's HS code.
mid_codenull | string
The product's MID code.
materialnull | string
The product's material.
collection_idnull | string
The ID of the associated product collection.
type_idnull | string
The ID of the associated product type.
variantsnull | BaseProductVariant[]
The product's variants.
optionsnull | BaseProductOption[]
The product's options.
imagesnull | BaseProductImage[]
The product's images.
discountableboolean
Whether the product is discountable.
external_idnull | string
The ID of the product in external systems.
created_atnull | string
The date the product was created.
updated_atnull | string
The date the product was update.
deleted_atnull | string
The date the product was deleted.
collectionnull | BaseCollectionOptional
The product's collection.
categoriesnull | BaseProductCategory[]Optional
The product's categories.
typenull | BaseProductTypeOptional
The product's type.
tagsnull | BaseProductTag[]Optional
The product's tags.
metadatanull | Record<string, unknown>Optional
Key-value pairs of custom data.
Was this page helpful?
Edit this page
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵