API Dashboard

Taffy 3.1.0

Resources:

verifyRpUserOtp DELETE PATCH PUT POST GET /verifyRpUserOtp

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality: Verify the OTP sent to the user for login.

Query Params:
i) email - Type:String ; Optional (either email or phone is required to identify user)
ii) phone - Type:String ; Optional (either email or phone is required to identify user)
iii) otp - Type:String ; Required


Return:
success, message;

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.

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

rpUserDetails DELETE PATCH PUT POST GET /rpUserDetails

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality: Details of the User;

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

Return:
Success/failure message and user details if successful.
PUT
Functionality:Update User;

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

ii) user_name - Type:String ; Required

iii) first_name - Type:String ; Required

iv) last_name - Type:String ; Required

Return:
Success/failure message.

rpImageUpload DELETE PATCH PUT POST GET /rpUploadImage

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Uplaod Images;

Query Params:
i) product_id - Type: String ; Required
ii) product_unique_id - Type: String ; Required
iii) nfc_url - Type: String ; Required
iv) user_id - Type: String ; Required
v) reward_points - Type: String ; Required

Return:
success, message, imageUrls (if successful), and user_id/registered product details.

rpUpdateEmailPhone DELETE PATCH PUT POST GET /rpUpdateEmailPhone

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PUT
Functionality: Update Email/Phone of the User;

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

i) email - Type:String ; Required

iii) phone - Type:String ; Required

iv) country_code - Type:String ; Required

v) device_id - Type:String ; Required

Return:
Success/failure message.
POST
Functionality:Verify Phone/Email

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

i) email - Type:String ; Required

iii) phone - Type:String ; Required

iv) country_code - Type:String ; Required

v) device_id - Type:String ; Required

vi) otp - Type:String ; Required

Return:
Success/failure message.

rpShipping DELETE PATCH PUT POST GET /rpShipping

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get shipping details for user;

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

Return: Shipping address.

rpRewards DELETE PATCH PUT POST GET /rpRewards

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get List of Rewards;

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

Return:
List of Rewards;

rpRegisteredProducts DELETE PATCH PUT POST GET /rpRegisteredProducts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get List of registered products for a user;

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

Return:
List of registered products for a user;

rpRegisterRequestsCount DELETE PATCH PUT POST GET /rpRegisterRequestsCount

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Return Product Register Requests Count;

Query Params:
i) user_id - Type:String ; Required
Headers:
Return:
Product Register Requests Count;

rpRegister DELETE PATCH PUT POST GET /rpRegister

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Validate User Register;

Query Params:
i) first_name - Type:String ; Required
ii) last_name - Type:String ; Required
iii) user_name - Type:String ; Required
iv) email - Type:String ; Optional
v) phone - Type:String ; Optional

Headers:
Return:
email;

rpProducts DELETE PATCH PUT POST GET /rpProducts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get List of Products;

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

Return:
List of Products;

rpProductTransfer DELETE PATCH PUT POST GET /rpProductTransfer

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get Transfer Product;

Query Params:
i) user_id - Type: String ; Required ;
PUT
Functionality:Get Transfer Product;

Query Params:
i) product_unique_id - Type: String ; Required ;
ii) action - Type: String ; Required ;
POST
Functionality:Transfer Product;

Query Params:
i) product_unique_id - Type: String ; Required
ii) email - Type: String ;
iii) phone - Type: String ;

rpOrders DELETE PATCH PUT POST GET /rpOrders

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get List of Orders;

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

Return:
List of Orders;
POST
Functionality:Create Order;

Body Params:
i) member_id - Type:Numeric ; Required
ii) full_name - Type:String ; Required
iii) email - Type:String ; Required
iv) phone - Type:String ; Required
v) address - Type:String ; Required
vi) save_shipping_details - Type:String ; Required
vii) total_amount - Type:String ; Required viii) billing_address - Type:String ; Required
ix) items - Type:Strcut ; Required

Return: Success/ Error message after creating order.

rpLogin DELETE PATCH PUT POST GET /rpLogin

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality: Authenticate RP User by sending OTP via Email or Phone;

Query Params:
i) email - Type:String ; Required (if phone is not provided)
ii) phone - Type:String ; Required (if email is not provided)

Return:
Success/failure message and user details if successful.

rpConfig DELETE PATCH PUT POST GET /rpConfig

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Functionality:Get List of Orders;

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

Return:
List of Orders;

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

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

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

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

supportTicket DELETE PATCH PUT POST GET /dashboard/saveSupportTicket

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
Functionality:Save Support Ticket;

Query Params:
i) nfc_url - Type:String ; Required
ii) message - Type:String ; Required

Accept: NA;

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

nfcValidation DELETE PATCH PUT POST GET /dashboard/nfcValidation

+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

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

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

customerSupport DELETE PATCH PUT POST GET /customerSupport

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
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

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)

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

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;

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

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

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;

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;

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.