Create Product

POST 
/openapi/2022-01/products

Create a new product with the provided details.

Request

application/json

Body

Body

product objectrequired

titlestringrequired

Product's title

briefstring

Product's briefing description

descriptionstring

Product's description

publishedboolean

Whether it is published or not

requires_shippingboolean

Whether it is required to shipping

taxableboolean

Whether it is taxable

tagsstring

Tags, separated by comma, for example: tag1,tag2

vendorstring

Vendor's name

vendor_urlstring

Vendor's URL

notestring

seo_titlestring

SEO title

seo_descriptionstring

SEO description

seo_keywordsstring

SEO keywords, separated by comma, for example: key1,key2

handlestring

Product's handle

has_only_default_variantbooleanrequired

Whether it is a single variant

Default value: true

inventory_trackingboolean

Whether to tracking inventory

inventory_policystring

Inventory policy: continue, deny, auto_unpublished, required while inventory_tracking is true

need_variant_imageboolean

Whether variant image is needed. It's required if has_only_default_variant is false

spustring

Product's SPU

fake_salesint32

Product's fake sales

display_fake_salesboolean

Whether to display fake sales

options object[]

Array [

namestringrequired

Option's name, for example: "color","size".

valuesstring[]required

Option's values, for example: ["red", "black"],["small", "large"]

Default value: []

]

images object[]

Array [

srcstringrequired

Image's URL

widthint32

Image's width in px

heightint32

Image's height in px

altstring

Image's alt

]

variants object[]

Array [

option1string

Option 1

option2string

Option 2

option3string

Option 3

image object

Variant's images, e.g.: {"src":"//cn.cdn.shoplazza.com/c8bf5695d347092d7a010f00182581f7.jpeg"}

srcstringrequired

Image's URL

widthint32

Image's width in px

heightint32

Image's height in px

altstring

Image's alt

compare_at_pricestring

Compare at price ( original price )

pricestringrequired

Price, set it to "0.00" if you want to leave the price empty.

skustring

SKU

barcodestring

The barcode of the variant

notestring

inventory_quantityint32

Inventory quantity

weightstring

weight_unitstring

Unit of weight, possible value are: kg, g, lb, oz

cost_pricestring

Cost price

wholesale_price object[]

Array [

pricestring

min_quantityint32

Mini Order Quantity

]

]

unique_tokenstring

Unique_token is a unique string identifier generated by your app, will be used for idempotency verification, for example: e6cc4df1-d4f5-4ad4-a019-2e0f3ddd6e63

mixed_wholesaleboolean

Whether mixed wholesale is supported

Example

{
  "product": {
    "title": "string",
    "brief": "string",
    "description": "string",
    "published": true,
    "requires_shipping": true,
    "taxable": true,
    "tags": "string",
    "vendor": "string",
    "vendor_url": "string",
    "note": "string",
    "seo_title": "string",
    "seo_description": "string",
    "seo_keywords": "string",
    "handle": "string",
    "has_only_default_variant": true,
    "inventory_tracking": true,
    "inventory_policy": "string",
    "need_variant_image": true,
    "spu": "string",
    "fake_sales": 0,
    "display_fake_sales": true,
    "options": [
      {
        "name": "string",
        "values": [
          "string"
        ]
      }
    ],
    "images": [
      {
        "src": "string",
        "width": 0,
        "height": 0,
        "alt": "string"
      }
    ],
    "variants": [
      {
        "option1": "string",
        "option2": "string",
        "option3": "string",
        "image": {
          "src": "string",
          "width": 0,
          "height": 0,
          "alt": "string"
        },
        "compare_at_price": "string",
        "price": "string",
        "sku": "string",
        "barcode": "string",
        "note": "string",
        "inventory_quantity": 0,
        "weight": "string",
        "weight_unit": "string",
        "cost_price": "string",
        "wholesale_price": [
          {
            "price": "string",
            "min_quantity": 0
          }
        ]
      }
    ],
    "unique_token": "string",
    "mixed_wholesale": true
  }
}

Responses

200

200

application/json

Schema

Schema

