Create Collection

JS SDK

import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.productCollection.create({
  title: "Summer Collection"
})
.then(({ collection }) => {
  console.log(collection)
})

{
  "collection": {
    "id": "<string>",
    "title": "<string>",
    "handle": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "products": [
      {
        "variants": [
          {}
        ],
        "length": 123,
        "title": "<string>",
        "status": "draft",
        "options": [
          {
            "id": "<string>",
            "title": "<string>",
            "product": {},
            "product_id": "<string>",
            "values": [
              {
                "id": "<string>",
                "value": "<string>",
                "option": {},
                "option_id": "<string>",
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ],
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "description": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "handle": "<string>",
        "subtitle": "<string>",
        "is_giftcard": true,
        "thumbnail": "<string>",
        "width": 123,
        "weight": 123,
        "height": 123,
        "origin_country": "<string>",
        "hs_code": "<string>",
        "mid_code": "<string>",
        "material": "<string>",
        "collection_id": "<string>",
        "type_id": "<string>",
        "images": [
          {
            "id": "<string>",
            "url": "<string>",
            "rank": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "discountable": true,
        "external_id": "<string>",
        "deleted_at": "2023-11-07T05:31:56Z",
        "collection": {
          "id": "<string>",
          "title": "<string>",
          "handle": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "metadata": {},
          "products": [
            {}
          ]
        },
        "categories": [
          {
            "category_children": [
              {
                "category_children": [
                  {}
                ],
                "parent_category": {},
                "name": "<string>",
                "description": "<string>",
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "handle": "<string>",
                "deleted_at": "2023-11-07T05:31:56Z",
                "is_active": true,
                "is_internal": true,
                "rank": 123,
                "parent_category_id": "<string>",
                "products": [
                  {}
                ],
                "metadata": {}
              }
            ],
            "parent_category": {
              "category_children": [
                {}
              ],
              "parent_category": {},
              "name": "<string>",
              "description": "<string>",
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "handle": "<string>",
              "deleted_at": "2023-11-07T05:31:56Z",
              "is_active": true,
              "is_internal": true,
              "rank": 123,
              "parent_category_id": "<string>",
              "products": [
                {}
              ],
              "metadata": {}
            },
            "name": "<string>",
            "description": "<string>",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "handle": "<string>",
            "deleted_at": "2023-11-07T05:31:56Z",
            "is_active": true,
            "is_internal": true,
            "rank": 123,
            "parent_category_id": "<string>",
            "products": [
              {}
            ],
            "metadata": {}
          }
        ],
        "type": {
          "id": "<string>",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "metadata": {}
        },
        "tags": [
          {
            "id": "<string>",
            "value": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "metadata": {}
      }
    ]
  }
}

POST

admin

collections

JS SDK

import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.productCollection.create({
  title: "Summer Collection"
})
.then(({ collection }) => {
  console.log(collection)
})

{
  "collection": {
    "id": "<string>",
    "title": "<string>",
    "handle": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "products": [
      {
        "variants": [
          {}
        ],
        "length": 123,
        "title": "<string>",
        "status": "draft",
        "options": [
          {
            "id": "<string>",
            "title": "<string>",
            "product": {},
            "product_id": "<string>",
            "values": [
              {
                "id": "<string>",
                "value": "<string>",
                "option": {},
                "option_id": "<string>",
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ],
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "description": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "handle": "<string>",
        "subtitle": "<string>",
        "is_giftcard": true,
        "thumbnail": "<string>",
        "width": 123,
        "weight": 123,
        "height": 123,
        "origin_country": "<string>",
        "hs_code": "<string>",
        "mid_code": "<string>",
        "material": "<string>",
        "collection_id": "<string>",
        "type_id": "<string>",
        "images": [
          {
            "id": "<string>",
            "url": "<string>",
            "rank": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "discountable": true,
        "external_id": "<string>",
        "deleted_at": "2023-11-07T05:31:56Z",
        "collection": {
          "id": "<string>",
          "title": "<string>",
          "handle": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "metadata": {},
          "products": [
            {}
          ]
        },
        "categories": [
          {
            "category_children": [
              {
                "category_children": [
                  {}
                ],
                "parent_category": {},
                "name": "<string>",
                "description": "<string>",
                "id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "handle": "<string>",
                "deleted_at": "2023-11-07T05:31:56Z",
                "is_active": true,
                "is_internal": true,
                "rank": 123,
                "parent_category_id": "<string>",
                "products": [
                  {}
                ],
                "metadata": {}
              }
            ],
            "parent_category": {
              "category_children": [
                {}
              ],
              "parent_category": {},
              "name": "<string>",
              "description": "<string>",
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "handle": "<string>",
              "deleted_at": "2023-11-07T05:31:56Z",
              "is_active": true,
              "is_internal": true,
              "rank": 123,
              "parent_category_id": "<string>",
              "products": [
                {}
              ],
              "metadata": {}
            },
            "name": "<string>",
            "description": "<string>",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "handle": "<string>",
            "deleted_at": "2023-11-07T05:31:56Z",
            "is_active": true,
            "is_internal": true,
            "rank": 123,
            "parent_category_id": "<string>",
            "products": [
              {}
            ],
            "metadata": {}
          }
        ],
        "type": {
          "id": "<string>",
          "value": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "metadata": {}
        },
        "tags": [
          {
            "id": "<string>",
            "value": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "metadata": {}
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

string

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.

Body

application/json

the product collection's details.

title

string

required

The collection's title.

handle

string

The collection's handle.

metadata

object

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

additional_data

object

Pass additional custom data to the API route. This data is passed to the underlying workflow under the additional_data parameter.

Response

The collection's details.

collection

object

required

The product collection's details.

Show child attributes

collection.id

string

required

The collection's ID.

collection.title

string

required

The collection's title.

collection.handle

string

required

The collection's handle.

collection.created_at

string<date-time>

required

The collection's creation date.

collection.updated_at

string<date-time>

required

The collection's update date.

collection.deleted_at

string<date-time>

required

The collection's deletion date.

collection.metadata

object

required

The collection's metadata, used to store custom key-value pairs.

collection.products

object[]

The collection's products.

Show child attributes

collection.products.variants

object[]

required

The product's variants.

collection.products.length

number

required

The product's length.

collection.products.title

string

required

The product's title.

collection.products.status

enum<string>

required

The product's status.

Available options:

draft,

proposed,

published,

rejected

collection.products.options

object[]

required

The product's options.

Show child attributes

collection.products.options.id

string

required

The product option's ID.

collection.products.options.title

string

required

The product option's title.

collection.products.options.product

object

collection.products.options.product_id

string

The ID of the product this option belongs to.

collection.products.options.values

object[]

The product option's values.

Show child attributes

collection.products.options.values.id

string

required

The value's ID.

collection.products.options.values.value

string

required

The value.

collection.products.options.values.option

object

collection.products.options.values.option_id

string

The ID of the option this value belongs to.

collection.products.options.values.metadata

object

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

collection.products.options.values.created_at

string<date-time>

The date the value was created.

collection.products.options.values.updated_at

string<date-time>

The date the value was updated.

collection.products.options.values.deleted_at

string<date-time>

The date the value was deleted.

collection.products.options.metadata

object

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

collection.products.options.created_at

string<date-time>

The date the product option was created.

collection.products.options.updated_at

string<date-time>

The date the product option was updated.

collection.products.options.deleted_at

string<date-time>

The date the product option was deleted.

collection.products.description

string

required

The product's description.

collection.products.id

string

required

The product's ID.

collection.products.created_at

string<date-time>

required

The date the product was created.

collection.products.updated_at

string<date-time>

required

The date the product was updated.

collection.products.handle

string

required

The product's unique handle.

collection.products.subtitle

string

required

The product's subtitle.

collection.products.is_giftcard

boolean

required

Whether the product is a gift card.

collection.products.thumbnail

string

required

The product's thumbnail.

collection.products.width

number

required

The product's width.

collection.products.weight

number

required

The product's weight.

collection.products.height

number

required

The product's height.

collection.products.origin_country

string

required

The product's origin country.

collection.products.hs_code

string

required

The product's HS code.

collection.products.mid_code

string

required

The product's MID code.

collection.products.material

string

required

The product's material.

collection.products.collection_id

string

required

The ID of the collection that the product belongs to.

collection.products.type_id

string

required

The ID of the product's type.

collection.products.images

object[]

required

The product's images.

Show child attributes

collection.products.images.id

string

required

The image's ID.

collection.products.images.url

string

required

The image's URL.

collection.products.images.rank

number

required

The image's rank among its sibling images.

collection.products.images.created_at

string<date-time>

The date the image was created.

collection.products.images.updated_at

string<date-time>

The date the image was updated.

collection.products.images.deleted_at

string<date-time>

The date the image was deleted.

collection.products.images.metadata

object

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

collection.products.discountable

boolean

required

Whether discounts can be applied on the product.

collection.products.external_id

string

required

The ID of a product in an external system, such as an ERP or CMS.

collection.products.deleted_at

string<date-time>

required

The date the product was deleted.

collection.products.collection

object

The product collection's details.

Show child attributes

collection.products.collection.id

string

required

The collection's ID.

collection.products.collection.title

string

required

The collection's title.

collection.products.collection.handle

string

required

The collection's handle.

collection.products.collection.created_at

string<date-time>

required

The collection's creation date.

collection.products.collection.updated_at

string<date-time>

required

The collection's update date.

collection.products.collection.deleted_at

string<date-time>

required

The collection's deletion date.

collection.products.collection.metadata

object

required

The collection's metadata, used to store custom key-value pairs.

collection.products.collection.products

object[]

The collection's products.

collection.products.categories

object[]

The product's categories.

Show child attributes

collection.products.categories.category_children

object[]

required

The category's children.

Show child attributes

collection.products.categories.category_children.category_children

object[]

required

The category's children.

collection.products.categories.category_children.parent_category

object

required

collection.products.categories.category_children.name

string

required

The category's name.

collection.products.categories.category_children.description

string

required

The category's description.

collection.products.categories.category_children.id

string

required

The category's ID.

collection.products.categories.category_children.created_at

string<date-time>

required

The date the category was created.

collection.products.categories.category_children.updated_at

string<date-time>

required

The date the category was updated.

collection.products.categories.category_children.handle

string

required

The category's unique handle.

collection.products.categories.category_children.deleted_at

string<date-time>

required

The date the category was deleted.

collection.products.categories.category_children.is_active

boolean

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

collection.products.categories.category_children.is_internal

boolean

required

Whether the category is internal. If enabled, the category is only seen by admin users.

collection.products.categories.category_children.rank

number

required

The category's rank among sibling categories.

collection.products.categories.category_children.parent_category_id

string

required

The ID of the category's parent.

collection.products.categories.category_children.products

object[]

The category's products.

collection.products.categories.category_children.metadata

object

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

collection.products.categories.parent_category

object

required

The product category's details.

Show child attributes

collection.products.categories.parent_category.category_children

object[]

required

The category's children.

collection.products.categories.parent_category.parent_category

object

required

collection.products.categories.parent_category.name

string

required

The category's name.

collection.products.categories.parent_category.description

string

required

The category's description.

collection.products.categories.parent_category.id

string

required

The category's ID.

collection.products.categories.parent_category.created_at

string<date-time>

required

The date the category was created.

collection.products.categories.parent_category.updated_at

string<date-time>

required

The date the category was updated.

collection.products.categories.parent_category.handle

string

required

The category's unique handle.

collection.products.categories.parent_category.deleted_at

string<date-time>

required

The date the category was deleted.

collection.products.categories.parent_category.is_active

boolean

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

collection.products.categories.parent_category.is_internal

boolean

required

Whether the category is internal. If enabled, the category is only seen by admin users.

collection.products.categories.parent_category.rank

number

required

The category's rank among sibling categories.

collection.products.categories.parent_category.parent_category_id

string

required

The ID of the category's parent.

collection.products.categories.parent_category.products

object[]

The category's products.

collection.products.categories.parent_category.metadata

object

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

collection.products.categories.name

string

required

The category's name.

collection.products.categories.description

string

required

The category's description.

collection.products.categories.id

string

required

The category's ID.

collection.products.categories.created_at

string<date-time>

required

The date the category was created.

collection.products.categories.updated_at

string<date-time>

required

The date the category was updated.

collection.products.categories.handle

string

required

The category's unique handle.

collection.products.categories.deleted_at

string<date-time>

required

The date the category was deleted.

collection.products.categories.is_active

boolean

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

collection.products.categories.is_internal

boolean

required

Whether the category is internal. If enabled, the category is only seen by admin users.

collection.products.categories.rank

number

required

The category's rank among sibling categories.

collection.products.categories.parent_category_id

string

required

The ID of the category's parent.

collection.products.categories.products

object[]

The category's products.

collection.products.categories.metadata

object

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

collection.products.type

object

The product type's details.

Show child attributes

collection.products.type.id

string

required

The type's ID.

collection.products.type.value

string

required

The type's value.

collection.products.type.created_at

string<date-time>

required

The date the type was created.

collection.products.type.updated_at

string<date-time>

required

The date the type was updated.

collection.products.type.deleted_at

string<date-time>

The date the type was deleted.

collection.products.type.metadata

object

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

collection.products.tags

object[]

The product's tags.

Show child attributes

collection.products.tags.id

string

required

The tag's ID.

collection.products.tags.value

string

required

The tag's value.

collection.products.tags.created_at

string<date-time>

required

The date the tag was created.

collection.products.tags.updated_at

string<date-time>

required

The date the tag was updated.

collection.products.tags.deleted_at

string<date-time>

The date the tag was deleted.

collection.products.tags.metadata

object

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

collection.products.metadata

object

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

List Collections

Get a Collection

⌘I

Overview

Scanner API

Admin API

Authorizations

Query Parameters

Body

Response