Create a product (with optional variants)

POST

/admin/v1/products

const url = 'https://your-store.example.com/admin/v1/products';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"title":"example","slug":"example","description":"example","status":"draft","seoTitle":"example","seoDescription":"example","isBundle":false,"variants":[{"sku":"example","title":"example","options":{},"priceAmount":1,"currency":"example","compareAtAmount":1,"stockQuantity":0,"allowBackorder":false,"weightGrams":1,"lengthMm":1,"widthMm":1,"heightMm":1,"position":0}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://your-store.example.com/admin/v1/products \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "slug": "example", "description": "example", "status": "draft", "seoTitle": "example", "seoDescription": "example", "isBundle": false, "variants": [ { "sku": "example", "title": "example", "options": {}, "priceAmount": 1, "currency": "example", "compareAtAmount": 1, "stockQuantity": 0, "allowBackorder": false, "weightGrams": 1, "lengthMm": 1, "widthMm": 1, "heightMm": 1, "position": 0 } ] }'

Request Body^required

application/json

object

title

required

string

>= 1 characters <= 512 characters

slug

string

>= 1 characters <= 512 characters

description

Any of:

string
null

string

status

string

default: draft

Allowed values: draft published archived

seoTitle

Any of:

string
null

string

<= 512 characters

seoDescription

Any of:

string
null

string

<= 1024 characters

isBundle

boolean

variants

Array<object>

object

sku

string

>= 1 characters <= 255 characters

title

string

>= 1 characters <= 512 characters

options

object

key

additional properties

priceAmount

required

integer

<= 9007199254740991

currency

required

string

/^[A-Za-z]{3}$/

compareAtAmount

Any of:

integer
null

integer

<= 9007199254740991

stockQuantity

integer

0 <= 9007199254740991

allowBackorder

boolean

weightGrams

Any of:

integer
null

integer

<= 9007199254740991

lengthMm

Any of:

integer
null

integer

<= 9007199254740991

widthMm

Any of:

integer
null

integer

<= 9007199254740991

heightMm

Any of:

integer
null

integer

<= 9007199254740991

position

integer

0 <= 9007199254740991

Create a product (with optional variants)

Request Body^required

Responses

201

Create a product (with optional variants)

Request Body required

Responses

201

Request Body^required