Yelo
  1. Promo
Yelo
  • Acl
    • Create Role
      POST
    • Get Role
      POST
    • Edit Role
      POST
    • Delete Role
      POST
    • Get Role Permissions
      POST
  • Custom PG
    • paymentStatus
      POST
  • CSV Import
    • csv
      POST
  • Menu
    • Add Menu
      POST
    • Get Menu
      POST
  • Notification
    • getCreds
      POST
    • sendCustomPushNotification
      POST
  • Tax
    • delete
      POST
    • edit
      POST
    • get
      POST
    • add
      POST
  • Themes
    • configure
      POST
    • resetTemplate
      POST
    • cloneFeatures
      POST
    • editTemplate
      POST
    • getTemplate
      POST
    • getPagesAndComponents
      POST
    • updateUserTheme
      POST
    • getThemeSemantics
      POST
    • enableTheme
      POST
    • getThemeJson
      POST
    • editTheme
      POST
    • getThemes
      POST
    • forkTheme
      POST
    • getUserTheme
      POST
  • Customer
    • customer Deletion
    • Add Customer
    • customer verifyOtp
    • customerForgotPassword
    • View Customer
    • Customer Details
    • Edit Customer
    • Add Customer Subscription Plan
    • Get Customer Subscriptions List
    • Edit Customer Subscription Plan
    • googleLogin
    • Assign Customer Subscription Plan
    • Customer login
    • getFavLocation
    • Forgot Password
  • Wallet
    • addMoney
    • customer/getWalletTxnHistory
  • Loyality Points
    • Update Loyality Points
    • Reward Loyalty Points
  • City
    • Get City
  • Promo
    • Delete Promo
      POST
    • Change Promo Status
      POST
    • Edit Promo
      POST
    • Add Promo
      POST
    • Get Promo
      POST
  • Order
    • Order review
    • Get All Orders
    • Get Order Details
    • Create Order
    • Custom Order
    • orderPrepTime
  • Search
    • searchGlobalProduct
    • searchProducts
    • searchGlobalMerchants
  • Marketplace
    • Settings
    • Edit Merchant details
    • Get Banner
    • get Activity Logs
    • marketplaceVendorFacebookLogin
    • Add Debt For Job
    • addMerchant
    • getMerchantList
    • getAccountTranslations
    • getfilter
    • Cancellation reason
  • Task
    • edit task prep time
    • addRemarks
    • getTookanRequest
    • Edit Task
    • Accept Reject Order
    • updateStatus
  • Merchant
    • Add Store Availability
    • Update Store Availability for day
    • Get merchant custom field
    • Edit Store Status
    • Get Store FrontDateSchedule
    • Add Store FrontDateSchedule
    • Update Store FrontDateSchedule
    • Get merchant
    • Merchant settings
    • user_login
  • Catalogue
    • Catagory
      • Add Catalogue
      • Update Catalogue
      • Get Catalogue
      • Get All Catalogues
      • Get Catalogue Products
      • Enable Disable Category wise
      • Delete catalogue
    • Products
      • disable
      • Add product
      • Edit Product
      • delete
      • Disable Products
      • Get product
      • Get All Products
      • Get Products For Category
    • Product Customization
      • Deprecated
        • Get Customization
        • Add Customization
        • Delete Customization
        • Edit Customization
      • Customizations
    • tags
      • Get All tags
      • Get tags Products
  • Business Categories
    • Assign Business Category
    • Get Business Category
    • businessCategory
  • Send SMS
    • Send App Link SMS
  • Admin
    • Edit Order
    • Add Address
    • Get address
    • Delete Address
    • Edit address
    • Admin Detail
  • Billing
    • getPlans
    • getInvoices
    • getBillBreakDown
  • Project
    • get
  • Discount
    • merchant Discount
      • /open/merchant/discount/get
      • merchant/discount/edit
      • merchantDiscount/add
    • Product Discount
      • productDiscount/add
      • product/discount/get
      • product/discount/edit
      • product/discount/delete
  • Store Reviews
    • getStoreAllReviews
  • checkout template
    • template/getCheckoutTemplate
  • Payment
    • activePaymentMethods
    • getPaymentUrl
  1. Promo

