Skip to main content

Update a product

Update a product.

Authorizations:Token, JWT
Query Parameters
product_id
required
stringResource identifier
Request Body Schema:
The updated Product resource
og_meta_tags_typestringDefault: "A"Enum: "A""C"Example: "A"
og_meta_tagsstring
market_pricenumber
pin_codes_enabledboolean
auto_pin_codesboolean
participate_saleboolean
discount_typestringDefault: "sale_percent"Enum: "sale_price""sale_percent"Example: "sale_percent"
sale_price_valuenumber
apply_sale_to_wholesaleboolean
available_for_backorderbooleanDefault: trueExample: true
backorder_limitintegerExample: "0"
cost_pricenumberExample: "5.75"
stickersArray of integers
facebook_marketing_enabledbooleanDefault: trueExample: true
google_feed_enabledbooleanDefault: trueExample: true
vendor_idinteger or null
tagsArray of strings
skustring[1 .. 32] charactersExample: "0001"
namestring[1 .. 255] charactersExample: "Product name"
descriptionstringExample: "Full description"
brief_descriptionstringExample: "Description"
meta_tagsstring
meta_description_typestringDefault: "A"Enum: "A""C"Example: "A"
meta_descriptionstring
meta_titlestring
pricenumberExample: "9.99"
enabledbooleanDefault: trueExample: true
weightnumberExample: "1.5"
separate_boxboolean
widthnumberExample: "1.5"
lengthnumberExample: "1.5"
heightnumberExample: "1.5"
free_shippingboolean
taxablebooleanDefault: trueExample: true
arrival_datestring or nullExample: "2021-10-22T00:00:00+00:00"
inventory_traceablebooleanDefault: trueExample: true
amountinteger>= 0Default: 1000Example: "1000"
product_classstring or nullExample: "Fashion"
tax_classstring or nullExample: "VAT"
membershipsArray of strings
clean_urlstring

Responses

200Product resource updated
Response schema:
Product resource updated
og_meta_tagsstring
market_pricenumber
pin_codes_enabledboolean
auto_pin_codesboolean
participate_saleboolean
discount_typestringDefault: "sale_percent"Enum: "sale_price""sale_percent"Example: "sale_percent"
sale_price_valuenumber
apply_sale_to_wholesaleboolean
available_for_backorderboolean
backorder_limitinteger
cost_pricenumber
stickersArray of integers
facebook_marketing_enabledboolean
google_feed_enabledboolean
vendor_idinteger or null
tagsArray of objects
Array
idinteger
namestring
idinteger
skustring
namestring
descriptionstring
brief_descriptionstring
meta_tagsstring
meta_descriptionstring
meta_titlestring
pricenumber
enabledboolean
weightnumber
separate_boxboolean
widthnumber
lengthnumber
heightnumber
free_shippingboolean
taxableboolean
create_datestring
update_datestring
arrival_datestring
inventory_traceableboolean
amountinteger
product_classobject or null
  • object
idinteger
namestring
tax_classobject or null
  • object
idinteger
namestring
membershipsArray of objects
Array
idinteger
namestring
enabledboolean
clean_urlstring
imagesArray of objects
Array
idinteger
positioninteger
altstring
urlstring
widthinteger
heightinteger
400Invalid input
401Unauthorized
Response schema:
Unauthorized
typestring
titlestring
detailstring or null
instancestring or null
404Resource not found
Response schema:
Resource not found
typestring
titlestring
detailstring or null
instancestring or null
422Unprocessable entity
500Internal error
Response schema:
Internal error
typestring
titlestring
detailstring or null
instancestring or null