Create Special Offer

POST https://api.salla.dev/admin/v2/specialoffers

This endpoint allows you to create a new special offer and return the created special offer id and its details.

💡 Note

More details of body samples of differnt types of offers are listed in this link.

Request Body

{"name"=>"<string>", "applied_channel"=>"browser_and_application", "offer_type"=>"fixed_amount", "applied_to"=>"product", "expiry_date"=>"<string>", "min_purchase_amount"=>"<number>", "min_items_count"=>"<number>", "buy"=>{"type"=>"category", "min_amount"=>"<number>", "quantity"=>"<number>", "products"=>["<integer>", "<integer>"], "categories"=>["<integer>", "<integer>"], "payment_methods"=>["<integer>", "<integer>"]}, "get"=>{"discount_amount"=>"<number>", "type"=>"category", "discount_type"=>"percentage", "quantity"=>"<number>", "products"=>["<integer>", "<integer>"], "categories"=>["<integer>", "<integer>"]}}

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","message":"\u003cstring\u003e","expiry_date":"\u003cstring\u003e","start_date":"\u003cstring\u003e","offer_type":"fixed_amount","status":"\u003cstring\u003e","show_price_after_discount":"\u003cboolean\u003e","show_discounts_table_message":"\u003cboolean\u003e","buy":{"type":"category","quantity":"\u003cnumber\u003e","products":[{"id":"\u003cnumber\u003e","type":"service","promotion":{"title":"\u003cstring\u003e","sub_title":"\u003cstring\u003e"},"status":"\u003cstring\u003e","is_available":"\u003cboolean\u003e","sku":"\u003cstring\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"url":"\u003cstring\u003e","has_special_price":"\u003cboolean\u003e","regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"currency":"\u003cstring\u003e","thumbnail":"\u003cstring\u003e","calories":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","favorite":"\u003cstring\u003e","starting_price":"\u003cstring\u003e"},{"id":"\u003cnumber\u003e","type":"service","promotion":{"title":"\u003cstring\u003e","sub_title":"\u003cstring\u003e"},"status":"\u003cstring\u003e","is_available":"\u003cboolean\u003e","sku":"\u003cstring\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"url":"\u003cstring\u003e","has_special_price":"\u003cboolean\u003e","regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"currency":"\u003cstring\u003e","thumbnail":"\u003cstring\u003e","calories":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","favorite":"\u003cstring\u003e","starting_price":"\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"}],"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"}],"parent_id":"\u003cinteger\u003e","sort_order":"\u003cinteger\u003e","status":"hidden","metadata_title":"\u003cstring\u003e","metadata_description ":"\u003cstring\u003e","metadata_url":"\u003cstring\u003e"}]},"get":{"type":"\u003cstring\u003e","discount_type":"percentage ","quantity":"\u003cinteger\u003e","products":[{"id":"\u003cnumber\u003e","type":"product","promotion":{"title":"\u003cstring\u003e","sub_title":"\u003cstring\u003e"},"status":"\u003cstring\u003e","is_available":"\u003cboolean\u003e","sku":"\u003cstring\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"url":"\u003cstring\u003e","has_special_price":"\u003cboolean\u003e","regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"currency":"\u003cstring\u003e","thumbnail":"\u003cstring\u003e","calories":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","favorite":"\u003cstring\u003e","starting_price":"\u003cstring\u003e"},{"id":"\u003cnumber\u003e","type":"food","promotion":{"title":"\u003cstring\u003e","sub_title":"\u003cstring\u003e"},"status":"\u003cstring\u003e","is_available":"\u003cboolean\u003e","sku":"\u003cstring\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"url":"\u003cstring\u003e","has_special_price":"\u003cboolean\u003e","regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"currency":"\u003cstring\u003e","thumbnail":"\u003cstring\u003e","calories":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","favorite":"\u003cstring\u003e","starting_price":"\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"}],"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"}],"parent_id":"\u003cinteger\u003e","sort_order":"\u003cinteger\u003e","status":"hidden","metadata_title":"\u003cstring\u003e","metadata_description ":"\u003cstring\u003e","metadata_url":"\u003cstring\u003e"}]}}}