Update Product
PUT {{baseUrl}}/products/:product
You can update specific product Details by providing the ID of the product you want to update its details in the product path parameter.
Scope: products.read_write
- Products Read & Write
Request Body
{"name"=>"<string>", "price"=>"<number>", "status"=>"hidden", "quantity"=>"<number>", "booking_details"=>{"location"=>"<string>", "type"=>"date_time", "session_duration"=>"<number>", "session_gap"=>"<number>", "session_count"=>"<number>", "time_strict_value"=>"<number>", "time_strict_type"=>"days", "availabilities"=>[{"day"=>"sunday", "is_available"=>true, "times"=>[{"from"=>"<string>", "to"=>"<string>"}, {"from"=>"<string>", "to"=>"<string>"}]}, {"day"=>"saturday", "is_available"=>true, "times"=>[{"from"=>"<string>", "to"=>"<string>"}, {"from"=>"<string>", "to"=>"<string>"}]}], "overrides"=>[{"day"=>"<string>", "date"=>"<string>"}, {"day"=>"<string>", "date"=>"<string>"}]}, "unlimited_quantity"=>"<boolean>", "description"=>"<string>", "categories"=>["<number>", "<number>"], "min_amount_donating"=>"<number>", "max_amount_donating"=>"<number>", "sale_price"=>"<number>", "cost_price"=>"<number>", "sale_end"=>"<string>", "require_shipping"=>"<boolean>", "maximum_quantity_per_order"=>"<number>", "weight"=>"<number>", "weight_type"=>"lb", "sku"=>"<string>", "mpn"=>"<string>", "gtin"=>"<string>", "calories"=>"<string>", "with_tax"=>true, "hide_quantity"=>"<boolean>", "show_in_web"=>"<boolean>", "channels"=>["web", "app"], "enable_upload_image"=>"<boolean>", "enable_note"=>"<boolean>", "pinned"=>"<boolean>", "active_advance"=>"<boolean>", "subtitle"=>"<string>", "promotion_title"=>"<string>", "promotion_subtitle"=>"<string>", "metadata_title"=>"<string>", "metadata_description"=>"<string>", "metadata_url"=>"<string>", "brand_id"=>"<number>", "tags"=>["<number>", "<number>"]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cnumber\u003e","promotion":{"title":"\u003cstring\u003e","sub_title":"\u003cstring\u003e"},"sku":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","type":"codes","name":"\u003cstring\u003e","short_link_code":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"taxed_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"pre_tax_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"tax":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"description":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","unlimited_quantity":"\u003cboolean\u003e","status":"sale","is_available":"\u003cboolean\u003e","views":"\u003cinteger\u003e","sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_end":"\u003cstring\u003e","require_shipping":"\u003cboolean\u003e","cost_price":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","weight_type":"kg","with_tax":"\u003cboolean\u003e","url":"\u003cstring\u003e","images":[{"id":"\u003cnumber\u003e","url":"\u003cstring\u003e","main":true,"alt":"\u003cstring\u003e","video_url":"\u003cstring\u003e","type":"image","sort":"\u003cnumber\u003e","three_d_image_url":"\u003cstring\u003e","main_image":"\u003cstring\u003e"}],"sold_quantity":"\u003cinteger\u003e","rating":{"total":"\u003cinteger\u003e","count":"\u003cinteger\u003e","rate":"\u003cnumber\u003e"},"regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"max_items_per_user":"\u003cnumber\u003e","maximum_quantity_per_order":"\u003cnumber\u003e","show_in_app":"\u003cboolean\u003e","notify_quantity":"\u003cstring\u003e","hide_quantity":"\u003cboolean\u003e","channels":["app","app"],"managed_by_branches":"\u003cboolean\u003e","service_blocks":{"installments":[{"name":"\u003cstring\u003e","title":"\u003cstring\u003e","logo":"\u003cstring\u003e","details":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","title":"\u003cstring\u003e","logo":"\u003cstring\u003e","details":"\u003cstring\u003e"}]},"calories":"\u003cstring\u003e","starting_price":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"allow_attachments":"\u003cboolean\u003e","is_pinned":"\u003cboolean\u003e","pinned_date":"\u003cstring\u003e","sort":"\u003cnumber\u003e","active_advance":"\u003cboolean\u003e","enable_upload_image":"\u003cboolean\u003e","updated_at":"\u003cstring\u003e","options":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"checkbox","required":"\u003cboolean\u003e","associated_with_order_time":"\u003cinteger\u003e","sort":"\u003cinteger\u003e","display_type":"color","visibility":"always","visibility_condition_type":"=","visibility_condition_option":"\u003cinteger\u003e","visibility_condition_value":"\u003cinteger\u003e","values":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"formatted_price":"\u003cstring\u003e","display_value":"\u003cstring\u003e","advance":"\u003cboolean\u003e","option_id":"\u003cnumber\u003e","image_url":"\u003cstring\u003e","hashed_display_value":"\u003cstring\u003e","translations":{"ar":{"option_details_name":"\u003cstring\u003e"}},"is_default":"\u003cboolean\u003e","is_out_of_stock":"\u003cboolean\u003e"}]}],"skus":[{"id":"\u003cnumber\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cost_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"has_special_price":"\u003cboolean\u003e","stock_quantity":"\u003cinteger\u003e","unlimited_quantity":"\u003cboolean\u003e","notify_low":"\u003cinteger\u003e","barcode":"\u003cstring\u003e","sku":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","related_options":["\u003cinteger\u003e","\u003cinteger\u003e"],"related_option_values":["\u003cinteger\u003e","\u003cinteger\u003e"],"weight":"\u003cnumber\u003e","weight_type":"\u003cstring\u003e","weight_label":"\u003cstring\u003e","is_user_subscribed_to_sku":"\u003cboolean\u003e","is_default":"\u003cboolean\u003e"},{"id":"\u003cnumber\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cost_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"has_special_price":"\u003cboolean\u003e","stock_quantity":"\u003cinteger\u003e","unlimited_quantity":"\u003cboolean\u003e","notify_low":"\u003cinteger\u003e","barcode":"\u003cstring\u003e","sku":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","related_options":["\u003cinteger\u003e","\u003cinteger\u003e"],"related_option_values":["\u003cinteger\u003e","\u003cinteger\u003e"],"weight":"\u003cnumber\u003e","weight_type":"\u003cstring\u003e","weight_label":"\u003cstring\u003e","is_user_subscribed_to_sku":"\u003cboolean\u003e","is_default":"\u003cboolean\u003e"}],"metadata":{"title":"\u003cstring\u003e","description":"\u003cstring\u003e","url":"\u003cstring\u003e"},"booking_details":{"id":"\u003cnumber\u003e","location":"\u003cstring\u003e","type":"date","session_duration":"\u003cnumber\u003e","session_gap":"\u003cnumber\u003e","session_count":"\u003cnumber\u003e","time_strict_value":"\u003cnumber\u003e","time_strict_type":"days","availabilities":[{"day":"wednesday","is_available":true,"times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]},{"day":"sunday","is_available":true,"times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]}],"overrides":[{"id":"\u003cnumber\u003e","date":"\u003cstring\u003e"},{"id":"\u003cnumber\u003e","date":"\u003cstring\u003e"}]},"categories":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"items":[{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"}],"parent_id":"\u003cinteger\u003e","sort_order":"\u003cinteger\u003e","status":"hidden","metadata_title":"\u003cstring\u003e","metadata_description ":"\u003cstring\u003e","metadata_url":"\u003cstring\u003e"},{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"items":[{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/Category detected\u003e"}],"parent_id":"\u003cinteger\u003e","sort_order":"\u003cinteger\u003e","status":"active","metadata_title":"\u003cstring\u003e","metadata_description ":"\u003cstring\u003e","metadata_url":"\u003cstring\u003e"}],"brand":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","banner":"\u003cstring\u003e","logo":"\u003cstring\u003e","ar_char":"\u003cstring\u003e","en_char":"\u003cstring\u003e","metadata":{"title":"\u003cstring\u003e","description":"\u003cstring\u003e","url":"\u003cstring\u003e"}},"tags":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"},{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"}]}}