Create Product

POST

vendor

products

curl -X POST 'http://localhost:9000/vendor/products' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Acme T-Shirt",
    "options": [{ "title": "Size", "values": ["S", "M"] }],
    "variants": [
      { "title": "S", "sku": "ACME-SHIRT-S", "options": { "Size": "S" } },
      { "title": "M", "sku": "ACME-SHIRT-M", "options": { "Size": "M" } }
    ]
  }'

const { product } = await client.vendor.products.mutate({
  title: "Acme T-Shirt",
  options: [{ title: "Size", values: ["S", "M"] }],
  variants: [
    { title: "S", sku: "ACME-SHIRT-S", options: { Size: "S" } },
    { title: "M", sku: "ACME-SHIRT-M", options: { Size: "M" } },
  ],
})

{
  "product": {
    "id": "prod_01HXYZ",
    "title": "Acme T-Shirt",
    "status": "proposed",
    "handle": "acme-t-shirt",
    "variants": [
      { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
    ]
  }
}

Creates a product; when no status is provided it is created with status proposed.

When the product request flow is enabled, status may only be draft or proposed. Publishing requires operator approval.

Query parameters

string

Comma-separated fields to include in the returned product. Prefix with +/- to add to or remove from the defaults.

Body parameters

string

required

The product’s title.

string

The product’s subtitle.

string

The product’s description.

string

default:"proposed"

One of draft, proposed, published, rejected. Restricted to draft / proposed when the product request flow is enabled.

boolean

default:"false"

Whether the product is a gift card.

boolean

default:"true"

Whether discounts can apply to the product.

object[]

Show properties

string

required

Image URL.

string

URL of the product’s thumbnail image.

string

The product’s URL handle; generated from the title when omitted.

string

ID of the product in an external system.

string

ID of the product type.

string

ID of the collection the product belongs to.

object[]

Show properties

string

required

Category ID.

object[]

Show properties

string

required

Tag ID.

object[]

Show properties

string

required

Option title, e.g. Size.

string[]

required

Allowed option values.

object[]

Product attribute assignments; each entry references an existing attribute by id or defines one inline by title.

Show properties

string

Existing attribute ID (referencing form).

string[]

IDs of attribute values to select (referencing form).

string | number | boolean

Scalar value for text, unit, or toggle attributes.

string

Attribute title (inline form).

string

One of single_select, multi_select, text, toggle, unit (inline form).

string[]

Value names to create and select (inline form).

boolean

Whether the attribute drives variant combinations (inline form).

boolean

Whether the attribute is filterable (inline form).

boolean

Whether the attribute is required (inline form).

string

Attribute description (inline form).

object

Custom key-value pairs (inline form).

object[]

Show properties

string

required

Variant title.

string

Variant SKU.

string

EAN barcode.

string

UPC barcode.

string

ISBN code.

string

Amazon ASIN.

string

GTIN code.

string

Generic barcode.

string

Harmonized System code.

string

Manufacturer ID code.

number

Sort rank of the variant.

number

Weight of the variant.

number

Length of the variant.

number

Height of the variant.

number

Width of the variant.

string

Country of origin.

string

Material of the variant.

object

Custom key-value pairs.

object

Option title to value mapping, e.g. {"Size": "M"}.

number

Weight of the product.

number

Length of the product.

number

Height of the product.

number

Width of the product.

string

Harmonized System code.

string

Manufacturer ID code.

string

Country of origin.

string

Material of the product.

object

Custom key-value pairs.

object

Extra data passed to workflow hooks.

Response

object

Show properties

string

The product’s ID.

string

The product’s title.

string

The product’s status (proposed unless overridden).

string

The product’s URL handle.

object[]

The created variants.

object[]

The product’s attribute assignments.

curl -X POST 'http://localhost:9000/vendor/products' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Acme T-Shirt",
    "options": [{ "title": "Size", "values": ["S", "M"] }],
    "variants": [
      { "title": "S", "sku": "ACME-SHIRT-S", "options": { "Size": "S" } },
      { "title": "M", "sku": "ACME-SHIRT-M", "options": { "Size": "M" } }
    ]
  }'

const { product } = await client.vendor.products.mutate({
  title: "Acme T-Shirt",
  options: [{ title: "Size", values: ["S", "M"] }],
  variants: [
    { title: "S", sku: "ACME-SHIRT-S", options: { Size: "S" } },
    { title: "M", sku: "ACME-SHIRT-M", options: { Size: "M" } },
  ],
})

{
  "product": {
    "id": "prod_01HXYZ",
    "title": "Acme T-Shirt",
    "status": "proposed",
    "handle": "acme-t-shirt",
    "variants": [
      { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
    ]
  }
}

curl -X POST 'http://localhost:9000/vendor/products' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Acme T-Shirt",
    "options": [{ "title": "Size", "values": ["S", "M"] }],
    "variants": [
      { "title": "S", "sku": "ACME-SHIRT-S", "options": { "Size": "S" } },
      { "title": "M", "sku": "ACME-SHIRT-M", "options": { "Size": "M" } }
    ]
  }'

const { product } = await client.vendor.products.mutate({
  title: "Acme T-Shirt",
  options: [{ title: "Size", values: ["S", "M"] }],
  variants: [
    { title: "S", sku: "ACME-SHIRT-S", options: { Size: "S" } },
    { title: "M", sku: "ACME-SHIRT-M", options: { Size: "M" } },
  ],
})

{
  "product": {
    "id": "prod_01HXYZ",
    "title": "Acme T-Shirt",
    "status": "proposed",
    "handle": "acme-t-shirt",
    "variants": [
      { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
    ]
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Body parameters

Response

​Query parameters

​Body parameters

​Response

Query parameters

Body parameters

Response