product object
idstring
Example: 9fb9f3c6-2300-42c1-8593-d9008d7cfc09
titlestring
Example: Stylish Shirt
briefstring
Example: A stylish shirt.
descriptionstring
Example:
publishedboolean
Default value: true
Example: true
requires_shippingboolean
Default value: true
Example: true
taxableboolean
Default value: true
Example: true
tagsstring
Example: shirt,stylish,cotton
vendorstring
Example: Awesome Vendor
vendor_urlstring
Example: https://awesomevendor.com
inventory_quantityinteger
Default value: 0
Example: 300
published_atstring
Example: 2024-12-03T19:02:30Z
created_atstring
Example: 2024-12-03T19:02:30Z
updated_atstring
Example: 2024-12-03T19:02:30Z
notestring
Example: Special promotion item.
seo_titlestring
Example: Buy Stylish Shirt Online
seo_descriptionstring
Example: Premium cotton
seo_keywordsstring
Example: shirt, cotton, stylish
handlestring
Example: stylish-shirt-zbxf
has_only_default_variantboolean
Default value: true
Example: false
inventory_trackingboolean
Default value: true
Example: true
inventory_policystring
Example: continue
need_variant_imageboolean
Default value: true
Example: false
spustring
Example: SS1234
fake_salesinteger
Default value: 0
Example: 50
display_fake_salesboolean
Default value: true
Example: true
mixed_wholesaleboolean
Default value: true
Example: true
image object
srcstring
Example: //img.fantaskycdn.com/loading.png
widthinteger
Default value: 0
Example: 100
heightinteger
Default value: 0
Example: 100
pathstring
Example: loading.png
altstring
Example:
images object[]
Array [
idstring
Example: 15333433-a0d5-44c9-941b-2c59ea07683e
product_idstring
Example: 9fb9f3c6-2300-42c1-8593-d9008d7cfc09
positioninteger
Default value: 0
Example: 1
srcstring
Example: //img.fantaskycdn.com/loading.png
widthinteger
Default value: 0
Example: 100
heightinteger
Default value: 0
Example: 100
altstring
Example:
created_atstring
Example: 2024-12-03T19:02:30Z
updated_atstring
Example: 2024-12-03T19:02:30Z
]
options object[]
Array [
idstring
Example: 8e40555e-a152-45fc-9587-fe85280701c5
product_idstring
Example: 9fb9f3c6-2300-42c1-8593-d9008d7cfc09
positioninteger
Default value: 0
Example: 1
namestring
Example: Size
valuesstring[]
]
variants object[]
Array [
idstring
Example: d7c7f9ba-f824-46b6-94af-1c2d1befaf27
product_idstring
Example: 9fb9f3c6-2300-42c1-8593-d9008d7cfc09
image_idstring
Example:
created_atstring
Example: 2024-12-03T19:02:30Z
updated_atstring
Example: 2024-12-03T19:02:30Z
titlestring
Example: Small-Red
option1string
Example: Small
option2string
Example: Red
option3string
Example:
image
positioninteger
Default value: 0
Example: 1
compare_at_pricestring
Example: 29.99
pricestring
Example: 19.99
skustring
Example: SS1234-RD-S
barcodestring
Example: 123456789012
notestring
Example: Limited
inventory_quantityinteger
Default value: 0
Example: 100
weightstring
Example: 0.50
weight_unitstring
Example: kg
cost_pricestring
Example: 12.99
wholesale_price object[]
Array [
pricestring
Example: 19.99
min_quantityinteger
Default value: 0
Example: 1
]
extend
]
category

Example

{
  "product": {
    "id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
    "title": "Stylish Shirt",
    "brief": "A stylish shirt.",
    "description": "",
    "published": true,
    "requires_shipping": true,
    "taxable": true,
    "tags": "shirt,stylish,cotton",
    "vendor": "Awesome Vendor",
    "vendor_url": "https://awesomevendor.com",
    "inventory_quantity": 300,
    "published_at": "2024-12-03T19:02:30Z",
    "created_at": "2024-12-03T19:02:30Z",
    "updated_at": "2024-12-03T19:02:30Z",
    "note": "Special promotion item.",
    "seo_title": "Buy Stylish Shirt Online",
    "seo_description": "Premium cotton",
    "seo_keywords": "shirt, cotton, stylish",
    "handle": "stylish-shirt-zbxf",
    "has_only_default_variant": false,
    "inventory_tracking": true,
    "inventory_policy": "continue",
    "need_variant_image": false,
    "spu": "SS1234",
    "fake_sales": 50,
    "display_fake_sales": true,
    "mixed_wholesale": true,
    "image": {
      "src": "//img.fantaskycdn.com/loading.png",
      "width": 100,
      "height": 100,
      "path": "loading.png",
      "alt": ""
    },
    "images": [
      {
        "id": "15333433-a0d5-44c9-941b-2c59ea07683e",
        "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
        "position": 1,
        "src": "//img.fantaskycdn.com/loading.png",
        "width": 100,
        "height": 100,
        "alt": "",
        "created_at": "2024-12-03T19:02:30Z",
        "updated_at": "2024-12-03T19:02:30Z"
      }
    ],
    "options": [
      {
        "id": "8e40555e-a152-45fc-9587-fe85280701c5",
        "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
        "position": 1,
        "name": "Size",
        "values": [
          "Small"
        ]
      }
    ],
    "variants": [
      {
        "id": "d7c7f9ba-f824-46b6-94af-1c2d1befaf27",
        "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
        "image_id": "",
        "created_at": "2024-12-03T19:02:30Z",
        "updated_at": "2024-12-03T19:02:30Z",
        "title": "Small-Red",
        "option1": "Small",
        "option2": "Red",
        "option3": "",
        "image": {},
        "position": 1,
        "compare_at_price": "29.99",
        "price": "19.99",
        "sku": "SS1234-RD-S",
        "barcode": "123456789012",
        "note": "Limited",
        "inventory_quantity": 100,
        "weight": "0.50",
        "weight_unit": "kg",
        "cost_price": "12.99",
        "wholesale_price": [
          {
            "price": "19.99",
            "min_quantity": 1
          }
        ],
        "extend": {}
      }
    ],
    "category": {}
  }
}

