# Yelo ## API Docs - Acl [Create Role](https://openapiyelo.apidog.io/api-6772572.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumberYour marketplace user id
user_idnumberYour user_id
user_typenumberFor admin enter 2, For merchant enter 3
role_namestringEnter the role name (user,merchant)
permissionsobjectFor active permission =1 ,For inactive permission =0
role_descriptionstring(optional)role_description
- Acl [Get Role](https://openapiyelo.apidog.io/api-6772573.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumber(optional)Your marketplace user id
user_idnumberYour user_id
user_typenumberFor admin enter 2, For merchant enter 3
startnumber(optional)enter the start number
lengthnumber(optional)records limit
created_bynumbercreated by which user
- Acl [Edit Role](https://openapiyelo.apidog.io/api-6772574.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumberYour marketplace user id
user_idnumberYour user_id
user_typenumberFor admin enter 2, For merchant enter 3
role_namestringEnter the role name
role_idstringrole id
permissionsobjectFor active permission=1
For inactive permission=0
role_descriptionstring(optional)role_description
- Acl [Delete Role](https://openapiyelo.apidog.io/api-6772575.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumberYour marketplace user id
user_idnumberYour user_id
user_typenumberFor admin enter 2, For merchant enter 3
role_idnumberenter the role_id
- Acl [Get Role Permissions](https://openapiyelo.apidog.io/api-6772576.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
user_idnumberUser Id (Admin ID)

user_typenumber2 : for admin, 3 : for merchant
role_idnumberRole Id
- Custom PG [paymentStatus](https://openapiyelo.apidog.io/api-6772577.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumbermarketplace user id
reference_idnumber(required)reference id
transaction_idstring(required)transaction id
transaction_completeany(optional)If complete : 1 ,If incomplete:0
custom_pg_idany(optional)custom pg id
- CSV Import [csv](https://openapiyelo.apidog.io/api-6772578.md):
NameTypeDescription
user_idnumberz(required)user_id
marketplace_user_idnumber(required)marketplace_user_id
api_keystring(required)Your API-key
alternate_emailstring(optional)alternate_email
csv_typenumber(required)csv_type
[ CATALOGUE : 1,
PRODUCT : 2,
CUSTOMER : 3,
ADDON : 4,
JOBS : 5,
COMMISSION : 6,
FULL_MENU : 7,
JOBS_WITH_CATALOGUE : 8,
COMMISSION_WITH_CATALOGUE : 9,
MERCHANT : 10,
WEB_TERMINOLOGY : 11,
APP_TERMINOLOGY : 12,
UPDATE_CATALOGUE : 13,
UPDATE_PRODUCT : 14,
UPDATE_ADDON : 15,
DASHBOARD_TERMINOLOGY : 16, //Addition for dashboard
EDITED_JOBS : 17,
EDITED_JOBS_WITH_CATALOGUE : 18]
csv_levelnumber(optional)csv_level
[ ADD : 1,
UPDATE : 2,
DELETE_AND_ADD : 3]
selected_languagestring(optional)selected_language
- Menu [Add Menu](https://openapiyelo.apidog.io/api-6772579.md):
NameTypeDescription
marketplace_user_idnumbermarketplace user id
api_keystringYour API-key
user_idnumberuser id
(Admin Id)
user_typenumber2 : for admin, 3 : for merchant
menu_namearraymenu name
timingsarraytimings(product availibility timing)
product_idsarrayproduct_ids
- Menu [Get Menu](https://openapiyelo.apidog.io/api-6772580.md):
NameTypeDescription
marketplace_user_idnumbermarketplace user id
api_keystringYour API-key
user_idnumberuser id
user_typenumber2 : for admin, 3 : for merchant
menu_idnumbermenu id
startnumbestart
lengthnumbermenu length
- Notification [getCreds](https://openapiyelo.apidog.io/api-6772581.md):
NameTypeDescription
api_keystringYour API-key
app_typenumberapp_type
[ 1 for Customer]
2 for MERCHANT]
- Notification [sendCustomPushNotification](https://openapiyelo.apidog.io/api-6772582.md):
NameTypeDescription
api_keystringYour API-key
titlestringtitle
bodystringbody
customer_idsarraycustomer_ids
push_typenumberpush_type
marketplace_user_idnumbermarketplace_user_id
job_idnumberjob_id
job_statusnumberjob_status
case assigned = 0
case started = 1
case successful = 2
case failed = 3
case arrived = 4
case partial = 5
case unAssigned = 6
case declined = 8
case jobPending = 9

//ecom
case accepted = 11
case ordered = 10
case disPatched = 12
case delivered = 13
case rejected = 14
case canceled = 15
case deliveryPending = 16
case pending = 17
case noStatus = 18
case jobAssigned = 44
case processed = 45
case pickedUp = 46
case orderReady = 47
- Tax [delete](https://openapiyelo.apidog.io/api-6772583.md):
NameTypeDescription
api_keystringYour API-key
tax_idnumbertax_id
user_idnumberuser id
is_merchant_level_taxnumberis merchant level tax
[ INDIVIDUAL: 1,
MAPPING : 2,
FOR_ALL : 0
}]
- Tax [edit](https://openapiyelo.apidog.io/api-6772584.md):
NameTypeDescription
api_keystringYour API-key
tax_idnumbertax_id
tax_namestringtax name
tax_typenumber0-> percentage, 1-> fixed
valuenumbervalue
tax_applied_onnumber0 = marketplace, 1 = product
user_idnumberuser id
is_merchant_level_taxnumberis merchant level tax { INDIVIDUAL: 1,
MAPPING : 2,
FOR_ALL : 0
}
merchant_idsarraymerchant ids
- Tax [get](https://openapiyelo.apidog.io/api-6772585.md):
NameTypeDescription
api_keystringYour API-key
statusnumberstatus
tax_applied_onnumber0 = marketplace, 1 = product
user_idnumberuser id
is_merchant_level_taxnumberis merchant level tax { INDIVIDUAL: 1,
MAPPING : 2,
FOR_ALL : 0
}
- Tax [add](https://openapiyelo.apidog.io/api-6772586.md):
NameTypeDescription
api_keystringYour API-key
tax_typenumber0-> percentage, 1-> fixed
tax_namestringtax name
valuenumbervalue
tax_applied_onnumber0 = marketplace, 1 = product
user_idnumberuser id
is_merchant_level_taxnumberis merchant level tax{ INDIVIDUAL: 1,
MAPPING : 2,
FOR_ALL : 0
}
merchant_idsarraymerchant_ids
- Themes [configure](https://openapiyelo.apidog.io/api-6772587.md):
NameTypeDescription
api_keystringYour API-key

marketplace_user_idnumbermarketplace user id
theme_enablednumber1 = enabled
0 = disabled
- Themes [resetTemplate](https://openapiyelo.apidog.io/api-6772588.md):
NameTypeDescription
api_keystringYour API-key

marketplace_user_idnumbermarketplace user id
template_idnumbertemplate_id
htmlnumber(optional)html
1= if available
0 = if not


cssnumber(optional)css
1= if available
0 = if not
- Themes [cloneFeatures](https://openapiyelo.apidog.io/api-6772589.md):
NameTypeDescription
api_keystring(required)Your API-key

marketplace_user_idnumbermarketplace user id
theme_idnumbertheme_id
component_idsarraycomponent_ids

page_idsarraypage_ids
- Themes [editTemplate](https://openapiyelo.apidog.io/api-6772590.md):
NameTypeDescription
api_keystringYour API-key

template_idnumbertemplate_id
htmlstringhtml

cssstringcss
marketplace_user_idnumbermarketplace user id
- Themes [getTemplate](https://openapiyelo.apidog.io/api-6772591.md):
NameTypeDescription
api_keystringYour API-key

template_idnumbertemplate_id
marketplace_user_idnumbermarketplace user id
- Themes [getPagesAndComponents](https://openapiyelo.apidog.io/api-6772592.md):
NameTypeDescription
api_keystringYour API-key

theme_idnumbertheme id
marketplace_user_idnumbermarketplace user id
- Themes [updateUserTheme](https://openapiyelo.apidog.io/api-6772593.md):
NameTypeDescription
api_keystringYour API-key


modulestringmodule(theme)
jsonobjectjson
- Themes [getThemeSemantics](https://openapiyelo.apidog.io/api-6772594.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
user_typenumberFor admin enter 2, For merchant enter 3
user_idnumberuser id
- Themes [enableTheme](https://openapiyelo.apidog.io/api-6772595.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
theme_idnumbertheme id
- Themes [getThemeJson](https://openapiyelo.apidog.io/api-6772596.md):
NameTypeDescription
api_keystringYour API-key
theme_idnumbertheme id
marketplace_user_idnumbermarketplace user id
user_typenumberEnter 2 for admin, 3 for merchant
user_idnumberuser id
- Themes [editTheme](https://openapiyelo.apidog.io/api-6772597.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
theme_idnumbertheme id
is_deletenumberis delete
1= If deleted
0 = If not deleted
namestringname(theme name)
- Themes [getThemes](https://openapiyelo.apidog.io/api-6772598.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
- Themes [forkTheme](https://openapiyelo.apidog.io/api-6772599.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
theme_idnumbertheme id
namestringname(theme name)
- Themes [getUserTheme](https://openapiyelo.apidog.io/api-6772600.md): - Customer [customer Deletion](https://openapiyelo.apidog.io/api-6803399.md): This API endpoint is designed to allow authorized users to delete customer records from a system or database. Deleting a customer typically involves permanently removing their information from the system, including any associated data - Customer [Add Customer](https://openapiyelo.apidog.io/api-6772601.md):

Add Customer

- Customer [customer verifyOtp](https://openapiyelo.apidog.io/api-6772602.md):
NameTypeDescription
api_keystringYour API-key
otpstringotp
emailstring(optional)email
phonestring(optional)phone
languagestring(optional)language for e.g. "en"
app_typestring(optional)"IOS" or "ANDROID" or "WEB"
app_versionstring(optional)app version
is_demo_appnumber(optional)is demo app
login_vendor_via_otpnumber(optional)login customer via otp
1 = if login via otp
domain_namestring(optional)domain name
dual_user_keynumber(optional)dual user key
marketplace_user_idstring(optional)marketplace user id
device_tokenstring(optional)device token
reference_idstring(optional)reference id
- Customer [customerForgotPassword](https://openapiyelo.apidog.io/api-6772603.md):
NameTypeDescription
api_keystring(required)Your API-key
emailstring(optional)customer's email id
phonestring(optional)customer's number

languagestring(optional)language selected by customer
app_typestring(optional)web,IOS, android
app_versionstring(optional)app version
is_demo_appstring(optional)is demo app
marketplace_user_idstring(optional)your marketplace user id
- Customer [View Customer](https://openapiyelo.apidog.io/api-6772604.md):

View Customer

- Customer [Customer Details](https://openapiyelo.apidog.io/api-6772605.md):

Get Customer Details

- Customer [Edit Customer](https://openapiyelo.apidog.io/api-6772606.md):

Edit Customer Details

- Customer [Add Customer Subscription Plan](https://openapiyelo.apidog.io/api-6772607.md):

Add Subscription Plan

- Customer [Get Customer Subscriptions List](https://openapiyelo.apidog.io/api-6772608.md):

Get Subscriptions List

- Customer [Edit Customer Subscription Plan](https://openapiyelo.apidog.io/api-6772609.md):

Edit/Update Subcription Plan

- Customer [googleLogin](https://openapiyelo.apidog.io/api-6772610.md):
NameTypeDescription
api_keystringYour API-key
device_tokenany(optional)device_token
google_tokenstringgoogle_token

marketplace_reference_idstring(optional)marketplace reference id
domain_namestring(optional)domain name
app_versionstring(optional)app version
app_typestring(optional)"IOS" or "ANDROID"
or "web"
dual_user_keynumber(optional)dual user key
latstring(optional)lat
lngstring(optional)lng
longitudenumber(optional)longitude
languagestring(optional)language for e.g. "en"
emailstring(optional)email
ipConfigobject(optional)ipConfig
is_demo_appnumber(optional)is demo app
_ _app_typenumber(optional)_ app type
new_payment_gateways_requirednumber(optional)new payment gateways required
- Customer [Assign Customer Subscription Plan](https://openapiyelo.apidog.io/api-6772611.md):

Assign Plan

- Customer [Customer login](https://openapiyelo.apidog.io/api-6772612.md):

Assign Plan

- Customer [getFavLocation](https://openapiyelo.apidog.io/api-6772613.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
domain_namestring(optional)domain Name

dual_user_keynumber(optional)Dual User Key
languagestring(optional)language Selected By Customer
marketpalce_refrence_idstring(required)Market Place Refrence Id
vendor_idnumber(optional)Customer Id
- Customer [Forgot Password](https://openapiyelo.apidog.io/api-6772614.md): ### POST /open/customer/forgotPassword - Wallet [addMoney](https://openapiyelo.apidog.io/api-6772615.md):
NameTypeDescription
api_keystringYour API-key
user_idnumber(optional)user id
user_typenumber(optional)2 : for admin, 3 : for merchant

amountnumber(optional)amount
vendor_idnumbervendor_id
add_moneynumberEnter 1 to add amount to customer wallet or 0 to deduct amount from customer wallet.
marketplace_user_idnumber(optional)marketplace user id
descriptionstring(optional)description
manager_idstring(optional)manager id
- Wallet [customer/getWalletTxnHistory](https://openapiyelo.apidog.io/api-6772616.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(optional)marketplace_user_id
need_balance_onlynumber(optional)Need Balance Only

vendor_idnumber(optional)Customer Id
- Loyality Points [Update Loyality Points](https://openapiyelo.apidog.io/api-6772617.md):

Update Loyality Points

- Loyality Points [Reward Loyalty Points](https://openapiyelo.apidog.io/api-6772618.md):

Reward Loyality Points

- City [Get City](https://openapiyelo.apidog.io/api-6772619.md): - Promo [Delete Promo](https://openapiyelo.apidog.io/api-6772620.md):
- Promo [Change Promo Status](https://openapiyelo.apidog.io/api-6772621.md):
- Promo [Edit Promo](https://openapiyelo.apidog.io/api-6772622.md):
NameTypeDescription
api_keystringYour API-key
promo_codestringName of promo code
promo_typenumber0-public , 1-hidden, 2-auto apply

promo_idnumberpromo code unique id
descriptionstringdescription 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]
to_be_add_productsarray(optional)to be add products
remove_store_idnumber(optional)remove store id
to_be_remove_productsarray(optional)to be remove products
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
- Promo [Add Promo](https://openapiyelo.apidog.io/api-6772623.md): array(optional) - Promo [Get Promo](https://openapiyelo.apidog.io/api-6772624.md):
NameTypeDescription
api_keystringYour API-key
lengthnumber(optional)records limit
startnumber(optional)records from

currency_idnumber(optional)currency_id
- Order [Get All Orders](https://openapiyelo.apidog.io/api-6772625.md):

Get All Orders

- Order [Get Order Details](https://openapiyelo.apidog.io/api-6772626.md):
NameTypeDescription
api_keystringYour API-key
limitnumber(optional)limit
page_sizenumber(optional)page size
job_idnumber(optional)job id
- Order [Create Order](https://openapiyelo.apidog.io/api-6772627.md):

Create Order

- Order [Custom Order](https://openapiyelo.apidog.io/api-6772628.md):

Custom Order

- Order [orderPrepTime](https://openapiyelo.apidog.io/api-6772629.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
order_preparation_timestring(required)Ordert Prepration Time

user_idnumber(optional)User Id
user_typenumber(optional)2 : for admin, 3 : for merchant
- Search [searchGlobalProduct](https://openapiyelo.apidog.io/api-6772630.md):
NameTypeDescription
marketplace_user_idstring(optional)marketplace user id
search_textstringsearch text
latitudenumber(optional)latitude
longitudenumber(optional)longitude
date_timestring(optional)date time
app_typestring(optional)"IOS", "ANDROID", "WEB"
api_keystringyou api key
self_pickupnumber(optional)self pickup
0 if not
1 if yes
domain_namestring(optional)domain name
dual_user_keynumber(optional)dual user key
languagestring(optional)language
- Search [searchProducts](https://openapiyelo.apidog.io/api-6772631.md):
NameTypeDescription
api_keystringyour api key
marketplace_user_idnumbermarketplace user id
search_textstringsearch text
user_idstringuser id
vendor_idnumbercustomer id
date_timestring(optional)date time
domain_namestring(optional)domain name
dual_user_keynumber(optional)dual user key
languagestring(optional)language for eg. "en"
- Search [searchGlobalMerchants](https://openapiyelo.apidog.io/api-6772632.md):
NameTypeDescription
marketplace_user_idstringmarketplace user id
search_textstringsearch text
latitudenumber(optional)latitude
longitudenumber(optional)longitude
date_timestring(optional)date time
app_typestring(optional)"IOS", "ANDROID", "WEB"
api_keystring(optional)you api key
self_pickupnumber(optional)self pickup
0 if not
1 if yes
domain_namestring(optional)domain name
dual_user_keynumber(optional)dual user key
languagestring(optional)language
- Marketplace [Settings](https://openapiyelo.apidog.io/api-8203687.md): - Marketplace [Edit Merchant details](https://openapiyelo.apidog.io/api-8203743.md):
- Marketplace [Get Banner](https://openapiyelo.apidog.io/api-11123296.md):
- Marketplace [get Activity Logs](https://openapiyelo.apidog.io/api-12660611.md):
- Marketplace [marketplaceVendorFacebookLogin](https://openapiyelo.apidog.io/api-6772633.md):
NameTypeDescription
api_keystringYour API-key
fb_tokenstring(optional)fb token
marketplace_reference_idstring(optional)marketplace reference id
domain_namestring(optional)domain name
emailstring(optional)customer's email
dual_user_keynumber(optional)dual user key
vendor_imagestring(optional)vendor image
languagestring(optional)language for eg. "en"
- Marketplace [Add Debt For Job](https://openapiyelo.apidog.io/api-6772634.md): - Marketplace [addMerchant](https://openapiyelo.apidog.io/api-6772635.md):
- Marketplace [getMerchantList](https://openapiyelo.apidog.io/api-6772636.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
lengthnumber(optional)length

startnumber(optional)Start here
user_typenumber(optional)2 : for admin, 3 : for merchant
verification_statusnumber(optional)verification_status [
1= for verified,
2= for not verified ]
sSearchstring(optional)What you want to search(email or name)
sortColnumber(optional)If sort column equals to 1 then it will sort according to first name , default is by customer id
sortDirstring(optional)Default sort direction is descending. Send asc for ascending
searchByobject(optional)searchBy
isClosednumberisClosed
- Marketplace [getAccountTranslations](https://openapiyelo.apidog.io/api-6772637.md):
NameTypeDescription
api_keystring(requireed)Your Api Key
domain_namestring(optional)domain name
languagestring(optionallanguage selected by customer
marketplace user idstring(required)marketplace user id

- Marketplace [getfilter](https://openapiyelo.apidog.io/api-6772638.md):
NameTypeDescription
api_keystring(required)Your API-key
domain_namestring (optional)Domain Name
post_to_getnumber(optional)Post To Get

business_category_idnumber(optional)Business_Category Id
marketplace_user_idnumber(required)Marketplace_User Id
dual_user_keynumber(optional)Dual User Key
languagestring(optional)Language Selected BY
Customer
- Task [edit task prep time](https://openapiyelo.apidog.io/api-11177136.md): - Task [addRemarks](https://openapiyelo.apidog.io/api-6772639.md):
- Task [getTookanRequest](https://openapiyelo.apidog.io/api-6772640.md):
NameTypeDescription
api_keystringYour API-key
job_idnumberjob_id
product_idnumber(optional)product_id

- Task [Edit Task](https://openapiyelo.apidog.io/api-6772641.md): - Task [Accept Reject Order](https://openapiyelo.apidog.io/api-6772642.md):
- Task [updateStatus](https://openapiyelo.apidog.io/api-6772643.md):
- Merchant [Add Store Availability](https://openapiyelo.apidog.io/api-7619023.md): To set merchant available full on , partial or closed for a day - Merchant [Update Store Availability for day](https://openapiyelo.apidog.io/api-7620075.md): To set merchant available full on , partial or closed for a day - Merchant [Get merchant custom field ](https://openapiyelo.apidog.io/api-8121627.md):
ParameterTypeDescription
api_keystringYour API-key
user_typenumberFor admin enter 2, For merchant enter 3
marketplace_user_idnumberenter market place user Id
- Merchant [Edit Store Status](https://openapiyelo.apidog.io/api-6772644.md):
ParameterTypeDescription
api_keystringYour API-key
user_idnumberenter user id.
user_typenumberFor admin enter 2, For merchant enter 3
marketplace_user_idnumberenter market place user Id
is_activenumber(optional)1 For YES, 0 for NO
is_blockednumber(optional)1 For YES, 0 for NO
is_deletednumber(optional)1 For YES, 0 for NO
is_closednumber(optional)1 For YES, 0 for NO
- Merchant [Get Store FrontDateSchedule](https://openapiyelo.apidog.io/api-6772645.md):
ParameterTypeDescription
api_keystringYour API-key
user_idnumberenter user id.
user_typenumberFor admin enter 2, For merchant enter 3
marketplace_user_idnumberenter market place user Id
delivery_methodsnumber(optional)optional
- Merchant [Add Store FrontDateSchedule](https://openapiyelo.apidog.io/api-6772646.md):
ParameterTypeDescription
api_keystringYour API-key
user_idnumberenter user id.
user_typenumberFor admin enter 2, For merchant enter 3
marketplace_user_idnumberenter market place user Id
delivery_methodsnumber(optional)optional
end_datestringEnding date
- Merchant [Update Store FrontDateSchedule](https://openapiyelo.apidog.io/api-6772647.md):
ParameterTypeDescription
api_keystringYour API-key
user_idnumberenter user id.
user_typenumberFor admin enter 2, For merchant enter 3
marketplace_user_idnumberenter market place user Id
slot_idnumberYour slot id
is_deletednumber(optional)1 for YES, 0 for NO
- Merchant [Get merchant](https://openapiyelo.apidog.io/api-6772648.md):
ParameterTypeDescription
api_keystringYour API-key
user_idnumberUser id
marketplace_user_idnumberMarketplace user id
- Merchant [Merchant settings](https://openapiyelo.apidog.io/api-6772649.md):
ParameterTypeDescription
api_keystringYour API-key
marketplace_user_idnumberYour marketplace_user_id
user_idnumberuser id
user_typenumber2 for Admin, 3 for merchant
serving_distancenumber(optional)Serving Distance
- Merchant [user_login](https://openapiyelo.apidog.io/api-6772650.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
emailstringemail

passwordstringpassword
- Catalogue > Catagory [Add Catalogue](https://openapiyelo.apidog.io/api-6772651.md):

Add Catalogue

- Catalogue > Catagory [Update Catalogue](https://openapiyelo.apidog.io/api-6772652.md):

Update Catalogue

- Catalogue > Catagory [Get Catalogue](https://openapiyelo.apidog.io/api-6772653.md):

Get Catalogue

- Catalogue > Catagory [Get All Catalogues](https://openapiyelo.apidog.io/api-6772654.md):

Get All Catalogues

- Catalogue > Catagory [Get Catalogue Products](https://openapiyelo.apidog.io/api-6772655.md):

Get Catalogue Products

- Catalogue > Catagory [Enable Disable Category wise](https://openapiyelo.apidog.io/api-6772656.md):

Enable Disable Category wise

- Catalogue > Catagory [Delete catalogue](https://openapiyelo.apidog.io/api-6772657.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
user_idnumber(optional)User Id

catalogue_idnumber(optional)catalogue id
user_typenumber(optional)2 : for admin, 3 : for merchant
marketplace_refrence_idstringMarket Place Refrence Id
- Catalogue > Products [disable](https://openapiyelo.apidog.io/api-6772658.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumberyour marketplace_user_id
user_idnumberuser_id
is_enablednumberis_enabled
1= for enable
0 = for disable
product_idsarrayproduct_ids
user_typenumber2 : for admin, 3 : for merchant
- Catalogue > Products [Add product](https://openapiyelo.apidog.io/api-6772659.md):

Add Product

- Catalogue > Products [Edit Product](https://openapiyelo.apidog.io/api-6772660.md):

Edit Product

- Catalogue > Products [delete](https://openapiyelo.apidog.io/api-6772661.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumberyour marketplace_user_id
user_idnumberuser_id
product_idnumberproduct_id
parent_idnumberproduct_ids
user_typenumber2 : for admin, 3 : for merchant
- Catalogue > Products [Disable Products](https://openapiyelo.apidog.io/api-6772662.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
user_idnumberUser id
product_idsarrproduct ids
is_enablednumberis enabled
1= for enable
2= for disable
- Catalogue > Products [Get product](https://openapiyelo.apidog.io/api-6772663.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
user_idnumber(optional)User Id

product_idnumber(optional)Product id
product_ids_arrayarray(optional)product ids
9fomat - array)
app_typenumber(optional)App Type
"web"
"IOS"
"android"
limitnumber(optional)Limit
offsetnumber(optional)Offset
- Catalogue > Products [Get All Products](https://openapiyelo.apidog.io/api-6772664.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumber(optional)marketplace_user_id
user_idnumber(required)user

startnumber(optional)Start here
user_typenumber(optional)2 : for admin, 3 : for merchant
lenthnumber(optional)Lenth
sSearchstring(optional)What you want to search(email or name)
sortColnumber(optional)If sort column equals to 1 then it will sort according to first name , default is by customer id
sortDirstring(optional)Default sort direction is descending. Send asc for ascending
get_all_enable_productnumber(optional)1= if enable
0 = if disable
languagestringLanguage
- Catalogue > Products [Get Products For Category](https://openapiyelo.apidog.io/api-6772665.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
user_idnumber(optional)User Id

limitnumber(optional)Limit
offsetnumber(optional)Offsett
parent_category_idnumber(optional)Parent Category Id
- Catalogue > Product Customization > Deprecated [Get Customization](https://openapiyelo.apidog.io/api-6772667.md):
NameTypeDescription
api_key
string
Your API-key
customize_id
number
customize_id
product_id
number
product_id
- Catalogue > Product Customization > Deprecated [Add Customization](https://openapiyelo.apidog.io/api-6772668.md):

Add Product

ParameterTypeDescription
api_keystringYour API-key
marketplace_user_idnumberYour marketplace user id
user_idnumberYour user id
customizationobjectEnter customization parameters.For body parameters refer to the below customization table
- Catalogue > Product Customization > Deprecated [Delete Customization](https://openapiyelo.apidog.io/api-6772669.md):
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
user_idnumberuser_id
product_idnumberproduct_id
customize_idnumbercustomize_id
user_typenumber(optional)2 : for admin, 3 : for merchant
marketplace_reference_idstring(optional)marketplace_reference_id
- Catalogue > Product Customization > Deprecated [Edit Customization](https://openapiyelo.apidog.io/api-6772670.md):
NameTypeDescription
api_keystringYour API-key
user_idnumberuser_id
marketplace_user_idnumbermarketplace_user_id
user_typenumber(optional)2 : for admin, 3 : for merchant
marketplace_reference_idstring(optional)marketplace_reference_id
customizationobjectcustomization
- Catalogue > Product Customization [Customizations](https://openapiyelo.apidog.io/api-6772666.md): This endpoint makes an HTTP GET request to retrieve product customizations. The request includes the user's API key, user ID, limit, and offset as query parameters. The response returns a status code of 200 and a content type of text/html. The response body contains information about the total display records, total records, draw, and an array of data objects, each representing a product customization. Each data object includes details such as customize ID, type, is_active status, type JSON, is_check_box, is_selected, and an array of sub_types, each with its own set of attributes. - Catalogue > tags [Get All tags](https://openapiyelo.apidog.io/api-11523281.md): - Catalogue > tags [Get tags Products](https://openapiyelo.apidog.io/api-11523539.md):
- Business Categories [Assign Business Category](https://openapiyelo.apidog.io/api-6772671.md):
ParameterTypeDescription
api_key
string
Your API-key
marketplace_user_id
number
Your marketplace user id
merchant_id
number
merchant id.
id
number
Your business category id
is_active
number
if you want to make the category active,type 1 else 0.
- Business Categories [Get Business Category](https://openapiyelo.apidog.io/api-6772672.md): - Business Categories [businessCategory](https://openapiyelo.apidog.io/api-6772673.md):
NameTypeDescription
api_keystring(required)Your API-key
domain_namestring(optional)Domain Name
marketplace_user_idstring(optional)Marketplace user Id
versionstring(optional)Web,IOS, Android
vendor_idnumber(optional)Customer Id
latitudenumber(optional)Latitude
longitudenumber(optional)Longitude
duel_user_idnumber(optional)Duel User Id
languagestring(optional)Language Selected By Customer
- Send SMS [Send App Link SMS](https://openapiyelo.apidog.io/api-6772674.md): - Admin [Edit Order](https://openapiyelo.apidog.io/api-6772675.md):
ParameterTypeDescription
api_keystringYour API-key
marketplace_user_idnumberYour marketplace_user_id
payment_methodnumber, allow("",null)8 for payment in cash
card_idnumber, allow("",null)your card_id (optional)
checkout_templatearrayCheckout Template(optional)
user_idnumberYour user_id
customer_phonestringCustomer's phone number
customer_emailstringCustomer's email address
customer_usernamestringCustomer's username
job_pickup_datetimestringJob date and time
delivery_chargenumberDelivery Charges
currency_idnumberYour currency id
amountnumberAmount of products
is_schedulednumber1 for YES, 0 for NO<
vendor_idnumberVendor id
job_pickup_latitudenumberjob pickup latitude
job_pickup_longitudenumberjob pickup longitude
latitudenumberLatitude (optional)
longitudenumberlongitude (optional)
job_pickup_addressstringJob pickup address (optional)
job_pickup_namestringJob pickup name (optional)
job_pickup_phonestringJob pickup phone (optional)
job_pickup_emailstringJob pickup email (optional)
prev_job_idnumberprevious job id (optional)
return_enablednumber1 for Yes, 0 for No (optional)
verticalnumbervertical (optional)
timezonestringYour timezone (optional)
productsarrayArray Containing product_id, quantity, customizations (refer below PRODUCTS Table)
home_deliverynumber1 for YES, 0 for No
tipnumber1 for YES, 0 for No

Products

NameTypeDescription
product_idnumberProduct Id
quantitynumberQuantity of product
Customizationsarray(optional)Refer below customization table

Customizations

NameTypeDescription
cust_idnumberCustomization Id
quantitynumberQuantity of product
namestring(optional)Name of customization
- Admin [Add Address](https://openapiyelo.apidog.io/api-6772676.md):
ParameterTypeDescription
api_keystringYour API-key
addressstringCustomer's address
emailstringEmail id of customer (optional)
house_nostringCustomer's House number (optional)
landmarkstringLandmark (optional)
latitudenumberLatitude
longitudenumberlongitude
loc_typenumberLocation Type ,(valid (0,1,2))
namestringCustomer's name
phone_nostringPhone number (optional)
postal_codestringPostal code(optional)
customer_idnumberCostomer's id
- Admin [Get address](https://openapiyelo.apidog.io/api-6772677.md): - Admin [Delete Address](https://openapiyelo.apidog.io/api-6772678.md):
ParameterTypeDescription
api_keystringYour API-key
customer_idnumberCustomer's id
fav_idnumberfav_id
- Admin [Edit address](https://openapiyelo.apidog.io/api-6772679.md): - Admin [Admin Detail](https://openapiyelo.apidog.io/api-6772680.md):

Add Customer

- Billing [getPlans](https://openapiyelo.apidog.io/api-6772681.md):
- Billing [getInvoices](https://openapiyelo.apidog.io/api-6772682.md):
- Billing [getBillBreakDown](https://openapiyelo.apidog.io/api-6772683.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
amountnumberv(required)amount

checkout_templatestring(optional)Checkout Template
customer_addressstring(optional)Customer Address
domain_namestring(optional)Domain Name
dual_user_keynumber(optional)Dual User Key
home_Deliverynumber(optional)2= Home Delivery
[ HOME_DELIVERY : 2,
SELF_PICKUP : 4,
PICK_AND_DROP : 8,
HOME_DELIVERY_SELF_PICKUP : 6,
HOME_DELIVERY_PICK_DROP : 10,
PICK_DROP_SELF_PICKUP : 12,
ALL : 14]
is_app_product_tax_enablednumber(optional)Product Tax Enable -Disable Status
job_pickup_datetimestring(optional)Job Pickup Date And Time
languagestring(optional)Language
latitudenumber(optional)Latitude
Longtitudenumber(optional)Longtitude
marketplace_refrence_idstring(required)Marketplace Refrence Id
productarray(required)Product
user_idnumber(required)User Id
Vendor_idnumber(required)Customer Id
- Project [get](https://openapiyelo.apidog.io/api-6772684.md):
NameTypeDescription
api_keystringYour API-key
project_idnumberproject_id
vendor_idnumber(optional)vendor_id

domain_namestring(optional)domain_name
dual_user_keynumber(optional)dual user key
languagestring(optional)language
user_idnumber(optional)user_id
statusstring(optional)status
marketplace_user_idnumber(optional)marketplace user id
- Discount > merchant Discount [/open/merchant/discount/get](https://openapiyelo.apidog.io/api-6772685.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_typenumber(required)User Type

user_idnumber(required)User Id
- Discount > merchant Discount [merchant/discount/edit](https://openapiyelo.apidog.io/api-6772686.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_idnumber(optional)User Id

namestring(optional)Discount Name
user_typenumber(optional)2 : for admin, 3 : for merchant
valuenumber(optional)Value Min(0) Value Max(100)
descriptionstring(optional)Discount Description
start_datestring(optional)Discount Start date
end_datestring(optional)Discount End Date
is_deletenumber(optional)Discount Validity
is_activatenumber(optional)Discount Validity
add_on_discountnumber(optional)Add On Discount
- Discount > merchant Discount [merchantDiscount/add](https://openapiyelo.apidog.io/api-6772687.md):
NameTypeDescription
api_keystringYour API-key
add_on_discountnumberAdd On Discount
descriptionnumber(optional)Discount Description

end_datestringDiscount End Date
marketplace_user_idnumber(optional)Marketplace User Id
namestring(optional)Discount Name
start_datestringDiscount Start Date
user_idnumber(optional)User Id
user_typenumber(optional)User Type
valueobject(optional)Discont Value
- Discount > Product Discount [productDiscount/add](https://openapiyelo.apidog.io/api-6772688.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_idnumber(required)User Id

Namestring(required)Name
descriptionnumber(required)Discont Description
valuenumber(required)Discount Value [min(0),
max(100)]
max_discount_amountnumber(optional)Maximam Discount Amount
start_datetime_utcstring(required)Discount Start Date And Time
expiry_datetime_utcstring(required)Discount End Date And Time
add_on_discountnumber(optional)Add On Discount
- Discount > Product Discount [product/discount/get](https://openapiyelo.apidog.io/api-6772689.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_idnumber(required)User Id

startnumber(optional)Start here
user_typenumber(required)2 : for admin, 3 : for merchant
limitnumber(optional)Limit
is_expirynumber(optional)Discont Expiry
- Discount > Product Discount [product/discount/edit](https://openapiyelo.apidog.io/api-6772690.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_idnumber(required)User Id

discount_idnumber(required)Discount Id
user_typenumber(optional)2 : for admin, 3 : for merchant
namestring(optional)Discount Name
descriptionstring(optional)Discount Description
valuenumber(optional)Discount Value min(0)-max(100)
start_datetime_utcstring(optional)Discount Start Date -Time
expiry_datetime_utcstring(optional)Discount Expiry Date -Time
add_on_discountnumber(optional)Add On Discount
- Discount > Product Discount [product/discount/delete](https://openapiyelo.apidog.io/api-6772691.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_idnumber(required)User Id

Discount_idnumber(required)Discount Id
user_typenumber(required)2 : for admin, 3 : for merchant
- Store Reviews [getStoreAllReviews](https://openapiyelo.apidog.io/api-6772692.md):
NameTypeDescription
api_keystring(required)Your API-key
domain_namestring(optional)Domain Name
dual_user_keynumber(optional)Dual User Key

languagestring(optional)Language Selected By Customer
limitnumber(optional)Limit
marketplace_refrence_idstring(required)Marketplace Refrence Id
marketplace_refrence_idstring(optional)Marketplace Refrence Id
page_nonumber(optional)page no
user_idstring(required)User Id
vendor_idnumber(required)Customer Id
- checkout template [template/getCheckoutTemplate](https://openapiyelo.apidog.io/api-6772693.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_idnumber(optional)User Id
domain_namestring(optional)Domain Name
dual_user_keynumber(optional)Duel User Key
langaugestring(optional)Langauge Selected By Customer
typenumber(optional)Type
post_to_getnumber(optional)Post To Get
- Payment [activePaymentMethods](https://openapiyelo.apidog.io/api-6772694.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
domain_namestring(optional)Domain Name

dual_user_keynumber(optional)Dual User Key
languagestring(optional)Language Selected By Customer
user_idnumber(required)User Id
vendor_idnumber(required)Customer Id
- Payment [getPaymentUrl](https://openapiyelo.apidog.io/api-6772695.md):
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
amountnumber(optional)Amount

app_typenumber(optional)App Type
['web' 'android'
'IOS'
currencystring(optional)Currency
domain_namestring(optional)Domain Name
dual_user_keynumber(optional)Duel User Key
Emailstring(optional)Customer Email
languagestring(optional)Language Selected By Customer
Nameobject(optional)Customer Name
payment_fornumber(optional)Payment For
payment_methodnumber(optional)Payment Method
User_idstring(required)Admin Id
vendor_idnumber(required)Customer Id