API Dashboard

Taffy 3.1.0

Resources:

whitelabel DELETE PATCH PUT POST GET /whitelabel

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get profile details;

Query Params:
i) client_id - Type:Numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
User Details;
PUT
Functionality:Get white details;

whiteLabelSettings DELETE PATCH PUT POST GET /whiteLabelSettings

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch the Client App Url, White Label App And saved NFC Web URLs per client Id.
client_id is required
DELETE
Delete NFC Web URLs for Client.
client_id is required.
url_id(The Id of the stored url) is required.
PUT
update the Client App Url.
client_id is required.
Below fields are optional
client_app_url
nfc_web_url
white_label_app

states DELETE PATCH PUT POST GET /states

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get a list of states.

Query Params: NA;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Array of states.

showDashboard DELETE PATCH PUT POST GET /showDashboard

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetching Scanacarta Dashboard Data.
use companyName to search for specific ones.
PATCH
Maintaining app_validation_allowed.
client_id is required.
app_validation : Y or N.

search DELETE PATCH PUT POST GET /search

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Search

Query Params:
i) client_id - Type:numeric ; Required
ii) search_for - Type:string ; Required (Value: Label)
iii) search_value - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Search

rewardsrewardOrders DELETE PATCH PUT POST GET /rewards/rewardOrders

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Reward Orders.

Query Params:
i) customer_id - Type:string ; Required
ii)order_status - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Category's Products.
optional string order_status (default: All)

rewardsrewardOrderDetail DELETE PATCH PUT POST GET /rewards/rewardOrderDetail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Reward Orders Details.

Query Params:
i) order_id - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Category's Products.

rewardsproductUpdate DELETE PATCH PUT POST GET /rewards/productUpdate

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality:Get Reward Orders Details.

Query Params:
i) Product_id - Type:numeric ; Required
ii) stock_quantity - Type:numeric ; Required
iii) product_status - Type:string ; Required
iv) product_reward_points - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Category's Products.

rewardscustomerRewards DELETE PATCH PUT POST GET /rewards/customerRewards

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Customer's Rewards.

Query Params:
i) customer_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Customer's Rewards.

rewardsclientOrders DELETE PATCH PUT POST GET /rewards/clientorders

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Client Orders.

Query Params:
i) client_id - Type:string ; Required
ii)order_status - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
optional string order_status (default: All)

rewardsclientRewards DELETE PATCH PUT POST GET /rewards/clientRewards

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Get Code validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) reward_points - Type:numeric ; Required
iii) reward_points_type - Type:string ; Required; Reward Points Type should be either 'credit' or 'debit'

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Success And Failed Message

rewardsclientProducts DELETE PATCH PUT POST GET /rewards/clientProducts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Code validation.

Query Params:
i) client_id - Type:string ;
ii)product_id - Type:numeric ;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Success And Failed Message
optional numeric product_id (default: 0)
optional string client_id (default: 0)

rewardschangeOrderStatus DELETE PATCH PUT POST GET /rewards/changeOrderStatus

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality:Get Code validation.

Query Params:
i) client_id - Type:string Required;
ii)status - Type:string Required;
ii)order_id - Type:string Required;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Success And Failed Message
optional numeric client_id
optional numeric order_id
optional string status

rewardscategoryProducts DELETE PATCH PUT POST GET /rewards/categoryProducts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Category's Products.

Query Params:
i) category_id - Type:string ; Required
ii) client_id - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Category's Products.

rewardsclientCategories DELETE PATCH PUT POST GET /rewards/categories

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Categories.

Query Params:
i) client_id - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Client's Categories.

rewardscancelOrder DELETE PATCH PUT POST GET /rewards/cancelOrder

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Get Code validation.

Query Params:
i) order_id - Type:numeric ;
i) reason - Type:string ;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Success And Failed Message
optional numeric order_id (default: "")
optional string reason (default: "")

rewardsaddOrderNotes DELETE PATCH PUT POST GET /rewards/addOrderNotes

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality:Get Code validation.

Query Params:
i) client_id - Type:string ;
ii) customer_id - Type:string ;
iii)Notes - Type:string Required;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Success And Failed Message
optional string customer_id (default: "")
optional string client_id (default: "")
optional string order_id
optional string notes

