Menu

Product Variants API Routes

GET /store/product-variants#

List Product Variants

Retrieve a list of product variants. The product variants can be filtered by fields such as id. The product variants can also be sorted or paginated.

Authentication: none.

Header parameters

x-publishable-api-keystring
Publishable API Key created in the Medusa Admin.
x-medusa-localestringOptional
The locale in BCP 47 format to retrieve localized content.
Example: en-US

Query parameters

localestringOptional
The locale in BCP 47 format to retrieve localized content.
Example: en-US
skustring | string[]Optional
Filter by a product variant's sku.
manage_inventorybooleanOptional
Filter by whether Medusa manages inventory for the product variant.
allow_backorderbooleanOptional
Filter by whether backorders are allowed for the product variant.
product_idstring | string[]Optional
Filter by a product ID to retrieve its variants.
qstringOptional
Query to search variants by their searchable fields.
idstring | string[]Optional
Filter by a product variant's ID.
optionsobjectOptional
Filter by the product variant's options.
created_atobjectOptional
Filter by the product variant's creation date. Accepts the filter operators.
updated_atobjectOptional
Filter by the product variant's last update date. Accepts the filter operators.
deleted_atobjectOptional
Filter by the product variant's deletion date. Accepts the filter operators.
limitnumberOptional
Limit the number of items returned in the list.
offsetnumberOptional
The number of items to skip when retrieving a list.
orderstringOptional
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
with_deletedbooleanOptional
The product variant's with deleted.
fieldsstringOptional
Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.
$andobject[]Optional
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
$orobject[]Optional
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Request examples

Responses

200 OK

limitnumber
The maximum number of items returned in the list.
offsetnumber
The number of items skipped before the retrieved list.
countnumber
The total number of items available.
estimate_countnumberOptional
The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.
variantsobject[]
The list of product variants.

400, 401, 404, 409, 422, 500: an error response is returned.

Found a problem with this page?Report Issue
Edited Nov 14·Edit this page