Skip to content
UNIMALL Developer & Integration Portal

Product Create

API Reference

EnvironmentMethodEndpoint
SandboxPOSThttps://api-develop.unimall.ai/supplier/product
ProductionPOSThttps://api-prod.unimall.ai/supplier/product

Description

To upload images, pass in the request the links to the images in the public cloud storage. The image format is JPG or PNG. This method allows you to create products.

You can create 100 products per minute.

Each product is a separate element.

To merge two product description pages, use parentSku field. When you send the same value for different products, we merge these products into the same card.

Make sure to specify all the product details: its characteristics, barcode, images, dimensions, price.

Request parameters

Field NameTypeIsRequiredValidation RulesDescriptionSample Input
parentSkuStringYesMax Length 30The Main SKU (Stock Keeping Unit) of the product. A product can have multiple variants that share the same Parent SKU to group product variations.UM1000000
skuStringYesMax Length 30Unique code for each variant of the product (e.g. different sizes or colors). Each variation must have a unique SKU value to identify these.UM1000000001
barcodeStringNoMax Length 30Barcode number for the product. Leave blank if not available.UM1000000001
gtinStringNoMax Length 30A GTIN (Global Trade Item Number) is a unique identifier for trade items. Leave blank if not available.012345678905
mpnStringNoMax Length 30An MPN (Manufacturer Part Number) is a unique identifier assigned by manufacturers to individual products. Leave blank if not available.MPN-12345ABC
categoryNameStringYesMax Length 400Category name of the product. Write full category path as seen in the example; Fashion > Clothing > Women’s Clothing > T-ShirtsFashion > Clothing > Women’s Clothing > T-Shirts
languageStringYesSupported language codes: EN, ZH, RUEN
nameStringYesMax Length 200Name of the product.Women’s Summer Tops Casual V-Neck T-Shirts
descriptionStringYesMax Length 4000Description of the product.Casual patchwork V-neck long sleeve T-shirt
brandNameStringNoMax Length 100Brand name of the product.Adidas
htsCodeStringNoMax Length 20An HTS code (Harmonized Tariff Schedule code) used to identify products in international trade.8471.30.0100
currencyCodeStringNoSupported currency codes: USD, CNY, RUBCNY
firstCostDecimalNoEmpty or > 0It is the acquisition cost of a product. Leave blank if not available.999.99
salePriceDecimalNoEmpty or > 0Sale price of the product to the seller.1199.90
heightDoubleNoEmpty or > 0Height of the product in cm.30.5
lengthDoubleNoEmpty or > 0Length of the product in cm.30.5
widthDoubleNoEmpty or > 0Width of the product in cm.50.5
weightDoubleYes> 0.0Weight of the product in kg.2.1
imagesArrayNoMin sizes: 700x900px, Max 10 imagesImage links of the product.https://firstimageurl.jpg
[images]orderIntOrder number of the image.0
[images]urlStringDownloadable image URL address.https://firstimageurl.jpg
videosArrayNoVideo links of the product.https://firstvideourl.mp4
[videos]orderIntOrder number of the video.0
[videos]urlStringDownloadable video URL address.https://firstvideourl.mp4
optionsArrayYesMax length 1000Option (variation) keys and values of the product.
[options]keyStringOption name of the product. (e.g., Color)
[options]valueStringOption value of the product. (e.g., Black)
attributesArrayYesMax length 1000Characteristics of the product.
[attributes]keyStringAttribute name of the product. (e.g., Gender)
[attributes]valueStringAttribute value of the product. (e.g., Women)

Sample Curl Request

