Create Special Offer

POST {{baseUrl}}/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.

OAuth Scopes

---

specialoffers.read_write

Request Body

{"name"=>"new offer", "applied_channel"=>"browser_and_application", "offer_type"=>"fixed_amount", "applied_to"=>"product", "expiry_date"=>"12/12/2021", "min_purchase_amount"=>100, "min_items_count"=>2, "min_items"=>0, "buy"=>{"type"=>"product", "min_amount"=>10, "quantity"=>3, "products"=>[1473353380], "categories"=>[1015488293, 1656418340], "payment_methods"=>[1473353380, 1298199463, 349994915]}, "get"=>{"type"=>"product", "discount_type"=>"percentage", "discount_amount"=>5, "quantity"=>20, "products"=>[566146469, 1939592358], "categories"=>[1015488293, 1656418340]}}

HEADERS

RESPONSES

status: OK

{"status":200,"success":true,"data":{"id":773200552,"name":"Sample Fixed Amount Offer 3","message":"اشتري قطعة واحصل على قطعة واحدة مجاناً من المنتجات التالية","expiry_date":"null","offer_type":"fixed_amount","applied_to":"product","buy":{"min_amount":0,"min_items":5,"products":[{"id":1,"sku":"HURT_128","name":"منتج 1","price":{"amount":100,"currency":"SAR"},"currency":"SAR","description":"null","options":[],"type":"product","store_id":2,"brand_id":0,"quantity":100,"status":"hidden","rand_token":"","views":1,"created_at":"2016-03-24 22:41:39","updated_at":"2020-06-22 18:38:22","minimum_order_time":"0","maximum_daily_order":null,"max_items_per_user":0,"allow_attachments":0,"pinned":false,"pinned_date":"2016-03-24 10:41:39","sale_price":{"amount":100,"currency":"SAR"},"sale_end":"null","source":null,"require_shipping":true,"cost_price":0,"digital_download_limit":null,"digital_download_expiry":null,"from_instagram":1,"weight":0,"with_tax":true,"hide_quantity":false,"min_amount_donating":0,"max_amount_donating":0,"subtitle":"null","active_advance":false,"enable_upload_image":true,"promotion_title":"null","extra_attributes":[],"sort":0,"enable_note":true,"thumbnail":"","thumbnail_alt_seo":null,"barcode":null,"target_donating_enable":false}]},"get":{"discount_amount":"50.00"}}}