EC Taffy API Dashboard

Taffy 3.6.0

Resources:

websitetestimonialscontent DELETE PATCH PUT POST GET /website/testimonials/content

Request Body:

Loading...

Response:

GET
This function returns testimonials content

websitetermsandconditionsterms_and_conditions DELETE PATCH PUT POST GET /website/termsandconditions/terms_and_conditions

Request Body:

Loading...

Response:

GET
This function returns the Terms and conditions

websitestaticsupport DELETE PATCH PUT POST GET /website/static/support

Request Body:

Loading...

Response:

GET

websitesocialmedialinks DELETE PATCH PUT POST GET /website/socialmedia/links

websiteresumeupload DELETE PATCH PUT POST GET /website/resume/upload

Request Body:

Loading...

Response:

performs resume upload and delete.

DELETE
required any file
POST
required any file

websiteproductsort DELETE PATCH PUT POST GET /website/products/sort

Request Body:

Loading...

Response:

Sort options for products

GET

websiteproductlist DELETE PATCH PUT POST GET /website/products/list

Request Body:

Loading...

Response:

website products list

POST
optional any super_category_id (default: "")

sample list (1,2,3)

optional any category_id (default: "")

sample list (1,2,3)

optional any colors (default: "")

sample list (white,black)

optional any pages (default: "")

sample list (12,16)

optional any no_of_copies (default: "")

sample list (2,3)

optional any sizes (default: "")

sample list (a3,a4)

optional any print_sides (default: "")

sample list (front,back)

optional any copy_colors (default: "")

sample list (white,black)

optional any params (default: "")

sample list (1,2,3)

optional any sort (default: 1)

sort options [1 - new items, 2 - price low to high, 3 - price high to low, 4 - popularity]

optional any page_number (default: 1)

for pagination

optional any limit (default: 5)

for pagination

websiteproductfilters DELETE PATCH PUT POST GET /website/products/filters

Request Body:

Loading...

Response:

website product filters

GET

websiteproductproducts DELETE PATCH PUT POST GET /website/product/products

Request Body:

Loading...

Response:

Customer contact CRUD operations

GET

websiteproductitems DELETE PATCH PUT POST GET /website/product/items

Request Body:

Loading...

Response:

get item variants by category id

GET
required numeric category_id
optional string file_spec (default: "")

websiteproductcategories DELETE PATCH PUT POST GET /website/product/categories

Request Body:

Loading...

Response:

get all categories

GET

websiteprivacypolicyprivacy_policy DELETE PATCH PUT POST GET /website/privacypolicy/privacy_policy

Request Body:

Loading...

Response:

GET
This function returns the privacy policy

websitejobscareers DELETE PATCH PUT POST GET /website/jobs/careers

Request Body:

Loading...

Response:

GET
This function returns careers dynamic data's
required string type

getCareerContentData

websitejobsjobs DELETE PATCH PUT POST GET /website/jobs

Request Body:

Loading...

Response:

Post for hiring

GET
optional numeric job_id
optional numeric category_id
optional numeric location_id
optional string job_url
POST
required numeric job_id
required string first_name
required string email
required string phone
required string experience
required string resume_link
optional string country_code
required string qualification
optional string last_name
optional string notes

websitehomeourproducts DELETE PATCH PUT POST GET /website/home/ourproducts

Request Body:

Loading...

Response:

GET

websitehomehomepage DELETE PATCH PUT POST GET /website/home/homepage

Request Body:

Loading...

Response:

GET
This function returns homepage dynamic data's
required string type

getBannerData,getBenefitsData,getProcessData,getClientData,getProductData

websitehomeapp_link DELETE PATCH PUT POST GET /website/home/app_link

websitehelpcenterquestions DELETE PATCH PUT POST GET /website/helpcenter/questions

Request Body:

Loading...

Response:

GET
This function returns help center Q & A

websitehelpcenterlinks DELETE PATCH PUT POST GET /website/helpcenter/links

websitehelpcenterhelp_section DELETE PATCH PUT POST GET /website/helpcenter/help_section

Request Body:

Loading...

Response:

outlet / virtual api

GET

websitefaqwhatsapp DELETE PATCH PUT POST GET /website/faq/whatsapp

Request Body:

Loading...

Response:

GET

websitefaqfaq DELETE PATCH PUT POST GET /website/faq

Request Body:

Loading...

Response:

get faq categories.

GET
optional numeric category_id
optional numeric question_id

websitecontactusqueries DELETE PATCH PUT POST GET /website/contactus/queries

Request Body:

Loading...

Response:

performs all customer queries.

POST
required string firstname
required string phone
optional string lastname
optional string email
optional string category_id
optional string queries
optional string notes

websitecontactuspagedata DELETE PATCH PUT POST GET /website/contactus/pagedata

Request Body:

Loading...

Response:

GET
This function returns careers dynamic data's
required string type

getContactUsContentData

websitecontactuscontact DELETE PATCH PUT POST GET /website/contactus/contact

Request Body:

Loading...

Response:

get all contact persons.

GET

websiteitems DELETE PATCH PUT POST GET /website/category/items

Request Body:

Loading...

Response:

GET
required numeric category_id

websitecategories DELETE PATCH PUT POST GET /website/categories

Request Body:

Loading...

Response:

GET
optional any limit (default: 200)

websitebuynowcontent DELETE PATCH PUT POST GET /website/buynow/content

Request Body:

Loading...

Response:

GET
This function returns buy now content

websiteabout_uscontent DELETE PATCH PUT POST GET /website/about_us/content

Request Body:

Loading...

Response:

GET
This function returns about us dynamic data's
required string type

getAboutUsData

vendorsusersvendorUsers DELETE PATCH PUT POST GET /vendors/users/vendorUsers

Request Body:

Loading...

Response:

get all vendor users by vendor_id

DELETE
required numeric vendor_id

vendor_id

required numeric vendor_user_id

vendor_user_id user to be deleted

PUT
required numeric vendor_id
required numeric vendor_user_id

vendor_user_id

optional string name
optional string email
optional string phone
optional numeric role_id

2-printer, 1-admin, 3-designer , 4-meeting

optional string img
optional string on_duty
optional string designation
optional boolean active (default: 1)

0 or 1

optional boolean isprimary (default: 0)

0 or 1

optional string password
get
optional any name
optional any email
optional any phone
optional any role_id (default: 2)

2-printer, 1-admin, 3-designer

optional any active
optional any updated_by
required any vendor_id
required any vendor_user_id

contact_id or vendor_user_id

post
required string name
required string email
required string phone
required numeric role_id
required string password
required any vendor_id
optional string img
optional string designation
optional any active (default: 1)
optional any isprimary

vendorsusersvendorUsersList DELETE PATCH PUT POST GET /vendors/users/vendorUserList

Request Body:

Loading...

Response:

update vendor jobs.

PUT
This use to assigned the job order to user
required numeric vendor_id
required numeric job_id
required numeric assigned_to

vendor_id printer

get
get all the users by vendor_id
required any vendor_id

contact_id for vendor

vendorsusersgetVendorsByBusinessTypes DELETE PATCH PUT POST GET /vendors/users/vendorsbybussinesstype

Request Body:

Loading...

Response:

get all vendors by search.

get
optional any business_type_ids

1 printer, 2 traders, 3 printer/traders

optional any isArray (default: true)

vendorsusersvendorsRole DELETE PATCH PUT POST GET /vendors/users/vendorRole

Request Body:

Loading...

Response:

Vendor roles

GET

vendorsusersgetAssignedUsersByTypeId DELETE PATCH PUT POST GET /vendors/users/getAssignedUserByTypeId

Request Body:

Loading...

Response:

get assigned user by type id

GET
required numeric type_id

7 for purchase tasks, 58 for drop task

optional any roleName (default: "")

HRAdmin

optional any user_id (default: 35,81,86)

user_id

vendorsprofileprofile DELETE PATCH PUT POST GET /vendors/profile/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

Vendor user by id.

GET
optional any isArray (default: true)
optional string vendor_id (default: "")

Vendor unique id. It could list or array.

PUT
optional any name
optional any email
optional any phone
optional any role_id
optional any img
optional any designation
optional boolean active
optional boolean isprimary (default: 0)
required any vendor_id
required any updated_by

vendorspoc DELETE PATCH PUT POST GET /vendors/poc

Request Body:

Loading...

Response:

get a bid status.

GET
required numeric vendor_id

vendor id

vendorsotpverify DELETE PATCH PUT POST GET /vendors/otp/verify

Request Body:

Loading...

Response:

OTP verification.

POST
required string otp
required string username

Either phone numer or email address

required string type

phone or email

required numeric registered (default: 1)

If 1, you should send registered phone or email. If 0, you can verify any phone or email.

vendorsotpsend DELETE PATCH PUT POST GET /vendors/otp/send

Request Body:

Loading...

Response:

OTP for phone or email.

POST
required string username

Either phone numer or email address

required string type

phone or email

required numeric registered (default: 1)

If 1, you should send registered phone or email. If 0, you can verify any phone or email.

vendorsordersupload DELETE PATCH PUT POST GET /vendors/orders/upload

Request Body:

Loading...

Response:

approved design attachments upload.

DELETE
required numeric lead_id
required string file_url
POST
required numeric vendor_id
required numeric lead_id
required numeric task_id
required any file
required numeric item_id
required string attachment_type

QC samples - qcSample, Vendors Invoice Upload - vendorInvoice, Production sample - productionSample, Referance sample - refSample

vendorsorderstypes DELETE PATCH PUT POST GET /vendors/orders/types

Request Body:

Loading...

Response:

list of job types.

GET
api for get list of job types and api does not required any inputs.

vendorsorderssaveTasks DELETE PATCH PUT POST GET /vendors/orders/taskSave

Request Body:

Loading...

Response:

get menu data.

GET
required numeric lead_id
required numeric item_id
required numeric vendor_id
required string type_id

7 purchase, 58 for delivery, 95 fro drop at , 62 post sale task

post
required numeric type_id
required numeric vendor_id
required numeric status_id
required numeric lead_id
required string design_items_id

can be more then one item_id

optional string description
optional string due
optional numeric job_Order_id

task_id or job_order_id

optional any supplier_id

item purchase purchase_vendor_id

optional string planningType
optional numeric drop_vendor_id

item drop at drop_vendor_id

optional numeric user_id

assigned to purchase_user_id

optional string created_by_role (default: vendor)

vendor, user, customer

optional string notes

add you notes

optional numeric customer_id

customer_id

vendorsordersstatus DELETE PATCH PUT POST GET /vendors/orders/status

Request Body:

Loading...

Response:

get a oreder job status.

GET

vendorsordersnotes DELETE PATCH PUT POST GET /vendors/orders/notes/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

list jobs for vendors.

GET
required string vendor_id

Job id unique id.

required string job_id

