Product

The product entity represents an item that is for sale on Joom. Each product can have multiple variations comprised of different sizes and colors. Each product has at least one product variation. Product variations, not products, are purchased by users. Each product contains multiple related SKUs.

With this API you can create, and update products. You can also retrieve one or many of your products.

object

The product entity represents an item that is for sale on Joom. Each product can have multiple variations comprised of different sizes and colors. Each product has at least one product variation. Product variations, not products, are purchased by users. Each product contains multiple related SKUs.

With this API you can create, and update products. You can also retrieve one or many of your products.

id
string

The Joom ID of the product

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
date_uploaded
string

Date when product was created

enabled
boolean

If true, this product is eligible for sale

is_promoted
string

if “True”, the product is used in advertising

1 validation
number_saves
string

Number of times this product has been added to favourite list

number_sold
string

Number of sales this product has received

number_orders
integer

Number of orders containing this product

number_refunds
integer

Number of refunded orders of this product

refund_rate
number

Refund rate = Number of refunds / Number of orders

number_ratings
integer

Number of orders of this product rated by users

average_rating
number

Average user rating

original_image_url
string

URL of the original image when product was created

1 validation
review_note
string

The note when the product marked as rejected

review_status
string

Our review status of the product. This value can be: approved, pending, rejected

1 validation
variants
array[object]

A list of Product Variation entities