resetPassword DELETE PATCH PUT POST GET /resetPassword

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Reset Password;

Query Params:
i) reset_id Type:String ; Required
ii) new_password Type:String ; Required
iii) verify_password Type:String ; Required

Accept: NA;

Headers:
Return:
NA;

report DELETE PATCH PUT POST GET /report

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get excel file download link

Query Params:
i) client_id - Type:numeric ; Required
ii) start_date - Type:date ; Required
iii) end_date - Type:numeric ; Required
iv) lab_result - Type:numeric ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Labels

profile DELETE PATCH PUT POST GET /profile

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get profile details;

Query Params:
i) client_id - Type:Numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
User Details;
PUT
Functionality:Update profile;

Query Params:
i) client_id - Type:Numeric ; Required
ii) email - Type:String ; Optional
iii) phone - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
NA;
PATCH
Functionality:Update Password;

Query Params:
i) client_id Type:Numeric ; Required
ii) current_password Type:String ; Required
iii) new_password Type:String ; Required
iv) verify_password Type:String ; Required

Accept: NA;

Headers:
i) Authorization: - Type: VARCHAR;
Return:
NA;

product DELETE PATCH PUT POST GET /product/type

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the email recipients list.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

orderDetails DELETE PATCH PUT POST GET /order/details

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the email recipients list.

Query Params:
i) tracking_id - Type:numeric ; Required
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list
POST
Functionality:Add file and comments to order status

Query Params:
i) client_id - Type:numeric ; Required
ii) tracking_id - Type:numeric ; Required
iii) user_id - Type:numeric ; Required
iv) comments - Type:string ;
v) file - Type:string ;
vi) type - Type:string ; Value = Revise or Approve

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

order DELETE PATCH PUT POST GET /order

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the email recipients list.

Query Params:
i) client_id - Type:numeric ; Required
ii) paginate - Type:boolean ; Optional (DEFAULT - true)
iii) offset - Type:numeric ; Conditional (If paginate is true the offset is required param)
iv) showAll - Type:boolean; default: false

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list
POST
Functionality:Get the email recipients list.

Query Params:
i) client_id - Type:numeric ; Required
ii) user_id - Type:numeric ; required
iii) product_type - Type:string ; required (Labels, NFC, Website, Social Media content, Promo)
iv) quantity - Type:numeric ; required
iv) comments - Type:string ; required
v) order_type - Type:string ; optional (New Order, Reorder)
vi) tracking_id - Type:integer ;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

worldLabelValLocation DELETE PATCH PUT POST GET /maps/worldLabelValLocation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get world label validation location.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Label validation locations

topUSStates DELETE PATCH PUT POST GET /maps/topUSStates

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get top US states

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Top US states

topCountries DELETE PATCH PUT POST GET /maps/topCountries

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get top countries

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Top countries

topCities DELETE PATCH PUT POST GET /maps/topCities

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get top cities

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Top cities

regionDetail DELETE PATCH PUT POST GET /maps/regionDetail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get region label validation location detail.

Query Params:
i) client_id - Type:numeric ; Required
ii) region_code - Type:string ; Required
iii) start_date - Type:date ; Optional
iv) end_date - Type:date ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Region detail label validation locations

nfcTagList DELETE PATCH PUT POST GET /maps/nfcTagList

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get label validation location.

Query Params:
i) client_id - Type:numeric ; Required
ii) filter - Type:string ;
iii) start_date - Type:date ;
iv) end_date - Type:date;

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Label validation locations

nfcGraph DELETE PATCH PUT POST GET /maps/nfcGraphdays

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get label validation location.

Query Params:
i) client_id - Type:numeric ; Required
ii) type - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Label validation locations

labelValidationLocation DELETE PATCH PUT POST GET /maps/labelValidationLocation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get label validation location.

Query Params:
i) client_id - Type:numeric ; Required
ii) start_date - Type:date ; Optional
iii) end_date - Type:date ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Label validation locations

label DELETE PATCH PUT POST GET /label

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get labels

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Labels

inventoryListing DELETE PATCH PUT POST GET /inventoryListing

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetches inventory items with pagination.

getAnUpdate DELETE PATCH PUT POST GET /getAnUpdate

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Get labels