Job id unique id.

optional string item_id

item id

POST
required numeric vendor_id
required numeric task_id
required numeric lead_id
required numeric item_id
required numeric job_id
required string notes

vendorsordersapprovedProduct DELETE PATCH PUT POST GET /vendors/orders/approvedProduct

Request Body:

Loading...

Response:

get all order or by id.

get
optional any lead_id
optional any vendor_id
optional any approvedorNot (default: 1)

vendorsordersorders DELETE PATCH PUT POST GET /vendors/orders/all

Request Body:

Loading...

Response:

list jobs for vendors.

GET
optional string vendor_id (default: "")

Vendor unique id. It could list or array.

optional any status_id (default: "")

Status id of jobs 0,10,11,12,13,14,15,and 26

optional any type_id (default: "")

type of task 4, 18, 48 and 63

optional any search (default: "")

search by lead_id or task_id or bid_id

optional any from (default: "")

from date for search. date fromat should be yyyy-mm-dd

optional any to (default: "")

to date for search. date fromat should be yyyy-mm-dd

optional numeric page (default: 1)
optional numeric pageSize (default: 5)
optional numeric assigned_to
optional binary is_verified_by_system

1 for verified by system and 0 for vendor executive

vendorsordersorder DELETE PATCH PUT POST GET /vendors/orders/{lead_id}/{job_order_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

list jobs for vendors.

GET
required string vendor_id

Vendor unique id. It could list or array.

optional string job_order_id (default: "")

Vendor unique id. It could list or array.

optional any status_id (default: "")

0 - new, 1 - Finish,

PUT
required string vendor_id (default: "")

Vendor unique id. It could list or array.

required numeric job_id (default: "")

Vendor unique id. It could list or array.

optional numeric status_id

Status id of jobs 0, 10, 11, 15, 26 and 30

optional numeric lead_id
optional binary accepted

0 - new, 1 - Finish,

optional numeric rejected

0 new, 1 - rejected,

optional binary callback

0, 1 - Request Callback Job

vendorsondutyonDutyStatus DELETE PATCH PUT POST GET /vendors/onduty/onDutyStatus

Request Body:

Loading...

Response:

get all bids by vendor

PUT
required numeric vendor_id

vendor_id is required eg 35

required numeric on_duty

status o for off duty and 1 for onduty

vendorsauthlogout DELETE PATCH PUT POST GET /vendors/logout

Request Body:

Loading...

Response:

Logout for customer.

POST

vendorsauthlogin DELETE PATCH PUT POST GET /vendors/login

Request Body:

Loading...

Response:

check authentication.

get
required string username

Email address or Phone number

required string type

email | phone

required string password

password for the username

vendorscountgetOrdersCountByVendor DELETE PATCH PUT POST GET /vendors/count/orderCount

Request Body:

Loading...

Response:

get all orders by vendor

GET
required any vendor_id
optional numeric assigned_to
optional any status_ids (default: "")
optional any isArray (default: true)

vendorscountgetBiddingsCountByVendor DELETE PATCH PUT POST GET /vendors/count/bidcount

Request Body:

Loading...

Response:

get all bids by vendor

GET
required any vendor_id
optional any all_status (default: false)
optional numeric assigned_to

vendorsprofilebranches DELETE PATCH PUT POST GET /vendors/branch

Request Body:

Loading...

Response:

get all vendors list.

POST
required string vendor_name
required numeric vendor_type_id
required string latitude
required string longitude
required string google_pin
required string logo
required string address1
optional string address2
required string city
required numeric state_id
required numeric country_id
required string trn_number
required string trade_license_copy
optional any vrm_id
optional string tax
required numeric business_type_id
optional string closing_time
optional string opening_time
optional string closing_time_second
optional string opening_time_second
optional any has_designer
optional any has_meeting_person
required string shop_no
optional numeric manager_id
optional string description
optional string office_ext
optional any is_main_branch
optional string vendor_address
optional numeric created_by
optional numeric zone_id
optional numeric payment_term
optional numeric mrm_id
optional numeric drm_id
optional any on_duty
optional any created_at
optional any updated_at
optional numeric updated_by
optional any zip_code
optional any direct_order (default: 0)
optional any vendor_contact_id

vendor_user_id

get
required numeric vendor_id
required numeric branch_id

branch_id is vendor_id to be selected

put
required numeric vendor_id

vendor id required to create vendor users

required numeric branch_id

id of branch or vendor_id

optional string address1
optional string address2
optional string City
optional string google_pin
optional string vendor_phone
optional string office_ext
optional string latitude
optional string longitude
optional numeric zone_id
optional numeric state_id
optional numeric country_id
optional string zip_code
optional string description
optional string logo
optional string banner_img
optional string vat_number
optional string trade_license_copy
optional boolean has_designer
optional string opening_time
optional string closing_time
optional string opening_time_second
optional string closing_time_second
optional string on_duty
optional boolean is_main_branch (default: false)
required numeric vendor_type_id (default: 1)
required numeric business_type_id (default: 1)
optional numeric category_id
optional numeric created_by
optional string name
optional string email
optional string password
optional string phone

vendorsbillingzohoReceiptDownload DELETE PATCH PUT POST GET /vendors/billing/zohoReceiptDownload

Request Body:

Loading...

Response:

This function use to download zoho invoice

GET
This Function is to generate Invoice PDF
optional any zoho_vendorpayment_id

vendorsbillingzohoInvoiceDownload DELETE PATCH PUT POST GET /vendors/billing/zohoInvoiceDownload

Request Body:

Loading...

Response:

create Invoice from vendor.

GET
This Function is to generate Invoice PDF
optional any invoice_id

vendorsbillingzohoInvoice DELETE PATCH PUT POST GET /vendors/billing/zohoInvoice

Request Body:

Loading...

Response:

create Invoice from vendor.

GET
This function is to get the vendorjob items to create zoho Invoice
required any job_id
required any vendor_id
required any item_id
required any lead_id
required any amount

vendorsbillingverifiedAmount DELETE PATCH PUT POST GET /vendors/billing/verifiedAmount

Request Body:

Loading...

Response:

get a bid status.

GET
required numeric item_id

item_id

vendorsbillingvendorInvoice DELETE PATCH PUT POST GET /vendors/billing/vendorInvoices

Request Body:

Loading...

Response:

verified amount for order

GET
required numeric item_id
required numeric vendor_id
required numeric job_id

job_id

required numeric lead_id

lead_id

POST
required numeric vendor_id

vendor id

required numeric job_id

job_id

required numeric lead_id

lead_id

required numeric item_id

item_id

required numeric requested_amount

amount for request

required binary is_advance

o or 1 bit

required string invoice_number

invoice number

required any invoive_attachments

file_url

PUT
required numeric lead_id

lead_id

required numeric item_id

item_id

optional numeric zoho_payment_id

zoho_payment_id

required numeric status_id

payment status 1 for new, 2 for Partially Paid, 3 for paid, 4 for payment rejected

vendorsbillinguploadInvoice DELETE PATCH PUT POST GET /vendors/billing/uploadInvoice

Request Body:

Loading...

Response:

performs attachments upload.

POST
required numeric job_id
required numeric item_id
required any file
required string attachment_type

upload your designs - customerArtworkAttachment, design tool - customerDesignFileLink

vendorsbillingorders DELETE PATCH PUT POST GET /vendors/billing/orders

Request Body:

Loading...

Response:

get all order or by id.

GET
required string vendor_id (default: "")

Vendor unique id. It could list or array.

optional any status_id (default: 26)

Status id of jobs 0,10,11,12,13,14,15,and 26

optional any type_id (default: "")

type of task 4, 18, 48 and 63

optional any search (default: "")

search by lead_id or task_id or bid_id

optional any from (default: "")

from date for search. date fromat should be yyyy-mm-dd

optional any to (default: "")

to date for search. date fromat should be yyyy-mm-dd

optional numeric page (default: 1)
optional numeric pageSize (default: 15)
optional numeric assigned_to

vendorsbidsstatus DELETE PATCH PUT POST GET /vendors/bids/status

Request Body:

Loading...

Response:

get a bid status.

GET

vendorsbidsprice DELETE PATCH PUT POST GET /vendors/bids/price_approval

Request Body:

Loading...

Response:

list bids for vendors.

POST
required number amount (default: "")

amount price

optional string currency (default: AED)

Currency in by default AED

vendorsbidsnotes DELETE PATCH PUT POST GET /vendors/bids/notes/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

list jobs for vendors.

GET
required numeric vendor_id

Job id unique id.

required numeric bid_id

Job id unique id.

optional numeric task_id

task id

POST
required any vendor_id
required any task_id
required any lead_id
required any item_id
required any job_id
required any notes

vendorsbidsbids DELETE PATCH PUT POST GET /vendors/bids/all

Request Body:

Loading...

Response:

list bids for vendors.

GET
optional string vendor_id (default: "")

Vendor unique id. It could list or array.

optional any status_id (default: "")

0 - new, 1 - Finish,

optional any search (default: "")

search by lead_id or task_id or bid_id

optional any from (default: "")

from date for search. date fromat should be yyyy-mm-dd

optional any to (default: "")

to date for search. date fromat should be yyyy-mm-dd

optional numeric page (default: 1)
optional numeric pageSize (default: 5)
optional numeric assigned_to

vendorsbidsbid DELETE PATCH PUT POST GET /vendors/bids/{lead_id}/{bid_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get a bid by lead_id & bid_id.

GET
required string vendor_id (default: "")

Vendor unique id. It could list or array.

optional any status_id (default: "")

0 - new, 1 - Finish,

vendorsbidsplacebid DELETE PATCH PUT POST GET /vendors/bid/placebid

Request Body:

Loading...

Response:

get a bid status.

POST
required numeric vendor_id

vendor id

required numeric bid_item_id

bid id

required string price

price for the requested item.

required string currency

currency of price

required any delivery

date of delivery

required string notes

notes of bid.

vendorsauthresetPassword DELETE PATCH PUT POST GET /vendors/auth/resetPassword

Request Body:

Loading...

Response:

Reset password

POST
required string old_password
required string new_password
required string confirm_password
required numeric vendor_id

vendorsprofilegetAllBranches DELETE PATCH PUT POST GET /vendors/allBranches

Request Body:

Loading...

Response:

get all vendors list.

GET
required any vendor_id (default: 0)

deliveryuserslogin DELETE PATCH PUT POST GET /users/login

Request Body:

Loading...

Response:

check authentication.

get
required string username

Email address or Phone number

required string type (default: email)

email | phone

required string userrole

delivery

required string password

password for the username

portaltaskstasks DELETE PATCH PUT POST GET /tasks/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

perform all tasks related CRUD operations.

GET
This function returns all tasks or products by id.
optional any lead_item_id
POST
required any name
optional any type_id
optional any status_id
optional any created_by
optional any notified_count
optional any customer_id
optional any description
optional any user_id
optional any params
optional any item_id
optional any delivery_mod
optional any delivery_address
optional any delivery_receiver_number
optional any delivery_receiver_name
optional any priority
optional any due
optional any dueTimeSpanID
optional any customer_approval
optional any payment_receipt
optional any sales_signature
optional any planningType
optional any payReq
optional any paylink
optional any isPlanningTask
optional any isUrgentTask
optional any isProductionTask
optional any sampleApproval
optional any job_order_id
optional any supplier_id
optional any design_items_id
optional any installationRequired
optional any event_customer
optional any message
optional any lead_item_id
optional any remote_attr
optional any reminder
optional any vendor_id
optional any vendor_job_id
optional any delivery_follow_up
optional any attachments
optional any attachment_type
optional any createdby
PUT
required any name
optional any type_id
optional any status_id
optional any updated_by
optional any notified_count
optional any customer_id
optional any description
optional any user_id
optional any params
optional any item_id
optional any delivery_mod
optional any delivery_address
optional any delivery_receiver_number
optional any delivery_receiver_name
optional any priority
optional any due
optional any dueTimeSpanID
optional any customer_approval
optional any payment_receipt
optional any sales_signature
optional any planningType
optional any payReq
optional any paylink
optional any isPlanningTask
optional any isUrgentTask
optional any isProductionTask
optional any sampleApproval
optional any job_order_id
optional any supplier_id
optional any design_items_id
optional any installationRequired
optional any event_customer
optional any message
optional any lead_item_id
optional any remote_attr
optional any reminder
optional any vendor_id
optional any vendor_job_id
optional any delivery_follow_up
optional any attachments
optional any attachment_type
optional any createdby
optional any task_id
optional any tasks_notes_id
optional any tasks_attachments_id

estimationreadymadecalculator DELETE PATCH PUT POST GET /readymade/calculator/

Request Body:

Loading...

Response:

Readymade Estimation Calculator

get
optional any item_id (default: "")
optional any material_id (default: "")
optional any fromQty (default: "")
optional any toQty (default: "")
optional any params (default: "")
optional any addons (default: 1)

content_apisetMetadescription DELETE PATCH PUT POST GET /productgallery/setMetadescription

Request Body:

Loading...

Response:

update meta description and title

POST
required any item_id
optional any id
optional any metaTitle
optional any metaDescription
optional any formatted_url
optional any alt_txt
optional any type_ID
optional any focus_key
optional any cat_id
optional any search_keywords

content_apilogin_user DELETE PATCH PUT POST GET /productgallery/login/{username}/{password}

URI Tokens: (required)

Request Body:

Loading...

Response:

check authentication.

get

content_apiitemClasses DELETE PATCH PUT POST GET /productgallery/itemClasses

Request Body:

Loading...

Response:

get classes and subclasses.

get

content_apiimages DELETE PATCH PUT POST GET /productgallery/images

Request Body:

Loading...

Response:

get Images.

get
optional any type
optional numeric website_img
optional numeric type_id
optional numeric page
optional numeric limit
optional numeric google_status
optional numeric upload_status
optional any search

content_apigetSubcategory DELETE PATCH PUT POST GET /productgallery/getsubcategory

Request Body:

Loading...

Response:

get classes and subclasses.

get
required numeric parent_id

content_apigetimageurls DELETE PATCH PUT POST GET /productgallery/getImageurls

Request Body:

Loading...

Response:

get the image Urls.

get
required numeric type_id

portaluservalidate DELETE PATCH PUT POST GET /portal/user/validate/user

Request Body:

Loading...

Response:

validation for phone or email.

POST
required string phone
required string email

portaluservalidate_user DELETE PATCH PUT POST GET /portal/user/validate

Request Body:

Loading...

Response:

validation for phone or email.

POST
required string phone
optional string email

portaltasksreportAnIssueProducts DELETE PATCH PUT POST GET /portal/tasks/reportAnIssueProducts

Request Body:

Loading...

Response:

perform task creation of report an issue.

GET
This function returns all leads based products using customer_id.
required numeric lead_id

pass the lead_id

portaltasksreport_an_issue DELETE PATCH PUT POST GET /portal/tasks/report_an_issue

Request Body:

Loading...

Response:

perform task creation of report an issue.

GET
This function returns all leads based products using customer_id.
optional numeric lead_id
optional string search
optional any page (default: 1)
optional any limit (default: 5)
POST
required numeric lead_id
required string issue_type
required string reason
required string item_id

lead items ID

portaltasksquote DELETE PATCH PUT POST GET /portal/tasks/quote

Request Body:

Loading...

Response:

perform task creation of waiting for quote.

POST
This function insert the task based on the type_id eg. Waiting for Quote - type_id -> 10.
required numeric lead_id
required string description
optional string leads_items_id
optional numeric is_meeting_required (default: 0)

1 for required, 0 for not required.

portaltasksissue_type DELETE PATCH PUT POST GET /portal/tasks/issueType

Request Body:

Loading...

Response:

perform task creation of report an issue.

GET

portaltasksgo_for_bid DELETE PATCH PUT POST GET /portal/tasks/go_for_bid

Request Body:

Loading...

Response:

perform task creation of Go for bid.

POST
required numeric lead_id
required numeric item_id
required string description
optional string bidding_reason
optional string expected_delivery_date

2023-09-12 12:00:00

portaltasksrequest_for_quote DELETE PATCH PUT POST GET /portal/task/request_for_quote

Request Body:

Loading...

Response:

perform request_for_quote tasks related GET operations.

GET
This function returns all request_for_quote based products using lead_id.
required numeric lead_id

pass the lead_id

optional numeric status_id

portaltasksquotation DELETE PATCH PUT POST GET /portal/task/quotation

Request Body:

Loading...

Response:

perform design quotation tasks related CRUD operations.

GET
This function returns all quotations based products using lead_id.
required numeric lead_id

pass the lead_id

required numeric quote_id

pass the quote_id

POST
required numeric lead_id
optional numeric quote_id
required any lead_item_list
optional numeric rounding (default: 0)
optional numeric tax_included (default: 0)
optional numeric show_totals (default: 0)
optional numeric approved (default: 0)

portaltabbyemi_plans DELETE PATCH PUT POST GET /portal/tabby/emi

Request Body:

Loading...

Response:

GET
This function returns tabby emi plans content
optional numeric price

portalrefundrefund_policy DELETE PATCH PUT POST GET /portal/refund/refund_policy

Request Body:

Loading...

Response:

refund policy

GET

portalrefferal DELETE PATCH PUT POST GET /portal/referral/check

Request Body:

Loading...

Response:

Referral check by code.

GET
required string code

portalratingsratings DELETE PATCH PUT POST GET /portal/ratings

Request Body:

Loading...

Response:

perform all ratings related operations.

DELETE
required numeric item_id
GET
This function returns all ratings by lead_item_id and customer.
required numeric item_id
POST
required numeric item_id
required numeric rating
optional string review
PUT
required numeric item_id
optional numeric rating
optional string review

portalquotationnewquote DELETE PATCH PUT POST GET /portal/quotation/newquote

Request Body:

Loading...

Response:

performs quotation list operation

GET
required numeric lead_id
optional any page (default: 1)
optional any limit (default: 5)

portalquotationdownloadEquote DELETE PATCH PUT POST GET /portal/quotation/downloadEquote

Request Body:

Loading...

Response:

perform new quotation generation.

GET
This function returns quotations based products using lead_id and quote_id.
required numeric lead_id
required numeric quote_id
POST
perform quotation generation
required numeric lead_id
required string leads_items_list

123456,123457,123458

required numeric is_approved (default: 0)

1 for approved, 0 for Not approved

PUT
required numeric lead_id
required numeric quote_id
required string leads_items_list

123456,123457,123458

portalquotationapproved DELETE PATCH PUT POST GET /portal/quotation/approved

Request Body:

Loading...

Response:

performs quotation list operation

POST
required numeric lead_id
required numeric quote_id

portalquicklead DELETE PATCH PUT POST GET /portal/quicklead

Request Body:

Loading...

Response:

Create new lead.

POST
required numeric customer_id
required numeric customer_contact_id
optional array category_list_id
optional string order_range
optional numeric isonlineLead (default: 1)

Either 1(online) or 0(offline)

optional numeric email_send_enabled (default: 1)

Either 1(enabled) or 0(disabled)

optional numeric sms_send_enabled (default: 1)

Either 1(enabled) or 0(disabled)

portalpricessamplerequest DELETE PATCH PUT POST GET /portal/prices/samplerequest

Request Body:

Loading...

Response:

Getting price for sample request

GET

portalpricesdeliverycharges DELETE PATCH PUT POST GET /portal/prices/deliverycharges

Request Body:

Loading...

Response:

Get request for delivery service charges

GET

portalpaymentgatewaystabbylanguage DELETE PATCH PUT POST GET /portal/paymentgateways/tabby/language

Request Body:

Loading...

Response:

get tabby language

GET

portalpaymentgatewaystabbyduration DELETE PATCH PUT POST GET /portal/paymentgateways/tabby/duration

Request Body:

Loading...

Response:

get tabby duration

GET

portalpaymentgatewaystabbycountries DELETE PATCH PUT POST GET /portal/paymentgateways/tabby/country

Request Body:

Loading...

Response:

get tabby country

GET

portalpaymentgatewaystabbytabby DELETE PATCH PUT POST GET /portal/paymentgateways/tabby

Request Body:

Loading...

Response:

performs create session request for tabby.

POST
required string amount
required string order_id
required string currency
required string customer_name
required string customer_phone
required string customer_email
required string merchant_code
required string country_code
required string language
required string success
required string cancel
required string failure

portalpaymentgatewayspaypalpaypal DELETE PATCH PUT POST GET /portal/paymentgateways/paypal

Request Body:

Loading...

Response:

performs create payment request for paypal.

POST
required numeric lead_id
required string amount
required string currency

USD

required string agent
required string success
required string failure
required string cancel

portalpaymentgatewayspayments DELETE PATCH PUT POST GET /portal/paymentgateways/payments

Request Body:

Loading...

Response:

GET

portalpaymentgatewayspaypalexpress_checkout_details DELETE PATCH PUT POST GET /portal/paymentgateways/express_checkout_details

Request Body:

Loading...

Response:

performs express checkout payment request for paypal.

POST
required any token

portalpaymentgatewayspaypaldo_express_checkout DELETE PATCH PUT POST GET /portal/paymentgateways/do_express_checkout

Request Body:

Loading...

Response:

performs express checkout payment request for paypal.

POST
required any token
required any payer_id
required any payment_action
required string amount
required string currency

USD

portalpaymentgatewaysrakbankpayment_info DELETE PATCH PUT POST GET /portal/paymentgateway/rakbank/data

Request Body:

Loading...

Response:

create request data for rakbank.

GET
required numeric lead_id
required string amount
required string currency

AED or USD

required string agent_name
required string return_url

http://abc.com/dashboard/order-sucess

portalpaymentgatewaysrakbankrakbank DELETE PATCH PUT POST GET /portal/paymentgateway/rakbank/create_session

Request Body:

Loading...

Response:

performs create session request for rakbank.

POST
required numeric lead_id
required string amount
required string currency

AED or USD

required string agent_name
required string return_url

http://abc.com/dashboard/order-sucess

required string cancel_url

http://abc.com/dashboard/order-sucess

required string failure_url

http://abc.com/dashboard/order-sucess

required string error_url

http://abc.com/dashboard/order-sucess

optional string dump (default: false)

portalpasswordpassword DELETE PATCH PUT POST GET /portal/password

Request Body:

Loading...

Response:

Set password

POST
required string phone
required string email
required numeric customer_contact_id
required string password_hash
PUT
required string phone
required string email
required numeric customer_contact_id

portalotpverify DELETE PATCH PUT POST GET /portal/otp/verify

Request Body:

Loading...

Response:

OTP verification.

POST
required string otp
required string username

Either phone numer or email address

required string type

phone or email

required numeric registered (default: 1)

If 1, you should send registered phone or email. If 0, you can verify any phone or email.

portalotpsend DELETE PATCH PUT POST GET /portal/otp/send

Request Body:

Loading...

Response:

OTP for phone or email.

POST
required string username

Either phone numer or email address

required string type

phone or email

required numeric registered (default: 1)

If 1, you should send registered phone or email. If 0, you can verify any phone or email.

portalordersutmcall DELETE PATCH PUT POST GET /portal/orders/utmcall

Request Body:

Loading...

Response:

performs utm data create.

POST
optional numeric lead_id
optional string utm_source
optional string utm_medium
optional string utm_campaign
optional string lpurl

portalleadssampleTracking DELETE PATCH PUT POST GET /portal/orders/sampleTracking

Request Body:

Loading...

Response:

perform all leads related products operations.

GET
This function returns all leads based products using customer_id.
required numeric lead_id

pass the lead_id

portalordersrequestSample DELETE PATCH PUT POST GET /portal/orders/requestSample/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

perform all leads related products operations.

GET
This function returns all leads based products using customer_id.
required numeric lead_id

pass the lead_id

portalordersrelatedProducts DELETE PATCH PUT POST GET /portal/orders/relatedProducts

Request Body:

Loading...

Response:

perform all leads related products operations.

GET
This function returns all leads based products using items.
optional any item_id_list (default: 21,108,109)

pass the items list

portalorderspriceSummary DELETE PATCH PUT POST GET /portal/orders/priceSummary

Request Body:

Loading...

Response:

perform order status related GET operations.

GET
This function returns order status by lead_id.
required numeric lead_id
optional string leads_items_id

123456,123457

portalordersorderTracking DELETE PATCH PUT POST GET /portal/orders/orderTracking

Request Body:

Loading...

Response:

perform all leads related operations.

GET
This function returns all leads by customer.
optional numeric lead_id
optional string search
optional any page (default: 1)
optional any limit (default: 5)

portalordersorder_status_static DELETE PATCH PUT POST GET /portal/orders/orderstatus_static

Request Body:

Loading...

Response:

perform order status related GET operations.

GET

portalordersorderStatus DELETE PATCH PUT POST GET /portal/orders/orderStatus

Request Body:

Loading...

Response:

perform order status related GET operations.

GET
This function returns order status by lead_id.
required numeric lead_id
required numeric leads_items_id

portalordersorderProductsTracking DELETE PATCH PUT POST GET /portal/orders/orderProductsTracking

Request Body:

Loading...

Response:

perform all leads related products operations.

GET
This function returns all leads based products using customer_id.
required numeric lead_id

pass the lead_id

portalordersleadsActivities DELETE PATCH PUT POST GET /portal/orders/leadsActivities

Request Body:

Loading...

Response:

perform all leads_activities related operations.

GET
This function returns all leads_activities by leadid.
required numeric lead_id

portalordersorder_invoice DELETE PATCH PUT POST GET /portal/orders/invoice

Request Body:

Loading...

Response:

Get invoice for the order.

GET
This Function is to generate invoice from zoho.
required numeric lead_id

portalordershistory_old DELETE PATCH PUT POST GET /portal/orders/history_old

Request Body:

Loading...

Response:

GET
optional string search
optional any page (default: 1)
optional any limit (default: 5)

portalordershistory DELETE PATCH PUT POST GET /portal/orders/history

Request Body:

Loading...

Response:

GET
optional string search
optional numeric status_id
optional any page (default: 1)
optional any limit (default: 5)

portalorderscustomSample DELETE PATCH PUT POST GET /portal/orders/customSample/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

perform all leads related products operations.

GET
This function returns all leads based products using customer_id.
required numeric lead_id

pass the lead_id

portalordershistoryProducts DELETE PATCH PUT POST GET /portal/orders/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

perform all leads related products operations.

GET
This function returns all leads based products using customer_id.
required numeric lead_id

pass the lead_id

websitenewsletterunsubscribe DELETE PATCH PUT POST GET /portal/newsletter/unsubscribe

Request Body:

Loading...

Response:

Customer contact CRUD operations

POST

portalnewslettersubscriptions DELETE PATCH PUT POST GET /portal/newsletter/subscriptions

Request Body:

Loading...

Response:

get newsletter subscription

POST
create newsletter subscription
required string email

websitenewslettersubscribe DELETE PATCH PUT POST GET /portal/newsletter/subscribe

Request Body:

Loading...

Response:

Customer contact CRUD operations

POST

portalmenumenus_old DELETE PATCH PUT POST GET /portal/menu/menus_old

Request Body:

Loading...

Response:

GET

portalmenumenus DELETE PATCH PUT POST GET /portal/menu/menus

Request Body:

Loading...

Response:

GET

portalmembershipmemberships DELETE PATCH PUT POST GET /portal/memberships

Request Body:

Loading...

Response:

membership details.

get

portalmembershipusage DELETE PATCH PUT POST GET /portal/membership/usage/{customer_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

perform all customer Membership related CRUD operations.

PUT
required any membership
required any rule_id
required any limit_used

portalmembershiprules DELETE PATCH PUT POST GET /portal/membership/rules

Request Body:

Loading...

Response:

get customer questions.

get

portalmembershipplans DELETE PATCH PUT POST GET /portal/membership/plans

Request Body:

Loading...

Response:

GET
This function returns pricing plans content

portalmembershipcurrentMemberships DELETE PATCH PUT POST GET /portal/membership/currentMembership

Request Body:

Loading...

Response:

perform all membership operations.

GET
perform all membership operations.

portalmembershipmembership DELETE PATCH PUT POST GET /portal/membership

Request Body:

Loading...

Response:

perform all membership operations.

DELETE
required numeric lead_id
optional any code (default: SEV05)
POST
required numeric lead_id
optional any code (default: SEV05)

portalmeetingtypes DELETE PATCH PUT POST GET /portal/meeting/types

Request Body:

Loading...

Response:

outlet / virtual api

GET

portalmeetingslots DELETE PATCH PUT POST GET /portal/meeting/slots/{type_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

meeting slots api

GET
required numeric type_id

9 for Outlet,8 for Outdoor, 97 for virtual

required any meeting_date

yyyy-mm-dd

optional numeric iscrm (default: 0)
optional numeric customer_id

portalmeetingnearesthub DELETE PATCH PUT POST GET /portal/meeting/nearesthub

Request Body:

Loading...

Response:

outlet / virtual api

GET
optional numeric iscrm (default: 0)
optional numeric customer_id

portalmeetingtrack DELETE PATCH PUT POST GET /portal/meeting/meeting/track

Request Body:

Loading...

Response:

meeting api

GET
This function returns meeting tasks.
optional numeric lead_id

pass the lead_id

optional numeric search
optional any page (default: 1)
optional any limit (default: 5)
optional numeric iscrm (default: 0)
optional numeric task_id

portalmeetingmeeting DELETE PATCH PUT POST GET /portal/meeting/meeting

Request Body:

Loading...

Response:

meeting api

GET
This function returns meeting tasks.
optional numeric lead_id

pass the lead_id

optional numeric search
optional numeric status_id
optional any page (default: 1)
optional any limit (default: 5)
optional numeric iscrm (default: 0)
optional numeric task_id
POST
required numeric lead_id
required numeric type_id

9 for Outlet,8 for Outdoor, 97 for virtual

required any meeting_datetime

yyyy-mm-dd hh:nn:ss

optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
optional numeric address_id
optional numeric meeting_hub_id
optional string meeting_link
optional string item_id

need to pass all products Id's like (12345, 12346, 12347)

optional string service_code (default: SEV04)

SEV04 for Door step meeting meeting service code

optional string task_name
optional string description
optional string task_notes
optional numeric user_id
optional numeric customer_id
optional numeric created_by
optional string created_by_role
optional any price
optional any meeting_price
optional string type
optional any iscrm (default: 0)
PUT
required numeric lead_id
required numeric task_id
optional string item_id
optional numeric status_id

9 for cancel meeting

optional numeric type_id

9 for Outlet,8 for Outdoor, 97 for virtual

optional any meeting_datetime

YYYY-mm-dd hh:nn:ss

optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
optional numeric address_id

required when type_id is 8

optional numeric meeting_hub_id

required when type_id is 9

optional string meeting_link

required when type_id is 97

optional string task_name
optional string description
optional string task_notes
optional numeric user_id
optional numeric customer_id
optional numeric updated_by
optional string created_by_role
optional string iscrm (default: 0)

portalmeetinghub DELETE PATCH PUT POST GET /portal/meeting/hub

Request Body:

Loading...

Response:

outlet / virtual api

GET

portalmasterdatatasktype DELETE PATCH PUT POST GET /portal/masterdata/tasktype

Request Body:

Loading...

Response:

get all task types from masterdata

GET

portalmasterdatataskstatus DELETE PATCH PUT POST GET /portal/masterdata/taskstatus

Request Body:

Loading...

Response:

get all task status from masterdata

GET

portalmasterdatataskiconclass DELETE PATCH PUT POST GET /portal/masterdata/taskiconclass

Request Body:

Loading...

Response:

get all task icon classes from masterdata

GET

portalmasterdataleadstatus DELETE PATCH PUT POST GET /portal/masterdata/leadstatus

Request Body:

Loading...

Response:

get all lead status from masterdata

GET

portalmasterdata DELETE PATCH PUT POST GET /portal/masterdata

Request Body:

Loading...

Response:

get masterdata from utils

GET
optional string type

portalloginlogout DELETE PATCH PUT POST GET /portal/logout

Request Body:

Loading...

Response:

Logout for customer.

POST

portalloginchange_password DELETE PATCH PUT POST GET /portal/login/change_password

Request Body:

Loading...

Response:

Reset password

POST
required string old_password
required string new_password
required string confirm_password

portalloginlogin DELETE PATCH PUT POST GET /portal/login

Request Body:

Loading...

Response:

Login using password.

POST
required string username
required string password

portalleadviewtasktype DELETE PATCH PUT POST GET /portal/leadview/tasktypes

Request Body:

Loading...

Response:

get task type based on user role

GET
required string user_role
required numeric lead_id

portalleadviewsmstab DELETE PATCH PUT POST GET /portal/leadview/smstab/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get sms details by lead ID.

GET

portalleadviewleadstatus DELETE PATCH PUT POST GET /portal/leadview/leadstatus

Request Body:

Loading...

Response:

get lead status based on user role

GET
required string user_role

portalleadviewhistorytab DELETE PATCH PUT POST GET /portal/leadview/historytab/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get lead history details by lead ID.

GET

portalleadviewemailtab DELETE PATCH PUT POST GET /portal/leadview/emailtab/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get email details by lead ID.

GET

portalleadviewcustomer_lead_information DELETE PATCH PUT POST GET /portal/leadview/customer_lead_information/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get lead and customer info by lead ID.

GET

portalleadsdownloadSOA DELETE PATCH PUT POST GET /portal/leads/soa

Request Body:

Loading...

Response:

get downloaded SOA by lead_id

GET
required numeric lead_id

enter a valid lead_id

portalleadssampleTrackingHistory DELETE PATCH PUT POST GET /portal/leads/sampleTrackingHistory

Request Body:

Loading...

Response:

perform all leads related operations.

GET
This function returns all leads by customer.
optional numeric lead_id
optional string search
optional any page (default: 1)
optional any limit (default: 5)

portalleadssampleProductsTracking DELETE PATCH PUT POST GET /portal/leads/sampleProductsTracking

Request Body:

Loading...

Response:

perform all leads related products operations.

GET
This function returns all leads based products using customer_id.
required numeric lead_id

pass the lead_id

portalleadsrequestsample_bckup10-15-2024 DELETE PATCH PUT POST GET /portal/leads/requestsample_backup_10

Request Body:

Loading...

Response:

GET
This function returns sample tasks.
optional numeric lead_id
POST
This function insert the task based on the type_id eg. sampling task - type_id -> 18 , pre production sample type_id -> 48.
required numeric lead_id
optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
required any item_id
required numeric type_id

18 - reference sample, 48 - custom sample

optional string description

sampling_note is required for sampling task and pre production sample

optional numeric image_ref (default: 1)

1 for digital reference

optional numeric physical_ref (default: 0)

1 for physical reference

optional numeric delivery_type

30 - outlet, 49 - home delivery, 31 - Courier,99 - Digital

optional numeric meeting_hub_id

required when delivery_type is 30

optional numeric address_id

required when delivery_type is 49

PUT
required numeric lead_id
required numeric task_id
required numeric updated_by
optional any name
optional numeric customer_id
optional numeric type_id
optional numeric status_id
optional dateTime due
optional numeric user_id
optional string message

portalleadsrequestsample_backup DELETE PATCH PUT POST GET /portal/leads/requestsample_backup

Request Body:

Loading...

Response:

GET
This function returns sample tasks.
optional numeric lead_id
POST
This function insert the task based on the type_id eg. sampling task - type_id -> 18 , pre production sample type_id -> 48.
required numeric lead_id
optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
required any item_id
required numeric type_id

18 - reference sample, 48 - custom sample

required string description

sampling_note is required for sampling task and pre production sample

optional numeric image_ref (default: 1)

1 for digital reference

optional numeric physical_ref (default: 0)

1 for physical reference

optional numeric delivery_type

30 - outlet, 49 - home delivery

optional numeric meeting_hub_id

required when delivery_type is 30

optional numeric address_id

required when delivery_type is 49

PUT
required numeric lead_id
required numeric task_id
required numeric updated_by
optional any name
optional numeric customer_id
optional numeric type_id
optional numeric status_id
optional dateTime due
optional numeric user_id
optional string message

portalleadsrequestsample DELETE PATCH PUT POST GET /portal/leads/requestsample

Request Body:

Loading...

Response:

GET
This function returns sample tasks.
optional numeric lead_id
POST
This function insert the task based on the type_id eg. sampling task - type_id -> 18 , pre production sample type_id -> 48.
required numeric lead_id
optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
required any item_id
required numeric type_id

18 - reference sample, 48 - custom sample

optional string description

sampling_note is required for sampling task and pre production sample

optional numeric image_ref (default: 1)

1 for digital reference

optional numeric physical_ref (default: 0)

1 for physical reference

optional numeric delivery_type

30 - outlet, 49 - home delivery, 31 - Courier,99 - Digital

optional numeric meeting_hub_id

required when delivery_type is 30

optional numeric address_id

required when delivery_type is 49

PUT
required numeric lead_id
required numeric task_id
required numeric updated_by
optional any name
optional numeric customer_id
optional numeric type_id
optional numeric status_id
optional dateTime due
optional numeric user_id
optional string message

portalleadsprice_match DELETE PATCH PUT POST GET /portal/leads/pricematch

Request Body:

Loading...

Response:

performs price match operations.

POST
required numeric lead_id
required array attachment_data

[{"type":"image","url":"https://imgkit.64sec.com/upload/lead_85377/D38E6409-7A00-4701-89F0A755561A8AE8.png"}]

optional string category_id_list
optional numeric iscrm (default: 0)
optional numeric user_id

portalleadspacking_delivery_task DELETE PATCH PUT POST GET /portal/leads/packing_delivery_task

Request Body:

Loading...

Response:

perform all packing and delivery task operations.

POST
Packing and delivery creation function.
required numeric lead_id
required numeric job_order_id
required string delivery_mod

courier,collection,doorstep

required any delivery_date

2023-10-12 13:00:00

optional numeric address_id
optional numeric hub_id

portalleadssuccess DELETE PATCH PUT POST GET /portal/leads/order/success

Request Body:

Loading...

Response:

perform new quotation generation.

GET
This function returns order details of lead by lead_id.
required numeric lead_id
POST
perform quotation generation
required numeric lead_id
required string leads_items_list

123456,123457,123458

required numeric is_approved (default: 0)

1 for approved, 0 for Not approved

portalleadsleads_items_post DELETE PATCH PUT POST GET /portal/leads/leads_items_post

Request Body:

Loading...

Response:

get lead products by lead ID.

DELETE
required numeric lead_id
required numeric id
GET
required numeric lead_id
POST
required string category_id

1,2,3

optional numeric marketing_enabled (default: 1)

Either 1(enabled) or 0(disabled)

optional any lead_id (default: "")

65432

PUT
required numeric lead_id
required numeric leads_items_id
required numeric category_id
required numeric item_id
optional numeric price_history_id
optional string description
optional numeric quantity
optional string unit

portalleadsleads_items_old DELETE PATCH PUT POST GET /portal/leads/leads_items_old/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get lead products by lead ID.

DELETE
required numeric id
GET
required numeric lead_id
optional numeric item_id (default: 0)
POST
required numeric lead_id
required string category_id

1,2,3

PUT
required numeric id
required numeric lead_id
optional numeric category_id
optional numeric item_id
optional string description
optional numeric quantity
optional string unit
optional numeric price
optional array materials
optional array params
optional array addons
optional boolean tax
optional numeric cost_price
optional string cost_price_currency
optional numeric offer_percentage

portalleadsleads_items DELETE PATCH PUT POST GET /portal/leads/leads_items

Request Body:

Loading...

Response:

get lead products by lead ID.

DELETE
required numeric lead_id
required numeric id
GET
required numeric lead_id
POST
required string category_id

1,2,3

optional numeric marketing_enabled (default: 1)

Either 1(enabled) or 0(disabled)

optional any lead_id (default: "")

65432

PUT
required numeric lead_id
required numeric leads_items_id
required numeric category_id
required numeric item_id
optional numeric price_history_id
optional string description
optional any quantity
optional string unit

portalleadsjoborder DELETE PATCH PUT POST GET /portal/leads/joborder

Request Body:

Loading...

Response:

perform all tasks related CRUD operations.

GET
This function returns tasks by lead id.
required numeric lead_id

pass the lead_id

optional any type_id

pass the type_id like 18 or 48

optional numeric task_id

pass the task_id

optional numeric status_id

pass the status_id like 1 or 3

POST
Job order creation function.
required numeric lead_id
required string delivery_mod

courier,collection,doorstep

required any delivery_date

2023-10-12 13:00:00

optional numeric is_event_customer (default: 0)
optional numeric is_required_installation (default: 0)
PUT
required numeric lead_id
required numeric task_id
required numeric updated_by
optional any name
optional numeric customer_id
optional numeric type_id
optional numeric status_id
optional dateTime due
optional numeric user_id
optional string message

portalleadsitemstask DELETE PATCH PUT POST GET /portal/leads/items/task

Request Body:

Loading...

Response:

fetch tasks details by leads_items.

DELETE
required numeric lead_id
required numeric leads_items_id
required numeric type_id
GET
required numeric lead_id
required numeric leads_items_id
optional string type_id (default: 8,9,97,18,48)

portalleadsitemsduplicate DELETE PATCH PUT POST GET /portal/leads/items/duplicate

Request Body:

Loading...

Response:

performs Duplicate leads items operations.

POST
required numeric lead_id
required numeric leads_items_id

portalleadsitem DELETE PATCH PUT POST GET /portal/leads/item/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get lead item customised details by lead ID.

GET
required numeric lead_id
required numeric leads_items_id

portalleadsdelivery DELETE PATCH PUT POST GET /portal/leads/delivery

Request Body:

Loading...

Response:

perform leads delivery.

GET
This function returns order delivery details by lead id
required numeric lead_id
POST
required numeric lead_id
required string delivery_mod

collection,doorstepdelivery

required any delivery_date

2023-10-12 13:00:00

optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
optional numeric address_id
optional numeric meeting_hub_id

portalleadsaddress DELETE PATCH PUT POST GET /portal/leads/address/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get customer address by lead id.

GET
optional numeric task_id
optional numeric address_id

portalleadupload DELETE PATCH PUT POST GET /portal/lead/upload

Request Body:

Loading...

Response:

performs attachments upload.

DELETE
required numeric lead_id
required string file_url
POST
required numeric lead_id
required any file
required string attachment_type

upload your designs - customerArtworkAttachment, design tool - customerDesignFileLink

portalleadmeetingmeeting DELETE PATCH PUT POST GET /portal/lead/meeting/meeting

Request Body:

Loading...

Response:

meeting api

GET
required numeric lead_id
required numeric customer_id
required numeric task_id

portalleadmeetingall DELETE PATCH PUT POST GET /portal/lead/meeting/all

Request Body:

Loading...

Response:

meeting api

GET
required numeric lead_id
required numeric customer_id

portalleadlist DELETE PATCH PUT POST GET /portal/lead/list

Request Body:

Loading...

Response:

get lead ID by customer ID.

GET

portalleaddesigntypes DELETE PATCH PUT POST GET /portal/lead/designtypes

Request Body:

Loading...

Response:

get design task types.

GET

portalleaddesigns DELETE PATCH PUT POST GET /portal/lead/designs

Request Body:

Loading...

Response:

perform design tasks related CRUD operations.

DELETE
required numeric lead_id
required numeric task_id
required numeric task_attachment_id
GET
required numeric lead_id
optional numeric task_id
POST
required numeric lead_id
required numeric design_type

1 - upload your designs, 2 - hire a designer, 3 - design tool

required numeric design_items_id
optional string attachment_type

upload your designs - customerArtworkAttachment, design tool - customerDesignFileLink

optional array attachment_data

[{"type":"image","url":"https://imgkit.64sec.com/upload/lead_85377/D38E6409-7A00-4701-89F0A755561A8AE8.png"},{"type":"image","url":"https://imgkit.64sec.com/upload/lead_85377/D38E6409-7A00-4701-89F0A755561A8AE8.png"}]

optional string code (default: SEV06)
optional string created_by_role (default: customer)

portalleadaddress DELETE PATCH PUT POST GET /portal/lead/address

Request Body:

Loading...

Response:

get customer address by lead ID.

GET
required numeric lead_id
optional numeric task_id
POST
required string lead_id
required string address_id
required string type
optional numeric task_id

portallead DELETE PATCH PUT POST GET /portal/lead

Request Body:

Loading...

Response:

get single lead by lead ID.

GET
required numeric lead_id
POST
required string phone
optional string email
optional string customer_name
optional string source
optional string job_title
optional numeric isCompany
required numeric agent_id
PUT
required string phone
required numeric lead_id
optional string email
optional string customer_name
optional string source
optional string job_title
optional numeric isCompany
required numeric agent_id

portaljoborderreorder DELETE PATCH PUT POST GET /portal/joborder/reorder

Request Body:

Loading...

Response:

performs reorder CRUD operations.

POST
optional any lead_id
required numeric item_id

portalinvoicecheque DELETE PATCH PUT POST GET /portal/invoice/cheque

Request Body:

Loading...

Response:

performs create invoice task operations.

POST
required numeric lead_id
required string cheque_no
required string attachment_file

https://imgkit.64sec.com/assets/productimages/no_image/no_image.jpg

portalinvoiceinvoice DELETE PATCH PUT POST GET /portal/invoice

Request Body:

Loading...

Response:

performs create invoice task operations.

POST
required numeric lead_id
PUT
required numeric customise_id
required numeric lead_id
required numeric item_id
optional string delivery_mod

collection,doorstep

optional any delivery_date

2023-10-12 13:00:00

portalhomehomepage DELETE PATCH PUT POST GET /portal/home/homepage

Request Body:

Loading...

Response:

GET
This function returns homepage dynamic data's
required string type

getBannerData,getBenefitsData,getProcessData,getClientData,getProductData

portalpasswordforgetpassword DELETE PATCH PUT POST GET /portal/forgetpassword

Request Body:

Loading...

Response:

Reset password

POST
required string username

Either phone numer or email address

required string type

phone or email

required string otp
required string password

firebaseconfig DELETE PATCH PUT POST GET /portal/firebase/config

Request Body:

Loading...

Response:

get firebase config.

GET

portalenvironmenturl DELETE PATCH PUT POST GET /portal/environment/url

Request Body:

Loading...

Response:

live and staging env urls

GET

portaldeliverycustomise DELETE PATCH PUT POST GET /portal/delivery/customise

Request Body:

Loading...

Response:

performs product customise delivery CRUD operations.

GET
required numeric lead_id
POST
required numeric lead_id
required string item_id

list of item id as (12345,12346)

required any delivery_date

2023-10-12 13:00:00

required string delivery_mod

collection,doorstepdelivery

optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
optional numeric address_id
optional numeric meeting_hub_id
PUT
required numeric customise_id
required numeric lead_id
required numeric item_id
optional string delivery_mod

collection,doorstep

optional any delivery_date

2023-10-12 13:00:00

portaldashboardstatic DELETE PATCH PUT POST GET /portal/dashboard/static

Request Body:

Loading...

Response:

GET

portalcustomersdeactive_reasons DELETE PATCH PUT POST GET /portal/customers/deactive_reasons

Request Body:

Loading...

Response:

GET

portalcustomerscontacts DELETE PATCH PUT POST GET /portal/customers/contacts

Request Body:

Loading...

Response:

Customer contact CRUD operations

DELETE
required numeric contact_id
GET
optional numeric customer_id
optional any iscrm (default: 0)
POST
required string phone
required string email
required string name
optional any have_whats_app (default: 0)
optional any position
optional numeric created_by
optional string created_by_role

vendor, user, customer

optional numeric updated_by
optional string updated_by_role

vendor, user, customer

optional numeric iscrm (default: 0)
optional numeric is_default

1 - primary, 0 - not primary

PUT
required numeric contact_id
optional string phone
optional string email
optional string name
optional numeric have_whats_app (default: 0)

1 for have_whats_app, 0 for not have_whats_app

optional any position
optional numeric is_default

1 for default, 0 for not default

portalcustomeraddress DELETE PATCH PUT POST GET /portal/customers/address

Request Body:

Loading...

Response:

get customer address by customer id.

DELETE
required numeric address_id
GET
optional numeric iscrm (default: 0)
optional numeric customer_id
POST
optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
required string address
optional string flat_floor
required string city_district
required string address_label
optional string lattitude
optional string longitude
required numeric is_default

1 - primary, 0 - not primary

optional string landmark
optional string google_pin
optional numeric lead_id
optional numeric task_id
optional string type
optional string iscrm (default: 0)
PUT
required numeric address_id
required numeric contact_id
required string address
optional string landmark
required string lattitude
required string longitude
optional string flat_floor
optional string address_label
optional string google_pin
optional numeric is_default

1 - primary, 0 - not primary

optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp
optional string iscrm (default: 0)

portalmembershipcustomerMembershipUsage DELETE PATCH PUT POST GET /portal/customerMembershipUsage

Request Body:

Loading...

Response:

perform all customerMembershipUsage operations.

DELETE
required numeric membership_id
required numeric rule_id
required numeric lead_id
optional numeric task_id
POST
required numeric membership_id
required numeric rule_id
required numeric lead_id
optional numeric task_id

portalcustomerlead DELETE PATCH PUT POST GET /portal/customerlead

Request Body:

Loading...

Response:

Customer lead

GET
optional any category_list_id
optional string order_range (default: 0)
optional numeric marketing_enabled (default: 1)

Either 1(enabled) or 0(disabled)

required string title
optional string exp_delivery
optional string exp_delivery_reason
required numeric customer_id
optional any contact_id (default: "")
required string source
optional string vat (default: 0)
optional string address (default: "")
optional string country (default: "")
optional string city (default: "")
optional numeric cus_cat
optional numeric lead_type_id (default: "")
optional numeric user_id
optional numeric type_id

portalcustomerstrack_application DELETE PATCH PUT POST GET /portal/customer/track/application

Request Body:

Loading...

Response:

track the application by lead id or quote id.

POST
required any search

Either quote id or lead id or link

required any type

link or value

portalcustomersdeactive DELETE PATCH PUT POST GET /portal/customer/deactive

Request Body:

Loading...

Response:

performs customer account deactivate operations.

POST
required string reason_id

reason_id = 1 for (Somethings was broken)

optional string deactivate_reason

Comment text area its is required for reason id 6 (other) for other reason id it is optional

portalcustomersaddress DELETE PATCH PUT POST GET /portal/customer/address

Request Body:

Loading...

Response:

get customer address by customer id.

DELETE
required numeric address_id
GET
POST
optional string address
optional string flat_floor
optional string city_district
optional string address_label
optional string lattitude
optional string longitude
optional numeric is_default

1 - primary, 0 - not primary

optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
optional string landmark
optional string google_pin
optional numeric lead_id
optional numeric task_id
optional string type
optional any iscrm (default: 0)
PUT
required numeric address_id
required string address
optional string landmark
required string lattitude
required string longitude
optional string flat_floor
optional string city_district
optional string address_label
optional string google_pin
optional numeric is_default

1 - primary, 0 - not primary

optional numeric contact_id
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp
optional any iscrm (default: 0)

portalcustomer DELETE PATCH PUT POST GET /portal/customer

Request Body:

Loading...

Response:

get customer by phone or email.

GET
POST
optional string phone
optional string email
required string customer_name
required string contact_name
optional string source
optional numeric havewhatsapp
required numeric personal_or_company

If personal 0 If company 1

optional string password
optional string vat_number
optional string marketing_enabled (default: 0)
optional array category_id_list (default: [runtime expression])
optional string order_range (default: "")
optional numeric created_by
optional string created_by_role

vendor, user, customer

optional numeric updated_by
optional string updated_by_role

vendor, user, customer

optional numeric iscrm (default: 0)
optional numeric user_id
optional string referral_code
PUT
required numeric customer_id
required string contact_name
optional string company_name (default: "")
optional string email
optional string phone
optional string alternate_phone
optional string vat_no

portalmembershipcreateMembership DELETE PATCH PUT POST GET /portal/createMembership

Request Body:

Loading...

Response:

perform all membership operations.

POST
required numeric lead_id
required numeric lead_item_id
required numeric membership_id

portalcheckcustomer DELETE PATCH PUT POST GET /portal/checkcustomer

Request Body:

Loading...

Response:

get customer by phone or email.

GET
required string username

Either phone numer or email address or vat number

required string type

phone or email or vat

portalcallbackrequest DELETE PATCH PUT POST GET /portal/callback/request

Request Body:

Loading...

Response:

performs create customer callback request.

POST
required string phone
optional any lead_id
optional string name

portalbusinesstype DELETE PATCH PUT POST GET /portal/business/type

Request Body:

Loading...

Response:

get lead types.

GET

websiteblogsblogs DELETE PATCH PUT POST GET /portal/blogs/blogs

Request Body:

Loading...

Response:

performs GET operrations for website blogs.

GET
optional numeric blog_id
optional numeric category_id
optional string blog_url

websiteblogsblog DELETE PATCH PUT POST GET /portal/blogs/blog

Request Body:

Loading...

Response:

performs GET operrations for website blog.

GET
optional string blog_url

portalbankinfobankinfo DELETE PATCH PUT POST GET /portal/bankinfo

Request Body:

Loading...

Response:

company bank details

GET

portalactivity DELETE PATCH PUT POST GET /portal/activity/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get lead activities by lead ID.

GET
POST
required numeric lead_id
required string message
required numeric created_by
required string user_role

estitemsportalunmatched_param DELETE PATCH PUT POST GET /item/portal/params/unmatched

Request Body:

Loading...

Response:

get unmatched id by list of param id

GET
pass the params to get unmatched params for the validation
required any item_id

id of item

required any param_id

param_id list like (1,2,3)

estitemsportalunmatched_addon DELETE PATCH PUT POST GET /item/portal/addons/unmatched

Request Body:

Loading...

Response:

get unmatched id by list of addon id

GET
pass the addons to get unmatched addons for the validation
required any item_id

id of item

required any addon_id

addon_id list like (1,2,3)

influencerscustomers DELETE PATCH PUT POST GET /influencer/customers

Request Body:

Loading...

Response:

get all customers for influencer

GET
required string referral_code
POST
optional string address
optional any altphoneNumber
optional string city
optional string country
optional string email
optional string name
optional numeric phoneNumber
optional numeric notifyEmail
optional numeric notifySMS
optional numeric active (default: 1)
optional string vat_no
required string referral_code

estitemsitems_params DELETE PATCH PUT POST GET /estimation/items_params/{item_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

Items Params Mapping

Get
required any item_id

estitemsitem_dimensions DELETE PATCH PUT POST GET /estimation/item_dimensions/{item_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

Itemn Dimension

Get
required any item_id

estimationcalculator DELETE PATCH PUT POST GET /estimation/calculator

Request Body:

Loading...

Response:

Estimation Calculator

get
required any item_id
required any material_id
required any params_array
optional any addons_id (default: 0)
required any quantity
required any print_side
required any ItemDimension
required any hasCustomSize
optional any customLength
optional any customWidth
optional any customUnit
optional any ribbonDimensionArray
optional any currency_type (default: 1)
optional any pages (default: "")
optional any coverMaterialId
optional any dump (default: false)

estparamsunmatched_params DELETE PATCH PUT POST GET /est/unmatched_params/{param_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get params by material id

GET
required numeric param_id

estsession_history DELETE PATCH PUT POST GET /est/session_history

Request Body:

Loading...

Response:

save to lead_items table

GET
required string combinationID
POST
required numeric category
required numeric item_id
optional numeric material
optional any param
optional any addon
required string price
required numeric qty

estseoseo DELETE PATCH PUT POST GET /est/seo/products

Request Body:

Loading...

Response:

get products by focus key

GET
required string focus_key

estseoprint_landing_page DELETE PATCH PUT POST GET /est/seo/printing

Request Body:

Loading...

Response:

get seo for corborate printing

GET
optional string focus_key (default: corporate printing service)

estitemsportalstationarycalculator DELETE PATCH PUT POST GET /est/portal/stationary/calculator

Request Body:

Loading...

Response:

save lead_items to the description table

POST
required numeric item_id

id of item - 1

required numeric user_id

user id - 1

required any variants (default: [runtime expression])

{ "colours" : "", "noofpages" : "", "size" : "", "noofpcsperpack": "", "ctn": "", "warrenty": "", "model": "", "weight" : "" }

required any quantity

total quantity of item with unit requested by user. (unit = qty OR rolls OR sqm) - { "total" : 500, "unit" : "qty" }

optional any currency (default: AED)

currency

optional any role (default: customer)

role

optional boolean edit (default: false)

edit

optional any history_id (default: "")

history_id required if edit = true

optional any dump (default: false)

estparamsportalparams DELETE PATCH PUT POST GET /est/portal/params

Request Body:

Loading...

Response:

get params by material id

GET
required numeric item_id
optional numeric material_id

estitemsportalfindMaterialByVariants DELETE PATCH PUT POST GET /est/portal/materials/findMaterialByVariants

Request Body:

Loading...

Response:

get material id by list of material_id and paper_format

GET
required any material_id

material id list like (1,2,3)

required string paper_format

DIGITAL or OFFSET

estmaterialsportalmaterials DELETE PATCH PUT POST GET /est/portal/materials

Request Body:

Loading...

Response:

get materials by item id

GET
required numeric item_id
optional numeric material_id

estitemsportalmaterial_params - Copy DELETE PATCH PUT POST GET /est/portal/material/params/copy

Request Body:

Loading...

Response:

get item params by material_id

GET
required numeric item_id

item id

required any material_id

list of material ids

optional string variants (default: {})

estitemsportalmaterial_params DELETE PATCH PUT POST GET /est/portal/material/params

Request Body:

Loading...

Response:

get item params by material_id

GET
required numeric item_id

item id

required any material_id

list of material ids

optional string variants (default: {})

estitemsportalunits DELETE PATCH PUT POST GET /est/portal/items/units

Request Body:

Loading...

Response:

get get units by item id

GET
required numeric item_id

estitemsportalitems DELETE PATCH PUT POST GET /est/portal/items/{type_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get items by category id

GET
optional numeric item_id

estitemsportalitems_variants DELETE PATCH PUT POST GET /est/portal/item/variants/{type_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get item variants by category id

GET

estitemsportalitem_variants DELETE PATCH PUT POST GET /est/portal/item/variants

Request Body:

Loading...

Response:

get item variants by category id

GET
required numeric category_id
required string item_type
required any variant_type

size,orientation,noofcopies,copycolors,pages,colours,printside

estitemsportalitem_types DELETE PATCH PUT POST GET /est/portal/item/types

Request Body:

Loading...

Response:

get item variants by category id

GET
required numeric category_id
optional string file_spec (default: "")
optional string exceptItemType (default: "")

estitemsportalitem_quantity DELETE PATCH PUT POST GET /est/portal/item/quantity

Request Body:

Loading...

Response:

get quantity by item_id

GET
required numeric item_id

id of item

optional any param_id

param id list like (1,2,3)

estitemsportalitem_params_new DELETE PATCH PUT POST GET /est/portal/item/params/new

Request Body:

Loading...

Response:

get item params by item_id

GET
required numeric item_id
optional string variants (default: {})

estitemsportalitem_params DELETE PATCH PUT POST GET /est/portal/item/params

Request Body:

Loading...

Response:

get item params by item_id

GET
required numeric item_id
optional string variants (default: {})

estitemsportalitem_materials DELETE PATCH PUT POST GET /est/portal/item/materials

Request Body:

Loading...

Response:

get materials by item

GET
required numeric item_id

estitemsportalfindItemQuantityDetails DELETE PATCH PUT POST GET /est/portal/item/findItemQuantityDetails

Request Body:

Loading...

Response:

GET
required any item_id

estitemsportalfindItemIdByCategoryID DELETE PATCH PUT POST GET /est/portal/item/findItemIdByCategoryID

Request Body:

Loading...

Response:

GET
required any item_name

estitemsportalfindItemByVariantsForStationary DELETE PATCH PUT POST GET /est/portal/item/findItemByVariantsForStationary

Request Body:

Loading...

Response:

get item by variants. Find your unique item by send proper variants

GET
required numeric type_id
required string item_name
optional any variants_array (default: [])

estitemsportalfindItemByVariants DELETE PATCH PUT POST GET /est/portal/item/findItemByVariants

Request Body:

Loading...

Response:

get item by variants. Find your unique item by send proper variants

GET
required numeric type_id
optional string item_type (default: "")
optional string size (default: "")
optional string width (default: "")
optional string height (default: "")
optional string depth (default: "")

estitemsportalitem_cover_materials DELETE PATCH PUT POST GET /est/portal/item/covermaterials

Request Body:

Loading...

Response:

get covermaterials by item

GET
required numeric item_id

estitemsportalitems_addons DELETE PATCH PUT POST GET /est/portal/item/addons

Request Body:

Loading...

Response:

get addons by item_id

GET
required numeric item_id

portalcustomerstatement_of_accounts DELETE PATCH PUT POST GET /est/portal/customer/statement_of_accounts

Request Body:

Loading...

Response:

save lead_items to the description table

GET
This Function is to generate statements of account
optional any zoho_customer_id

portalchatresetNotifications DELETE PATCH PUT POST GET /est/portal/chat/notifications/reset

Request Body:

Loading...

Response:

reset notifications

DELETE
required string room_id
required string type

portalchatresetNotificationsCount DELETE PATCH PUT POST GET /est/portal/chat/notifications/count/reset

Request Body:

Loading...

Response:

reset notifications count

DELETE
required string room_id
required string type

portalchatnotifications DELETE PATCH PUT POST GET /est/portal/chat/notifications

Request Body:

Loading...

Response:

get chat notifications by user

GET

portalchatmessages DELETE PATCH PUT POST GET /est/portal/chat/messages

Request Body:

Loading...

Response:

get chat messages by room id.

GET
required numeric room_id

user_id of

required string type

leads or tasks or jobs or bids

optional string last_key (default: "")

last key value for lazy loading

optional string limit (default: 20)

limit of chats

optional string search (default: "")

search string

POST
required numeric room_id

user_id of

required string type

leads or tasks or jobs or bids or whatsapp

required struct data (default: { "isPrivate": false, "lead_id": "", "message": "", "messageByRole": "", "name": "", "original_uid": "", "receiver_id": "", "task_id": "", "uid": "" })

{ "isPrivate": false, "lead_id": "49104", "message": "Hi", "messageByRole": "admin", "name": "admin", "original_uid": "52", "receiver_id": "52", "task_id": "112028", "uid": "admin-7" }

optional boolean send_to_customer (default: false)

send to customer

portalchatchat DELETE PATCH PUT POST GET /est/portal/chat/chat

Request Body:

Loading...

Response:

get or create chat room by room id.

GET
optional string last_key (default: "")

last key value ( lead_id, task_id, job_id, bid_id ) for lazy loading

optional string limit (default: 10)

limit of chats

optional string search (default: "")

search string

POST
required string room_id

room id

required string type

leads or tasks or jobs or bids

optional numeric iscrm (default: 0)
optional numeric user_id
optional string user_role

estcategoriesportalcategory DELETE PATCH PUT POST GET /est/portal/category

Request Body:

Loading...

Response:

get category and its mapped items

GET

estitemsportalcalculator_ DELETE PATCH PUT POST GET /est/portal/calculator/old

Request Body:

Loading...

Response:

save lead_items to the description table

GET
required numeric item_id

id of item - 1

required numeric user_id

user id - 1

required any dimensions

size like A4, A5.. { 'width' : '90', 'height' : '50', 'depth' : '', 'unit' : 'mm', 'size' : '', 'has_custom_size' : '0' }

required any size

For Apparels only.[{ "name" : "S", "qty" : "10", "unit" : "pcs" }, { "name" : "L", "qty" : "5", "unit" : "pcs" }]

required any variants

{ "colors" : "", "ncr_copy" : "", "copy_colors" : [], "orientation": "", "pages" : "" }

required any material_array

array of ids of material like - ["2","67"]

required any cover_material_array

array of ids of cover material like - []

required any params_array

[ { "param_id" : "2", "has_printside" : 1, "printsides" : [{ "name" : "FRONT", "printarea" : "" }, { "name" : "BACK", "printarea" : "" }], "color" : "", "page_input" : "", "cover_page_input" : "" }, { "param_id":30, "has_printside":1, "printsides" : [{ "name" : "FRONT", "printarea" : "" }, { "name" : "BACK", "printarea" : "" }], "color":"", "page_input":"", "cover_page_input":"" }]

required any addons_array

[]

required any quantity

total quantity of item with unit requested by user. (unit = qty OR rolls OR sqm) - { "total" : 500, "unit" : "qty" }

optional any currency (default: AED)

currency

optional any role (default: customer)

role

estitemsportalcalculator DELETE PATCH PUT POST GET /est/portal/calculator

Request Body:

Loading...

Response:

save lead_items to the description table

GET
required numeric item_id

id of item - 1

required numeric user_id

user id - 1

required any dimensions

size like A4, A5.. { 'width' : '90', 'height' : '50', 'depth' : '', 'unit' : 'mm', 'size' : '', 'has_custom_size' : '0' }

required any size

For Apparels only.[{ "name" : "S", "qty" : "10", "unit" : "pcs" }, { "name" : "L", "qty" : "5", "unit" : "pcs" }]

required any variants (default: [runtime expression])

{ "colors" : "", "ncr_copy" : "", "copy_colors" : [], "orientation": "", "pages" : "" }

required any material_array

array of ids of material like - ["2","67"]

required any cover_material_array

array of ids of cover material like - []

required any params_array

[ {"param_id":[1],"printsides":[],"has_printside":1,"page_input":"","cover_page_input":"","color":""},{"param_id":[4],"printsides":[],"has_printside":0,"page_input":"","cover_page_input":"","color":""},{"param_id":[5],"printsides":[],"has_printside":1,"page_input":"","cover_page_input":"","color":""},{"param_id":[24],"printsides":[],"has_printside":1,"page_input":"","cover_page_input":"","color":""},{"param_id":[7],"printsides":[],"has_printside":0,"page_input":"","cover_page_input":"","color":""},{"param_id":[14],"printsides":[],"has_printside":0,"page_input":"","cover_page_input":"","color":""}]

required any addons_array

[]

required any quantity

total quantity of item with unit requested by user. (unit = qty OR rolls OR sqm) - { "total" : 500, "unit" : "qty" }

optional any currency (default: AED)

currency

optional any role (default: customer)

role

optional boolean edit (default: false)

edit

optional any history_id (default: "")

history_id required if edit = true

optional any dump (default: false)
POST
required numeric item_id

id of item - 1

required numeric user_id

user id - 1

required any dimensions

size like A4, A5.. { 'width' : '90', 'height' : '50', 'depth' : '', 'unit' : 'mm', 'size' : '', 'has_custom_size' : '0' }

required any size

For Apparels only.[{ "name" : "S", "qty" : "10", "unit" : "pcs" }, { "name" : "L", "qty" : "5", "unit" : "pcs" }]

required any variants (default: [runtime expression])

{ "colors" : "", "ncr_copy" : "", "copy_colors" : [], "orientation": "", "pages" : "" }

required any material_array

array of ids of material like - ["2","67"]

required any cover_material_array

array of ids of cover material like - []

required any params_array

[ { "param_id" : [20] , "has_printside" : 0 , "printsides" : [] , "page_input" : "" , "cover_page_input" : "" }, { "param_id" : [29] , "has_printside" : 0 , "printsides" : [] , "page_input" : "" , "cover_page_input" : "" }, { "param_id" : [2] , "has_printside" : 1 , "printsides" : [ { "name" : "front" , "printarea" : "" , "color" : "" }, { "name" : "back" , "printarea" : "" , "color" : "" }], "page_input" : "" , "cover_page_input" : "" }]

required any addons_array

[]

required any quantity

total quantity of item with unit requested by user. (unit = qty OR rolls OR sqm) - { "total" : 500, "unit" : "qty" }

optional any currency (default: AED)

currency

optional any role (default: customer)

role

optional boolean edit (default: false)

edit

optional any history_id (default: "")

history_id required if edit = true

optional any is_modified (default: true)

should be false when no changes where made while editing the api to show custom price.

optional any dump (default: false)

estaddonsportaladdons DELETE PATCH PUT POST GET /est/portal/addons

Request Body:

Loading...

Response:

get addons by item id

GET
required numeric item_id
optional numeric addon_id

estparamsparams_quantity DELETE PATCH PUT POST GET /est/params_quantity

Request Body:

Loading...

Response:

get params by material id

GET
required numeric item_id

estparamsparams DELETE PATCH PUT POST GET /est/params

Request Body:

Loading...

Response:

get params by material id

GET
required numeric item_id
required string material_id
optional numeric group_id

estparamsparam_quantity DELETE PATCH PUT POST GET /est/param_quantity

Request Body:

Loading...

Response:

get params by material id

GET
required any params
required numeric item_id

estmaterialsmaterial_by_variants DELETE PATCH PUT POST GET /est/materials/byVariants

Request Body:

Loading...

Response:

get materials by variants

GET
required string materal_name
optional string material_thickness
optional numeric currency_id (default: 1)

estmaterialscover_materials DELETE PATCH PUT POST GET /est/materials/{item_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get cover material by item id

GET
required numeric item_id

estmaterialsmaterials DELETE PATCH PUT POST GET /est/materials

Request Body:

Loading...

Response:

get materials by item id

GET
required numeric item_id
optional numeric material_id

estlead_items DELETE PATCH PUT POST GET /est/lead_items/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

save to lead_items table

POST
required numeric lead_id
required numeric type_id
required numeric item_id
required string description
required string Qty
required string price
required any materials
required any params
required any addons

estitemsportalvariants DELETE PATCH PUT POST GET /est/items/portal/variants

Request Body:

Loading...

Response:

get item variants by category id

GET
required numeric item_id

estitemsall DELETE PATCH PUT POST GET /est/items/all

Request Body:

Loading...

Response:

get all items

GET

estitemsitems DELETE PATCH PUT POST GET /est/items/{type_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get items by category id

GET
optional numeric item_id

estitemsitem_variants DELETE PATCH PUT POST GET /est/item_variants/{item_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get variants by item id

GET
required numeric item_id

estcategoriescategorylist DELETE PATCH PUT POST GET /est/categorylist

Request Body:

Loading...

Response:

get category and its mapped items

GET

estcategoriesall DELETE PATCH PUT POST GET /est/categories/all

Request Body:

Loading...

Response:

get all categories

GET
optional any iscrm (default: 0)
optional any lead_type_id (default: 1)

estcategoriescategory DELETE PATCH PUT POST GET /est/categories

Request Body:

Loading...

Response:

get category and its mapped items

GET
required numeric category_id

estaddonsaddons DELETE PATCH PUT POST GET /est/addons

Request Body:

Loading...

Response:

get addons by item id

GET
required numeric item_id
optional numeric addon_id

crmtasksrequestsample DELETE PATCH PUT POST GET /crm/tasks/requestsample

Request Body:

Loading...

Response:

GET
This function returns sample tasks.
optional numeric lead_id
optional numeric iscrm (default: 0)
optional numeric customer_id
optional numeric task_id
POST
This function insert the task based on the type_id eg. sampling task - type_id -> 18 , pre production sample type_id -> 48.
required numeric lead_id
optional string contact_id (default: "")
optional string contact_name
optional string contact_phone
optional string contact_email
optional numeric have_whatsapp (default: 0)
required any item_id
required numeric type_id

18 - reference sample, 48 - custom sample

optional string description

sampling_note is required for sampling task and pre production sample

optional numeric image_ref (default: 1)

1 for digital reference

optional numeric physical_ref (default: 0)

1 for physical reference

optional numeric delivery_type

30 - outlet, 49 - home delivery, 31 - Courier,99 - Digital

optional numeric meeting_hub_id

required when delivery_type is 30

optional numeric address_id

required when delivery_type is 49

optional numeric sampling_charge
optional numeric user_id
optional string user_type
required numeric sessionUserID
optional numeric iscrm (default: 0)
PUT
required numeric lead_id
required numeric task_id
required numeric updated_by
optional any name
optional numeric customer_id
optional numeric type_id
optional numeric status_id
optional dateTime due
optional numeric user_id
optional string message

crmtasksmessage DELETE PATCH PUT POST GET /crm/tasks/message

Request Body:

Loading...

Response:

perform design tasks related CRUD operations.

GET
required numeric task_id

crmtasksdesign DELETE PATCH PUT POST GET /crm/tasks/design

Request Body:

Loading...

Response:

perform design tasks related CRUD operations.

GET
required numeric task_id
POST
required numeric lead_id
required numeric customer_id
required numeric type_id
required numeric user_id
required string name
required numeric design_type
required string design_items_id
required string due
optional string tasks_description
optional string tasks_notes
optional string userrole
optional numeric created_by
optional numeric status_id
optional numeric call_to_customer
optional numeric email_to_customer
optional numeric get_approve
optional string attachment_data
optional string attachment_type
optional numeric dueTimeSpanID
optional numeric price
optional any delivery_due_time
optional any delivery_due_date
optional string iscrm (default: 0)

crmleadsnon_est_leads_items DELETE PATCH PUT POST GET /crm/leads/non_est_lead_items/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get lead products by lead ID.

POST
required numeric lead_id
required numeric type_id
required numeric item_id
required numeric quantity
required any unit
required any description
required any vat
optional any price
required any edit
required any delivery_charges
optional any business_key

crmleadsleads_items DELETE PATCH PUT POST GET /crm/leads/leads_items/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get lead products by lead ID.

POST
required numeric lead_id
required numeric category_id
required numeric price_history_id
required any custom_price
optional boolean edit (default: false)
optional any leads_items_id (default: "")
optional any textareadescription (default: "")
optional string delivery_charges
optional any business_key

crmleadslead_items_services DELETE PATCH PUT POST GET /crm/leads/lead_items_services/{lead_id}

URI Tokens: (required)

Request Body:

Loading...

Response:

save service related products to leads_items

POST
required numeric lead_id
required numeric item_id
required numeric type_id
required any description
required any price

influencersverification DELETE PATCH PUT POST GET /auth/verification

Request Body:

Loading...

Response:

get all customers for influencer

GET
required string email
optional string password
optional string is_active (default: 1)
POST
required string email
required string password

Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.
Resources are listed in matching order. From top to bottom, the first URI to match the request is used.