promo

set referral scheme

post/promo/addPromo

Request

  • Base URL: http://api.pickerexpress.com
  • URL: http://api.pickerexpress.com/promo/addPromo
  • Auth: none declared. Required headers: authorization, content-language

Headers

authorizationstring required

Bearer Token

content-languagestring required

en/ar

Request body application/x-www-form-urlencoded

promoSchemeType'Promo for all users' | 'Role Specific Promo' | 'Region Specific Promo' | 'Role and Region Specific promo' | 'Not valid for commerce' | 'Workspace Promo' required

type of promo scheme to be used

noOfPromoUsersnumber

total number of times promo can be used, infinite in case of empty

aliasstring required

Promo that should be displayed to user

individualUserPromoAttemptnumber

total number of times promo can be used by single user, infinite in case of empty

minimumBookingPricenumber required

Minimum price of booking on which promo will be applied

cashbacknumber

cashback for user who used promo

percentagenumber

% off for user who used promo

expirePromoDatestring

Expiry Date of the promo

hoursToExpirestring

Expiry hours of the promo

role'customer' | 'driver'

role of user order is customer/driver

regionIDstring[] required
maximumDeliveryFeenumber

Maximum price to which this promo is applicable

availableAllRegionsboolean required

Indicates if the promo is available for all regions

messageobject

Notification to send to customer segment

Response

Successful

Changes

No recorded changes to this operation across all 2 revisions of this API.