# Yelo ## API Docs - Acl [Create Role](https://openapiyelo.apidog.io/api-6772572.md):
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | Your marketplace user id | |
user_id | number | Your user_id | |
user_type | number | For admin enter 2, For merchant enter 3 | |
role_name | string | Enter the role name (user,merchant) | |
permissions | object | For active permission =1 ,For inactive permission =0 | |
role_description | string(optional) | role_description |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number(optional) | Your marketplace user id | |
user_id | number | Your user_id | |
user_type | number | For admin enter 2, For merchant enter 3 | |
start | number(optional) | enter the start number | |
length | number(optional) | records limit | |
created_by | number | created by which user |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | Your marketplace user id | |
user_id | number | Your user_id | |
user_type | number | For admin enter 2, For merchant enter 3 | |
role_name | string | Enter the role name | |
role_id | string | role id | |
permissions | object | For active permission=1 For inactive permission=0 | |
role_description | string(optional) | role_description |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | Your marketplace user id | |
user_id | number | Your user_id | |
user_type | number | For admin enter 2, For merchant enter 3 | |
role_id | number | enter the role_id | |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id | |
user_id | number | User Id (Admin ID) | |
user_type | number | 2 : for admin, 3 : for merchant | |
role_id | number | Role Id |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number | marketplace user id | |
reference_id | number(required) | reference id | |
transaction_id | string(required) | transaction id | |
transaction_complete | any(optional) | If complete : 1 ,If incomplete:0 | |
custom_pg_id | any(optional) | custom pg id |
Name | Type | Description | |
---|---|---|---|
user_id | numberz(required) | user_id | |
marketplace_user_id | number(required) | marketplace_user_id | |
api_key | string(required) | Your API-key | |
alternate_email | string(optional) | alternate_email | |
csv_type | number(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_level | number(optional) | csv_level [ ADD : 1, UPDATE : 2, DELETE_AND_ADD : 3] | |
selected_language | string(optional) | selected_language |
Name | Type | Description | |
---|---|---|---|
marketplace_user_id | number | marketplace user id | |
api_key | string | Your API-key | |
user_id | number | user id (Admin Id) | |
user_type | number | 2 : for admin, 3 : for merchant | |
menu_name | array | menu name | |
timings | array | timings(product availibility timing) | |
product_ids | array | product_ids |
Name | Type | Description | |
---|---|---|---|
marketplace_user_id | number | marketplace user id | |
api_key | string | Your API-key | |
user_id | number | user id | |
user_type | number | 2 : for admin, 3 : for merchant | |
menu_id | number | menu id | |
start | numbe | start | |
length | number | menu length |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
app_type | number | app_type [ 1 for Customer] 2 for MERCHANT] |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
title | string | title | |
body | string | body | |
customer_ids | array | customer_ids | |
push_type | number | push_type | |
marketplace_user_id | number | marketplace_user_id | |
job_id | number | job_id | |
job_status | number | job_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 |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
tax_id | number | tax_id | |
user_id | number | user id | |
is_merchant_level_tax | number | is merchant level tax [ INDIVIDUAL: 1, MAPPING : 2, FOR_ALL : 0 }] |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
tax_id | number | tax_id | |
tax_name | string | tax name | |
tax_type | number | 0-> percentage, 1-> fixed | |
value | number | value | |
tax_applied_on | number | 0 = marketplace, 1 = product | |
user_id | number | user id | |
is_merchant_level_tax | number | is merchant level tax { INDIVIDUAL: 1, MAPPING : 2, FOR_ALL : 0 } | |
merchant_ids | array | merchant ids |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
status | number | status | |
tax_applied_on | number | 0 = marketplace, 1 = product | |
user_id | number | user id | |
is_merchant_level_tax | number | is merchant level tax { INDIVIDUAL: 1, MAPPING : 2, FOR_ALL : 0 } |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
tax_type | number | 0-> percentage, 1-> fixed | |
tax_name | string | tax name | |
value | number | value | |
tax_applied_on | number | 0 = marketplace, 1 = product | |
user_id | number | user id | |
is_merchant_level_tax | number | is merchant level tax{ INDIVIDUAL: 1, MAPPING : 2, FOR_ALL : 0 } | |
merchant_ids | array | merchant_ids |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace user id | |
theme_enabled | number | 1 = enabled 0 = disabled |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace user id | |
template_id | number | template_id | |
html | number(optional) | html 1= if available 0 = if not | |
css | number(optional) | css 1= if available 0 = if not |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number | marketplace user id | |
theme_id | number | theme_id | |
component_ids | array | component_ids | |
page_ids | array | page_ids |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
template_id | number | template_id | |
html | string | html | |
css | string | css | |
marketplace_user_id | number | marketplace user id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
template_id | number | template_id | |
marketplace_user_id | number | marketplace user id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
theme_id | number | theme id | |
marketplace_user_id | number | marketplace user id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
module | string | module(theme) | |
json | object | json |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace user id | |
user_type | number | For admin enter 2, For merchant enter 3 | |
user_id | number | user id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace user id | |
theme_id | number | theme id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
theme_id | number | theme id | |
marketplace_user_id | number | marketplace user id | |
user_type | number | Enter 2 for admin, 3 for merchant | |
user_id | number | user id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace user id | |
theme_id | number | theme id | |
is_delete | number | is delete 1= If deleted 0 = If not deleted | |
name | string | name(theme name) |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace user id | |
theme_id | number | theme id | |
name | string | name(theme name) |
Name | Type | Description |
---|---|---|
api_key | string | Your API-key |
otp | string | otp |
string(optional) | ||
phone | string(optional) | phone |
language | string(optional) | language for e.g. "en" |
app_type | string(optional) | "IOS" or "ANDROID" or "WEB" |
app_version | string(optional) | app version |
is_demo_app | number(optional) | is demo app |
login_vendor_via_otp | number(optional) | login customer via otp 1 = if login via otp |
domain_name | string(optional) | domain name |
dual_user_key | number(optional) | dual user key |
marketplace_user_id | string(optional) | marketplace user id |
device_token | string(optional) | device token |
reference_id | string(optional) | reference id |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
string(optional) | customer's email id | ||
phone | string(optional) | customer's number | |
language | string(optional) | language selected by customer | |
app_type | string(optional) | web,IOS, android | |
app_version | string(optional) | app version | |
is_demo_app | string(optional) | is demo app | |
marketplace_user_id | string(optional) | your marketplace user id | |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
device_token | any(optional) | device_token | |
google_token | string | google_token | |
marketplace_reference_id | string(optional) | marketplace reference id | |
domain_name | string(optional) | domain name | |
app_version | string(optional) | app version | |
app_type | string(optional) | "IOS" or "ANDROID" or "web" | |
dual_user_key | number(optional) | dual user key | |
lat | string(optional) | lat | |
lng | string(optional) | lng | |
longitude | number(optional) | longitude | |
language | string(optional) | language for e.g. "en" | |
string(optional) | |||
ipConfig | object(optional) | ipConfig | |
is_demo_app | number(optional) | is demo app | |
_ _app_type | number(optional) | _ app type | |
new_payment_gateways_required | number(optional) | new payment gateways required |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
domain_name | string(optional) | domain Name | |
dual_user_key | number(optional) | Dual User Key | |
language | string(optional) | language Selected By Customer | |
marketpalce_refrence_id | string(required) | Market Place Refrence Id | |
vendor_id | number(optional) | Customer Id | |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
user_id | number(optional) | user id | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
amount | number(optional) | amount | |
vendor_id | number | vendor_id | |
add_money | number | Enter 1 to add amount to customer wallet or 0 to deduct amount from customer wallet. | |
marketplace_user_id | number(optional) | marketplace user id | |
description | string(optional) | description | |
manager_id | string(optional) | manager id |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(optional) | marketplace_user_id | |
need_balance_only | number(optional) | Need Balance Only | |
vendor_id | number(optional) | Customer Id | |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
promo_code | string | Name of promo code | |
promo_type | number | 0-public , 1-hidden, 2-auto apply | |
promo_id | number | promo code unique id | |
description | string | description of promo | |
min_order_value | number(optional) | minimum order for promo to be applicable | |
max allowed users | number(optional) | number of users to be allowed | |
max_allowed_count | number(optional) | number of promo can be applicable | |
max_discount_value | number(optional) | maximum discount users can apply | |
promo_mode | number | 0 flat 1 percentage | |
promo_value | number | value of promo | |
usage_limit_per_day | number(optional) | day wise usage (number) | |
multiple_allowed_single_user | number(optional) | 0 - one time for single customer or 1 - allow multple times for single customer | |
promo_on | number(optional) | 0-subtotal , 1-delivery, 2-product | |
single_user_max_count | number(optional) | single user count promo to be used | |
timezone | number | in minutes (utc time - current local time) | |
from_time | string | local time in TZ format | |
end_time | string | local time in TZ format | |
store_id | number(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_products | array(optional) | to be add products | |
remove_store_id | number(optional) | remove store id | |
to_be_remove_products | array(optional) | to be remove products | |
merchant_ids | array(optional) | merchant ids | |
customer_subscription_plan_ids | array(optional) | array of plan ids map the promo (optional) | |
city_data | array(optional) | optional city data | |
loyalty_points_enabled | number(optional) | loyalty points enabled | |
loyalty_earning_enabled | number(optional) | loyalty earning enabled |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
length | number(optional) | records limit | |
start | number(optional) | records from | |
currency_id | number(optional) | currency_id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
limit | number(optional) | limit | |
page_size | number(optional) | page size | |
job_id | number(optional) | job id |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
order_preparation_time | string(required) | Ordert Prepration Time | |
user_id | number(optional) | User Id | |
user_type | number(optional) | 2 : for admin, 3 : for merchant |
Name | Type | Description | |
---|---|---|---|
marketplace_user_id | string(optional) | marketplace user id | |
search_text | string | search text | |
latitude | number(optional) | latitude | |
longitude | number(optional) | longitude | |
date_time | string(optional) | date time | |
app_type | string(optional) | "IOS", "ANDROID", "WEB" | |
api_key | string | you api key | |
self_pickup | number(optional) | self pickup 0 if not 1 if yes | |
domain_name | string(optional) | domain name | |
dual_user_key | number(optional) | dual user key | |
language | string(optional) | language |
Name | Type | Description |
---|---|---|
api_key | string | your api key |
marketplace_user_id | number | marketplace user id |
search_text | string | search text |
user_id | string | user id |
vendor_id | number | customer id |
date_time | string(optional) | date time |
domain_name | string(optional) | domain name |
dual_user_key | number(optional) | dual user key |
language | string(optional) | language for eg. "en" |
Name | Type | Description | |
---|---|---|---|
marketplace_user_id | string | marketplace user id | |
search_text | string | search text | |
latitude | number(optional) | latitude | |
longitude | number(optional) | longitude | |
date_time | string(optional) | date time | |
app_type | string(optional) | "IOS", "ANDROID", "WEB" | |
api_key | string(optional) | you api key | |
self_pickup | number(optional) | self pickup 0 if not 1 if yes | |
domain_name | string(optional) | domain name | |
dual_user_key | number(optional) | dual user key | |
language | string(optional) | language |
Name | Type | Description |
---|---|---|
api_key | string | Your API-key |
fb_token | string(optional) | fb token |
marketplace_reference_id | string(optional) | marketplace reference id |
domain_name | string(optional) | domain name |
string(optional) | customer's email | |
dual_user_key | number(optional) | dual user key |
vendor_image | string(optional) | vendor image |
language | string(optional) | language for eg. "en" |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id | |
length | number(optional) | length | |
start | number(optional) | Start here | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
verification_status | number(optional) | verification_status [ 1= for verified, 2= for not verified ] | |
sSearch | string(optional) | What you want to search(email or name) | |
sortCol | number(optional) | If sort column equals to 1 then it will sort according to first name , default is by customer id | |
sortDir | string(optional) | Default sort direction is descending. Send asc for ascending | |
searchBy | object(optional) | searchBy | |
isClosed | number | isClosed |
Name | Type | Description | |
---|---|---|---|
api_key | string(requireed) | Your Api Key | |
domain_name | string(optional) | domain name | |
language | string(optional | language selected by customer | |
marketplace user id | string(required) | marketplace user id | |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
domain_name | string (optional) | Domain Name | |
post_to_get | number(optional) | Post To Get | |
business_category_id | number(optional) | Business_Category Id | |
marketplace_user_id | number(required) | Marketplace_User Id | |
dual_user_key | number(optional) | Dual User Key | |
language | string(optional) | Language Selected BY Customer | |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
job_id | number | job_id | |
product_id | number(optional) | product_id |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key | user_type | number | For admin enter 2, For merchant enter 3 |
marketplace_user_id | number | enter market place user Id |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
user_id | number | enter user id. |
user_type | number | For admin enter 2, For merchant enter 3 |
marketplace_user_id | number | enter market place user Id |
is_active | number(optional) | 1 For YES, 0 for NO |
is_blocked | number(optional) | 1 For YES, 0 for NO |
is_deleted | number(optional) | 1 For YES, 0 for NO |
is_closed | number(optional) | 1 For YES, 0 for NO |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
user_id | number | enter user id. |
user_type | number | For admin enter 2, For merchant enter 3 |
marketplace_user_id | number | enter market place user Id |
delivery_methods | number(optional) | optional |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
user_id | number | enter user id. |
user_type | number | For admin enter 2, For merchant enter 3 |
marketplace_user_id | number | enter market place user Id |
delivery_methods | number(optional) | optional |
end_date | string | Ending date |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
user_id | number | enter user id. |
user_type | number | For admin enter 2, For merchant enter 3 |
marketplace_user_id | number | enter market place user Id |
slot_id | number | Your slot id |
is_deleted | number(optional) | 1 for YES, 0 for NO |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
user_id | number | User id |
marketplace_user_id | number | Marketplace user id |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
marketplace_user_id | number | Your marketplace_user_id |
user_id | number | user id |
user_type | number | 2 for Admin, 3 for merchant |
serving_distance | number(optional) | Serving Distance |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace user id | |
string | |||
password | string | password |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id | |
user_id | number(optional) | User Id | |
catalogue_id | number(optional) | catalogue id | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
marketplace_refrence_id | string | Market Place Refrence Id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | your marketplace_user_id | |
user_id | number | user_id | |
is_enabled | number | is_enabled 1= for enable 0 = for disable | |
product_ids | array | product_ids | |
user_type | number | 2 : for admin, 3 : for merchant |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | your marketplace_user_id | |
user_id | number | user_id | |
product_id | number | product_id | |
parent_id | number | product_ids | |
user_type | number | 2 : for admin, 3 : for merchant |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id | |
user_id | number | User id | |
product_ids | arr | product ids | |
is_enabled | number | is enabled 1= for enable 2= for disable |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id | |
user_id | number(optional) | User Id | |
product_id | number(optional) | Product id | |
product_ids_array | array(optional) | product ids 9fomat - array) | |
app_type | number(optional) | App Type "web" "IOS" "android" | |
limit | number(optional) | Limit | |
offset | number(optional) | Offset |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number(optional) | marketplace_user_id | |
user_id | number(required) | user | |
start | number(optional) | Start here | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
lenth | number(optional) | Lenth | |
sSearch | string(optional) | What you want to search(email or name) | |
sortCol | number(optional) | If sort column equals to 1 then it will sort according to first name , default is by customer id | |
sortDir | string(optional) | Default sort direction is descending. Send asc for ascending | |
get_all_enable_product | number(optional) | 1= if enable 0 = if disable | |
language | string | Language |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id | |
user_id | number(optional) | User Id | |
limit | number(optional) | Limit | |
offset | number(optional) | Offsett | |
parent_category_id | number(optional) | Parent Category Id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
customize_id | number | customize_id | |
product_id | number | product_id |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
marketplace_user_id | number | Your marketplace user id |
user_id | number | Your user id |
customization | object | Enter customization parameters.For body parameters refer to the below customization table |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
marketplace_user_id | number | marketplace_user_id | |
user_id | number | user_id | |
product_id | number | product_id | |
customize_id | number | customize_id | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
marketplace_reference_id | string(optional) | marketplace_reference_id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
user_id | number | user_id | |
marketplace_user_id | number | marketplace_user_id | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
marketplace_reference_id | string(optional) | marketplace_reference_id | |
customization | object | customization |
Parameter | Type | Description |
---|---|---|
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. |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
domain_name | string(optional) | Domain Name | |
marketplace_user_id | string(optional) | Marketplace user Id | |
version | string(optional) | Web,IOS, Android | |
vendor_id | number(optional) | Customer Id | |
latitude | number(optional) | Latitude | |
longitude | number(optional) | Longitude | |
duel_user_id | number(optional) | Duel User Id | |
language | string(optional) | Language Selected By Customer | |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
marketplace_user_id | number | Your marketplace_user_id |
payment_method | number, allow("",null) | 8 for payment in cash |
card_id | number, allow("",null) | your card_id (optional) |
checkout_template | array | Checkout Template(optional) |
user_id | number | Your user_id |
customer_phone | string | Customer's phone number |
customer_email | string | Customer's email address |
customer_username | string | Customer's username |
job_pickup_datetime | string | Job date and time |
delivery_charge | number | Delivery Charges |
currency_id | number | Your currency id |
amount | number | Amount of products |
is_scheduled | number | 1 for YES, 0 for NO< |
vendor_id | number | Vendor id |
job_pickup_latitude | number | job pickup latitude |
job_pickup_longitude | number | job pickup longitude |
latitude | number | Latitude (optional) |
longitude | number | longitude (optional) |
job_pickup_address | string | Job pickup address (optional) |
job_pickup_name | string | Job pickup name (optional) |
job_pickup_phone | string | Job pickup phone (optional) |
job_pickup_email | string | Job pickup email (optional) |
prev_job_id | number | previous job id (optional) |
return_enabled | number | 1 for Yes, 0 for No (optional) |
vertical | number | vertical (optional) |
timezone | string | Your timezone (optional) |
products | array | Array Containing product_id, quantity, customizations (refer below PRODUCTS Table) |
home_delivery | number | 1 for YES, 0 for No |
tip | number | 1 for YES, 0 for No |
Name | Type | Description |
---|---|---|
product_id | number | Product Id |
quantity | number | Quantity of product |
Customizations | array(optional) | Refer below customization table |
Name | Type | Description |
---|---|---|
cust_id | number | Customization Id |
quantity | number | Quantity of product |
name | string(optional) | Name of customization |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
address | string | Customer's address |
string | Email id of customer (optional) | |
house_no | string | Customer's House number (optional) |
landmark | string | Landmark (optional) |
latitude | number | Latitude |
longitude | number | longitude |
loc_type | number | Location Type ,(valid (0,1,2)) |
name | string | Customer's name |
phone_no | string | Phone number (optional) |
postal_code | string | Postal code(optional) |
customer_id | number | Costomer's id |
Parameter | Type | Description |
---|---|---|
api_key | string | Your API-key |
customer_id | number | Customer's id |
fav_id | number | fav_id |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
amount | numberv(required) | amount | |
checkout_template | string(optional) | Checkout Template | |
customer_address | string(optional) | Customer Address | |
domain_name | string(optional) | Domain Name | |
dual_user_key | number(optional) | Dual User Key | |
home_Delivery | number(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_enabled | number(optional) | Product Tax Enable -Disable Status | |
job_pickup_datetime | string(optional) | Job Pickup Date And Time | |
language | string(optional) | Language | |
latitude | number(optional) | Latitude | |
Longtitude | number(optional) | Longtitude | |
marketplace_refrence_id | string(required) | Marketplace Refrence Id | |
product | array(required) | Product | |
user_id | number(required) | User Id | |
Vendor_id | number(required) | Customer Id |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
project_id | number | project_id | |
vendor_id | number(optional) | vendor_id | |
domain_name | string(optional) | domain_name | |
dual_user_key | number(optional) | dual user key | |
language | string(optional) | language | |
user_id | number(optional) | user_id | |
status | string(optional) | status | |
marketplace_user_id | number(optional) | marketplace user id |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
user_type | number(required) | User Type | |
user_id | number(required) | User Id | |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
user_id | number(optional) | User Id | |
name | string(optional) | Discount Name | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
value | number(optional) | Value Min(0) Value Max(100) | |
description | string(optional) | Discount Description | |
start_date | string(optional) | Discount Start date | |
end_date | string(optional) | Discount End Date | |
is_delete | number(optional) | Discount Validity | |
is_activate | number(optional) | Discount Validity | |
add_on_discount | number(optional) | Add On Discount |
Name | Type | Description | |
---|---|---|---|
api_key | string | Your API-key | |
add_on_discount | number | Add On Discount | |
description | number(optional) | Discount Description | |
end_date | string | Discount End Date | |
marketplace_user_id | number(optional) | Marketplace User Id | |
name | string(optional) | Discount Name | |
start_date | string | Discount Start Date | |
user_id | number(optional) | User Id | |
user_type | number(optional) | User Type | |
value | object(optional) | Discont Value | |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
user_id | number(required) | User Id | |
Name | string(required) | Name | |
description | number(required) | Discont Description | |
value | number(required) | Discount Value [min(0), max(100)] | |
max_discount_amount | number(optional) | Maximam Discount Amount | |
start_datetime_utc | string(required) | Discount Start Date And Time | |
expiry_datetime_utc | string(required) | Discount End Date And Time | |
add_on_discount | number(optional) | Add On Discount |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
user_id | number(required) | User Id | |
start | number(optional) | Start here | |
user_type | number(required) | 2 : for admin, 3 : for merchant | |
limit | number(optional) | Limit | |
is_expiry | number(optional) | Discont Expiry |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
user_id | number(required) | User Id | |
discount_id | number(required) | Discount Id | |
user_type | number(optional) | 2 : for admin, 3 : for merchant | |
name | string(optional) | Discount Name | |
description | string(optional) | Discount Description | |
value | number(optional) | Discount Value min(0)-max(100) | |
start_datetime_utc | string(optional) | Discount Start Date -Time | |
expiry_datetime_utc | string(optional) | Discount Expiry Date -Time | |
add_on_discount | number(optional) | Add On Discount |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
user_id | number(required) | User Id | |
Discount_id | number(required) | Discount Id | |
user_type | number(required) | 2 : for admin, 3 : for merchant |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
domain_name | string(optional) | Domain Name | |
dual_user_key | number(optional) | Dual User Key | |
language | string(optional) | Language Selected By Customer | |
limit | number(optional) | Limit | |
marketplace_refrence_id | string(required) | Marketplace Refrence Id | |
marketplace_refrence_id | string(optional) | Marketplace Refrence Id | |
page_no | number(optional) | page no | |
user_id | string(required) | User Id | |
vendor_id | number(required) | Customer Id | |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
user_id | number(optional) | User Id | |
domain_name | string(optional) | Domain Name | |
dual_user_key | number(optional) | Duel User Key | |
langauge | string(optional) | Langauge Selected By Customer | |
type | number(optional) | Type | |
post_to_get | number(optional) | Post To Get |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
domain_name | string(optional) | Domain Name | |
dual_user_key | number(optional) | Dual User Key | |
language | string(optional) | Language Selected By Customer | |
user_id | number(required) | User Id | |
vendor_id | number(required) | Customer Id | |
Name | Type | Description | |
---|---|---|---|
api_key | string(required) | Your API-key | |
marketplace_user_id | number(required) | marketplace_user_id | |
amount | number(optional) | Amount | |
app_type | number(optional) | App Type ['web' 'android' 'IOS' | |
currency | string(optional) | Currency | |
domain_name | string(optional) | Domain Name | |
dual_user_key | number(optional) | Duel User Key | |
string(optional) | Customer Email | ||
language | string(optional) | Language Selected By Customer | |
Name | object(optional) | Customer Name | |
payment_for | number(optional) | Payment For | |
payment_method | number(optional) | Payment Method | |
User_id | string(required) | Admin Id | |
vendor_id | number(required) | Customer Id |