Create Special Offer

POST {{baseUrl}}/specialoffers

This endpoint allows you to create a new special offer in the store.

specialoffers.read_write- Special Offers Read & Write

Request Body

{"name"=>"<string>", "applied_channel"=>"browser", "offer_type"=>"buy_x_get_y", "applied_to"=>"order", "expiry_date"=>"<string>", "min_purchase_amount"=>"<number>", "min_items_count"=>"<number>", "buy"=>{"type"=>"product", "quantity"=>"<number>", "products"=>[{"id"=>"<number>", "type"=>"group_products", "promotion"=>{"title"=>"<string>", "sub_title"=>"<string>"}, "status"=>"<string>", "is_available"=>"<boolean>", "sku"=>"<string>", "name"=>"<string>", "price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "sale_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "url"=>"<string>", "has_special_price"=>"<boolean>", "regular_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "currency"=>"<string>", "thumbnail"=>"<string>", "calories"=>"<string>", "mpn"=>"<string>", "gtin"=>"<string>", "favorite"=>"<string>", "starting_price"=>"<string>"}, {"id"=>"<number>", "type"=>"service", "promotion"=>{"title"=>"<string>", "sub_title"=>"<string>"}, "status"=>"<string>", "is_available"=>"<boolean>", "sku"=>"<string>", "name"=>"<string>", "price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "sale_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "url"=>"<string>", "has_special_price"=>"<boolean>", "regular_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "currency"=>"<string>", "thumbnail"=>"<string>", "calories"=>"<string>", "mpn"=>"<string>", "gtin"=>"<string>", "favorite"=>"<string>", "starting_price"=>"<string>"}], "categories"=>[{"name"=>"<string>", "url"=>"<string>"}, {"name"=>"<string>", "url"=>"<string>"}]}, "get"=>{"type"=>"<string>", "discount_type"=>"percentage ", "quantity"=>"<integer>", "products"=>[{"id"=>"<number>", "type"=>"digital", "promotion"=>{"title"=>"<string>", "sub_title"=>"<string>"}, "status"=>"<string>", "is_available"=>"<boolean>", "sku"=>"<string>", "name"=>"<string>", "price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "sale_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "url"=>"<string>", "has_special_price"=>"<boolean>", "regular_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "currency"=>"<string>", "thumbnail"=>"<string>", "calories"=>"<string>", "mpn"=>"<string>", "gtin"=>"<string>", "favorite"=>"<string>", "starting_price"=>"<string>"}, {"id"=>"<number>", "type"=>"digital", "promotion"=>{"title"=>"<string>", "sub_title"=>"<string>"}, "status"=>"<string>", "is_available"=>"<boolean>", "sku"=>"<string>", "name"=>"<string>", "price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "sale_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "url"=>"<string>", "has_special_price"=>"<boolean>", "regular_price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "currency"=>"<string>", "thumbnail"=>"<string>", "calories"=>"<string>", "mpn"=>"<string>", "gtin"=>"<string>", "favorite"=>"<string>", "starting_price"=>"<string>"}], "categories"=>[{"name"=>"<string>", "url"=>"<string>"}, {"name"=>"<string>", "url"=>"<string>"}]}}

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":"percentage","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":"codes","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":"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"}],"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":"active","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":"hidden","metadata_title":"\u003cstring\u003e","metadata_description ":"\u003cstring\u003e","metadata_url":"\u003cstring\u003e"}]},"get":{"type":"\u003cstring\u003e","discount_type":"free-product","quantity":"\u003cinteger\u003e","products":[{"id":"\u003cnumber\u003e","type":"group_products","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"},{"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"},{"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"}]}}}