Query Params:
i) client_id - Type:numeric ; Required
ii) email_addr - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Labels

forgotPassword DELETE PATCH PUT POST GET /forgotPassword

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Forgot password

Query Params:
i) email - Type:String ; Required

Accept: NA;

Headers:
i) app_name - Type: String;
Return:
NA

fetchAllClientUrl DELETE PATCH PUT POST GET /fetchAllClientUrl

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch the client url.
client_id is required
PUT
update client and client_app url.
client_id is required.
client_url: add here.
app_client_url: add here.

emailPreview DELETE PATCH PUT POST GET /email/preview

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the email preview.

Query Params:
i) client_id - Type:numeric ; Required
ii) content - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

demoApi DELETE PATCH PUT POST GET /demo

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get

socialMediaClick DELETE PATCH PUT POST GET /dashboard/socialMediaClick

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get social media clicks

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Scoail media click counts

socialMedia DELETE PATCH PUT POST GET /dashboard/socialMedia

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get social media links

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Scoail media links
PUT
Functionality:Get social media link update

Query Params:
i) client_id - Type:numeric ; Required
ii) fieldName - Type:string ; Required; (instagram, facebook, website, twitter, snapchat)
ii) fieldValue - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Social media links

serialValidationVerified DELETE PATCH PUT POST GET /dashboard/serialValidationVerified

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get serial validation verified.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Serial validation verified count and percentage data

nfcLineChart DELETE PATCH PUT POST GET /dashboard/nfcLineChart

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get serial validation verified.

Query Params:
i) client_id - Type:numeric ; Required
ii) type - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
NFC Line Chart Data

nfcDataTableDetail DELETE PATCH PUT POST GET /dashboard/nfcDataTableDetial

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET

nfcDataTable DELETE PATCH PUT POST GET /dashboard/nfcDataTable

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get serial validation verified.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
NFC Line Chart Data

nfcCodeValidation DELETE PATCH PUT POST GET /dashboard/nfcCodeValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Code validation.

Query Params:
i) product_page - Type:string ; Required
ii) serial_no - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

nfcValidation DELETE PATCH PUT POST GET /dashboard/nfcClientValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get label validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) period - Type:string ; Optional default 'period':'weekly' hint - ('period':'weekly', 'period':'monthly')

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

nfcChartDays DELETE PATCH PUT POST GET /dashboard/nfcChartDays

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get label validation location.

Query Params:
i) client_id - Type:numeric ; Required
ii) type - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
NFC Graph Data

mostRecent DELETE PATCH PUT POST GET /dashboard/mostRecent

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the most recent email list.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

labelValidation DELETE PATCH PUT POST GET /dashboard/labelValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get label validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) period - Type:string ; Optional default 'period':'weekly' hint - ('period':'weekly', 'period':'monthly')

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

codeValidation DELETE PATCH PUT POST GET /dashboard/CodeValidation

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Code validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) code - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

customerverifyLoginCode DELETE PATCH PUT POST GET /customer/verifyLoginCode

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Validate Customer

Query Params:
i) code - Type:string ; Required
ii) customer_id - Type:string ; Required

Accept: NA;

optional string code
optional string customer_id

customercreditRewards DELETE PATCH PUT POST GET /customer/rewardsCredit

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Validate Customer

Query Params:
i) customer_id - Type:string ; Required
ii) client_id - Type:string ; Required
iii) product_rewards - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Credit Rewards for the Customer.

customerregisterCustomer DELETE PATCH PUT POST GET /customer/registerCustomer

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Register Customer.

Query Params:
i) Name - Type:string ; Required
ii) Email - Type:string ;
iii)Phone - Type:string ;

Accept: NA;

optional name (default: "")
optional email (default: "")
optional phone (default: "")

customerloginCustomer DELETE PATCH PUT POST GET /customer/loginCustomer

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Validate Customer

Query Params:
i) email - Type:string ;
ii) phone - Type:string ;

Accept: NA;

optional string email (default: "")
optional string phone (default: "")

customergoogleAndFacebookLogin DELETE PATCH PUT POST GET /customer/googleFacebookLogin

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Login Customer using Google and Facebook

