{"info":{"_postman_id":"17a99e26-80e1-402f-bc6f-8b3277b33b74","name":"OPEN API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"15678241","collectionId":"17a99e26-80e1-402f-bc6f-8b3277b33b74","publishedId":"2s93CUHAQo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-02T13:53:51.000Z"},"item":[{"name":"Acl","item":[{"name":"Create Role","id":"d2d2ca37-f08d-4db9-bdc9-66d6321f94fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"role_name\" : \"user\",\r\n \"permissions\" :{\r\n \"1\": {\r\n \"read\": 1,\r\n \"update\": 1\r\n }\r\n }, \r\n \"role_description\" : \" \"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/acl/createRole","description":"
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
","urlObject":{"path":["open","acl","createRole"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2d2ca37-f08d-4db9-bdc9-66d6321f94fd"},{"name":"Get Role","id":"f6c0d1b2-ea6a-4e5d-b523-d4587a7a2ea4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"start\" : 1,\r\n \"length\" : 10,\r\n \"created_by\" : 0\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/acl/getRole","description":"
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
","urlObject":{"path":["open","acl","getRole"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6c0d1b2-ea6a-4e5d-b523-d4587a7a2ea4"},{"name":"Edit Role","id":"3cc8a629-cec8-4352-ba21-81a9f3fcdcce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"role_name\" : \"user\",\r\n \"role_id\" : 0,\r\n \"permissions\" :{\r\n \"1\": {\r\n \"read\": 0,\r\n \"update\": 0\r\n }\r\n },\r\n \"role_description\" : \" \"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/acl/editRole","description":"
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
","urlObject":{"path":["open","acl","editRole"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cc8a629-cec8-4352-ba21-81a9f3fcdcce"},{"name":"Delete Role","id":"db6d90a7-bf98-48bf-85dd-d2a288156abc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"role_id\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/acl/deleteRole","description":"
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
","urlObject":{"path":["open","acl","deleteRole"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"db6d90a7-bf98-48bf-85dd-d2a288156abc"},{"name":"Get Role Permissions","id":"5ab1bc1c-7233-417f-9e6c-420d6188b3d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"role_id\" : 0\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/acl/getRolePermissions","description":"
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
","urlObject":{"path":["open","acl","getRolePermissions"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ab1bc1c-7233-417f-9e6c-420d6188b3d9"}],"id":"9b0b5543-be24-4901-9767-2aaf99fd05c8","_postman_id":"9b0b5543-be24-4901-9767-2aaf99fd05c8","description":""},{"name":"Custom PG","item":[{"name":"paymentStatus","id":"d620d6f0-4870-4460-8350-75753f03c8ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"reference_id\" : 510001,\r\n \"transaction_id\" : \"test\",\r\n \"transaction_complete\" : 1,\r\n \"custom_pg_id\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customPG/paymentStatus","description":"
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
","urlObject":{"path":["open","customPG","paymentStatus"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d620d6f0-4870-4460-8350-75753f03c8ec"}],"id":"d654272e-6b5f-4857-989f-e87dae2d4a95","_postman_id":"d654272e-6b5f-4857-989f-e87dae2d4a95","description":""},{"name":"CSV Import","item":[{"name":"csv","id":"4ad89796-07df-45c5-8895-6b9e623e5c93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\" : 510001,\r\n \"marketplace_user_id\" : 510001,\r\n \"api_key\" : {{apikey}},\r\n \"alternate_email\" : \"test@email.com\",\r\n \"csv_type\" : 1,\r\n \"csv_level\" : 0,\r\n \"selected_language\" : \"en\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/import/csv","description":"
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
","urlObject":{"path":["open","import","csv"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ad89796-07df-45c5-8895-6b9e623e5c93"}],"id":"d4c7b8f4-1fa1-4286-af1a-9868647ff115","_postman_id":"d4c7b8f4-1fa1-4286-af1a-9868647ff115","description":""},{"name":"Menu","item":[{"name":"Add Menu","id":"c4d18112-65b4-4628-b6f6-a5cc08f251d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"marketplace_user_id\" : 510001,\r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 510001,\r\n \"user_type\" : 3,\r\n \"menu_name\" : \"test\",\r\n \"timings\" : [1],\r\n \"product_ids\" : [1]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/menu/addMenu","description":"
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
","urlObject":{"path":["open","menu","addMenu"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4d18112-65b4-4628-b6f6-a5cc08f251d1"},{"name":"Get Menu","id":"6b3f8c99-d083-41f5-b5ad-ba58e76bfbbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"marketplace_user_id\" : 510001,\r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"menu_id\" : 123,\r\n \"start\" : 1,\r\n \"length\" : 10\r\n}\r\n\r\n ","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/menu/get","description":"
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
","urlObject":{"path":["open","menu","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b3f8c99-d083-41f5-b5ad-ba58e76bfbbc"}],"id":"01d9b29e-2713-4201-876c-aadaf2f78d8e","_postman_id":"01d9b29e-2713-4201-876c-aadaf2f78d8e","description":""},{"name":"Notification","item":[{"name":"getCreds","id":"f7c47b28-11e5-445c-bd81-0e2f333ec127","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"app_type\" : 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/notification/getCreds","description":"
NameTypeDescription
api_keystringYour API-key
app_typenumberapp_type
[ 1 for Customer]
2 for MERCHANT]
","urlObject":{"path":["open","notification","getCreds"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7c47b28-11e5-445c-bd81-0e2f333ec127"},{"name":"sendCustomPushNotification","id":"5e6475c3-222d-42c5-adc4-b878e5f20d16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"title\" : \"test\",\r\n\t\t\"body\" : \"test\",\r\n\t\t\"customer_ids\": [1],\r\n\t\t\"push_type\" : 1,\r\n\t\t\"job_id\" : 1,\r\n\t\t\"job_status\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/notification/sendCustomPushNotification","description":"
NameTypeDescription
api_keystringYour API-key
titlestringtitle
bodystringbody
customer_idsarraycustomer_ids
push_typenumberpush_type
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
","urlObject":{"path":["open","notification","sendCustomPushNotification"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e6475c3-222d-42c5-adc4-b878e5f20d16"}],"id":"532c228b-eca3-40bd-bbc2-bf0de4b42e14","_postman_id":"532c228b-eca3-40bd-bbc2-bf0de4b42e14","description":""},{"name":"Tax","item":[{"name":"delete","id":"3d485c1e-214a-4086-9b5f-9e8f342f59dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"tax_id\" : 125,\r\n\t\"user_id\" : 510001, \r\n\t\"is_merchant_level_tax\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/tax/delete","description":"
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
}]
","urlObject":{"path":["open","tax","delete"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d485c1e-214a-4086-9b5f-9e8f342f59dc"},{"name":"edit","id":"7d113300-c8be-4fd2-9fe4-44189360128a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"tax_id\" : 1254,\r\n \"tax_name\" : \"any\",\r\n \"tax_type\" : 1, \r\n \"value\" : 1,\r\n \"tax_applied_on\" : 0, \r\n \"user_id\" : 510001,\r\n\t\t\"is_merchant_level_tax\": 0,\r\n\t\t\"merchant_ids\"\t\t : [1]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/tax/edit","description":"
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
","urlObject":{"path":["open","tax","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d113300-c8be-4fd2-9fe4-44189360128a"},{"name":"get","id":"9aed78fd-a9a1-48e8-8724-925cbd44c80d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"status\" : 100,\r\n \"tax_applied_on\" : 10,\r\n \"user_id\" : 510001, \r\n\t\t\"is_merchant_level_tax\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/tax/get","description":"
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
}
","urlObject":{"path":["open","tax","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"9aed78fd-a9a1-48e8-8724-925cbd44c80d"},{"name":"add","id":"c2e8244e-62e0-40fa-a63b-ad35b30ca8be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"tax_type\" : 1,\r\n \"tax_name\" : \"any\",\r\n \"value\" : 1,\r\n \"tax_applied_on\" : 0, \r\n \"user_id\" : 510001,\r\n\t\t\"is_merchant_level_tax\": 0,\r\n\t\t\"merchant_ids\"\t\t : [1]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/tax/add","description":"
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
","urlObject":{"path":["open","tax","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2e8244e-62e0-40fa-a63b-ad35b30ca8be"}],"id":"05f2f2fc-0c53-4734-b496-6879388cf595","_postman_id":"05f2f2fc-0c53-4734-b496-6879388cf595","description":""},{"name":"Themes","item":[{"name":"configure","id":"d67554b5-4560-4dfe-acef-f564756dc36c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"theme_enabled\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/configure","description":"
NameTypeDescription
api_keystringYour API-key

marketplace_user_idnumbermarketplace user id
theme_enablednumber1 = enabled
0 = disabled
","urlObject":{"path":["open","themes","configure"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d67554b5-4560-4dfe-acef-f564756dc36c"},{"name":"resetTemplate","id":"9bd4ee11-f96e-4dd1-b2a3-5ce168afbc59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"template_id\" : 1,\r\n \"html\" : 0,\r\n \"css\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/resetTemplate","description":"
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
","urlObject":{"path":["open","themes","resetTemplate"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"9bd4ee11-f96e-4dd1-b2a3-5ce168afbc59"},{"name":"cloneFeatures","id":"a8acce50-e06a-4a91-af7d-94da507c6554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"theme_id\" : 0,\r\n \"component_ids\" : [0],\r\n \"page_ids\" : [1]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/cloneFeatures","description":"
NameTypeDescription
api_keystring(required)Your API-key

marketplace_user_idnumbermarketplace user id
theme_idnumbertheme_id
component_idsarraycomponent_ids

page_idsarraypage_ids
","urlObject":{"path":["open","themes","cloneFeatures"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8acce50-e06a-4a91-af7d-94da507c6554"},{"name":"editTemplate","id":"de6e56ed-f1be-4af2-8d8c-e2414f134eb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"template_id\" : 0,\r\n \"html\" : \"html\",\r\n \"css\" : \"css\",\r\n \"marketplace_user_id\" : 510001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/editTemplate","description":"
NameTypeDescription
api_keystringYour API-key

template_idnumbertemplate_id
htmlstringhtml

cssstringcss
marketplace_user_idnumbermarketplace user id
","urlObject":{"path":["open","themes","editTemplate"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"de6e56ed-f1be-4af2-8d8c-e2414f134eb1"},{"name":"getTemplate","id":"b3d766a6-cb8a-4299-9e79-72535829b7be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"template_id\" : 0,\r\n \"marketplace_user_id\" : 510001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/getTemplate","description":"
NameTypeDescription
api_keystringYour API-key

template_idnumbertemplate_id
marketplace_user_idnumbermarketplace user id
","urlObject":{"path":["open","themes","getTemplate"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3d766a6-cb8a-4299-9e79-72535829b7be"},{"name":"getPagesAndComponents","id":"ad7b9eda-6863-42e6-836c-13f4bb6ba080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"theme_id\" : 921,\r\n \"marketplace_user_id\" : 510001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/getPagesAndComponents","description":"
NameTypeDescription
api_keystringYour API-key

theme_idnumbertheme id
marketplace_user_idnumbermarketplace user id
","urlObject":{"path":["open","themes","getPagesAndComponents"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad7b9eda-6863-42e6-836c-13f4bb6ba080"},{"name":"updateUserTheme","id":"384b2d4f-9c72-4ee1-9048-611a4ceb57d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"module\" : \"theme\",\r\n \"json\" : {\"true\":1}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/updateUserTheme","description":"
NameTypeDescription
api_keystringYour API-key


modulestringmodule(theme)
jsonobjectjson
","urlObject":{"path":["open","themes","updateUserTheme"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"384b2d4f-9c72-4ee1-9048-611a4ceb57d1"},{"name":"getThemeSemantics","id":"baad5385-6dcf-42b9-9298-0f30a88b422d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"user_id\" : 510001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/getThemeSemantics","description":"
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
user_typenumberFor admin enter 2, For merchant enter 3
user_idnumberuser id
","urlObject":{"path":["open","themes","getThemeSemantics"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"baad5385-6dcf-42b9-9298-0f30a88b422d"},{"name":"enableTheme","id":"2f3ff6a4-c047-4794-a25f-cf63398c21d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"theme_id\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/enableTheme","description":"
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
theme_idnumbertheme id
","urlObject":{"path":["open","themes","enableTheme"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f3ff6a4-c047-4794-a25f-cf63398c21d6"},{"name":"getThemeJson","id":"4afd9454-4d90-46ed-b407-ebcc7e0335d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"theme_id\" : 1,\r\n \"marketplace_user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"user_id\" : 4652\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/getThemeJson","description":"
NameTypeDescription
api_keystringYour API-key
theme_idnumbertheme id
marketplace_user_idnumbermarketplace user id
user_typenumberEnter 2 for admin, 3 for merchant
user_idnumberuser id
","urlObject":{"path":["open","themes","getThemeJson"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4afd9454-4d90-46ed-b407-ebcc7e0335d0"},{"name":"editTheme","id":"9a35444e-a7cc-4336-bbe1-5be4d814c53a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"theme_id\" : 456,\r\n \"is_deleted\" : 0,\r\n \"name\" : \"theme\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/editTheme","description":"
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)
","urlObject":{"path":["open","themes","editTheme"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a35444e-a7cc-4336-bbe1-5be4d814c53a"},{"name":"getThemes","id":"6e7032a4-6fd7-45bf-a39d-ff04ef93af38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/getThemes","description":"
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
","urlObject":{"path":["open","themes","getThemes"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e7032a4-6fd7-45bf-a39d-ff04ef93af38"},{"name":"forkTheme","id":"30edc769-b993-4c3e-8432-a1e9e9a4bb97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"theme_id\" : 921,\r\n \"name\" : \"theme\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/forkTheme","description":"
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
theme_idnumbertheme id
namestringname(theme name)
","urlObject":{"path":["open","themes","forkTheme"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"30edc769-b993-4c3e-8432-a1e9e9a4bb97"},{"name":"getUserTheme","id":"fa95d9e9-f344-4068-aeaf-db786c060d1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"domain_name\" : \"test.com\",\r\n \"module\" : \"abc\",\r\n \"source\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/themes/getUserTheme","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
domain_namestringdomain name\n
modulestring(optional)module\n
sourcenumber(optional)source\n
","urlObject":{"path":["open","themes","getUserTheme"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa95d9e9-f344-4068-aeaf-db786c060d1b"}],"id":"343705d4-b0aa-4270-8218-461c1487eebc","_postman_id":"343705d4-b0aa-4270-8218-461c1487eebc","description":""},{"name":"Customer","item":[{"name":"Add Customer","id":"650e6a58-d1f1-4b43-9471-89f6194dc47f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"first_name\" : \"Ankit\" ,\r\n \"last_name\" : \"Singh\" ,\r\n \"email\" : \"test@email.com\" ,\r\n \"phone_no\" : \"9898981122\" ,\r\n \"password\" : \"asdf1234\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/customer/add","description":"

Add Customer

\n\n
This API will add the customer.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystring(required)Your API-key
first_namestringFirst name of customer
last_namestring(optional)Last name of customer
emailstringEmail id of customer
phone_nostringMobile number of customer
passwordstringDesired password of customer
","urlObject":{"path":["open","admin","customer","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"650e6a58-d1f1-4b43-9471-89f6194dc47f"},{"name":"customer verifyOtp","id":"e9d2ef7d-3c2c-46e5-a509-c5db3611146e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{api_key}},\r\n \"otp\" : \"4444\",\r\n \"email\" : \"test@yopmail.com\",\r\n \"phone\" : \"+1 9547215\",\r\n \"language\" : \"en\",\r\n \"app_type\" : \"IOS\",\r\n \"app_version\" : \"1\",\r\n \"is_demo_app\" : 1,\r\n \"login_vendor_via_otp\" : 1,\r\n \"domain_name\" : \"test.yelo.red\",\r\n \"dual_user_key\" : 0,\r\n \"marketplace_user_id\" : \"1234000\",\r\n \"device_token\" : \"998465316\",\r\n \"reference_id\" : \"1234199\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/verifyOtp","description":"
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
","urlObject":{"path":["open","customer","verifyOtp"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9d2ef7d-3c2c-46e5-a509-c5db3611146e"},{"name":"customerForgotPassword","id":"4772ca5e-9760-4d30-943d-8b810c1fd141","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : \"71c07d0c9792bb70566560ad71e4c460\",\r\n \"email\" : \"15654dfs44df@yopmail.com\",\r\n \"phone\" : \"+1 65132645\",\r\n \"language\" : \"en\",\r\n \"app_type\" : \"web\",\r\n \"app_version\" : \"2\",\r\n \"is_demo_app\" : \"1\",\r\n \"marketplace_user_id\" : \"1234199\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/forgotPassword","description":"
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
","urlObject":{"path":["open","customer","forgotPassword"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4772ca5e-9760-4d30-943d-8b810c1fd141"},{"name":"View Customer","id":"f2a5c4f3-70a4-4b17-95fe-0d2ee76ff61f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"is_vendor_verified\" : 1,\r\n \"sSearch\" : \"test@email.com\" ,\r\n \"marketplace_user_id\" : 510001,\r\n \"start\" : \" \" ,\r\n \"length\" : \" \" ,\r\n \"sortCol\" : \"1\" ,\r\n \"sortDir\" : \"asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/view","description":"

View Customer

\n
This API will view the customers
\nRequest Body Parameters:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
api_keystringYour API-key
is_vendor_verifiednumber(optional)This flag is used when customer verification is on
sSearchstring(optional)What you want to search(email or name)
marketplace_user_idstring(optional)Your marketplace user id
startstring(optional)Start here(pagination columns)
lengthstring(optional)Length here(pagination columns)
sortColstring(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
","urlObject":{"path":["open","customer","view"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2a5c4f3-70a4-4b17-95fe-0d2ee76ff61f"},{"name":"Customer Details","id":"b7670a67-b30f-4498-8f91-dcbdba6d7408","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"vendor_id\" : 452\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/getDetails","description":"

Get Customer Details

\n
This API will provide details of the customer
\nRequest Body Parameters:\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
api_keystringYour API-key
vendor_idnumberCustomer id of which you want to see the details
","urlObject":{"path":["open","customer","getDetails"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7670a67-b30f-4498-8f91-dcbdba6d7408"},{"name":"Edit Customer","id":"068ed0de-b94b-4a0e-93ad-91b5847bf979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"vendor_id\" : 334 ,\r\n \"marketplace_user_id\" : 510001 ,\r\n \"email\" : \"test@email.com\" ,\r\n \"first_name\" : \"Ankit\" ,\r\n \"last_name\" : \"Singh\" ,\r\n \"phone_no\" : \"9898981122\" ,\r\n \"language\" : \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.redopen/updateVendor","description":"

Edit Customer Details

\n
This API will enable you to edit details of the customer.
\nRequest Body Parameters:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
api_keystringYour API-key
vendor_idnumberCustomer's id
marketplace_user_idnumberMarketplace user id
emailstringCustomer's email id
first_namestringCustomer's first name
last_namestringCustomer's last name
phone_nostringCustomer's phone number
languagestring(optional)\"en\" is mandatory and refer to below language table
\n
\n\n

Languages

\n
Different languages supported. If you are not passing any language then it is mandatory to pass \"en\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameType
ENGLISHen
ARABIANar
FRENCHfr
SPANISHes
MALAYms
SIMPLIFIED_CHINESEzh-Hans
PORTUGUESEpt
TRADITIONAL_CHINESEzh-Hant
BENGALIbn
MEXICAN_SPANISHes-mx
KHMERkm
TAMILta
SINHALAsi
SWEDISHsv
","urlObject":{"path":["updateVendor"],"host":["https://api.yelo.redopen"],"query":[],"variable":[]}},"response":[],"_postman_id":"068ed0de-b94b-4a0e-93ad-91b5847bf979"},{"name":"Add Customer Subscription Plan","id":"12907788-1ba6-4134-80b6-6b57f7566f70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"plan_name\" : \"Gold Plan\" ,\r\n \"amount\" : 1420 ,\r\n \"plan_duration\" : 180 ,\r\n \"reminder_days\" : 15 ,\r\n \"image_url\" : \"@/home/user/Downloads/test.jpeg\" ,\r\n \"number_of_orders\": 1 ,\r\n \"description\" : \"With Gold Plan You Can Have Unlimited Access For 180 Days\" ,\r\n \"is_active\" : 0 ,\r\n \"auto_assign\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customerSubscription/create","description":"

Add Subscription Plan

\n\n
This API will add promo
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
plan_namestringSubscription plan name
amountnumberPlan amount (number)
plan_durationnumberValid upto in days
reminder_daysnumberNumber of days before expiry date to send reminder notification
image_urlstringImage url of subscription
number_of_ordersnumber(optional)Valid upto order (number) optional if not given valid to unlimited no of orders
descriptionstringDescription of plan
is_activenumber (optional)1 for active
0 for in active
auto_assignnumber(optional)1 for assign plan to new customers for free
","urlObject":{"path":["open","customerSubscription","create"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"12907788-1ba6-4134-80b6-6b57f7566f70"},{"name":"Get Customer Subscriptions List","id":"4999f765-60a0-4676-8405-56a2de25709c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"plan_id\" : 123,\r\n \"is_active\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customerSubscription/get","description":"

Get Subscriptions List

\n\n
This API will get subscription plans list.
\n

Request Body Parameters:

\n\n\n\n
NameTypeDescription
api_keystringEnter your API-key (generated from dashboard)
Plan IdnumberEnter Your Plan Id
Is Activenumber1 For YES, 0 for NO
","urlObject":{"path":["open","customerSubscription","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4999f765-60a0-4676-8405-56a2de25709c"},{"name":"Edit Customer Subscription Plan","id":"8d1ad1cb-a1a1-43b6-b3de-981adaebde4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"plan_id\" : 123,\r\n \"plan_name\" : \"gold\",\r\n \"amount\" : 100,\r\n \"plan_duration\" : 30,\r\n \"reminder_days\" : 10,\r\n \"image_url\" : \"@/home/user/Downloads/test.jpeg\",\r\n \"number_of_orders\": 5,\r\n \"description\" : \"With Gold Plan You Can Have Unlimited Access For 180 Days\",\r\n \"is_active\" : 0,\r\n \"is_deleted\" : 0,\r\n \"auto_assign\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customerSubscription/edit","description":"

Edit/Update Subcription Plan

\n\n
This API will edit Plan
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
plan_idnumberNew Plan id to update
plan namestringSubscription plan name
amountnumberPlan amount (number)
plan_durationnumberValid upto in days (number)
reminder_daysnumberNumber of days before expiry date to send reminder notification
image_urlstringImage url of subscriptiion
number_of_ordersnumber(optional)Valid upto order (number) optional if not given valid to unlimited no of orders
descriptionstringDescription of plan
is_activenumber(optional)1 for active
0 for in active (optional)
auto_assignnumber(optional)1 for assign plan to new customers for free (optional)
","urlObject":{"path":["open","customerSubscription","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d1ad1cb-a1a1-43b6-b3de-981adaebde4f"},{"name":"googleLogin","id":"c0cd25fa-aa05-4937-baea-186bfc330677","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{api_key}},\r\n \"device_token\" : 4646666,\r\n \"google_token\" : \"84654865000\",\r\n \"marketplace_reference_id\" : \"1234000\",\r\n \"domain_name\" : \"test.red\",\r\n \"app_version\" : \"1\",\r\n \"app_type\" : \"IOS\",\r\n \"dual_user_key\" : 0,\r\n \"lat\" : \"9.96233\",\r\n \"lng\" : \"10.96233\",\r\n \"longitude\" : \"9.96233\",\r\n \"language\" : \"9.96233\",\r\n \"email\" : \"test142@yopmail.com\",\r\n \"ipConfig\" : { \"country_code\": \"IN\", \"continent_code\": \"AS\"},\r\n \"is_demo_app\" : 1,\r\n \"--_app_type\" : 1,\r\n \"new_payment_gateways_required\": 0\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/vendor/googleLogin","description":"
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
","urlObject":{"path":["open","vendor","googleLogin"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0cd25fa-aa05-4937-baea-186bfc330677"},{"name":"Assign Customer Subscription Plan","id":"f4f7c48e-2458-435d-83c6-78b955f90aa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"plan_id\" : 123,\r\n \"customer_id\" : 13546\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customerSubscription/assign\n","description":"

Assign Plan

\n\n
This API will assign plan.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
plan_idnumberPlan id of customer subscription
customer_idnumberCustomer id to assign
","urlObject":{"path":["open","customerSubscription","assign\n"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4f7c48e-2458-435d-83c6-78b955f90aa0"},{"name":"Customer login","id":"5ad38da6-000b-45ba-9c5b-7f5269cea630","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"app_type\" : \"3\",\r\n \"language\" : \"en\",\r\n \"email\" : \"test@test.com\",\r\n \"phone_no\" : \"+91 456746548\",\r\n \"password\" : \"test@214\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/login","description":"

Assign Plan

\n\n
This API will assign plan.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketpalce user id
app_typestring(optional)app type
\"android\"
\"IOS\"
\"WebAPP\"
languagestring(optional)language
emailstring(optional)Email
Phone_nostring(optional)phone no
passwordstring(optional)Password
","urlObject":{"path":["open","customer","login"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ad38da6-000b-45ba-9c5b-7f5269cea630"},{"name":"getFavLocation","id":"71d480d5-5970-4fae-bcf9-b97e5aa58a62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{api key}},\r\n\"domain_name\" : \"gs-trazaar.taxi-hawk.com\",\r\n\"dual_user_key\" : 0,\r\n\"language\" : \"en\",\r\n\"marketplace_reference_id\": \"5c55faf78b410b90e9ff51d7f6caa77e\",\r\n\"marketplace_user_id\" : 10995407,\r\n\"vendor_id\" : 32881\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/get_fav_location","description":"
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
","urlObject":{"path":["open","customer","get_fav_location"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"71d480d5-5970-4fae-bcf9-b97e5aa58a62"},{"name":"Forgot Password","id":"b6aa6e72-0091-4f9d-b9cf-1f3747a19eb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"asdfadsfas\",\n \"email\" : \"sshak@gmail.com\",\n \"language\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/forgotPassword","description":"

POST /open/customer/forgotPassword

\n

This endpoint is used to initiate the process of resetting a customer's password.

\n

Request Body

\n\n

Response

\n

The response for this request is not in JSON format. Instead, it returns a 404 status code with a content type of text/html, along with an error message in the HTML format.

\n

Response JSON Schema

\n
{\n  \"message\": \"string\",\n  \"status\" :\"number\",\n  \"data\": \"object\"\n}\n\n
\n","urlObject":{"path":["open","customer","forgotPassword"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6aa6e72-0091-4f9d-b9cf-1f3747a19eb6"}],"id":"572b3760-04c2-4dd2-82e7-b6b733181e1a","_postman_id":"572b3760-04c2-4dd2-82e7-b6b733181e1a","description":""},{"name":"Wallet","item":[{"name":"addMoney","id":"9a943898-2588-4df5-88b0-0f8ecc5db031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"amount\" : 10,\r\n \"vendor_id\" : 123,\r\n \"add_money\" : 0,\r\n \"marketplace_user_id\" : 510001,\r\n \"description\" : \"test\",\r\n \"manager_id\" : \"456896\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/wallet/addMoney","description":"
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
","urlObject":{"path":["open","wallet","addMoney"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a943898-2588-4df5-88b0-0f8ecc5db031"},{"name":"customer/getWalletTxnHistory","id":"06e238c5-18b3-416b-9b3c-f61a8a580eea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \r\n\"api_key\" :{{api key}},\r\n\"marketplace_user_id\" : 1234199,\r\n\"need_balance_only\" : 0,\r\n\"vendor_id\" : 5355813\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/getWalletTxnHistory","description":"
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
","urlObject":{"path":["open","customer","getWalletTxnHistory"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"06e238c5-18b3-416b-9b3c-f61a8a580eea"}],"id":"83e1e707-ac57-464e-99f7-6de26d49698c","_postman_id":"83e1e707-ac57-464e-99f7-6de26d49698c","description":""},{"name":"Loyality Points","item":[{"name":"Update Loyality Points","id":"e5f4e3fe-23e8-45bb-bd76-8b94b2fd95f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"customers\" : \"[{\\\"vendor_id\\\":334,\\\"expiry_limit\\\":30,\\\"points\\\":50}]\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/loyaltyPoints/customers/bulkUpdate","description":"

Update Loyality Points

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
api_keystringYour API-key
customersarrayarray of json [ vendor_id : customer unique id (number) expiry_limit: 50 in days limit (number) points: loyalty points (number) ]
\n\n

Customers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
pointsnumberloyalty points
expiry_limitnumberin days limit
vendor_idnumbercustomer unique id
","urlObject":{"path":["open","loyaltyPoints","customers","bulkUpdate"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5f4e3fe-23e8-45bb-bd76-8b94b2fd95f3"},{"name":"Reward Loyalty Points","id":"88d4e882-6c04-41bc-ac88-4862c83958b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\"\t : {{apikey}},\r\n \"points\" : 30,\r\n \"expiry_limit\": 10,\r\n \"vendor_id\" : 2289\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/loyaltyPoints/rewardLoyaltyPoints","description":"

Reward Loyality Points

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
api_keystringYour API-key
pointsnumberloyalty points
expiry_limitnumberin days of point
vendor_idnumbercustomer unique id
","urlObject":{"path":["open","loyaltyPoints","rewardLoyaltyPoints"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"88d4e882-6c04-41bc-ac88-4862c83958b2"}],"id":"95c51292-4940-43da-8033-e2558f5cb2a0","_postman_id":"95c51292-4940-43da-8033-e2558f5cb2a0","description":""},{"name":"City","item":[{"name":"Get City","id":"97c71d6f-2c90-4df3-9211-7c9236123dff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"city_id\" : 24,\r\n \"is_active\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/city/get","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
city_idnumber(optional)city_id\n
is_activenumber(optional)0 for in active\n
","urlObject":{"path":["open","city","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"97c71d6f-2c90-4df3-9211-7c9236123dff"}],"id":"5955b359-7e4c-4b0c-9091-5507443c3196","_postman_id":"5955b359-7e4c-4b0c-9091-5507443c3196","description":""},{"name":"Promo","item":[{"name":"Delete Promo","id":"bac2bb84-4ee7-4630-8bcc-2b70e521b839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"promo_id\" : 45689647\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/promo/delete","description":"\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
promo_idstringName of promo code\n
","urlObject":{"path":["open","promo","delete"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"bac2bb84-4ee7-4630-8bcc-2b70e521b839"},{"name":"Change Promo Status","id":"d34f6dda-a991-4fbc-b0ac-abec62c36a16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \t\"promo_id\" : 45689647,\r\n\t\t\"status\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/promo/changeStatus","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
promo_idstringName of promo code\n
statusnumber0-public , 1-hidden, 2-auto apply\n
","urlObject":{"path":["open","promo","changeStatus"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d34f6dda-a991-4fbc-b0ac-abec62c36a16"},{"name":"Edit Promo","id":"82843a66-6578-4c7a-ac2b-8ea9e3240044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"promo_code\" : \"PROMO60\",\r\n\t\t\"promo_type\" : 0,\r\n\t\t\"promo_id\" : 45689644,\r\n\t\t\"description\" : \"promo\",\r\n\t\t\"min_order_value\" : 1,\r\n\t\t\"max_allowed_users\" : 10,\r\n\t\t\"max_allowed_count\" : 2,\r\n\t\t\"max_discount_value\" : 50,\r\n\t\t\"promo_mode\" : 0,\r\n\t\t\"promo_value\" : 25,\r\n\t\t\"usage_limit_per_day\" : 2,\r\n\t\t\"multiple_allowed_single_user\" : 1,\r\n\t\t\"promo_on\" : 0,\r\n\t\t\"single_user_max_count\" : 10,\r\n\t\t\"timezone\" : 15,\r\n \"from_time\" :\"2021-11-15T10:34:52Z\",\r\n\t\t\"end_time\" : \"2021-11-15T10:34:52Z\",\r\n\t\t\"store_id\" : 65465466,\r\n\t\t\"to_be_add_products\" : [],\r\n\t\t\"remove_store_id\" : 65465466,\r\n\t\t\"to_be_remove_products\" : [],\r\n\t\t\"merchant_ids\" : [],\r\n\t\t\"customer_subscription_plan_ids\" : [],\r\n\t\t\"city_data\" : [],\r\n\t\t\"loyalty_points_enabled\" : 0,\r\n\t\t\"loyalty_earning_enabled\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/promo/edit","description":"
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
","urlObject":{"path":["open","promo","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"82843a66-6578-4c7a-ac2b-8ea9e3240044"},{"name":"Add Promo","id":"5ae7265c-415b-4760-93d7-d19c86885fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"promo_code\" : \"PROMO\",\r\n\t\t\"promo_type\" : 0,\r\n\t\t\"description\" : \"promo\",\r\n\t\t\"min_order_value\" : 1,\r\n\t\t\"max_allowed_users\" : 10,\r\n\t\t\"max_allowed_count\" : 2,\r\n\t\t\"max_discount_value\" : 50,\r\n\t\t\"promo_mode\" : 0, \r\n\t\t\"promo_value\" : 25, \r\n\t\t\"usage_limit_per_day\" : 2,\r\n\t\t\"multiple_allowed_single_user\" : 1,\r\n\t\t\"promo_on\" : 0,\r\n\t\t\"single_user_max_count\" : 10,\r\n\t\t\"timezone\" : 15,\r\n \"from_time\" :\"2021-11-15T10:34:52Z\",\r\n\t\t\"end_time\" : \"2021-11-15T10:34:52Z\",\r\n\t\t\"store_id\" : 65465466,\r\n\t\t\"product_ids\" : [],\r\n\t\t\"merchant_ids\" : [],\r\n\t\t\"customer_subscription_plan_ids\" : [],\r\n\t\t\"city_data\" : [],\r\n\t\t\"loyalty_points_enabled\" :0,\r\n\t\t\"loyalty_earning_enabled\" : 1\r\n\t\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/promo/add","description":"

array(optional)

\n
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
","urlObject":{"path":["open","promo","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ae7265c-415b-4760-93d7-d19c86885fd2"},{"name":"Get Promo","id":"c4be4e9c-3b8f-4f0f-818c-dd95566ffc93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"length\" : 10,\r\n\t\t\"start\" : 1,\r\n\t\t\"currency_id\" : 15\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/promo/get","description":"
NameTypeDescription
api_keystringYour API-key
lengthnumber(optional)records limit
startnumber(optional)records from

currency_idnumber(optional)currency_id
\n\n

currency id

\n
Namesymbolid
USD
EUR
JPY
GBP
AUD
CAD
CHF
CNY
SEK
MXN
NZD
SGD
HKD
NOK
KRW
INR
RUB
ZAR
KES
ZMW
AED
EGP
PEN
UGX
IQD
QAR
COP
NGN
MYR
RES
KWD
GHS
HNL
SAR
₱
MAD
OMR
BHD
PKR
BMD
DOP
THB
TWD
ZK
JOD
XOF
AWG
JMD
TRY
R$
BDT
DZD
ARS
PEN
BRL
CLP
GMD
LBP
BWP
BND
BTN
Rp
TTD
GEL
JOD
LKR
FJD
KYD
TZS
AOA
XCD
DKK
MZN
NIO
ILS
MMK
LAK
ISK
XPF
BSD
CRC
GTQ
IDR
KGS
PHP
PHP
BOB
KZT
NAD
SCR
OUV
BGN
BAM		$
‎€
¥‎
£
$
C$
Fr.
¥
kr
Mex$
NZ$
S$
HK$
kr
₩
₹
₽
R
KSh
ZK
AED
E£
S
UGX
ع.د
QAR
$
₦
RM
re
KWD
GH₵
HNL
SAR
₱
MAD
OMR
BHD
Rs
$
RD$
‎฿
NT$
ZK
JOD
XOF
Afl.
JMD $
₺
R$
৳
DZD
$
S/.
R$
$
GMD
L.L.
P
B$
Nu.
Rp
TT$
ლ
دينا
Rs
FJ$
CI$
TSh
Kz
$
DKK
MT
C$
₪
MMK
LAK
kr
F
B$
₡
Q
Rp
Лв
PHP
PHP
Bs
₸
N$
₨
OUV
Лв
KM
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
29
30
31
32
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
80
81
82
83
84
85
87
88
89
100
101
150
74
92
86
87
90
90
123
124
102
125
94
95
96
","urlObject":{"path":["open","promo","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4be4e9c-3b8f-4f0f-818c-dd95566ffc93"}],"id":"43aa60bc-4697-4a68-a618-f15d8320582d","_postman_id":"43aa60bc-4697-4a68-a618-f15d8320582d","description":""},{"name":"Order","item":[{"name":"Get All Orders","id":"f6da1619-2572-41cd-a952-7278479469fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"user_id\" : 569866 ,\r\n \"marketplace_user_id\" : 25632 ,\r\n \"order_status\" : 13 ,\r\n \"sortCol\" : 3 ,\r\n \"sortDir\" : \"desc\" ,\r\n \"start\" : 2 ,\r\n \"length\" : 100 ,\r\n \"start_date\" : \"2021-05-06T15:54:00Z\" ,\r\n \"end_date\" : \"2021-04-06T15:54:00Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/orders/getAll","description":"

Get All Orders

\n\n
This API will get all orders.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
user_idnumber(optional)Your userid
marketplace_user_idnumber(required)Your marketplace user id
order_statusnumber

List of statuses :

  • Pending : 9

  • Ordered : 10

  • Dispatched : 12

  • Delivered : 13

  • Cancelled : 15

sortCol
number
If sort column equals to 1 then it will sort according to order Id , if it is equals to 3 then it will sort according to job delivery datetime
sortDir
any
Sort direction is descending
start
number
Start here (pagination columns)
length
number
Length (pagination columns)
start_date
string
Start date for filtering results
end_date
string
End date for filtering results.
","urlObject":{"path":["open","orders","getAll"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6da1619-2572-41cd-a952-7278479469fb"},{"name":"Get Order Details","id":"d6305ca6-541a-441d-903c-208d567cdc7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"limit\" : 10,\r\n \"page_size\" : 10,\r\n \"job_id\" : 123\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/orders/getDetails","description":"
NameTypeDescription
api_keystringYour API-key
limitnumber(optional)limit
page_sizenumber(optional)page size
job_idnumber(optional)job id
","urlObject":{"path":["open","orders","getDetails"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6305ca6-541a-441d-903c-208d567cdc7b"},{"name":"Create Order","id":"c8190067-df5e-4eed-9e87-e4614506260e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"payment_method\" : 8 ,\r\n \"job_description\" : \"Deliver on time!\" ,\r\n \"customer_address\" : \"xyz colony, abc, chandigarh-134109\" ,\r\n \"customer_username\" : \"tester\" ,\r\n \"customer_email\" : \"test@email.com\" ,\r\n \"customer_phone\" : \"9898981122\" ,\r\n \"job_date_time\" : \"2021-05-06T15:54:00Z\" ,\r\n \"job_latitude\" : 9.96233 ,\r\n \"job_longitude\" : 49.80404 ,\r\n \"products\" : {\r\n \"product_id\" : 457894 ,\r\n \"unit_price\" : 120 ,\r\n \"quantity\" : 2 ,\r\n \"total_price\" : 240 ,\r\n \"Customizations\" : {\r\n \"cust_id\" : 101 ,\r\n \"unit_price\" : 32 ,\r\n \"quantity\" : 1 ,\r\n \"total_price\" : 32 ,\r\n \"name\" : \" \"\r\n }\r\n } ,\r\n \"vendor_id\" : 587465 ,\r\n \"is_scheduled\" : 1 ,\r\n \"amount\" : 341 ,\r\n \"delivery_charge\" : 50 ,\r\n \"currency_id\" : 9955623 ,\r\n \"store_id\" : 125 ,\r\n \"self_pickup\" : 0,\r\n \"checkout_template\": { },\r\n \"tip\" : 20,\r\n \"subtotal_amount\" : 130\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/order/create","description":"

Create Order

\n\n
This API will enable you to create orders.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
payment_methodnumberpayment method =
job_descriptionstring(optional)Job description
customer_addressstringCustomer's address
customer_usernamestringCustomer's username
customer_emailstringCustomer's email address
customer_phonenumberCustomer's phone number
job_date_timestringJob date and time
job_latitudenumberJob latitude
job_longitudenumberJob longitude
productsarrayRefer below products table
vendor_idnumberCustomer id
is_schedulednumberTo enable scheduled customization enter 1 else 0
amountnumberAmount of products
delivery_chargenumberDelivery charge
currency_idnumberCurrency id
store_idnumberSeller id
self_pickupnumber(optional)To enable self pickup enter 1 else 0

Products

NameTypeDescription
product_idnumberProduct Id
unit_pricenumber(optional)Per unit price of product
quantitynumberQuantity of product
total_pricenumber(optional)Total price of products
Customizationsarray(optional)Refer below customization table

Customizations

NameTypeDescription
cust_idnumberCustomization Id
unit_pricenumber(optional)Per unit price
quantitynumberQuantity of product
total_pricenumber(optional)Total price of products
namestring(optional)Name of customization
checkout_templatearraycheckout template
tipnumbertip
subtotal_amountnumbersubtotal amount
\n\n

payment method

\n
NameidDescription
ENABLED
STRIPE
PAYPAL
PAYPALV2
CASH
PAY_ON_DELIVERY
VENMO
PAYFORT
PAYTM
RAZORPAY
PAYSTACK
ETISALAT
SUNCASH
GOCARDLESS
ATHMOVIL
IPAY88
PROXYPAY
CYBERSOURCE
BANKALFALAH
CULQI
NMI
FLUTTERWAVE
MPESA
ADYEN
HYPUR
PAYMARK
PAYTMV3
PIXELPAY
DOKU
PEACH
PAGUELOFACIL
NOQOODY
URWAY
GTPAY
CXPAY
VPOS
VUKA
PAYKU
REVOLUT
BAMBORA
PAYWAYONE
TELR
EWAY
PLACETOPAY
BENEFIT
CEVNN
PAYMAYA
UNIPAY
CMI
OPENPAY
CUSTOMPG
PAYMENTEZ
STRIPE_GPAY
STRIPE_APPLEPAY
BILLPLZ
SBM
NIUBIZ
QPAY
PAYFAST
FAC
PAYGATE
KANOO
ORANGEPAY
SPOTII
PAYWAY_ABA
APCOPAY
PAYTABS
RAZORPAY_STOREFRONT
REDSYS
PAYTM_UPI
BILLPLZV2
WOMPI
PAYZENV2
QUADPAY
STRIPE_STANDARD_CONNECT
INNSTAPAY
KEYPAY
HALYKBANK
WEBPAY
RAZORPAY_UPI
PAYULATAM
WALLET
AUTHORIZENET
PAYLATER
PAYMOB
VISTAMONEY
STRIPE_IDEAL
PAYNOW
VIVA
PAYHERE
MPAISA
PAYTM_LINK
CREDIMAX
SSL_COMMERZ
LIME_LIGHT
TWO_CHECKOUT
CHECKOUT
FAC3D
AZUL

HYPERPAY

MYFATOORAH

THETELLER

PAYNET


TAP


CURLEC


WIPAY


PAGARME



WHOOSH

MTN

STRIPE_WECHAT


ONEPAY


PAGOPLUX

MYBILLPAYMENT


BANKOPEN


VALITOR



BHARATPE

TRUEVO

CUSTOM_PG_START

CUSTOM_PG_STOP


PAYZEN


FIRSTDATA


SQUAREUP		: 1
: 2
: 4
: 6
: 8

: 9
: 16
: 32
: 64
: 128
: 256
: 257
: 258

: 259
: 260
: 261
: 262

: 263

: 264
: 265
: 266

: 267
: 268
: 269
: 270
: 271
: 272
: 273
: 274
: 275

: 276
: 277
: 278
: 279
: 280
: 281
: 282
: 283
: 284
: 285
: 286
: 287
: 288
: 297
: 298
: 299
: 301
: 302
: 305
: 307
: 303
: 311
: 304

: 403
: 512
: 702
: 701
: 704
: 1024
: 2048
: 3001
: 3002
: 5012
: 5020
: 5010
: 5019
: 5021

: 5025
: 5005
: 5007
: 3003
: 3013
: 5001
: 5009


: 5022
: 4096
: 7000
: 7001
: 7002

: 5006
: 8192
: 16384

: 32768
: 65536
: 131072

: 262144

: 524288
: 1048576
: 2097152
: 4194304
: 8388608
: 16777216
: 33554432

: 67108864
: 134217728

: 268435456
: 536870912
: 1073741824
: 2147483648
: 4294967296

: 8589934592
: 17179869184
: 34359738368
: 68719476736
: 137438953472
: 274877906944
: 549755813888
: 1099511627776
: 2199023255552
: 4398046511104
: 8796093022208
: 17592186044416
: 35184372088832
: 70368744177664
: 140737488355328
: 281474976710656
: 562949953421312
: 600000000000000
: 999999999999999
: 1125899906842624
: 2251799813685248
: 4503599627370496
\n\n

currency id

\n
Namesymbolid
USD
EUR
JPY
GBP
AUD
CAD
CHF
CNY
SEK
MXN
NZD
SGD
HKD
NOK
KRW
INR
RUB
ZAR
KES
ZMW
AED
EGP
PEN
UGX
IQD
QAR
COP
NGN
MYR
RES
KWD
GHS
HNL
SAR
₱
MAD
OMR
BHD
PKR
BMD
DOP
THB
TWD
ZK
JOD
XOF
AWG
JMD
TRY
R$
BDT
DZD
ARS
PEN
BRL
CLP
GMD
LBP
BWP
BND
BTN
Rp
TTD
GEL
JOD
LKR
FJD
KYD
TZS
AOA
XCD
DKK
MZN
NIO
ILS
MMK
LAK
ISK
XPF
BSD
CRC
GTQ
IDR
KGS
PHP
PHP
BOB
KZT
NAD
SCR
OUV
BGN
BAM		$
‎€
¥‎
£
$
C$
Fr.
¥
kr
Mex$
NZ$
S$
HK$
kr
₩
₹
₽
R
KSh
ZK
AED
E£
S
UGX
ع.د
QAR
$
₦
RM
re
KWD
GH₵
HNL
SAR
₱
MAD
OMR
BHD
Rs
$
RD$
‎฿
NT$
ZK
JOD
XOF
Afl.
JMD $
₺
R$
৳
DZD
$
S/.
R$
$
GMD
L.L.
P
B$
Nu.
Rp
TT$
ლ
دينا
Rs
FJ$
CI$
TSh
Kz
$
DKK
MT
C$
₪
MMK
LAK
kr
F
B$
₡
Q
Rp
Лв
PHP
PHP
Bs
₸
N$
₨
OUV
Лв
KM
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
29
30
31
32
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
80
81
82
83
84
85
87
88
89
100
101
150
74
92
86
87
90
90
123
124
102
125
94
95
96
","urlObject":{"path":["open","admin","order","create"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8190067-df5e-4eed-9e87-e4614506260e"},{"name":"Custom Order","id":"82492f7c-d716-47c1-8b00-28bd0485c9ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"user_id\" : 109955 ,\r\n \"marketplace_user_id\" : 109866 ,\r\n \"customer_email\" : \"test@email.com\" ,\r\n \"customer_phone\" : 1234567890 ,\r\n \"customer_username\" : \"test@1234\" ,\r\n \"customer_address\" : \"xyz colony, abc, Chandigarh-462003\" ,\r\n \"job_description\" : \"Add Some extra cheese\" ,\r\n \"job_delivery_latitude\" : 23.0078201 ,\r\n \"job_delivery_longitude\" : 88.5428696 ,\r\n \"job_pickup_datetime\" : \"2021-05-07T09:22Z\" ,\r\n \"currency_id\" : 16 ,\r\n \"vendor_id\" : 5869695 ,\r\n \"delivery_charge\" : 100 ,\r\n \"payment_method\" : 8 ,\r\n \"amount\" : 204\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/order/customOrder","description":"

Custom Order

\n\n
This API will enable you to create custom order.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
user_idnumber(optional)Customer's User Id
marketplace_user_idnumberMarket place user Id
customer_emailstringCustomer's email
customer_phonenumberCustomer's phone number
customer_usernamestringCustomer's user name
customer_addressstringCustomer's address
job_descriptionstring(optional)Job description
job_delivery_latitudenumberDelivery latitude
job_delivery_longitudenumberDelivery longitude
job_pickup_datetimestringJob pickup date time
currency_idnumberCurrency id
vendor_idnumberCustomer id
delivery_chargenumber(optional)Delivery charge
payment_methodnumber8 for payment in cash
amountnumber(optional)Amount for custom order
\n\n\n

payment method

\n
NameidDescription
ENABLED
STRIPE
PAYPAL
PAYPALV2
CASH
PAY_ON_DELIVERY
VENMO
PAYFORT
PAYTM
RAZORPAY
PAYSTACK
ETISALAT
SUNCASH
GOCARDLESS
ATHMOVIL
IPAY88
PROXYPAY
CYBERSOURCE
BANKALFALAH
CULQI
NMI
FLUTTERWAVE
MPESA
ADYEN
HYPUR
PAYMARK
PAYTMV3
PIXELPAY
DOKU
PEACH
PAGUELOFACIL
NOQOODY
URWAY
GTPAY
CXPAY
VPOS
VUKA
PAYKU
REVOLUT
BAMBORA
PAYWAYONE
TELR
EWAY
PLACETOPAY
BENEFIT
CEVNN
PAYMAYA
UNIPAY
CMI
OPENPAY
CUSTOMPG
PAYMENTEZ
STRIPE_GPAY
STRIPE_APPLEPAY
BILLPLZ
SBM
NIUBIZ
QPAY
PAYFAST
FAC
PAYGATE
KANOO
ORANGEPAY
SPOTII
PAYWAY_ABA
APCOPAY
PAYTABS
RAZORPAY_STOREFRONT
REDSYS
PAYTM_UPI
BILLPLZV2
WOMPI
PAYZENV2
QUADPAY
STRIPE_STANDARD_CONNECT
INNSTAPAY
KEYPAY
HALYKBANK
WEBPAY
RAZORPAY_UPI
PAYULATAM
WALLET
AUTHORIZENET
PAYLATER
PAYMOB
VISTAMONEY
STRIPE_IDEAL
PAYNOW
VIVA
PAYHERE
MPAISA
PAYTM_LINK
CREDIMAX
SSL_COMMERZ
LIME_LIGHT
TWO_CHECKOUT
CHECKOUT
FAC3D
AZUL

HYPERPAY

MYFATOORAH

THETELLER

PAYNET


TAP


CURLEC


WIPAY


PAGARME



WHOOSH

MTN

STRIPE_WECHAT


ONEPAY


PAGOPLUX

MYBILLPAYMENT


BANKOPEN


VALITOR



BHARATPE

TRUEVO

CUSTOM_PG_START

CUSTOM_PG_STOP


PAYZEN


FIRSTDATA


SQUAREUP		: 1
: 2
: 4
: 6
: 8

: 9
: 16
: 32
: 64
: 128
: 256
: 257
: 258

: 259
: 260
: 261
: 262

: 263

: 264
: 265
: 266

: 267
: 268
: 269
: 270
: 271
: 272
: 273
: 274
: 275

: 276
: 277
: 278
: 279
: 280
: 281
: 282
: 283
: 284
: 285
: 286
: 287
: 288
: 297
: 298
: 299
: 301
: 302
: 305
: 307
: 303
: 311
: 304

: 403
: 512
: 702
: 701
: 704
: 1024
: 2048
: 3001
: 3002
: 5012
: 5020
: 5010
: 5019
: 5021

: 5025
: 5005
: 5007
: 3003
: 3013
: 5001
: 5009


: 5022
: 4096
: 7000
: 7001
: 7002

: 5006
: 8192
: 16384

: 32768
: 65536
: 131072

: 262144

: 524288
: 1048576
: 2097152
: 4194304
: 8388608
: 16777216
: 33554432

: 67108864
: 134217728

: 268435456
: 536870912
: 1073741824
: 2147483648
: 4294967296

: 8589934592
: 17179869184
: 34359738368
: 68719476736
: 137438953472
: 274877906944
: 549755813888
: 1099511627776
: 2199023255552
: 4398046511104
: 8796093022208
: 17592186044416
: 35184372088832
: 70368744177664
: 140737488355328
: 281474976710656
: 562949953421312
: 600000000000000
: 999999999999999
: 1125899906842624
: 2251799813685248
: 4503599627370496
\n\n

currency id

\n
Namesymbolid
USD
EUR
JPY
GBP
AUD
CAD
CHF
CNY
SEK
MXN
NZD
SGD
HKD
NOK
KRW
INR
RUB
ZAR
KES
ZMW
AED
EGP
PEN
UGX
IQD
QAR
COP
NGN
MYR
RES
KWD
GHS
HNL
SAR
₱
MAD
OMR
BHD
PKR
BMD
DOP
THB
TWD
ZK
JOD
XOF
AWG
JMD
TRY
R$
BDT
DZD
ARS
PEN
BRL
CLP
GMD
LBP
BWP
BND
BTN
Rp
TTD
GEL
JOD
LKR
FJD
KYD
TZS
AOA
XCD
DKK
MZN
NIO
ILS
MMK
LAK
ISK
XPF
BSD
CRC
GTQ
IDR
KGS
PHP
PHP
BOB
KZT
NAD
SCR
OUV
BGN
BAM		$
‎€
¥‎
£
$
C$
Fr.
¥
kr
Mex$
NZ$
S$
HK$
kr
₩
₹
₽
R
KSh
ZK
AED
E£
S
UGX
ع.د
QAR
$
₦
RM
re
KWD
GH₵
HNL
SAR
₱
MAD
OMR
BHD
Rs
$
RD$
‎฿
NT$
ZK
JOD
XOF
Afl.
JMD $
₺
R$
৳
DZD
$
S/.
R$
$
GMD
L.L.
P
B$
Nu.
Rp
TT$
ლ
دينا
Rs
FJ$
CI$
TSh
Kz
$
DKK
MT
C$
₪
MMK
LAK
kr
F
B$
₡
Q
Rp
Лв
PHP
PHP
Bs
₸
N$
₨
OUV
Лв
KM
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
29
30
31
32
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
80
81
82
83
84
85
87
88
89
100
101
150
74
92
86
87
90
90
123
124
102
125
94
95
96
","urlObject":{"path":["open","admin","order","customOrder"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"82492f7c-d716-47c1-8b00-28bd0485c9ea"},{"name":"orderPrepTime","id":"51093e94-742b-4980-b7b2-2d2a63933b79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"marketplace_user_id\": 10995407,\r\n\"user_id\": \"510003404\",\r\n\"user_type\": 2,\r\n\"settings\" : {\"order_prepration_time\" : 30}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/configureSettings","description":"
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
","urlObject":{"path":["open","merchant","configureSettings"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"51093e94-742b-4980-b7b2-2d2a63933b79"}],"id":"784c35c3-de88-4fda-8460-e3db41d5d4c6","_postman_id":"784c35c3-de88-4fda-8460-e3db41d5d4c6","description":""},{"name":"Search","item":[{"name":"searchGlobalProduct","id":"e6640b89-c7c8-4919-8eb7-3a8cf4905773","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\" Not A;Brand\";v=\"99\", \"Chromium\";v=\"98\", \"Google Chrome\";v=\"98\""},{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"Referer","value":"https://internal-betaweb.yelo.red/en/search"},{"key":"Content-Type","value":"application/json"},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"User-Agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"},{"key":"sec-ch-ua-platform","value":"\"Windows\""}],"body":{"mode":"raw","raw":"{\r\n \"marketplace_user_id\" : 1025779,\r\n \"search_text\" : \"pizz\",\r\n \"latitude\" : 30.7187849,\r\n \"longitude\" : 76.8103741,\r\n \"date_time\" : \"2022-02-28T09:04:10.410Z\",\r\n \"app_type\" : \"WEB\",\r\n \"api_key\" : {{apikey}},\r\n \"self_pickup\" : 0,\r\n \"domain_name\" : \"api.red\",\r\n \"dual_user_key\" : 0,\r\n \"language\" : \"en\"\r\n}"},"url":"https://api.yelo.red/open/search/global/product","description":"
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
","urlObject":{"path":["open","search","global","product"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6640b89-c7c8-4919-8eb7-3a8cf4905773"},{"name":"searchProducts","id":"6a66d801-ddc7-475a-92fd-66c9922f531d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : \"71c07d0c9792bb70566560ad71e00000\",\r\n\t \"marketplace_user_id\" : 1234000,\r\n \"search_text\" \t\t : \"pizza\",\r\n \"user_id\" : \"1234000\",\r\n \"vendor_id\" \t\t\t : 465489000,\r\n \"date_time\" \t\t\t : \"2021-05-06T15:54Z\",\r\n \"domain_name\" \t\t : \"test.red\",\r\n \"dual_user_key\" \t\t : 0,\r\n \"language\" \t\t\t : \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/search_products","description":"
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\"
","urlObject":{"path":["open","search_products"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a66d801-ddc7-475a-92fd-66c9922f531d"},{"name":"searchGlobalMerchants","id":"898accf3-9fab-4011-9225-7e1d8515d1c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"marketplace_user_id\" : 1025779,\r\n \"search_text\" : \"pizz\",\r\n \"latitude\" : 30.7187849,\r\n \"longitude\" : 76.8103741,\r\n \"date_time\" : \"2022-02-28T09:04:10.410Z\",\r\n \"app_type\" : \"WEB\",\r\n \"api_key\" : {{apikey}},\r\n \"self_pickup\" : 0,\r\n \"domain_name\" : \"api.red\",\r\n \"dual_user_key\" : 0,\r\n \"language\" : \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/search/global/merchants","description":"
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
","urlObject":{"path":["open","search","global","merchants"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"898accf3-9fab-4011-9225-7e1d8515d1c1"}],"id":"0fb7e56f-d83c-417e-a3cf-010de9a84d25","_postman_id":"0fb7e56f-d83c-417e-a3cf-010de9a84d25","description":""},{"name":"Marketplace","item":[{"name":"marketplaceVendorFacebookLogin","id":"f96133e8-fc00-49b6-ab97-102d38e8f9bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{api_key}},\r\n \"fb_token\" : \"989934511954741\", \r\n \"marketplace_reference_id\": \"550d12d95d69b9858f4c7e8050e00000\",\r\n \"domain_name\" : \"test.red\",\r\n \"email\" : \"test@yopmail.com\",\r\n \"dual_user_key\" : 0,\r\n \"vendor_image\" : \"https://graph.facebook.com/989934511954741/picture?type=large&width=400&height=400\",\r\n \"language\" : \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/marketplace_vendor_facebook_login","description":"
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\"
","urlObject":{"path":["open","marketplace_vendor_facebook_login"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f96133e8-fc00-49b6-ab97-102d38e8f9bc"},{"name":"Add Debt For Job","id":"d5db3b3d-1259-43d5-954c-7caa4edb37ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"debt_amount\" : 125,\r\n \"job_id\" :921\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/marketplace/addDebtForJob","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
debt_amountnumberdebt_amount\n
job_idnumberjob_id\n\n
","urlObject":{"path":["open","marketplace","addDebtForJob"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5db3b3d-1259-43d5-954c-7caa4edb37ec"},{"name":"addMerchant","id":"18f0c70e-aa14-45bf-aafc-85337e7a29e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"name\" : \"xyz\",\r\n \"first_name\" : \"arun\",\r\n \"last_name\" : \"\",\r\n \"email\" : \"test@email.com\",\r\n \"company_address\" : \"xyz colony, abc, chandigarh-134109\",\r\n \"display_address\" : \"xyz colony,chandigarh-134109\",\r\n \"company_longitude\" : 49.80404,\r\n \"company_latitude\" : 9.96233 ,\r\n \"logo\" : \" \",\r\n \"banner_image\" : \"abc.jpeg\",\r\n \"store_name\" : \"abc\",\r\n \"display_store_name\": \"abc\",\r\n \"description\" : \"xyz\",\r\n \"store_name_json\" : {\r\n \"store_name\" : \"abc\"\r\n },\r\n \"description_json\" : {\r\n \"description\" : \"abcde\"\r\n },\r\n \"phone\" : 7979789565,\r\n \"country_phone_code\": \"+91\",\r\n \"timezone\" : 5\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/marketplace/addMerchant","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
namenumbername\n
first_namestring(optional)merchant's first name\n
last_namestring(optional)/td>\nmerchant's last name\n
emailstringemail\n
company_addressstringcompany_address\n
display_addressstringdisplay_address\n
company_longitudenumbercompany_longitude\n
company_latitudenumbercompany_latitude\n
logostring(optional)logo\n
banner_imagestring(optional)banner_image\n
store_namestring(optional)store_name\n
display_store_namestring(optional)display_store_name\n
descriptionstring(optional)description of merchant\n
store_name_jsonstring(optional)store_name_json\n
description_jsonstring(optional)description_json\n
","urlObject":{"path":["open","marketplace","addMerchant"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"18f0c70e-aa14-45bf-aafc-85337e7a29e6"},{"name":"getMerchantList","id":"c4b293f1-3903-4e0c-8660-976bf1974b20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"length\" : 10,\r\n \"start\" : 2,\r\n \"user_type\" : 2,\r\n \"verification_status\" : 1,\r\n \"sSearch\" : \"\",\r\n \"sortCol\" : \"1\",\r\n \"sortDir\" : \"asc\",\r\n \"searchBy\" : { \"xyz\" : \"xyz\"},\r\n \"isClosed\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/marketplace/getMerchantList","description":"
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
","urlObject":{"path":["open","marketplace","getMerchantList"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4b293f1-3903-4e0c-8660-976bf1974b20"},{"name":"getAccountTranslations","id":"ff7b2e2b-9ddb-4b8f-a0dc-d84add6d23c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{api key}},\r\n\"domain_name\" : \"mbeta-betaweb.red\",\r\n\"language\" : \"en\",\r\n\"marketplace_user_id\" : 1234199\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/getAccountTranslations","description":"
NameTypeDescription
api_keystring(requireed)Your Api Key
domain_namestring(optional)domain name
languagestring(optionallanguage selected by customer
marketplace user idstring(required)marketplace user id

","urlObject":{"path":["open","getAccountTranslations"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff7b2e2b-9ddb-4b8f-a0dc-d84add6d23c3"},{"name":"getfilter","id":"d0a3a076-88a0-40d1-85dd-5741ea092e1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{api key}},\r\n\"domain_name\" : \"mbeta-betaweb.red\",\r\n\"business_category_id\" : 318694,\r\n\"marketplace_user_id\" : 1234199,\r\n\"dual_user_key\" : 0,\r\n\"language\" : \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/customer/getFilters","description":"
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
","urlObject":{"path":["open","customer","getFilters"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0a3a076-88a0-40d1-85dd-5741ea092e1c"}],"id":"8781b521-033e-4851-b404-cc7e0f3d05e7","_postman_id":"8781b521-033e-4851-b404-cc7e0f3d05e7","description":""},{"name":"Task","item":[{"name":"addRemarks","id":"44ffa423-1ee2-4945-93b7-dd5caf6380f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"job_id\" : 125,\r\n \"remarks\" :\"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/task/addRemarks","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
job_idnumberjob_id\n
remarksstringremarks\n\n
","urlObject":{"path":["open","task","addRemarks"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"44ffa423-1ee2-4945-93b7-dd5caf6380f7"},{"name":"getTookanRequest","id":"8f5aafbf-1602-4753-aaab-a2c8509789ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"job_id\" : 125,\r\n \"product_id\" : 123\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/task/getTookanRequest","description":"
NameTypeDescription
api_keystringYour API-key
job_idnumberjob_id
product_idnumber(optional)product_id

","urlObject":{"path":["open","task","getTookanRequest"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f5aafbf-1602-4753-aaab-a2c8509789ea"},{"name":"Edit Task","id":"da97bc8b-16ca-49f5-a40e-706d490dce59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"job_id\" : 1245555,\r\n \"job_address\" : \"xyz colony, abc, chandigarh-134109\",\r\n \"job_pickup_address\" : \"xyz colony, abc, chandigarh-134108\",\r\n \"customer_phone\" : \"9898981122\",\r\n \"job_description\" : \"Deliver on time!\",\r\n \"job_pickup_datetime\" : \"2021-05-07T09:22Z\",\r\n \"order_amount\" : 100,\r\n \"language\" : \"en\",\r\n \"job_latitude\" : 23.0078201,\r\n \"job_longitude\" : 88.5428696,\r\n \"job_pickup_latitude\" : 23.0078201,\r\n \"job_pickup_longitude\" : 88.5428696,\r\n \"total_amount\" : 100,\r\n \"products\" : 1,\r\n \"coupon_discount\" : 100,\r\n \"tax\" : 10, \r\n \"tip\" : 10,\r\n \"currency_symbol\" : \"INR\",\r\n \"delivery_charge\" : 10,\r\n \"user_type\" : 2,\r\n \"user_id\" : 510001213,\r\n \"additional_charges\" : 5,\r\n \"additional_charge_label\" : \"any\",\r\n \"job_delivery_time\" : \"2021-05-07T09:22Z\",\r\n \"is_laundry_task\" : 5\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/task/edit","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
marketplace_user_idnumbermarketplace user id\n
job_idnumberjob id\n\n
job_addressstring(optional)job address\n
job_pickup_addressstring(optional)job pickup address\n
customer_phonestring(optional)customer phone\n
job_descriptionstring(optional)job description\n
job_pickup_datetimestring(optional)job pickup date time\n
order_amountnumber(optional)order amount\n
language/td>\nstring(optional)language\n
job_latitudenumber(optional)job latitude\n
job_longitudenumber(optional)job longitude\n
job_pickup_latitude/td>\nnumber(optional)job pickup latitude\n
job_pickup_longitudenumber(optional)job pickup longitude\n
total_amountnumber(optional)total amount\n
productsany(optional)products\n
coupon_discountnumber(optional)coupon discount\n
taxnumber(optional)tax\n
tipnumber(optional)tip\n
currency_symbolstring(optional)currency symbol\n
delivery_chargenumber(optional)delivery charge\n
user_typenumber(optional)For admin enter 2, For merchant enter 3\n
user_idnumber(optional)user id\n
additional_chargesnumber(optional)additional charges\n
additional_charge_labelstring(optional)additional charge label\n
job_delivery_timestring(optional)job delivery time\n
is_laundry_tasknumber(optional)is laundry task\n
","urlObject":{"path":["open","task","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"da97bc8b-16ca-49f5-a40e-706d490dce59"},{"name":"Accept Reject Order","id":"0b67a83e-ca24-4a20-8987-a912a33ca1bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"access_user_type\" : 3,\r\n \"job_id\" : 125,\r\n\t\t\"refunded_amount\" : 20,\r\n\t\t\"user_id\" : 510001,\r\n\t\t\"marketplace_user_id\": 510001,\r\n\t\t\"product_id\" : 123,\r\n\t\t\"accept_reject\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/task/acceptReject","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
access_user_typenumber(optional)2 : for admin, 3 : for merchant\n
job_idnumberjob id\n\n
refunded_amountnumber(optional)Amount to be refunded\n
user_idnumberuser id\n
marketplace_user_idnumbermarketplace user id\n
product_idnumber(optional)product id\n
accept_rejectnumberIf you want to accept order enter 1 else 0.\n
","urlObject":{"path":["open","task","acceptReject"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b67a83e-ca24-4a20-8987-a912a33ca1bc"},{"name":"updateStatus","id":"2e8362b5-a213-42ec-bf40-d0ff8a647532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"job_id\" : 125,\r\n\t\t\"user_id\" : 510001,\r\n\t\t\"marketplace_user_id\": 510001,\r\n\t\t\"product_id\" : 123,\r\n\t\t\"status\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/task/updateStatus","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
job_idnumberjob id\n
user_idnumberuser id\n
marketplace_user_idnumbermarketplace user id\n
product_idnumberproduct id\n
statusnumberIf you want to accept order enter 1 else 0.\n
","urlObject":{"path":["open","task","updateStatus"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e8362b5-a213-42ec-bf40-d0ff8a647532"}],"id":"7c5d5af1-6976-426b-812d-03f573ff0790","_postman_id":"7c5d5af1-6976-426b-812d-03f573ff0790","description":""},{"name":"Merchant","item":[{"name":"Edit Store Status","id":"a9a7aace-ab79-445e-ba77-9470572fabdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" :{{apikey}},\r\n \"marketplace_user_id\": 510001,\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"is_active\" : 1,\r\n \"is_blocked\" : 0,\r\n \"is_deleted\" : 0,\r\n \"is_closed\" : 0\r\n }\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/marketplace/editStoreStatus","description":"
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
","urlObject":{"path":["open","marketplace","editStoreStatus"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9a7aace-ab79-445e-ba77-9470572fabdd"},{"name":"Get Store FrontDateSchedule","id":"e72def42-f369-46dc-9438-38c6cc039a8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{apikey}},\r\n\"user_id\" : 510001,\r\n\"user_type\" : 2,\r\n\"marketplace_user_id\": 510001,\r\n\"delivery_methods\" : 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/getStoreFrontDateSchedule","description":"
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
","urlObject":{"path":["open","merchant","getStoreFrontDateSchedule"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"e72def42-f369-46dc-9438-38c6cc039a8b"},{"name":"Add Store FrontDateSchedule","id":"b41b0ec6-a54a-4088-9bc2-d04eedb56edc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{apikey}},\r\n\"user_id\" : 510001,\r\n\"user_type\" : 2,\r\n\"delivery_methods\" : 10,\r\n\"marketplace_user_id\": 510001,\r\n\"start_date\" : \"2021-04-21\",\r\n\"end_date\" : \"2021-05-13\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/addStoreFrontDateSchedule","description":"
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
","urlObject":{"path":["open","merchant","addStoreFrontDateSchedule"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"b41b0ec6-a54a-4088-9bc2-d04eedb56edc"},{"name":"Update Store FrontDateSchedule","id":"1dc8ff62-41bb-4e04-8590-1670dac9b1d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{apikey}},\r\n\"user_id\" : 510001,\r\n\"user_type\" : 2,\r\n\"marketplace_user_id\": 510001,\r\n\"slot_id\" : 7151,\r\n\"is_deleted\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/updateStoreFrontDateSchedule","description":"
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
","urlObject":{"path":["open","merchant","updateStoreFrontDateSchedule"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"1dc8ff62-41bb-4e04-8590-1670dac9b1d3"},{"name":"Get merchant","id":"0fc6e319-5d1f-4bf5-8c9d-5da061edeaf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 2345,\r\n \"marketplace_user_id\" : 2233344 \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/get","description":"
ParameterTypeDescription
api_keystringYour API-key
user_idnumberUser id
marketplace_user_idnumberMarketplace user id
","urlObject":{"path":["open","merchant","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fc6e319-5d1f-4bf5-8c9d-5da061edeaf7"},{"name":"Merchant settings","id":"d67881fd-a565-4b73-9647-d1cde8fc8da9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"serving_distance\" : 5\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/settings","description":"
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
","urlObject":{"path":["open","merchant","settings"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"d67881fd-a565-4b73-9647-d1cde8fc8da9"},{"name":"user_login","id":"f8bf877b-023b-45c8-bfea-72f255ee66fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"email\" : \"test@test.com\",\r\n \"password\" : \"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/user_login","description":"
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace user id
emailstringemail

passwordstringpassword
","urlObject":{"path":["open","user_login"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8bf877b-023b-45c8-bfea-72f255ee66fb"}],"id":"9c6b8c55-d5ac-4193-b46d-b91e59afdd4d","_postman_id":"9c6b8c55-d5ac-4193-b46d-b91e59afdd4d","description":""},{"name":"Catalogue","item":[{"name":"Catagory","item":[{"name":"Add Catalogue","id":"4ea80b5c-6cfb-45ac-a043-07bb410ae469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"name\" : \"Indian\",\r\n \"description\" : \"\",\r\n \"image_url\" : [],\r\n \"is_side_order\" : 0,\r\n \"name_json\" : {\r\n \"en\": \"Indian\"\r\n },\r\n \"description_json\" : {\r\n \"en\": \"\"\r\n },\r\n \"parent_category_id\" : 123\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/catalogue/add","description":"

Add Catalogue

\n\n
This API will add the catalog
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
user_idnumberThis is merchant id on which the catalog is created.
marketplace_user_idnumberYour marketplace user id
namestringCategory name here
descriptionstringDescription of catalogue
image_urlstring(optional)Enter image URL
is_side_ordernumber(optional)If the category is to be marked as side order enter 1 else 0.
name_jsonobject(optional)\"en\" is mandatory and refer to below language table.
description_jsonobject(optional)\"en\" is mandatory and refer to below language table.
parent_category_idnumber(optional)Parent category id if you want to create nested category structure.

Languages

\n\n \n

Different languages supported. If you are not passing any languages then it is mandatory to pass \"en\"

\n
NameType
ENGLISHen
ARABIANar
FRENCHfr
SPANISHes
MALAYms
SIMPLIFIED_CHINESEzh-Hans
PORTUGUESEpt
TRADITIONAL_CHINESEzh-Hant
BENGALIbn
MEXICAN_SPANISHes-mx
KHMERkm
TAMILta
SINHALAsi
SWEDISHsv
","urlObject":{"path":["open","catalogue","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ea80b5c-6cfb-45ac-a043-07bb410ae469"},{"name":"Update Catalogue","id":"da7f3d7d-3a90-4e36-a394-1d446fb9316c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"catalogue_id\" : 1234,\r\n \"image_url\" : [],\r\n \"name\" : \"Pizza\",\r\n \"is_side_order\" : 0,\r\n \"name_json\" : {\r\n \"en\": \"Pizza\"\r\n },\r\n \"description_json\" : {\r\n \"en\": \"\"\r\n }\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/catalogue/update","description":"

Update Catalogue

\n\n
This API will enable you to Update catalogue.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
user_idnumberUser id.
marketplace_user_idnumberMarketplace user id.
catalogue_idnumberCatalogue id
image_urlstring(optional)Image URL.
description_jsonobject(optional)\"en\" is mandatory and refer to below language table.
is_side_ordernumber1 to enable side order else 0.
namestringName of catalogue
name_jsonobject\"en\" is mandatory and refer to below language table.

Languages

\n\n

Different languages supported. If you are not passing any languages then it is mandatory to pass \"en\"

\n
NameType
ENGLISHen
ARABIANar
FRENCHfr
SPANISHes
MALAYms
SIMPLIFIED_CHINESEzh-Hans
PORTUGUESEpt
TRADITIONAL_CHINESEzh-Hant
BENGALIbn
MEXICAN_SPANISHes-mx
KHMERkm
TAMILta
SINHALAsi
SWEDISHsv
","urlObject":{"path":["open","catalogue","update"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"da7f3d7d-3a90-4e36-a394-1d446fb9316c"},{"name":"Get Catalogue","id":"461acda5-f017-4183-bd3b-fce0880451dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\": 510001,\r\n \"catalogue_id\" : 1234\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/catalogue/get","description":"

Get Catalogue

\n\n
This API will enable you to fetch catalogues.
\n

Request Body Parameters:

\n
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumber(optional)Market place user Id
catalogue_idnumberCatalogue id
","urlObject":{"path":["open","catalogue","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"461acda5-f017-4183-bd3b-fce0880451dd"},{"name":"Get All Catalogues","id":"62fbe8c1-8f1b-4f5e-b707-d131cf1fb9dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"parent_category_id\" : 3468353\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/catalogue/getAll","description":"

Get All Catalogues

\n
This API will enable you to get products.
\nRequest Body Parameters:\n\n\n \n \n\n\n\n \n \n\n\n\n \n \n\n\n\n \n \n\n\n\n\n \n \n\n\n
NameTypeDescription
api_keystringYour API-key
user_idnumberYour user Id
marketplace_user_idnumberYour market place user Id
parent_category_idnumberParent catalogue id for which catalogues need to be fetched
","urlObject":{"path":["open","catalogue","getAll"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"62fbe8c1-8f1b-4f5e-b707-d131cf1fb9dc"},{"name":"Get Catalogue Products","id":"29d9cc38-728d-4fb0-8f6f-f25629ff3767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"limit\"\t : 10,\r\n \"offset\" : 0,\r\n \"parent_category_id\" : 3468353\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/catalogue/products","description":"

Get Catalogue Products

\n
This API will enable you to get catalogs.
\nRequest Body Parameters:\n\n\n \n \n\n\n\n \n \n\n\n\n \n \n\n\n\n \n \n\n\n\n \n \n\n\n\n \n \n\n\n\n \n \n\n\n
NameTypeDescription
api_keystringYour API-key
user_idnumberYour user Id
marketplace_user_idnumberYour market place user Id
limitnumberNumber (for example 10 for fetching 10 products)
offsetnumberOffset denotes the starting point from where you want to fetch product
parent_category_idnumberCatalogue id for which products need to be fetched
","urlObject":{"path":["open","catalogue","products"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"29d9cc38-728d-4fb0-8f6f-f25629ff3767"},{"name":"Enable Disable Category wise","id":"1a3e4af0-e5c0-4b2f-ab7a-ec0f851b79fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 510001,\r\n \"marketplace_user_id\" : 510001,\r\n \"user_type\" : 2,\r\n \"catalogue_id\" : 3462866,\r\n \"status\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/enable_disable_catalogue","description":"

Enable Disable Category wise

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
api_keystringYour API-key
marketplace_user_idnumberYour marketplace_user_id
user_idnumberThis is merchant id on which the product is created.
user_typenumberEnter 2 for admin, 3 for merchant
catalogue_idnumberThis is catalogue id for which the catalogue is created.
statusnumberFor Enable Enter 1, For Disable enter 0
","urlObject":{"path":["open","enable_disable_catalogue"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a3e4af0-e5c0-4b2f-ab7a-ec0f851b79fd"},{"name":"Delete catalogue","id":"4fdae378-8d01-4ba8-92fc-b9bbcc2d7c15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"catalogue_id\" : 1,\r\n \"user_type\" : 1,\r\n \"marketplace_reference_id\": \"10995407\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/catalogue/delete","description":"
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
","urlObject":{"path":["open","catalogue","delete"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4fdae378-8d01-4ba8-92fc-b9bbcc2d7c15"}],"id":"37fd8a20-f266-4300-aa2a-01b89142d981","_postman_id":"37fd8a20-f266-4300-aa2a-01b89142d981","description":""},{"name":"Products","item":[{"name":"disable","id":"50486b6f-7314-4686-af42-8900ce6660b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"is_enabled\" : 1,\r\n \"product_ids\" : [1],\r\n \"user_type\" : 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/disable","description":"
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
","urlObject":{"path":["open","product","disable"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"50486b6f-7314-4686-af42-8900ce6660b1"},{"name":"Add product","id":"cc57d2c2-cce5-4037-b4a9-f0b2de12428b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 510001,\r\n \"marketplace_user_id\": 510001,\r\n \"parent_category_id\" : 3462866,\r\n \"name\" : \"pasta\",\r\n \"minimum_quantity\" : 1,\r\n \"description\" : \"\",\r\n \"long_description\" : \"\",\r\n \"cost_price\" : 180,\r\n \"multi_image_url\" : [],\r\n \"price\" : \"200\",\r\n \"unit_type\" : 1,\r\n \"unit\" : 1,\r\n \"service_time\" : 0,\r\n \"return_enabled\" : 0,\r\n \"inventory_enabled\" : 0,\r\n \"available_quantity\" : 0,\r\n \"is_veg\" : 1,\r\n \"taxes\" : [],\r\n \"name_json\" : {\r\n \"en\": \"pasta\"\r\n },\r\n \"description_json\" : {\r\n \"en\": \"\"\r\n },\r\n \"long_description_json\": {\r\n \"en\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/add","description":"

Add Product

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Languages

\n

Different languages supported. If you are not passing any languages then it is mandatory to pass \"en\"

\n
ParameterType Description
api_keystringYour API-key
marketplace_user_idnumberYour marketplace_user_id
merchant_idnumberThis is merchant id on which the product is created.
namestring(optional)Enter name of product
name_jsonobject(optional)\"en\" is mandatory and refer to below language table.
descriptionstring(optional)Enter description of product
description_jsonobject(optional)\"en\" is mandatory and refer to below language table.
long_description_jsonobject(optional)\"en\" is mandatory and refer to below language table.
parent_category_idnumber(optional)Enter parent catalog id
long_descriptionstring(optional)\"en\" is mandatory and refer to below language table.
cost_pricenumberCost Price
service_timenumber(optional)Enter service time in minutes and append in case it is service order.
multi_image_urlarray(optional)Enter image url
inventory_enablednumber(optional)If inventory is need to be marked as enabled enter 1 else 0.
available_quantitynumber(optional)Enter available quantity
is_vegnumber1 for veg, 0 for non-veg, 2 for none
minimum_quatitynumber(optional)Enter minimum quantity of products that is required to be in the cart.
pricenumber(optional)Enter price of Product
unitnumber(optional)Enter unit of Product
is_side_ordernumber(optional)If the product is to be marked as side order enter 1 else 0.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Unit Types

\n

Unit Types:

\n
NameType
ENGLISHen
ARABIANar
FRENCHfr
SPANISHes
MALAYms
SIMPLIFIED_CHINESEzh-Hans
PORTUGUESEpt
TRADITIONAL_CHINESEzh-Hant
BENGALIbn
MEXICAN_SPANISHes-mx
KHMERkm
TAMILta
SINHALAsi
SWEDISHsv
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameType
FIXED1
MINUTE2
HOUR3
DAY4
WEEK5
MONTH6
YEAR7
KILOGRAM8
POUND9
PERSON10
KILOMETER11
","urlObject":{"path":["open","product","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc57d2c2-cce5-4037-b4a9-f0b2de12428b"},{"name":"Edit Product","id":"52398b19-5f1e-45c2-81ba-1e0c3dc6529e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 510001,\r\n \"marketplace_user_id\" : 510001,\r\n \"product_id\" : 409973,\r\n \"name\" : \"pizza\",\r\n \"description\" : \"\",\r\n \"long_description\" : \"\",\r\n \"multi_image_url\" : [],\r\n \"price\" : \"140.00\",\r\n \"unit_type\" : 1,\r\n \"unit\" : 1,\r\n \"return_enabled\" : 0,\r\n \"service_time\" : 0,\r\n \"minimum_quantity\" : 1,\r\n \"inventory_enabled\" : 0,\r\n \"available_quantity\" : 0,\r\n \"enable_tookan_agent\" : 0,\r\n \"buffer_schedule\" : 15,\r\n \"timezone\" : -330,\r\n \"is_veg\" : 0,\r\n \"taxes\" : [],\r\n \"search_tags\" : [\"loreum ipsum\"], \r\n \"name_json\" : {\r\n \"en\": \"pizza\"\r\n },\r\n \"description_json\" : {\r\n \"en\": \"\"\r\n },\r\n \"long_description_json\" : {\r\n \"en\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/edit","description":"

Edit Product

\n\n
ParameterTypeDescription
api_keystringYour API-key
marketplace_user_idnumberYour marketplace_user_id
user_idnumberThis is merchant id on which the product is created.
product_idnumberYour product Id.
namestring(optional)Enter name of product
name_jsonobject(optional)\"en\" is mandatory and refer to below language table.
descriptionstring(optional)Enter description of product
description_jsonobject(optional)\"en\" is mandatory and refer to below language table.
long_description_jsonobject(optional)\"en\" is mandatory and refer to below language table.
parent_category_idnumber(optional)Enter parent catalog id
long_descriptionstring(optional)\"en\" is mandatory and refer to below language table.
service_timenumber(optional)Enter service time in minutes and append in case it is service order.
multi_image_urlarray(optional)Enter image url
inventory_enablednumber(optional)If inventory is need to be marked as enabled enter 1 else 0.
available_quantitynumber(optional)Enter available quantity
cost_pricenumberCost Price
is_vegnumber1 for veg, 0 for non-veg, 2 for none
minimum_quatitynumber(optional)Enter minimum quantity of products that is required to be in the cart.
pricenumber(optional)Enter price of Product (Price update happens with a delay of a few seconds)
unitnumber(optional)Enter unit of Product
is_side_ordernumber(optional)If the product is to be marked as side order enter 1 else 0.
search_tagsarray(optinal)add tags like ['loreum ipsum'] and search will work on tags
\n\n

Languages

\n\n

Different languages supported. If you are not passing any languages then it is mandatory to pass \"en\"

\n\n
NameType
ENGLISHen
ARABIANar
FRENCHfr
SPANISHes
MALAYms
SIMPLIFIED_CHINESEzh-Hans
PORTUGUESEpt
TRADITIONAL_CHINESEzh-Hant
BENGALIbn
MEXICAN_SPANISHes-mx
KHMERkm
TAMILta
SINHALAsi
SWEDISHsv
","urlObject":{"path":["open","product","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"52398b19-5f1e-45c2-81ba-1e0c3dc6529e"},{"name":"delete","id":"5ea7e85d-0508-42b4-8085-8c3fbfe190b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"product_id\" : 12345,\r\n \"parent_id\" : 85698,\r\n \"user_type\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/delete","description":"
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
","urlObject":{"path":["open","product","delete"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ea7e85d-0508-42b4-8085-8c3fbfe190b1"},{"name":"Disable Products","id":"35f17f58-541a-43ce-8e7e-ebfb9426b633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"marketplace_user_id\" : {{marketplaceUserId}},\r\n \"api_key\" : {{api key}},\r\n \"user_id\" : 510001,\r\n \"product_ids\" : [1],\r\n \"is_enabled\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/disable_products","description":"
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
","urlObject":{"path":["open","disable_products"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"35f17f58-541a-43ce-8e7e-ebfb9426b633"},{"name":"Get product","id":"0cd43c7d-b391-4696-ba57-07acb2f81977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\": 510001,\r\n\t\t\"user_id\" : 510001,\r\n\t\t\"product_id\" : 1,\r\n\t\t\"product_ids_array\" : [1],\r\n\t\t\"app_type\" : 3,\r\n\t\t\"limit\" : 5,\r\n\t\t\"offset\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/get","description":"
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
","urlObject":{"path":["open","product","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"0cd43c7d-b391-4696-ba57-07acb2f81977"},{"name":"Get All Products","id":"8ffe4a69-5ad2-4f15-a309-4b8aebc15387","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_type\" : 1,\r\n \"user_id\" : 510001,\r\n \"start\" : 1,\r\n \"length\" : 10,\r\n \"sSearch\" : \"test\",\r\n \"sortCol\" : \"1\",\r\n \"sortDir\" : \"1\",\r\n \"get_all_enabled_products\": 1,\r\n \"language\" : \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/getAllProducts","description":"
NameTypeDescription
api_keystringYour API-key
marketplace_user_idnumbermarketplace_user_id
user_idnumber(optional)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
","urlObject":{"path":["open","product","getAllProducts"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ffe4a69-5ad2-4f15-a309-4b8aebc15387"},{"name":"Get Products For Category","id":"774668bc-ec48-4de8-a5e2-cc8a212586d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n\t\t\"user_id\" : 1,\r\n\t\t\"limit\" : 10,\r\n\t\t\"offset\" : 1,\r\n\t\t\"parent_category_id\" : null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/products/getProductsForCategory","description":"
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
","urlObject":{"path":["open","products","getProductsForCategory"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"774668bc-ec48-4de8-a5e2-cc8a212586d5"}],"id":"4689b252-31df-4049-8053-1f03c02768a7","_postman_id":"4689b252-31df-4049-8053-1f03c02768a7","description":""},{"name":"Product Customization","item":[{"name":"Deprecated","item":[{"name":"Get Customization","id":"4a2cb8d6-b28f-4dbf-ad7a-b89b70955c31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"customize_id\" : 456548,\r\n\t \"product_id\" : 409973\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/getCustomization","description":"
NameTypeDescription
api_key
string
Your API-key
customize_id
number
customize_id
product_id
number
product_id
","urlObject":{"path":["open","product","getCustomization"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a2cb8d6-b28f-4dbf-ad7a-b89b70955c31"},{"name":"Add Customization","id":"8f56f322-d8a4-40e0-8fbb-1d826acab451","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"user_id\" : 510001,\r\n \"marketplace_user_id\" : 510001,\r\n \"customization\" : {\r\n \"product_id\": 409973,\r\n \"type\": \"veg pizza\",\r\n \"type_json\" : {\r\n \"en\": \"veg pizza\"\r\n },\r\n \"is_multiple\": 0,\r\n \"sub_types\": [\r\n {\r\n \"name\": \"veg\",\r\n \"price\": 120,\r\n \"is_default\": 0,\r\n \"name_json\" : {\r\n \"en\" : \"veg\"\r\n }\r\n }\r\n ],\r\n \"minimum_selection_required\": 0,\r\n \"minimum_selection\" : 0\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/addCustomization","description":"

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
","urlObject":{"path":["open","product","addCustomization"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f56f322-d8a4-40e0-8fbb-1d826acab451"},{"name":"Delete Customization","id":"18ce07db-4748-45e1-991a-fe266af0eae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"marketplace_user_id\" : 510001,\r\n \"user_id\" : 510001,\r\n \"product_id\" : 12,\r\n \"customize_id\" : 125,\r\n \"user_type\" : 2,\r\n \"marketplace_reference_id\": \"51003\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/deleteCustomization","description":"
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
","urlObject":{"path":["open","product","deleteCustomization"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"18ce07db-4748-45e1-991a-fe266af0eae1"},{"name":"Edit Customization","id":"7ea52549-a600-46c0-8bb2-23d470a04fc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : \"7c675d32d0a695363ed2e60eee2301bb\",\r\n \"user_id\" : 510001,\r\n\t\"marketplace_user_id\" : 510001,\r\n\t\"user_type\" : 2,\r\n\t\"marketplace_reference_id\" : \"510001\",\r\n\t\"customization\" : {\r\n\t\t\"customize_id\"\t\t\t : 456548,\r\n\t\t\"product_id\" : 409973,\r\n\t\t\"type\" : \"veg pizza\",\r\n\t\t\"type_json\" : {\r\n \"en\" : \"veg pizza\"\r\n },\r\n\t\t\"is_multiple\" : 0,\r\n\t\t\"sub_types\" : [\r\n {\r\n \"name\": \"veg\",\r\n \"price\": 120,\r\n \"is_default\": 0,\r\n \"name_json\": {\r\n \"en\": \"veg\"\r\n }\r\n }\r\n ],\r\n\t\"minimum_selection_required\" : 0,\r\n\t\"minimum_selection\" : 0\r\n}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/editCustomization","description":"
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
","urlObject":{"path":["open","product","editCustomization"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ea52549-a600-46c0-8bb2-23d470a04fc2"}],"id":"acae791f-7c97-47db-bf9e-ab10f9d390ab","_postman_id":"acae791f-7c97-47db-bf9e-ab10f9d390ab","description":""},{"name":"Customizations","id":"6640c86c-b1db-43bb-93b2-a9a3ac4ac224","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://api.yelo.red/open/v2/product/customizations?api_key={{api_key}}&user_id={{user_id}}&limit=30&offset=0&sSearch=Example Addon","description":"

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.

\n","urlObject":{"path":["open","v2","product","customizations"],"host":["https://api.yelo.red"],"query":[{"description":{"content":"

Required

\n","type":"text/plain"},"key":"api_key","value":"{{api_key}}"},{"description":{"content":"

Required

\n","type":"text/plain"},"key":"user_id","value":"{{user_id}}"},{"description":{"content":"

Required

\n","type":"text/plain"},"key":"limit","value":"30"},{"description":{"content":"

Required

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Optional

\n","type":"text/plain"},"key":"sSearch","value":"Example Addon"}],"variable":[]}},"response":[{"id":"bfecd1cf-d27c-4e4d-9710-ab85b3039da6","name":"Customizations","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.yelo.red/open/v2/product/customizations","host":["https://api.yelo.red"],"path":["open","v2","product","customizations"],"query":[{"key":"sSearch","value":"","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, DELETE , PATCH"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With,content-type,base_version,timezone,device_type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"4317"},{"key":"ETag","value":"W/\"10dd-ZibNeFSr5T7hhokm4CaocdfkAtc\""},{"key":"Date","value":"Wed, 10 Apr 2024 07:06:30 GMT"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\"iTotalDisplayRecords\":5,\"iTotalRecords\":16,\"draw\":0,\"data\":[{\"customize_id\":6849860,\"type\":\"MS NO exactly no default\",\"is_active\":0,\"type_json\":{\"en\":\"MS NO exactly no default\"},\"is_check_box\":1,\"is_selected\":0,\"sub_types\":[{\"cust_id\":47763249,\"name\":\"a\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"a\"},\"price\":10},{\"cust_id\":47763250,\"name\":\"b\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"b\"},\"price\":20},{\"cust_id\":47763251,\"name\":\"c\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"c\"},\"price\":30},{\"cust_id\":47763252,\"name\":\"d\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"d\"},\"price\":40},{\"cust_id\":47763253,\"name\":\"e\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"e\"},\"price\":50},{\"cust_id\":47763254,\"name\":\"f\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"f\"},\"price\":60},{\"cust_id\":47763255,\"name\":\"g\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"g\"},\"price\":70}]},{\"customize_id\":6849859,\"type\":\"MS w min exactly 2 w default a\",\"is_active\":1,\"type_json\":{\"en\":\"MS w min exactly 2 w default a\"},\"is_check_box\":1,\"is_selected\":0,\"sub_types\":[{\"cust_id\":47763242,\"name\":\"a\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"a\"},\"price\":10},{\"cust_id\":47763243,\"name\":\"b\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"b\"},\"price\":20},{\"cust_id\":47763244,\"name\":\"c\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"c\"},\"price\":30},{\"cust_id\":47763245,\"name\":\"d\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"d\"},\"price\":40},{\"cust_id\":47763246,\"name\":\"e\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"e\"},\"price\":50},{\"cust_id\":47763247,\"name\":\"f\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"f\"},\"price\":60},{\"cust_id\":47763248,\"name\":\"g\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"g\"},\"price\":70}]},{\"customize_id\":6849858,\"type\":\"MS NO exactly no default\",\"is_active\":0,\"type_json\":{\"en\":\"MS NO exactly no default\"},\"is_check_box\":1,\"is_selected\":0,\"sub_types\":[{\"cust_id\":47763235,\"name\":\"a\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"a\"},\"price\":10},{\"cust_id\":47763236,\"name\":\"b\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"b\"},\"price\":20},{\"cust_id\":47763237,\"name\":\"c\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"c\"},\"price\":30},{\"cust_id\":47763238,\"name\":\"d\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"d\"},\"price\":40},{\"cust_id\":47763239,\"name\":\"e\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"e\"},\"price\":50},{\"cust_id\":47763240,\"name\":\"f\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"f\"},\"price\":60},{\"cust_id\":47763241,\"name\":\"g\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"g\"},\"price\":70}]},{\"customize_id\":6849857,\"type\":\"MS w min exactly 2 w default a\",\"is_active\":1,\"type_json\":{\"en\":\"MS w min exactly 2 w default a\"},\"is_check_box\":1,\"is_selected\":0,\"sub_types\":[{\"cust_id\":47763228,\"name\":\"a\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"a\"},\"price\":10},{\"cust_id\":47763229,\"name\":\"b\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"b\"},\"price\":20},{\"cust_id\":47763230,\"name\":\"c\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"c\"},\"price\":30},{\"cust_id\":47763231,\"name\":\"d\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"d\"},\"price\":40},{\"cust_id\":47763232,\"name\":\"e\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"e\"},\"price\":50},{\"cust_id\":47763233,\"name\":\"f\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"f\"},\"price\":60},{\"cust_id\":47763234,\"name\":\"g\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"g\"},\"price\":70}]},{\"customize_id\":6849856,\"type\":\"SS W Default 1\",\"is_active\":1,\"type_json\":{\"en\":\"SS W Default 1\"},\"is_check_box\":0,\"is_selected\":0,\"sub_types\":[{\"cust_id\":47763220,\"name\":\"1\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"1\"},\"price\":10},{\"cust_id\":47763221,\"name\":\"2\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"2\"},\"price\":20},{\"cust_id\":47763222,\"name\":\"3\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"3\"},\"price\":30},{\"cust_id\":47763223,\"name\":\"4\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"4\"},\"price\":40},{\"cust_id\":47763224,\"name\":\"5\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"5\"},\"price\":50},{\"cust_id\":47763225,\"name\":\"6\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"6\"},\"price\":60},{\"cust_id\":47763226,\"name\":\"7\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"7\"},\"price\":70},{\"cust_id\":47763227,\"name\":\"8\",\"is_default\":0,\"is_active\":1,\"name_json\":{\"en\":\"8\"},\"price\":80}]}]}"}],"_postman_id":"6640c86c-b1db-43bb-93b2-a9a3ac4ac224"}],"id":"2eb88fb8-db01-4956-9bcf-59b80996f0d0","_postman_id":"2eb88fb8-db01-4956-9bcf-59b80996f0d0","description":""}],"id":"aff19bfc-b1a7-4522-a650-216d712289ee","_postman_id":"aff19bfc-b1a7-4522-a650-216d712289ee","description":""},{"name":"Business Categories","item":[{"name":"Assign Business Category","id":"de7bee94-bbeb-4a38-871e-c8d35acc56a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"marketplace_user_id\": 510001,\r\n \"merchant_id\" : 23,\r\n \"id\" :5,\r\n \"is_active\" :1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/businessCategory/selectCategory","description":"
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.
","urlObject":{"path":["open","businessCategory","selectCategory"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"de7bee94-bbeb-4a38-871e-c8d35acc56a9"},{"name":"Get Business Category","id":"0baa8b48-b49b-4e3c-93c1-dc568005adac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}} ,\r\n \"marketplace_user_id\" : 510001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/businessCategory/getCategoryDashboard","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
api_keystringYour API-key
marketplace_user_idnumberYour marketplace user id
","urlObject":{"path":["open","businessCategory","getCategoryDashboard"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"0baa8b48-b49b-4e3c-93c1-dc568005adac"},{"name":"businessCategory","id":"1ee077be-5783-48d6-9c27-ad2e49e187ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{api key}},\r\n\"domain_name\" : \"mbeta-betaweb.red\",\r\n\"marketplace_user_id\" : 1234199,\r\n\"version\" : 2,\r\n\"vendor_id\" : 5355813,\r\n\"latitude\" : 26.4962048,\r\n\"longitude\" : 80.248832,\r\n\"dual_user_key\" : 0,\r\n\"language\" : \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/businessCategory/getCategory","description":"
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
","urlObject":{"path":["open","businessCategory","getCategory"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ee077be-5783-48d6-9c27-ad2e49e187ad"}],"id":"e1ffb2bd-f41e-411c-9b04-f5c7778e341c","_postman_id":"e1ffb2bd-f41e-411c-9b04-f5c7778e341c","description":""},{"name":"Send SMS","item":[{"name":"Send App Link SMS","id":"e5295b50-9d7b-4790-935e-2cfcb344b624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"domain_name\": \"dom\",\r\n \"phone\" : 8989898989,\r\n \"app_type\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/sendAppLinkSMS","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
domain_namestringCustomer side domain is required
phonenumberPhone number is required including country code.
app_typenumberFor Merchant app enter 1, for Customer app enter 2
","urlObject":{"path":["open","sendAppLinkSMS"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5295b50-9d7b-4790-935e-2cfcb344b624"}],"id":"1dbffa7c-28bc-41f5-a1fe-ea1b54b843a8","_postman_id":"1dbffa7c-28bc-41f5-a1fe-ea1b54b843a8","description":""},{"name":"Admin","item":[{"name":"Edit Order","id":"fae7fc29-66db-4bf2-b2c3-57320392727c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{apikey}},\r\n\"marketplace_user_id\" : 510001,\r\n\"payment_method\" : \"\",\r\n\"card_id\" : \"\",\r\n\"checkout_template\" : \"[]\",\r\n\"user_id\" : 510001,\r\n\"customer_phone\" : \"+18658472111\",\r\n\"customer_email\" : \"n.amrit+devfood@jungleworks.com\",\r\n\"customer_username\" : \"Home\",\r\n\"job_pickup_datetime\" : \"2021-04-28T06:22:56.984Z\",\r\n\"delivery_charge\" : 100,\r\n\"currency_id\" : 1,\r\n\"amount\" : 300,\r\n\"is_scheduled\" : 0,\r\n\"vendor_id\" : {{vendorId}},\r\n\"job_pickup_latitude\" : 30.7333148,\r\n\"job_pickup_longitude\" : 76.7794179,\r\n\"latitude\" : 30.7333148,\r\n\"longitude\" : 76.7794179,\r\n\"job_pickup_address\" : \"Chandigarh, India\",\r\n\"job_pickup_name\" : \"Home\",\r\n\"job_pickup_phone\" : \"+18658472111\",\r\n\"job_pickup_email\" : \"n.amrit+devfood@jungleworks.com\",\r\n\"prev_job_id\" : 103317,\r\n\"return_enabled\" : 0,\r\n\"vertical\" : 0,\r\n\"timezone\" : 0,\r\n\"products\" : \"[{\\\"product_id\\\":325468,\\\"quantity\\\":2,\\\"customizations\\\":[]}]\",\r\n\"home_delivery\" : 1,\r\n\"tip\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/order/edit","description":"
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
\n\n

currency id

\n
Namesymbolid
USD
EUR
JPY
GBP
AUD
CAD
CHF
CNY
SEK
MXN
NZD
SGD
HKD
NOK
KRW
INR
RUB
ZAR
KES
ZMW
AED
EGP
PEN
UGX
IQD
QAR
COP
NGN
MYR
RES
KWD
GHS
HNL
SAR
₱
MAD
OMR
BHD
PKR
BMD
DOP
THB
TWD
ZK
JOD
XOF
AWG
JMD
TRY
R$
BDT
DZD
ARS
PEN
BRL
CLP
GMD
LBP
BWP
BND
BTN
Rp
TTD
GEL
JOD
LKR
FJD
KYD
TZS
AOA
XCD
DKK
MZN
NIO
ILS
MMK
LAK
ISK
XPF
BSD
CRC
GTQ
IDR
KGS
PHP
PHP
BOB
KZT
NAD
SCR
OUV
BGN
BAM		$
‎€
¥‎
£
$
C$
Fr.
¥
kr
Mex$
NZ$
S$
HK$
kr
₩
₹
₽
R
KSh
ZK
AED
E£
S
UGX
ع.د
QAR
$
₦
RM
re
KWD
GH₵
HNL
SAR
₱
MAD
OMR
BHD
Rs
$
RD$
‎฿
NT$
ZK
JOD
XOF
Afl.
JMD $
₺
R$
৳
DZD
$
S/.
R$
$
GMD
L.L.
P
B$
Nu.
Rp
TT$
ლ
دينا
Rs
FJ$
CI$
TSh
Kz
$
DKK
MT
C$
₪
MMK
LAK
kr
F
B$
₡
Q
Rp
Лв
PHP
PHP
Bs
₸
N$
₨
OUV
Лв
KM
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
29
30
31
32
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
80
81
82
83
84
85
87
88
89
100
101
150
74
92
86
87
90
90
123
124
102
125
94
95
96
","urlObject":{"path":["open","admin","order","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"fae7fc29-66db-4bf2-b2c3-57320392727c"},{"name":"Add Address","id":"dac11854-50bf-4d48-abde-c9c71cbe908c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"api_key\" : {{apikey}},\r\n \"address\" : \"Panchkula, India\",\r\n\t\t\"email\" : \"abc@gmail.com\",\r\n\t\t\"house_no\" : \"H.No.2001\",\r\n\t\t\"landmark\" : \" \",\r\n\t\t\"latitude\" : 30.7333148,\r\n \"longitude\" : 76.7794179,\r\n\t\t\"loc_type\" : 1,\r\n\t\t\"name\" : \"Name1\",\r\n\t\t\"phone_no\" : \"9090909090\",\r\n\t\t\"postal_code\": \"123401\",\r\n\t\t\"customer_id\": 234\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/customer/address/add","description":"
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
","urlObject":{"path":["open","admin","customer","address","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"dac11854-50bf-4d48-abde-c9c71cbe908c"},{"name":"Get address","id":"27d98ae5-9b72-4ef2-8d2e-813cf479c800","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"customer_id\" : 234\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/customer/address/get","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
api_keystringYour API-key
customer_idnumberCustomer's id
","urlObject":{"path":["open","admin","customer","address","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"27d98ae5-9b72-4ef2-8d2e-813cf479c800"},{"name":"Delete Address","id":"18759ec9-2108-47ba-846b-abb4f33e3723","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"customer_id\": 235,\r\n\t\"fav_id\" : 23\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/customer/address/delete","description":"
ParameterTypeDescription
api_keystringYour API-key
customer_idnumberCustomer's id
fav_idnumberfav_id
","urlObject":{"path":["open","admin","customer","address","delete"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"18759ec9-2108-47ba-846b-abb4f33e3723"},{"name":"Edit address","id":"acdda229-d8df-4a4e-b434-abd3bc496b63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"api_key\" : {{apikey}},\r\n \"address\" : \"Panchkula, India\",\r\n\t\t\"email\" : \"abc@gmail.com\",\r\n\t\t\"house_no\" : \"H.No.2001\",\r\n\t\t\"landmark\" : \" \",\r\n\t\t\"latitude\" : 30.7333148,\r\n \"longitude\" : 76.7794179,\r\n\t\t\"loc_type\" : 1,\r\n\t\t\"name\" : \"Name1\",\r\n\t\t\"phone_no\" : \"9090909090\",\r\n\t\t\"postal_code\": \"123401\",\r\n\t\t\"customer_id\": 234,\r\n \"fav_id\" : 23\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/customer/address/edit","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterType Description
api_keystringYour API-key
address stringCustomer'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
fav_idnumberfav_id
","urlObject":{"path":["open","admin","customer","address","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"acdda229-d8df-4a4e-b434-abd3bc496b63"},{"name":"Admin Detail","id":"9a194ff6-71a4-47bb-b3f6-2c9633327dc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"marketplace_user_id\" : 54784654,\r\n \"password\" : \"test@456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/admin/detail","description":"

Add Customer

\n\n
This API will add the customer.
\n

Request Body Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
marketplace_user_idstringMarketplace user id
Passwordstringpassword
","urlObject":{"path":["open","admin","detail"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a194ff6-71a4-47bb-b3f6-2c9633327dc7"}],"id":"f1f8dc27-f10e-4d20-a995-43364777a2f3","_postman_id":"f1f8dc27-f10e-4d20-a995-43364777a2f3","description":""},{"name":"Billing","item":[{"name":"getPlans","id":"34f0a0a5-777b-4d1e-bc73-1b522b4d629b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"country_code\" : \"ind\",\r\n \"offering\" : 12\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/billing/getPlans","description":"\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
country_codestringcountry code\n
offeringnumber(optional)offering\n
","urlObject":{"path":["open","billing","getPlans"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"34f0a0a5-777b-4d1e-bc73-1b522b4d629b"},{"name":"getInvoices","id":"95818c97-f850-4642-8d53-4c446bd3fbea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"sSearch\" : \"test@email.com\",\r\n \"start\" : \"test\",\r\n \"length\" : \"1\",\r\n \"sortCol\" : \"1\",\r\n \"sortDir\" : \"1\",\r\n \"offering\" : \"1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/billing/getInvoices","description":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription\n
api_keystringYour API-key\n
sSearchstring(optional)What you want to search(email or name)\n
startstring(optional)start\n
lengthstring(optional)length\n
sortColstring(optional)If sort column equals to 1 then it will sort according to first name , default is by customer id\n
sortDirstring(optional)Default sort direction is descending. Send asc for ascending\n
offeringstring(optional)offering\n
","urlObject":{"path":["open","billing","getInvoices"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"95818c97-f850-4642-8d53-4c446bd3fbea"},{"name":"getBillBreakDown","id":"4fade9bc-8fbe-45c9-b591-0f21502fb443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"amount\": 38.7,\r\n\"checkout_template\": \"[]\",\r\n\"customer_address\": \"08 Apm Market, Doddathoguru, Electronics City Phase 1, Electronic City, Bengaluru, Karnataka 560100, India\",\r\n\"domain_name\": \"gs-trazaar.taxi-hawk.com\",\r\n\"dual_user_key\": 0,\r\n\"home_delivery\": 1,\r\n\"is_app_product_tax_enabled\": 1,\r\n\"job_pickup_datetime\": \"2022-03-30T00:08:34.310Z\",\r\n\"language\": \"en\",\r\n\"latitude\": 12.8498481,\r\n\"longitude\": 77.6544856,\r\n\"marketplace_reference_id\": \"5c55faf78b410b90e9ff51d7f6caa77e\",\r\n\"marketplace_user_id\": 10995407,\r\n\"user_id\": 10995407,\r\n\"vendor_id\": 32881,\r\n\"products\": [\r\n {\r\n \"product_id\": 410003, \r\n\"unit_price\": 12.9,\r\n\"quantity\": 3,\r\n \"total_price\": 38.7,\r\n \"customizations\": []\r\n }\r\n ]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/get_bill_breakdown","description":"
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
","urlObject":{"path":["open","get_bill_breakdown"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"4fade9bc-8fbe-45c9-b591-0f21502fb443"}],"id":"17573639-3dd6-4ffe-a993-0b03445be404","_postman_id":"17573639-3dd6-4ffe-a993-0b03445be404","description":""},{"name":"Project","item":[{"name":"get","id":"0038b4f9-a8bd-4782-a9a4-a78e619faf28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{apikey}},\r\n \"project_id\" : 1, \r\n \"vendor_id\" : 1,\r\n \"domain_name\" : \"dom\",\r\n \"dual_user_key\" : 0,\r\n \"language\" : \"en\",\r\n \"user_id\" : 510001,\r\n \"status\" : 2,\r\n \"marketplace_user_id\" : 510001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/project/get","description":"
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
","urlObject":{"path":["open","project","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"0038b4f9-a8bd-4782-a9a4-a78e619faf28"}],"id":"98f6a483-3c9d-45c1-b500-6546e11733bf","_postman_id":"98f6a483-3c9d-45c1-b500-6546e11733bf","description":""},{"name":"Discount","item":[{"name":"merchant Discount","item":[{"name":"/open/merchant/discount/get","id":"e37e775d-8fd7-4b85-8aa9-884cd900abc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"marketplace_user_id\": 1234199,\r\n\"user_id\": 1234199,\r\n\"user_type\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/discount/get","description":"
NameTypeDescription
api_keystring(required)Your API-key
marketplace_user_idnumber(required)marketplace_user_id
user_typenumber(required)User Type

user_idnumber(required)User Id
","urlObject":{"path":["open","merchant","discount","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"e37e775d-8fd7-4b85-8aa9-884cd900abc5"},{"name":"merchant/discount/edit","id":"666f3df9-248c-45a6-bd8f-cc2b6b3a1b56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"add_on_discount\": 0,\r\n\"description\": \"upto 20$ discount\",\r\n\"marketplace_user_id\": 1234199,\r\n\"start_date\": \"2022-03-23T17:48:10.000Z\",\r\n\"user_id\": 1234199,\r\n\"user_type\": 2,\r\n\"value\": 21\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/discount/edit","description":"
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
","urlObject":{"path":["open","merchant","discount","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"666f3df9-248c-45a6-bd8f-cc2b6b3a1b56"},{"name":"merchantDiscount/add","id":"20a8aaf6-17ea-4e7c-80cb-e66317341c1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\":{{api key}},\r\n\"add_on_discount\": 0,\r\n\"description\": \"gwgw\",\r\n\"end_date\": \"2022-03-24T08:32:55.000Z\",\r\n\"marketplace_user_id\": 10995407,\r\n\"name\": \"gherger\",\r\n\"start_date\": \"2022-03-21T07:33:52.083Z\",\r\n\"user_id\": 10995407,\r\n\"user_type\": 2,\r\n\"value\": 20\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/merchant/discount/add","description":"
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
","urlObject":{"path":["open","merchant","discount","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"20a8aaf6-17ea-4e7c-80cb-e66317341c1a"}],"id":"d088e51f-b511-49a1-9a1c-ebca8ee9e2f6","_postman_id":"d088e51f-b511-49a1-9a1c-ebca8ee9e2f6","description":""},{"name":"Product Discount","item":[{"name":"productDiscount/add","id":"a1b7730f-9684-40e5-90c7-4eeba8a06d3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_key\" : {{api key}},\r\n\"add_on_discount\": 0,\r\n\"description\": \"b\",\r\n\"expiry_datetime_utc\": \"2022-03-29T07:06:45.000\",\r\n\"marketplace_user_id\": 1234199,\r\n\"max_discount_amount\": \"35.00\",\r\n\"name\": \"a\",\r\n\"start_datetime_utc\": \"2022-03-28T07:06:26.696Z\",\r\n\"user_type\": 2,\r\n\"value\": 20,\r\n\"user_id\" : 1234199\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/discount/add","description":"
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
","urlObject":{"path":["open","product","discount","add"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1b7730f-9684-40e5-90c7-4eeba8a06d3b"},{"name":"product/discount/get","id":"49e938cb-0cb3-4df6-be9b-d85235c5f909","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"marketplace_user_id\": 1234199,\r\n\"user_id\": 1234199,\r\n\"user_type\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/discount/get","description":"
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
","urlObject":{"path":["open","product","discount","get"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"49e938cb-0cb3-4df6-be9b-d85235c5f909"},{"name":"product/discount/edit","id":"e3fd66dc-e3a4-42bf-81ae-e17c909227d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"add_on_discount\": 0,\r\n\"description\": \"b\",\r\n\"discount_id\": 311981,\r\n\"expiry_datetime_utc\": \"2022-03-29T07:41:53.000Z\",\r\n\"marketplace_user_id\": 1234199,\r\n\"max_discount_amount\": \"35.00\",\r\n\"name\": \"30% pro\",\r\n\"start_datetime_utc\": \"2022-03-28T07:41:38.165Z\",\r\n\"user_id\": 1234199,\r\n\"user_type\": 2,\r\n\"value\": 21\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/discount/edit","description":"
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
","urlObject":{"path":["open","product","discount","edit"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3fd66dc-e3a4-42bf-81ae-e17c909227d5"},{"name":"product/discount/delete","id":"33556eb5-108a-4dcd-89e4-d1616d4a791e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"discount_id\": 311981,\r\n\"marketplace_user_id\": 1234199,\r\n\"user_id\": 1234199,\r\n\"user_type\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/product/discount/delete","description":"
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
","urlObject":{"path":["open","product","discount","delete"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"33556eb5-108a-4dcd-89e4-d1616d4a791e"}],"id":"f1196a99-cf69-493a-aa30-edfa00247fc5","_postman_id":"f1196a99-cf69-493a-aa30-edfa00247fc5","description":""}],"id":"53e05a6a-ec91-4b2d-9363-f66a7549c36e","_postman_id":"53e05a6a-ec91-4b2d-9363-f66a7549c36e","description":""},{"name":"Store Reviews","item":[{"name":"getStoreAllReviews","id":"799f7da7-7557-4dea-8601-ef548571d156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"domain_name\": \"gs-trazaar.taxi-hawk.com\",\r\n\"dual_user_key\": 0,\r\n\"language\": \"en\",\r\n\"limit\": 0,\r\n\"marketplace_reference_id\": \"5c55faf78b410b90e9ff51d7f6caa77e\",\r\n\"page_no\": 1,\r\n\"user_id\": \"10995407\",\r\n\"vendor_id\": 32881\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/get_store_all_reviews","description":"
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
","urlObject":{"path":["open","get_store_all_reviews"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"799f7da7-7557-4dea-8601-ef548571d156"}],"id":"81786307-46b5-4a26-88e6-4a36c3273c7d","_postman_id":"81786307-46b5-4a26-88e6-4a36c3273c7d","description":""},{"name":"checkout template","item":[{"name":"template/getCheckoutTemplate","id":"c02af373-7639-4450-b504-48e202d69120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : {{api key}},\r\n\"domain_name\": \"gs-trazaar.taxi-hawk.com\",\r\n\"post_to_get\": 1,\r\n\"marketplace_user_id\": 10995407,\r\n\"user_id\": 10995407,\r\n\"type\": 0,\r\n\"dual_user_key\": 0,\r\n\"language\": \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/template/getCheckoutTemplate","description":"
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
","urlObject":{"path":["open","template","getCheckoutTemplate"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"c02af373-7639-4450-b504-48e202d69120"}],"id":"27ec746b-073e-4788-ac90-0cc8a6f0c973","_postman_id":"27ec746b-073e-4788-ac90-0cc8a6f0c973","description":""},{"name":"Payment","item":[{"name":"activePaymentMethods","id":"448628ff-62aa-4d5e-a828-ef68c4b64c8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\": {{api key}},\r\n\"domain_name\": \"gs-trazaar.taxi-hawk.com\",\r\n\"dual_user_key\": 0,\r\n\"language\": \"en\",\r\n\"marketplace_user_id\": 10995407,\r\n\"user_id\": 10995407,\r\n\"vendor_id\": 32881\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.yelo.red/open/payment/getActivePaymentMethods","description":"
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
","urlObject":{"path":["open","payment","getActivePaymentMethods"],"host":["https://api.yelo.red"],"query":[],"variable":[]}},"response":[],"_postman_id":"448628ff-62aa-4d5e-a828-ef68c4b64c8c"},{"name":"getPaymentUrl","id":"3641f220-b7a8-4bc7-8bdc-de0a3c770fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_key\" : \"{{api key}}\",\r\n\"amount\": 20.95,\r\n\"app_type\": \"WEB\",\r\n\"currency\": \"NGN\",\r\n\"domain_name\": \"https://admin-vk-betaweb.red\",\r\n\"dual_user_key\": 0,\r\n\"email\": \"sadf12@yopmail.com\",\r\n\"language\": \"en\",\r\n\"marketplace_user_id\": 1068869,\r\n\"name\": \"wsdsarsa\",\r\n\"payment_for\": 0,\r\n\"payment_method\": 1073741824,\r\n\"user_id\": \"1068879\",\r\n\"vendor_id\": 5361939\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"
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
\n\n\n

payment method

\n
NameidDescription
ENABLED
STRIPE
PAYPAL
PAYPALV2
CASH
PAY_ON_DELIVERY
VENMO
PAYFORT
PAYTM
RAZORPAY
PAYSTACK
ETISALAT
SUNCASH
GOCARDLESS
ATHMOVIL
IPAY88
PROXYPAY
CYBERSOURCE
BANKALFALAH
CULQI
NMI
FLUTTERWAVE
MPESA
ADYEN
HYPUR
PAYMARK
PAYTMV3
PIXELPAY
DOKU
PEACH
PAGUELOFACIL
NOQOODY
URWAY
GTPAY
CXPAY
VPOS
VUKA
PAYKU
REVOLUT
BAMBORA
PAYWAYONE
TELR
EWAY
PLACETOPAY
BENEFIT
CEVNN
PAYMAYA
UNIPAY
CMI
OPENPAY
CUSTOMPG
PAYMENTEZ
STRIPE_GPAY
STRIPE_APPLEPAY
BILLPLZ
SBM
NIUBIZ
QPAY
PAYFAST
FAC
PAYGATE
KANOO
ORANGEPAY
SPOTII
PAYWAY_ABA
APCOPAY
PAYTABS
RAZORPAY_STOREFRONT
REDSYS
PAYTM_UPI
BILLPLZV2
WOMPI
PAYZENV2
QUADPAY
STRIPE_STANDARD_CONNECT
INNSTAPAY
KEYPAY
HALYKBANK
WEBPAY
RAZORPAY_UPI
PAYULATAM
WALLET
AUTHORIZENET
PAYLATER
PAYMOB
VISTAMONEY
STRIPE_IDEAL
PAYNOW
VIVA
PAYHERE
MPAISA
PAYTM_LINK
CREDIMAX
SSL_COMMERZ
LIME_LIGHT
TWO_CHECKOUT
CHECKOUT
FAC3D
AZUL

HYPERPAY

MYFATOORAH

THETELLER

PAYNET


TAP


CURLEC


WIPAY


PAGARME



WHOOSH

MTN

STRIPE_WECHAT


ONEPAY


PAGOPLUX

MYBILLPAYMENT


BANKOPEN


VALITOR



BHARATPE

TRUEVO

CUSTOM_PG_START

CUSTOM_PG_STOP


PAYZEN


FIRSTDATA


SQUAREUP		: 1
: 2
: 4
: 6
: 8

: 9
: 16
: 32
: 64
: 128
: 256
: 257
: 258

: 259
: 260
: 261
: 262

: 263

: 264
: 265
: 266

: 267
: 268
: 269
: 270
: 271
: 272
: 273
: 274
: 275

: 276
: 277
: 278
: 279
: 280
: 281
: 282
: 283
: 284
: 285
: 286
: 287
: 288
: 297
: 298
: 299
: 301
: 302
: 305
: 307
: 303
: 311
: 304

: 403
: 512
: 702
: 701
: 704
: 1024
: 2048
: 3001
: 3002
: 5012
: 5020
: 5010
: 5019
: 5021

: 5025
: 5005
: 5007
: 3003
: 3013
: 5001
: 5009


: 5022
: 4096
: 7000
: 7001
: 7002

: 5006
: 8192
: 16384

: 32768
: 65536
: 131072

: 262144

: 524288
: 1048576
: 2097152
: 4194304
: 8388608
: 16777216
: 33554432

: 67108864
: 134217728

: 268435456
: 536870912
: 1073741824
: 2147483648
: 4294967296

: 8589934592
: 17179869184
: 34359738368
: 68719476736
: 137438953472
: 274877906944
: 549755813888
: 1099511627776
: 2199023255552
: 4398046511104
: 8796093022208
: 17592186044416
: 35184372088832
: 70368744177664
: 140737488355328
: 281474976710656
: 562949953421312
: 600000000000000
: 999999999999999
: 1125899906842624
: 2251799813685248
: 4503599627370496
","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"3641f220-b7a8-4bc7-8bdc-de0a3c770fd2"}],"id":"58e577dd-fed2-4d90-95dd-728a61618d49","_postman_id":"58e577dd-fed2-4d90-95dd-728a61618d49","description":""}],"event":[{"listen":"prerequest","script":{"id":"ecd3d878-1b42-4031-97ea-d05641751088","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cf42da0d-1f09-4a8a-a363-f73f7f2b2b49","type":"text/javascript","exec":[""]}}],"variable":[{"id":"2178cd6c-6702-47ef-bf1e-4cfa6cbd8761","key":"baseurl","value":"https://api.yelo.red"}]}