v1

latestSwagger 2.02026-07-134272111.8 KB
products

Update a product associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the product object will be updated, and those fields not provided will be left alone. Updating a product with a specified ID that does not exist will result in an error response. <p><strong>Update supports the following fields: sku, quantity, trackQuantity, quantityDelta, warningLimit, name, price, weight, tangible, enabled, fixedShippingRateOnly, fixedShippingRate, description, wholesalePrices, compareAtPrice, productClassId</strong>

patch/products/{id}

Path parameters

idstring required

The ID of the product to update in the eCommerce system

Headers

Authorizationstring required

The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

Request body

categoryIdsinteger[]
compareAtPricenumber double

Product’s sale price displayed strike-out in the customer

compareToPricenumber double
defaultCategoryIdinteger
descriptionstring

Product description in HTML

enabledboolean

true/false

fixedShippingRatenumber double
fixedShippingRateOnlyboolean

true/false

googleItemConditionstring

Google Item Condition Status

isShippingRequiredboolean
namestring

Product title

pricenumber double

Base Product price

productClassIdinteger

Id of the product type that this product belongs to.

quantityinteger

Amount of product items in stock.

seoDescriptionstring
seoTitlestring
showOnFrontpagenumber double
skustring

Product SKU

warningLimitinteger
weightnumber double

Product weight in the units defined in store settings

Response

OK - Everything worked as expected