Query Params:
i) name - Type:string ; Required
ii) email - Type:string ; Required
iii)code - Type:string ; Required

Accept: NA;

optional string name
optional string email
optional string code
optional string type

customercustomerShipping DELETE PATCH PUT POST GET /customer/customerShipping

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Register Customer.

Query Params:
i) customer_id - Type:numeric ; Required

Accept: NA;

required customer_id
POST
Functionality:Register Customer.

Query Params:
i) customer_id - Type:numeric ; Required
ii) name - Type:string ; Required
iii) email - Type:string ; Required
iv) phoneNumber - Type:string ;
v) address - Type:string ; Required
vi) city - Type:string ; Required
vii) state - Type:string ; Required
viii) country - Type:string ; Required
ix)zip_code - Type:string ; Required
ix)cart_Items - Type:json ; Required

Accept: NA;

required customer_id
required client_id
required total_points
required name
required email
optional phone (default: "")
required address
required city
optional state (default: "")
optional country (default: "")
required zipcode
optional cart_Items (default: "")
optional save_address (default: 0)

createNewNfcUrl DELETE PATCH PUT POST GET /createNewNFCUrl

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
create a new Nfc Url.
client_id is required.
nfc_url is required.

dropdown DELETE PATCH PUT POST GET /common/dropdown

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get all dropdowns.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Drop downs data

clientlistclientTotalPoints DELETE PATCH PUT POST GET /clientlist/clientTotalPoints

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Send email to client.

Query Params:
i) customer_id - Type:numeric ; Required
ii) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Success And Failed Message

clientlistclientEmail DELETE PATCH PUT POST GET /clientlist/clientEmail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Send email to client.

Query Params:
i) email - Type:string ; Required
ii) message - Type:string ; Required
iii) client_id - Type:numeric ; Required
iii) subject - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Success And Failed Message

clientProductCount DELETE PATCH PUT POST GET /clientProductCount

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Reward Orders.

Query Params:
i) client_id - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Category's Products.
optional string order_status (default: All)

clientPortalSettings DELETE PATCH PUT POST GET /clientPortalSettings

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Client's Settings;

Query Params:
i) client_id - Type:Numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Client's Settings;

clientOrderCount DELETE PATCH PUT POST GET /clientOrderCount

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Reward Orders.

Query Params:
i) client_id - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Category's Products.
optional string order_status (default: All)

clientPreviousEmail DELETE PATCH PUT POST GET /client/previousEmail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the email recipients list.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list
DELETE
Functionality:Delete the previous email list.

Query Params:
i) client_id - Type:numeric ; Required
ii) msg_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

client DELETE PATCH PUT POST GET /client

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get the email recipients list.

Query Params:
i) client_id - Type:numeric ; Required
ii) paginate - Type:boolean ; Optional (DEFAULT - true)
iii) offset - Type:numeric ; Conditional (If paginate is true the offset is required param)
iv) msg_id - Type:numeric ; Optional
iv) export - Type:numeric ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list
POST
Functionality:Saves the email message to send after approval.

Query Params:
i) client_id - Type:numeric ; Required
ii) from_email - Type:string ; Required
iii) recipient_ids - Type:string ; Conditional hint('recipient_ids':'1,2,3,4')
iv) email_content - Type:string ; Required
v) sendToAll - Type:Boolean ; Optional (Default : 0)
vi) msg_id - Type:numeric ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

changePassword DELETE PATCH PUT POST GET /changePassword

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Update the password for user.
client_id is required.
new_password is required.

changeLogo DELETE PATCH PUT POST GET /changeLogo

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Fetch the logo per client_id.
client_id is required.
POST
Update the logo for a specific user.
client_id is required.
image is required.

login DELETE PATCH PUT POST GET /authenticate

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Validate User Credentials;

Query Params:
i) email - Type:String ; Required
ii) password - Type:String ; Required

Accept: NA;

Headers:
i) app_name - Type: String;
Return:
Token and session info;

appVersion DELETE PATCH PUT POST GET /appVersion

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Return Previous Latest App Version;

adminuserRoles DELETE PATCH PUT POST GET /admin/userRoles

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Authorization is required.
Get user roles.
* use role_name to fetch specific.