curl -X 'POST' \
  'https://api-develop.unimall.ai/supplier/product' \
  -H 'accept: text/plain' \
  -H 'X-API-Key: **********' \
  -H 'Content-Type: application/json' \
  -d '{
  "parentSku": "UM1000000",
  "sku": "UM1000000001",
  "barcode": "UM1000000001",
  "gtin": "012345678905",
  "mpn": "MPN-12345ABC",
  "categoryName": "Fashion > Women > Tshirts",
  "language": "EN",
  "name": "Women'\''s Summer Tops Casual V-Neck Short Sleeve Basic T-Shirts",
  "description": "Womens tops casual patchwork color block V-neck long sleeve T-shirt sweatshirt tunic blouse top design can make you more lovely, vitality and beautiful. Simple and loose style is comfortable to wear.",
  "brandName": "Adidas",
  "htsCode": "8471.30.0100",
  "currencyCode": "CNY",
  "firstCost": 999.99,
  "salePrice": 1199.90,
  "height": 30.5,
  "length": 30.5,
  "width": 50.5,
  "weight": 2.1,
  "images": [
    {
      "order": 0,
      "url": "https://static.zara.net/assets/public/4123/946d/f7424c3dbbc1/9feda5915e3b/04060090406-001-p/04060090406-001-p.jpg"
    },
    {
      "order": 1,
      "url": "https://static.zara.net/assets/public/719d/aa9e/88d142879c13/44cf741c154a/04060090406-001-a1/04060090406-001-a1.jpg"
    }
  ],
  "videos": [
    {
      "order": 0,
      "url": "https://video-content.dsmcdn.com/prod/720p/2015934/2021916/2043850/a40109f9-66a0-46ef-99d1-635ac0cf3d5d.mp4"
    }
  ],
  "options": [
    {
      "key": "Color",
      "value": "White"
    },
    {
      "key": "Size",
      "value": "Small"
    }
  ],
  "attributes": [
    {
      "key": "Gender",
      "value": "Women"
    },
    {
      "key": "Season",
      "value": "Summer"
    }
  ]
}'

Sample Response (Successful)

HTTP 200

{
  "data": {
    "id": "ccc682f4-c128-40ee-9883-bb48c6ceac89",
    "createdAt": "2024-08-19T12:02:00.0479091Z",
    "updatedAt": "2024-08-19T12:02:00.0479105Z",
    "parentSku": "UM1000000",
    "sku": "UM1000000001",
    "barcode": "UM1000000001",
    "gtin": "012345678905",
    "mpn": "MPN-12345ABC",
    "categoryName": "Fashion > Women > Tshirts",
    "language": "EN",
    "name": "Women's Summer Tops Casual V-Neck Short Sleeve Basic T-Shirts",
    "description": "Womens tops casual patchwork color block V-neck long sleeve T-shirt sweatshirt tunic blouse top design can make you more lovely, vitality and beautiful. Simple and loose style is comfortable to wear.",
    "brandName": "Adidas",
    "htsCode": "8471.30.0100",
    "currencyCode": "CNY",
    "firstCost": 999.99,
    "salePrice": 1199.9,
    "height": 30.5,
    "length": 30.5,
    "width": 50.5,
    "weight": 2.1,
    "images": [
      {
        "order": 0,
        "url": "https://static.zara.net/assets/public/4123/946d/f7424c3dbbc1/9feda5915e3b/04060090406-001-p/04060090406-001-p.jpg"
      },
      {
        "order": 1,
        "url": "https://static.zara.net/assets/public/719d/aa9e/88d142879c13/44cf741c154a/04060090406-001-a1/04060090406-001-a1.jpg"
      }
    ],
    "videos": [
      {
        "order": 0,
        "url": "https://video-content.dsmcdn.com/prod/720p/2015934/2021916/2043850/a40109f9-66a0-46ef-99d1-635ac0cf3d5d.mp4"
      }
    ],
    "options": [
      {
        "key": "Color",
        "value": "White"
      },
      {
        "key": "Size",
        "value": "Small"
      }
    ],
    "attributes": [
      {
        "key": "Gender",
        "value": "Women"
      },
      {
        "key": "Season",
        "value": "Summer"
      }
    ]
  },
  "isSuccess": true
}