POST Product/Add

Add a product

Request Information

URI Parameters

None.

Body Parameters

Product
NameDescriptionTypeAdditional information
Sku

string

Required

Name

Name of the product as shown to users

string

Required

Description

Description of the product. Should not contain HTML. If you want a new line use "\n".

string

Required

Inventory

The physical quantities you have for this product, max 500,000

integer

Required

Range: inclusive between 0 and 500000

Price

The price of the product when the user purchases one, max 100,000

decimal number

Required

Range: inclusive between 0 and 100000

MSRP

optional Manufacturer's Suggested Retail Price. This field is recommended as it will show as a strikethrough price and appears above the selling price for the product.

decimal number

None.

Currency

The currency for the price. Will be converted to USD for Wish.

string

Required

MainImage

URL of a photo of your product. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Images should be at least 100 x 100 pixels in size.

string

Required

Brand

optional Brand or manufacturer of your product

string

None.

UPC

optional 12-digit Universal Product Codes (UPC)-contains no letters or other characters

string

None.

Tags

list of strings that describe the product. Only 10 are allowed. Any tags past 10 will be ignored.

Collection of string

Required

Color

optional The color of the product. Example: red, blue, green

string

None.

Size

optional The size of the product. Example: Large, Medium, Small, 5, 6, 7.5

string

None.

Shipping

The shipping of the product when the user purchases one, max 1000

string

Required

Range: inclusive between 0 and 1000

ShippingTime

optional The amount of time it takes for the shipment to reach the buyer. Please also factor in the time it will take to fulfill and ship the item. Provide a time range in number of days. Lower bound cannot be less than 2 days. Upper bound must be at least 5 days after the lower bound. Example: 15-20

string

None.

LandingPageURL

optional URL on your website containing the product details

string

None.

ExtraImages

optional URL of extra photos of your product. Link directly to the image, not the page where it is located. Same rules apply as main_image. You can specify one or more additional images separated by the character '|'. The total number of extra images plus the number of variation images must not exceed 20.

string

None.

MaxQuantity

optional The maximum quantity of products per order.

integer

None.

Length

optional The length of your product that will be packaged to ship to customer (Units in cm)

string

None.

Width

optional The width of your product that will be packaged to ship to customer (Units in cm)

string

None.

Height

optional The height of your product that will be packaged to ship to customer (Units in cm)

string

None.

Weight

optional The weight of your product that will be packaged to ship to customer (Units in g)

string

None.

DeclaredValue

optional The price of your product that will be declared to custom.

decimal number

None.

OriginCountry

optional country where product is manufactured. Country code should follow ISO 3166 Alpha-2 code. Example:CN, US

string

None.

HasPowder

optional Whether product contains powder. Example: true, false.

boolean

None.

HasLiquid

optional Whether product contains liquid. Example: true, false.

boolean

None.

HasBattery

optional Whether product contains battery. Example: true, false.

boolean

None.

Variants

Not supported at present, add products individually

Collection of ProductVariant

None.

Request Formats

application/json, text/json

Sample:
{
  "Sku": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Inventory": 4,
  "Price": 5.0,
  "MSRP": 1.0,
  "Currency": "sample string 6",
  "MainImage": "sample string 7",
  "Brand": "sample string 8",
  "UPC": "sample string 9",
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "Color": "sample string 10",
  "Size": "sample string 11",
  "Shipping": "sample string 12",
  "ShippingTime": "sample string 13",
  "LandingPageURL": "sample string 14",
  "ExtraImages": "sample string 15",
  "MaxQuantity": 16,
  "Length": "sample string 17",
  "Width": "sample string 18",
  "Height": "sample string 19",
  "Weight": "sample string 20",
  "DeclaredValue": 21.0,
  "OriginCountry": "sample string 22",
  "HasPowder": true,
  "HasLiquid": true,
  "HasBattery": true,
  "Variants": [
    {
      "ParentSku": "sample string 1",
      "Sku": "sample string 2",
      "Color": "sample string 3",
      "Size": "sample string 4",
      "Inventory": 5,
      "Price": 6.0,
      "Currency": "sample string 7",
      "Shipping": 8.0,
      "MSRP": 1.0,
      "ShippingTime": "sample string 9",
      "MainImage": "sample string 10",
      "Length": "sample string 11",
      "Width": "sample string 12",
      "Height": "sample string 13",
      "Weight": "sample string 14",
      "DeclaredValue": 15.0,
      "OriginCountry": "sample string 16",
      "HasPowder": true,
      "HasLiquid": true,
      "HasBattery": true
    },
    {
      "ParentSku": "sample string 1",
      "Sku": "sample string 2",
      "Color": "sample string 3",
      "Size": "sample string 4",
      "Inventory": 5,
      "Price": 6.0,
      "Currency": "sample string 7",
      "Shipping": 8.0,
      "MSRP": 1.0,
      "ShippingTime": "sample string 9",
      "MainImage": "sample string 10",
      "Length": "sample string 11",
      "Width": "sample string 12",
      "Height": "sample string 13",
      "Weight": "sample string 14",
      "DeclaredValue": 15.0,
      "OriginCountry": "sample string 16",
      "HasPowder": true,
      "HasLiquid": true,
      "HasBattery": true
    }
  ]
}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.