adminuserDetail DELETE PATCH PUT POST GET /admin/userDetail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get user detail

DELETE
param: user_id
PUT
Functionality:update user

required first_name
required last_name
required email
required user_id
required role (default: 1)
required active (default: 1)
POST
Functionality:Add new user

required first_name
required last_name
required email
required password
required role (default: 1)
optional active (default: 1)
required send_email (default: 1)

adminuploadImage DELETE PATCH PUT POST GET /admin/uploadImage

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Uplaod Images;

required imageFile
required path

adminupdateTestResults DELETE PATCH PUT POST GET /admin/updateTestResults

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
update Test Result.
Required fields:
1. client_name. 2. lab_result_name. 3. lab_result_url.
4. lab_test_id Optional fields:
1. Expiration Date((DD/DD/YYYY)). 2. Note. 3. pdfFile

admintrackingSearch DELETE PATCH PUT POST GET /admin/trackingsearch

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
required string search (default: "")

admintrackingcomment DELETE PATCH PUT POST GET /admin/trackingcomment

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
required numeric client_id (default: "")
required string comment (default: "")
required numeric tracking_id (default: 0)

admintrackingCount DELETE PATCH PUT POST GET /admin/trackingCount

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get distinct inventory locations

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Inventory Locations;

admintracking DELETE PATCH PUT POST GET /admin/tracking

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get userdetail

DELETE
Functionality: Delete tracking details by tracking_id.

PUT
Update an existing tracking record with optional media uploads.
required numeric client_id
required numeric tracking_id
optional string tracking_num
required string status
optional string tracking_number
optional string ETA
optional numeric pending_review (default: 0)
optional string client_status (default: pending)
optional array multipleUpload (default: [])
POST
Functionality:Add a new tracking record with optional media uploads.

required numeric client_id (default: "")
optional string tracking_num (default: "")
required string status (default: "")
optional string tracking_number (default: "")
optional string ETA (default: "")
optional numeric pending_review (default: 0)
optional string client_status (default: pending)
optional array multipleUpload (default: [])

admintestResults DELETE PATCH PUT POST GET /admin/testResults

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetching the Test Results Details.
Authorization: is required.

* Hit Raw GET to fetch all.
* use searchingFor to search for specific Name.
DELETE
Deleting the Test Results.
Authorization: is required.
client_id is required.
lab_test_id is required
POST
add a new Test Result.
Required fields:
1. client_name. 2. lab_result_name. 3. lab_result_url.
Optional fields:
1. Expiration Date((DD/DD/YYYY)). 2. Note. 3. pdfFile

adminrolelist DELETE PATCH PUT POST GET /admin/rolelist

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get distinct inventory locations

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
role Listing;

adminPrizeConfigPrizeWinnerClients DELETE PATCH PUT POST GET /admin/prizeConfig/PrizeWinnerClients

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Retrieve NFC generate details.

adminPrizeConfigPrzeWinner DELETE PATCH PUT POST GET /admin/prizeConfig/PrizeWinner

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get prize config details

adminPrizeConfigPrizeDetailDelete DELETE PATCH PUT POST GET /admin/prizeConfig/PrizeDetailDelete

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

delete
Functionality: Get prize config details

adminPrizeConfigPrizeConfig DELETE PATCH PUT POST GET /admin/prizeConfig/PrizeConfig

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get prize config details

DELETE
Functionality: Get Client details

PUT
Functionality: Add prize configuration details.

Parameters:
- threshold (numeric)
- grand_prize_threshold (numeric)
- client_id (numeric) - ID of the client.
- total_prizes (numeric) - Total number of prizes.
- prizes (array) - List of prize details.
- emails (array) - List of email addresses
- winners_daily (numeric) - Flag to ask for winners_daily (0 or 1).
- winners_weekly (numeric) - Flag to ask for winners_weekly (0 or 1).
- winners_monthly (numeric) - Flag to ask for monthly winners (0 or 1).
- ask_email (numeric) - Flag to ask for email (0 or 1).
- ask_ig (numeric) - Flag to ask for Instagram handle (0 or 1).

- config_id (numeric) - ID of the config_id.
Post
Functionality: Add prize configuration details.

