post

/product/add

The /product/add endpoint creates a new product. It also creates the first variant of that product, so if a product has a single variant, both the product and the variant can be created with this endpoint. If you have further variants, you can create them using the /variant/add endpoint.

In this endpoint, the main_image field sets the main image of the product. To set a different main image for the variant use the variant_main_image field.

Please note that if you intend to create several variations for the product, you’re required to provide the first variation in this endpoint. Otherwise, if you create all of the variations using the /variant/add endpoint, you may have to remove the variation created by this /product/add endpoint.

Returns

Upon success, a product is created and returned. The id field can be used to obtain the Joom product identifier that is assigned.

Request Body

Schema
object

Product and its first (or only) variation input.

access_token
string

Your access token

required
parent_sku
string

The unique identifier that your system uses for this product. In particular, you can use this identifier to add additional variants to the product. If this field is not specified, we’ll use the variant parameter sku, but you are advised to always specify this parameter

required
brand
string

Brand or manufacturer of your product

description
string

Description of the product, interpreted as plain text — HTML markup will not be processed. You can use “\n” to separate lines. Limit of 4,000 characters, and only the first 250 characters are displayed on the initial search page. Do not include details about store policies, other store-specific language or multiple lines. Information about size, fit, and measurements are helpful for apparel items
Acceptable: “This dress shirt is 100% cotton and fits true to size.”
Unacceptable: “This <b>dress shirt</b> is 100% cotton and <i>fits true to size</i>.”

extra_images
string

URL of extra photos of your product. Link directly to the image, not the page where it is located. The format and size requirements as the same as for the main_image field. You can specify one or more additional images separated by the character |

landing_page_url
string

URL on your website containing the product details

1 validation
main_image
string

URL of the main image of the product. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Do not include company logos or names or promotional or other identifying text. Images should be at least 550×550 pixels in size. Do not include any “image not found” images.
Acceptable: “http://www.yourwebsite.com/images/7324204/3”, “http://www.yourwebsite.com/images/dress.jpg”
Unacceptable: “http://www.yourwebsite.com/images/dresses.html”

1 validation + required
name
string

The name which you have given the product. Use the following template to build your product names: Main brand + Sub-brand, family or product name + Up to 3 key attributes + Generic product type. Product names must be clear and concise and should also be descriptive of the product being sold. This template will help consumers identifying your product.
Acceptable: “Men’s Dress Casual Shirt Navy”, “Women’s Solid Color Black Dress Pants”
Unacceptable: “Best Price!!! CHEAP Baby Stroller!!!”

required
tags
array[object]

Non-hierarchical keyword or term assigned to each product in your feed. This kind of metadata helps describe an item and allows it to be categorized and found again by browsing or searching on Joom.it. Select up to 5 per product. Tags should be comma separated, but do NOT use commas in individual tags. The more tags you add, and the more accurate your tags, the better the chances our users will find your products. There is a maximum of 10 tags allowed per product, if you add more than 10 we ignore the extra tags
Acceptable: “Shirt, Men’s Fashion, Navy, Blue, Casual, Apparel”, “Women’s Fashion, Jewelry & Watches”, “Men’s Fashion, Suits, Mafia, Silk Tie, Ties”
Unacceptable: “Clearance Items”, “Cheap Cheap Cheap”

required
dangerous_kind
string

Product dangerous kind. If product is not dangerous, “notDangerous” should be used.

1 validation
gtin
string

Global Trade Item Number (GTIN). GTIN may be 8, 12, 13 or 14 digits long. GTIN cannot contain letters or other characters.

alternative_id
string

ID of the same product on other marketplace (currently AliExpress IDs are supported).

1 validation
color
string

The color of the variation, especially as it pertains to apparel or jewelry. If you would like to have it show two colors (eg. “black and red”), simply separate the colors by “&” (eg. “black & red”). Note: not to be confused with products having two different colored variations. The name of the color must be in the list of currently accepted colors
Acceptable: “red”, “black & blue”
Unacceptable: “red, blue”, “black & blue & green”

hs_code
string

HS code.

3 validations
msrp
string

The Manufacturer Suggested Retail Price of the variation. This field is recommended as it will show as a strike-thru price on Joom and appears above the selling price for the product. It should contain no additional text
Acceptable: “$19.00”, “19.99”
Unacceptable: “19.99 + S/H”

price
string

The price of the variation when the user purchases one.
Acceptable: “$100.99”, “10.99”
Unacceptable: “$49.99 + S/H”

required
shipping
string

The shipping price of the variation when the user purchases one
Acceptable: “$4.00”, “4.99”
Unacceptable: “$4.99 + S/H”

required
shipping_height
string

Shipping height, should be provided in cm. Use float-point values to express size in millimeters.
Height, length, and width must always be set together in one request

shipping_length
string

Shipping length, should be provided in cm. Use float-point values to express size in millimeters.
Height, length, and width must always be set together in one request

shipping_weight
string

Gross weight, should be provided in kilograms

shipping_width
string

Shipping width, should be provided in cm. Use float-point values to express size in millimeters.
Height, length, and width must always be set together in one request

size
string

The size of the variation, especially as it pertains to apparel, footwear, or jewelry. It must be either a number or in the list of currently accepted sizes
Acceptable: “S”, “XXL”, “6”, “6.5”
Unacceptable: “small”, “S, M”

declaredValue
string

Declared value for customs. If empty, item price will be used.

inventory
number

The physical quantities you have for this variation, max 100,000

1 validation + required
sku
string

The unique identifier that your system uses to recognize this variation.
Acceptable: “HSC0424PP”, “112123343455432”.
Unacceptable: “2”, “a”.

required
product_main_image
string

Product main image URL.

1 validation
variant_main_image
string

Variation main image URL.

1 validation

Responses

Schema
object
code
number

Contains the status code for the request, 0 means success and any other number implies a failure

1 validation + required
message
string

Sometimes will store a human readable status message to aid in debugging. It is generally used only for errors

required
data
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host