post

/variant/add

To add a new variation to a product you can create a product variation. For example, a product has sizes “Large” and “Extra-Large” and you wanted to add size “Medium”, you would create a new product variation with this API.

Returns

If the request was successful and a Variant was added to the supplied Product, then the response will contain the variant created along with its Joom identifier.

Request Body

Schema
object
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
main_image
string

URL of a photo for this product variation. Provide this when you have different pictures for different product variation of the product. If left out, it’ll use the main_image of the product with the provided parent_sku. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Images should be at least 550×550 pixels in size

1 validation
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.

gtin
string

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

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

The parent_sku of the product this new product variation should be added to

required
access_token
string

Your access token

required

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