Parameters:
- threshold (numeric)
- grand_prize_threshold (numeric)
- client_id (numeric) - ID of the client.
- total_prizes (numeric) - Total number of prizes.
- prizes (array) - List of prize details.
- emails (array) - List of email addresses
- winners_daily (numeric) - Flag to ask for winners_daily (0 or 1).
- winners_weekly (numeric) - Flag to ask for winners_weekly (0 or 1).
- winners_monthly (numeric) - Flag to ask for monthly winners (0 or 1).
- ask_email (numeric) - Flag to ask for email (0 or 1).
- ask_ig (numeric) - Flag to ask for Instagram handle (0 or 1).

adminnfcnfcInventory DELETE PATCH PUT POST GET /admin/nfc/nfcInventory

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Retrieves NFC inventory details.

Parameters:
- page (numeric, optional): The current page number for pagination. Default is 1.
- pageSize (numeric, optional): The number of records per page. Default is 10.
- spool_id (numeric, optional): Filter results by spool ID.

Response:
- Returns NFC inventory details with pagination.
put
Functionality: Updates NFC inventory details.

Parameters:
- spool_id (numeric, required): The ID of the spool to be updated.
- client_id (numeric, optional): The client ID associated with the NFC inventory.
- tag_inactive_msg (string, optional): The message displayed when a tag is inactive.
- spool_active (numeric, optional): Indicates if the spool is active (1 for active, 0 for inactive).
- video_url (string, optional): The URL of the associated video.
- product_page (string, optional): The URL of the product page.

Response:
- Returns success or failure message after updating the NFC inventory details.

adminnfcnfcGenerate DELETE PATCH PUT POST GET /admin/nfc/nfcGenerate

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Retrieve NFC generate details.

Parameters:
- page (numeric, optional): The page number for pagination (default: 1).
- pageSize (numeric, optional): Number of records per page (default: 10).
- company_name (string, optional): Filter results by company name.

admininventoryType DELETE PATCH PUT POST GET /admin/inventoryType

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Inventories Type

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Inventories;

admininventorySubtype DELETE PATCH PUT POST GET /admin/inventorySubtype

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Inventories SubType

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Inventories;

admininventoryLocation DELETE PATCH PUT POST GET /admin/inventoryLocations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get distinct inventory locations

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Inventory Locations;

admininventory DELETE PATCH PUT POST GET /admin/inventory

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Inventories

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Inventories;
DELETE
Functionality:Delete an Inventory item

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Status of deletion;
PUT
Edit Inventory
POST
Create Inventory

clientListing DELETE PATCH PUT POST GET /admin/dashboard/clientListing

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Functionality: Get prize config details

admincreateNewCategory DELETE PATCH PUT POST GET /admin/createNewCategory

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
create a new category.Authorization is required.
Required Fields:
*category_name.
*order.
*category_handle.
*imageFile.
*category_description.
*status(Active/Inactive).

adminconfirguration DELETE PATCH PUT POST GET /admin/configurtaion

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get configurtaion

DELETE
Functionality: Delete configuration data

Headers:
i) authorization - Type: String;
PUT
Functionality: Update configuration data

Headers:
i) authorization - Type: String;
POST
Functionality: Insert configuration data

Headers:
i) authorization - Type: String;

adminclientsrewardSection DELETE PATCH PUT POST GET /admin/clients/rewardSection

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality: Get Client details

adminclientsreviewClientEmailCount DELETE PATCH PUT POST GET /admin/clients/reviewClientEmailCount

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client details

adminclientspreviewEmail DELETE PATCH PUT POST GET /admin/clients/previewEmail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:preview email temeplate

adminclientspendingEmails DELETE PATCH PUT POST GET /admin/clients/pendingEmails

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client details

adminclientsemailReviewRequest DELETE PATCH PUT POST GET /admin/clients/emailReviewRequest

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality: Get Client details

adminclientsemailRecepients DELETE PATCH PUT POST GET /admin/clients/emailRecepients

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client details

adminclientsemailClientsListing DELETE PATCH PUT POST GET /admin/clients/emailClientsListing

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client details

adminclientseditClientData DELETE PATCH PUT POST GET /admin/clients/editClientData

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client details

PUT
Updates client information based on the section provided.

