Create Product

POST

admin

products

curl -X POST 'http://localhost:9000/admin/products' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Linen Shirt",
    "seller_ids": ["sel_01HXYZABCDEF"],
    "options": [{ "title": "Size", "values": ["S", "M"] }],
    "variants": [
      { "title": "S", "sku": "LS-S", "options": { "Size": "S" } },
      { "title": "M", "sku": "LS-M", "options": { "Size": "M" } }
    ],
    "attributes": [{ "title": "Material", "type": "single_select", "values": ["Linen"] }]
  }'

const { product } = await client.admin.products.mutate({
  title: "Linen Shirt",
  seller_ids: ["sel_01HXYZABCDEF"],
  options: [{ title: "Size", values: ["S", "M"] }],
  variants: [
    { title: "S", sku: "LS-S", options: { Size: "S" } },
    { title: "M", sku: "LS-M", options: { Size: "M" } },
  ],
  attributes: [{ title: "Material", type: "single_select", values: ["Linen"] }],
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt",
    "handle": "linen-shirt",
    "status": "draft",
    "variants": [
      { "id": "variant_01HXYZABCDEF", "title": "S", "sku": "LS-S" },
      { "id": "variant_01HXYZABCDEG", "title": "M", "sku": "LS-M" }
    ]
  }
}

Creates a shared master product that sellers can be made eligible to sell.

Pass seller_ids to set which sellers may sell the product. The attributes array accepts a unified input: reference an existing catalog attribute by id, or create an inline product-scoped attribute by title.

Body parameters

string

required

Product title.

string

Product subtitle.

string

Product description.

string

Unique URL-safe handle, generated from the title if omitted.

string

One of draft, proposed, published, rejected.

boolean

default:"false"

Whether the product is a gift card.

boolean

default:"true"

Whether discounts can apply to the product.

string

URL of the product thumbnail.

object[]

Product images.

Show properties

string

required

Image URL.

string

ID of the product in an external system.

string

ID of the product type.

string

ID of the collection to assign the product to.

string[]

IDs of sellers eligible to sell the product.

object[]

Categories to assign the product to.

Show properties

string

required

Category ID.

object[]

Tags to assign to the product.

Show properties

string

required

Tag ID.

object[]

Product options used to build variants.

Show properties

string

required

Option title, for example Size.

string[]

required

Possible option values.

object[]

Unified attribute input, one of two shapes per item.

Show existing attribute (by id)

string

required

ID of an existing catalog attribute.

string[]

IDs of attribute values to select.

string | number | boolean

Scalar value for text, unit, or toggle attributes.

Show inline attribute (by title)

string

required

Attribute title.

string

One of single_select, multi_select, unit, toggle, text.

string[]

Value names to create and select.

string | number | boolean

Scalar value for non-select types.

boolean

Whether the attribute drives variant generation; only valid for multi_select.

boolean

Whether the attribute can be used as a storefront filter.

boolean

Whether a value is required on products.

string

Attribute description.

object

Custom key-value data.

object[]

Product variants.

Show properties

string

required

Variant title.

string

Variant SKU.

string

Variant EAN.

string

Variant UPC.

string

Variant ISBN.

string

Variant ASIN.

string

Variant GTIN.

string

Variant barcode.

string

Harmonized System code.

string

Manufacturer identification code.

number

Sort rank of the variant.

number

Variant weight.

number

Variant length.

number

Variant height.

number

Variant width.

string

Country of origin.

string

Variant material.

object

Map of option title to option value, for example {"Size": "M"}.

object

Custom key-value data.

number

Product weight.

number

Product length.

number

Product height.

number

Product width.

string

Harmonized System code.

string

Manufacturer identification code.

string

Country of origin.

string

Product material.

object

Custom key-value data.

object

Custom data passed to workflow hooks.

Response

object

Show properties

string

The product’s ID.

string

Product title.

string

Unique URL-safe handle.

string

One of draft, proposed, published, rejected.

object[]

Created variants.

object[]

Attribute values selected on the product.

object[]

Product-scoped (inline) attributes with their values.

object[]

Computed attribute groups with selected values and all_values.

string

Creation timestamp.

string

Last update timestamp.

curl -X POST 'http://localhost:9000/admin/products' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Linen Shirt",
    "seller_ids": ["sel_01HXYZABCDEF"],
    "options": [{ "title": "Size", "values": ["S", "M"] }],
    "variants": [
      { "title": "S", "sku": "LS-S", "options": { "Size": "S" } },
      { "title": "M", "sku": "LS-M", "options": { "Size": "M" } }
    ],
    "attributes": [{ "title": "Material", "type": "single_select", "values": ["Linen"] }]
  }'

const { product } = await client.admin.products.mutate({
  title: "Linen Shirt",
  seller_ids: ["sel_01HXYZABCDEF"],
  options: [{ title: "Size", values: ["S", "M"] }],
  variants: [
    { title: "S", sku: "LS-S", options: { Size: "S" } },
    { title: "M", sku: "LS-M", options: { Size: "M" } },
  ],
  attributes: [{ title: "Material", type: "single_select", values: ["Linen"] }],
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt",
    "handle": "linen-shirt",
    "status": "draft",
    "variants": [
      { "id": "variant_01HXYZABCDEF", "title": "S", "sku": "LS-S" },
      { "id": "variant_01HXYZABCDEG", "title": "M", "sku": "LS-M" }
    ]
  }
}

curl -X POST 'http://localhost:9000/admin/products' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Linen Shirt",
    "seller_ids": ["sel_01HXYZABCDEF"],
    "options": [{ "title": "Size", "values": ["S", "M"] }],
    "variants": [
      { "title": "S", "sku": "LS-S", "options": { "Size": "S" } },
      { "title": "M", "sku": "LS-M", "options": { "Size": "M" } }
    ],
    "attributes": [{ "title": "Material", "type": "single_select", "values": ["Linen"] }]
  }'

const { product } = await client.admin.products.mutate({
  title: "Linen Shirt",
  seller_ids: ["sel_01HXYZABCDEF"],
  options: [{ title: "Size", values: ["S", "M"] }],
  variants: [
    { title: "S", sku: "LS-S", options: { Size: "S" } },
    { title: "M", sku: "LS-M", options: { Size: "M" } },
  ],
  attributes: [{ title: "Material", type: "single_select", values: ["Linen"] }],
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt",
    "handle": "linen-shirt",
    "status": "draft",
    "variants": [
      { "id": "variant_01HXYZABCDEF", "title": "S", "sku": "LS-S" },
      { "id": "variant_01HXYZABCDEG", "title": "M", "sku": "LS-M" }
    ]
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Body parameters

Response

​Body parameters

​Response

Body parameters

Response