Product Update

Request
header Parameters
X-HMAC-SHA256
string
Example: wFplXQpltmwo1darqMleSj7ozgYoN4L+kM4UYYtDs7o=
Request Body schema: application/json
organization_id
required
string
title
required
string
body_html
string
vendor
string
product_type
required
string
Enum: "physical" "digital"
inventory_quantity
integer

Required when the product's inventory_management attribute is set to product

inventory_management
required
string
Enum: "product" "variant" "bypass"
img_src
required
string

The default product image, used as thumbnail only in the Rally admin.

external_id
required
string

The ID of the product, as defined in the Platform

can_be_added_to_cart
boolean

Whether this product can be added to a cart or not.

can_be_added_to_order
boolean

Whether this product can be added to an order or not.

tax_code
string or null

The tax code which identifies the product/service, if any.

Array of objects (ProductOption)

List of all the product options as defined in the platform

required
Array of objects (ProductVariant)

List of all the variations of the product as defined in the platform

required
Array of objects (ProductImage)

List of images that showcase the product.

meta
string

The raw payload of the product returned by the platform's API.

Responses
200
post/product-update
Request samples
application/json
{
  • "organization_id": "org_ABC",
  • "title": "My Amazing Product",
  • "body_html": "<p>The Chemex Coffeemaker was created in 1939 by famed inventor Peter J. Schlumbohm.</p>\r\n<p>Applying his knowledge of filtration and extraction, Mr. Schlumbohm was able to craft the vessel that would pour the perfect cup of joe. The angles of the drip, thickness of the filter paper and the air vent chamber allow coffee to brew in a specified time and release gases that are usually trapped in by other brewing methods. This results in a smooth, bitter-free cup in less than four minutes.</p>\r\n<p>Made of labratory heatproof borosilicate glass with a simple wooden handle, the Chemex coffeemaker's design has been inducted in to the permanent collection of The Museum of Modern Art.</p>\r\n<p>Measures 21 cm h x 7.6 cm dia/8.25 in h x 3 in dia</p>\r\n<p>Capacity 473 ml/1 Pint</p>",
  • "vendor": "Nike",
  • "product_type": "physical",
  • "inventory_quantity": 50,
  • "inventory_management": "bypass",
  • "external_id": "88",
  • "can_be_added_to_cart": false,
  • "can_be_added_to_order": false,
  • "tax_code": "19000",
  • "options": [
    ],
  • "variants": [],
  • "images": [],
  • "meta": "<unformatted_payload_from_the_platform>"
}
Response samples
application/json
{
  • "message": "Success"
}
Copyright © Rally Commerce, Inc. 2023. All right reserved.