adminclientsclientSetting DELETE PATCH PUT POST GET /admin/clients/clientSetting

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client setting data

PUT
Functionality: Get Client details

adminclientsclientRequestAction DELETE PATCH PUT POST GET /admin/clients/clientRequestAction

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality: Get Client details

adminclientsclientRequest DELETE PATCH PUT POST GET /admin/clients/clientRequest

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client details

adminclientsclientDetails DELETE PATCH PUT POST GET /admin/clients/clientDetail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get Client details

PUT
Functionality:Update Client details

required numeric client_id
The unique ID of the client to be updated
required string contact_name (default: "")
required string phone_num (default: 0)
required string company_name (default: "")
required string company_description (default: "")
required string instagram (default: "")
required string facebook (default: "")
required string twitter (default: "")
required string snapchat (default: "")
required string website (default: "")
required string large_logo (default: "")
required string small_logo (default: "")
required string city_state (default: "")
POST
Functionality:Add Client details

required contact_name
required phone_num
required email_addr
required comments
required company_name (default: 1)
optional monthly_units (default: 1)
required company_description (default: 1)

adminclients DELETE PATCH PUT POST GET /admin/clients

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get distinct inventory locations

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Inventory Locations;

adminclientlisting DELETE PATCH PUT POST GET /admin/clientlisting

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Get distinct inventory locations

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Inventory Locations;

adminRewardsscancartupdateProducts DELETE PATCH PUT POST GET /admin/Rewards/updateProducts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Update Scancart Product.
Authorization is required.

adminRewardsscancartshowOptionsVariants DELETE PATCH PUT POST GET /admin/Rewards/scancart/showVariants

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetch product variant options.
Authorization: is required.
DELETE
delete Uploaded Images by user,
*Authorization: is required.
*product_id is required.
*image_id is required

adminRewardsscancartscanacartProductOrders DELETE PATCH PUT POST GET /admin/Rewards/scancart/scanacartRewardsOrder

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetch admin Scancart Reward Orders.
Authorization: is required.
* Hit Raw GET to fetch all.
* use customer_name to search for specific one.
*start_date(dd/mm/yy) format.
*end_date(dd/mm/yy) format.
POST
fetch the order -item details per order_id

adminRewardsscancartgetVariantsListing DELETE PATCH PUT POST GET /admin/Rewards/scancart/getVariants

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetch product variant Details.
Authorization: is required.
*product_id is required.
* use variant name to search for specific one.
DELETE
Delete the variants.
Authorization: is required.
product_id: is required.
variant_id is required.
variant_status(0/1) is required.
PUT
edit and update variants.
Authorization: is required.
*variants(object)

adminRewardsscancartscanacartProductListing DELETE PATCH PUT POST GET /admin/Rewards/scancart

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetch admin Category Details.
Authorization: is required.
* Hit Raw GET to fetch all.
* use product_title name to search for specific one.
DELETE
Delete the product.
Authorization: is required.
product_id: is required.
POST
Add a new Product.
Authorization is required.
field.
*product_title. *product_description. *product_reward_points. *stock_quantity.
*product_categories[]. *product_status(Active/Inactive). *tags[]. *imageFile. *variants(object)

adminRewardsscancartrewardsPoint DELETE PATCH PUT POST GET /admin/Rewards/RewardPoints

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetch All Reward Points.
*Authorization is required.
* use company_name to search.
PUT
Update Reward Points for client.
* Authorization is required.
*reward_point
POST
Add New Reward Point for Client.
* Authorization is required.
* client_id is required.
* reward_point is required.

adminRewardsscancartrewardsLogs DELETE PATCH PUT POST GET /admin/Rewards/RewardLogs

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetch All Reward Logs.
*Authorization is required.
* use customer_name to search.

adminRewardsManageCategory DELETE PATCH PUT POST GET /admin/Rewards

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
fetch admin Category Details.
Authorization: is required.
* Hit Raw GET to fetch all.
* use category name to search for specific one.
DELETE
Delete the category.
Authorization is required.
category_id is required.
POST
update category.
Authorization is required.
Fields:
*category_id is required.
*category_name.
*category_handle.
*orderValue(numeric).
*description.
*status(Active/Inactive).
imageFile use this name.

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.