Menu

Collections API Routes

A product collection organizes products into a collection for marketing purposes. For example, a summer collection.

These API routes allow customers to browse collections and their products.

GET /store/collections#

List Collections

Retrieve a list of collections. The collections can be filtered by fields such as handle. The collections 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

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.
offsetnumberOptional
The number of items to skip when retrieving a list.
limitnumberOptional
Limit the number of items returned in the 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 -.
titlestring | string[]Optional
Filter by a collection's title.
created_atobjectOptional
Filter by the collection's creation date. Accepts the filter operators.
updated_atobjectOptional
Filter by the collection's update date. Accepts the filter operators.
handlestring | string[]Optional
Filter by a collection's handle.
qstringOptional
Search term to filter the collection's searchable properties.
$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.
with_deletedbooleanOptional
Whether to include deleted records in the result.
idstring | string[]Optional
Filter by a collection's ID.
localestringOptional
The locale in BCP 47 format to retrieve localized content.
Example: en-US
external_idstring | string[]Optional
Filter by a collection's external id.

Request examples

Responses

200 OK

limitnumber
The maximum number of items returned.
offsetnumber
The number of items skipped before retrieving the returned items.
countnumber
The total number of items.
collectionsobject[]
The collection's collections.

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

GET /store/collections/{id}#

Get a Collection

Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned.

Authentication: none.

Path parameters

idstring
The collection's ID.

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

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.
localestringOptional
The locale in BCP 47 format to retrieve localized content.
Example: en-US

Request examples

Responses

200 OK

collectionobject
The collection's details.

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