Get a Collection

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

{ "collection": { "id": "string", "title": "string", "handle": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": {}, "products": [ {} ] } }

Request

Path Params

string

required

The collection's ID.

Query Params

fields

string

fields

optional

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.

Header Params

x-publishable-api-key

string

required

Publishable API Key created in the Medusa Admin.

Responses

🟢200OK

application/json

Body

The collection's details.

collection

object (StoreCollection)

required

The collection's details.

string

required

The collection's ID.

title

string

title

required

The collection's title.

handle

string

handle

required

The collection's handle.

created_at

string <date-time>

created_at

required

The date the collection was created.

updated_at

string <date-time>

updated_at

required

The date the collection was updated.

deleted_at

string <date-time>

deleted_at

required

The date the collection was deleted.

metadata

object

required

The collection's metadata, can hold custom key-value pairs.

products

array [object]

optional

The collection's products.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error