post

/products/update

Updates an existing product. Either id or sku must be specified.

This endpoint works almost like a PATCH endpoint.

  • If you don’t send some fields in the request body, they won’t be updated or removed.
  • You can omit variants that you don’t want to change.
  • Variants with new SKUs will be created and added to the product. Variants with existing SKUs will be updated.
  • You can send just the fields you want to change and omit any field that you don’t want to change. E.g. if you want to change just the product’s name, the request body may be as simple as { "name" : "My New Name" }.
  • If you explicitly send null value for some field, this field will be set to default/empty value. Some fields don’t have a default value (e.g. currency), you cannot send null for them.

Returns

The updated product.

Request Parameters

2 Query Parameters

Request Body

Schema
object
name
string

Name

description
string

Description of the product, interpreted as plain text. HTML markup will not be accepted. You can use “\n” to separate lines.

extraImages
array[string]

URL of extra photos of your product, no more than 20. 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.

landingPageUrl
string

URL on merchant’s website containing the product details.

gtin
string

Global Trade Item Number (GTIN), may be 8, 12, 13 or 14 digits long, contains no letters or other characters.
Acceptable: “716393133224”
Unacceptable: “asdf884445ds”

tags
array[string]

Tags (not visible to customers, used as search keywords)

enabled
boolean

Whether the product is eligible for sale

dangerKind
string

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

1 validation
brand
string

Brand or manufacturer

mainImage
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.
Acceptable: “http://www.yourwebsite.com/images/7324204/3”, “http://www.yourwebsite.com/images/dress.jpg”
Unacceptable: “http://www.yourwebsite.com/images/dresses.html”

Details: https://merchant-help.joom.com/hc/en-us/articles/115003497334

categoryId
string

Joom’s unique identifier of the category

attributes
array[object]

Text attributes provided by the merchant

variants
array[object]

Responses

Product with its variants

Schema
object
data
object

Send a Test Request

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