Add Promo

POST
/open/promo/add
array(optional)
NameTypeDescription
api_keystringYour API-key
promo_codestring(optional)Name of promo code
promo_typenumber0-public , 1-hidden, 2-auto apply

descriptionstring(optional)description of promo
min_order_valuenumber(optional)minimum order for promo to be applicable
max allowed usersnumber(optional)number of users to be allowed
max_allowed_countnumber(optional)number of promo can be applicable
max_discount_valuenumber(optional)maximum discount users can apply
promo_modenumber0 flat 1 percentage
promo_valuenumbervalue of promo
usage_limit_per_daynumber(optional)day wise usage (number)
multiple_allowed_single_usernumber(optional)0 - one time for single customer or 1 - allow multple times for single customer
promo_onnumber(optional)0-subtotal , 1-delivery, 2-product
single_user_max_countnumber(optional)single user count promo to be used
timezonenumberin minutes (utc time - current local time)
from_timestringlocal time in TZ format
end_timestringlocal time in TZ format
store_idnumber(optional)if promo is product wise assign value of merchant of that products if promo is product wise else leave it as it is optional product_ids : [1,2,3] if promo is 0-subtotal , 1-delivery and assign to specific merchants merchant_ids : [2131, 2132]
product idsarr(optional)
merchant_idsarray(optional)merchant ids
customer_subscription_plan_idsarray(optional)array of plan ids map the promo (optional)
city_dataarray(optional)optional city data
loyalty_points_enablednumber(optional)loyalty points enabled
loyalty_earning_enablednumber(optional)loyalty earning enabled

Request

Body Params application/json
object {0}
Example
{
        "api_key"                              : {{apikey}},
        "promo_code"                           : "PROMO",
		"promo_type"                           : 0,
		"description"                          : "promo",
		"min_order_value"                      : 1,
		"max_allowed_users"                    : 10,
		"max_allowed_count"                    : 2,
		"max_discount_value"                   : 50,
		"promo_mode"                           : 0, 
		"promo_value"                          : 25, 
		"usage_limit_per_day"                  : 2,
		"multiple_allowed_single_user"         : 1,
		"promo_on"                             : 0,
		"single_user_max_count"                : 10,
		"timezone"                             : 15,
        "from_time"                             :"2021-11-15T10:34:52Z",
		"end_time"                             : "2021-11-15T10:34:52Z",
		"store_id"                             : 65465466,
		"product_ids"                          : [],
		"merchant_ids"                         : [],
		"customer_subscription_plan_ids"       : [],
		"city_data"                            : [],
		"loyalty_points_enabled"               :0,
		"loyalty_earning_enabled"              : 1
	
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.yelo.red/open/promo/add' \
--header 'Content-Type: application/json' \
--data-raw '{
        "api_key"                              : {{apikey}},
        "promo_code"                           : "PROMO",
		"promo_type"                           : 0,
		"description"                          : "promo",
		"min_order_value"                      : 1,
		"max_allowed_users"                    : 10,
		"max_allowed_count"                    : 2,
		"max_discount_value"                   : 50,
		"promo_mode"                           : 0, 
		"promo_value"                          : 25, 
		"usage_limit_per_day"                  : 2,
		"multiple_allowed_single_user"         : 1,
		"promo_on"                             : 0,
		"single_user_max_count"                : 10,
		"timezone"                             : 15,
        "from_time"                             :"2021-11-15T10:34:52Z",
		"end_time"                             : "2021-11-15T10:34:52Z",
		"store_id"                             : 65465466,
		"product_ids"                          : [],
		"merchant_ids"                         : [],
		"customer_subscription_plan_ids"       : [],
		"city_data"                            : [],
		"loyalty_points_enabled"               :0,
		"loyalty_earning_enabled"              : 1
	
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2024-04-17 07:11:33
Previous
Edit Promo
Next
Get Promo
Built with