Result

{
    "product": {
        "id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
        "title": "Stylish Shirt",
        "brief": "A stylish shirt.",
        "description": "",
        "published": true,
        "requires_shipping": true,
        "taxable": true,
        "tags": "shirt,stylish,cotton",
        "vendor": "Awesome Vendor",
        "vendor_url": "https://awesomevendor.com",
        "inventory_quantity": 300,
        "published_at": "2024-12-03T19:02:30Z",
        "created_at": "2024-12-03T19:02:30Z",
        "updated_at": "2024-12-03T19:02:30Z",
        "note": "Special promotion item.",
        "seo_title": "Buy Stylish Shirt Online",
        "seo_description": "Premium cotton",
        "seo_keywords": "shirt, cotton, stylish",
        "handle": "stylish-shirt-zbxf",
        "has_only_default_variant": false,
        "inventory_tracking": true,
        "inventory_policy": "continue",
        "need_variant_image": false,
        "spu": "SS1234",
        "fake_sales": 50,
        "display_fake_sales": true,
        "mixed_wholesale": true,
        "image": {
            "src": "//img.fantaskycdn.com/loading.png",
            "width": 100,
            "height": 100,
            "path": "loading.png",
            "alt": ""
        },
        "images": [
            {
                "id": "15333433-a0d5-44c9-941b-2c59ea07683e",
                "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
                "position": 1,
                "src": "//img.fantaskycdn.com/loading.png",
                "width": 100,
                "height": 100,
                "alt": "",
                "created_at": "2024-12-03T19:02:30Z",
                "updated_at": "2024-12-03T19:02:30Z"
            },
            {
                "id": "a926bfff-03b4-4d00-bd85-cae50e7f4941",
                "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
                "position": 2,
                "src": "//img.fantaskycdn.com/loading.png",
                "width": 100,
                "height": 100,
                "alt": "",
                "created_at": "2024-12-03T19:02:30Z",
                "updated_at": "2024-12-03T19:02:30Z"
            }
        ],
        "options": [
            {
                "id": "8e40555e-a152-45fc-9587-fe85280701c5",
                "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
                "position": 1,
                "name": "Size",
                "values": [
                    "Small",
                    "Medium",
                    "Large",
                    "Extra Large"
                ]
            },
            {
                "id": "1e340474-6464-4d35-872c-75b751f6aa7f",
                "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
                "position": 2,
                "name": "Color",
                "values": [
                    "Red",
                    "Blue",
                    "Black"
                ]
            }
        ],
        "variants": [
            {
                "id": "d7c7f9ba-f824-46b6-94af-1c2d1befaf27",
                "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
                "image_id": "",
                "created_at": "2024-12-03T19:02:30Z",
                "updated_at": "2024-12-03T19:02:30Z",
                "title": "Small-Red",
                "option1": "Small",
                "option2": "Red",
                "option3": "",
                "image": null,
                "position": 1,
                "compare_at_price": "29.99",
                "price": "19.99",
                "sku": "SS1234-RD-S",
                "barcode": "123456789012",
                "note": "Limited",
                "inventory_quantity": 100,
                "weight": "0.50",
                "weight_unit": "kg",
                "cost_price": "12.99",
                "wholesale_price": [
                    {
                        "price": "19.99",
                        "min_quantity": 1
                    }
                ],
                "extend": null
            },
            {
                "id": "c7b74858-ad5a-4da3-9695-bdb936d3c057",
                "product_id": "9fb9f3c6-2300-42c1-8593-d9008d7cfc09",
                "image_id": "",
                "created_at": "2024-12-03T19:02:30Z",
                "updated_at": "2024-12-03T19:02:30Z",
                "title": "Medium-Blue",
                "option1": "Medium",
                "option2": "Blue",
                "option3": "",
                "image": null,
                "position": 2,
                "compare_at_price": "29.99",
                "price": "19.99",
                "sku": "SS1234-BL-M",
                "barcode": "123456789013",
                "note": "Best-selling",
                "inventory_quantity": 200,
                "weight": "0.60",
                "weight_unit": "kg",
                "cost_price": "13.99",
                "wholesale_price": [
                    {
                        "price": "19.99",
                        "min_quantity": 1
                    }
                ],
                "extend": null
            }
        ],
        "category": null
    }
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Title is required"
  ]
}

Result

{
  "errors": [
    "Title is required"
  ]
}

425

425

application/json

Schema

Schema

errorstring[]

Example

{
  "error": [
    "Duplicate requests"
  ]
}

Result

{ "error": ["Duplicate requests"] }

500

500

application/json

Schema

Schema

errorstring[]

Example

{
  "error": [
    "failed to get unique token value"
  ]
}

Result

{ "error":[ "failed to get unique token value"] }