API DOCUMENTATION

BRANCH NAME: MASTER

Routers Endpoint File: app.js

 ROUTER ENDPOINT => /api/user

o API ENDPOINT => /userFromReq
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
FUNCTIONALITY => To get user data from tables hmgaccounts, amazonaccounts,
customers and user_config
USED ON FRONTEND=> /overview
o API ENDPOINT => /config
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdminOrViewer
o API ENDPOINT => /amazonAccounts
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
FUNCTIONALITY => To get amsprofiles,amazonaccountId and amazonprofiles
USED ON FRONTEND=> /overview
o API ENDPOINT => /registerCustomer
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /refershAmsProfiles
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
 ROUTER ENDPOINT => /api/ams
o API ENDPOINT => /products
HTTP METHOD => GET
MIDDLEWARE => NONE
o API ENDPOINT => /storeAllReports
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /reports/:reportType
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getSalesByLocation
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /keywords/:start/:end
HTTP METHOD => GET
MIDDLEWARE => auth.requires
o Admin API ENDPOINT => /campaigns/:start/:end
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /crontime
HTTP METHOD => GET
 MIDDLEWARE => NONE
o Admin API ENDPOINT => /asinProductTracker
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
FUNCTIONALITY => Get data from productads_tracker, productads_info and
new_products.
USED ON FRONTEND=> /tracker
o API ENDPOINT => /addProductWithAsin
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getUserAsinLimitStatus
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o Admin API ENDPOINT => /updateUserAsinLimit
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdminWithBasePlan
o Admin API ENDPOINT => /validate-for-brand-selection-process
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o Admin API ENDPOINT => /get-all-brands
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o Admin API ENDPOINT => /choose-brands
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/backup

o API ENDPOINT => /generateCsv
HTTP METHOD => POST
MIDDLEWARE => NONE
 ROUTER ENDPOINT => /api/verify
o API ENDPOINT => /check
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
 ROUTER ENDPOINT => /api/rulesetManager
o API ENDPOINT => /ruleset
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /ruleset
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /ruleset
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /ruleset/:id
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin
 o API ENDPOINT => /task
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /task
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /task /:id/rulesetid
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /task
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /ruleset/status
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /ruleset/getLogHistory
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /ruleset/getLogHistoryById/:rulesetid/:tasked/:date
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/feedback

o API ENDPOINT => /post
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
 ROUTER ENDPOINT => /api/group
o API ENDPOINT => /addAccountGroup
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getAccountGroup
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
FUNCTIONALITY => To get account groups.
USED ON FRONTEND=> /overview
o API ENDPOINT => /deleteAccountGroup/:id
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /updateAccountGroup
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /setAccountGroup
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /addPortfolioGroup
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
 o API ENDPOINT => /updatePortfolioGroup
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getPortfolioGroup
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
FUNCTIONALITY => To get PortfolioGroups data, get data from portfolio_groups and
portfolio_details using hmgaccountID and amsprofileId.
USED ON FRONTEND=> /goal
o API ENDPOINT => /getAllPortfolioGroup
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /setPortfolioGroup
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /createCampaign
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /associate-asins
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/stripePayment

o API ENDPOINT => /addCustomer
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /updateCustomerCard
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getSubscription
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /updateStripePlansInDatabase
HTTP METHOD => GET
MIDDLEWARE => NONE
o API ENDPOINT => /getStripePlansInDatabase
HTTP METHOD => GET
MIDDLEWARE => NONE
FUNCTIONALITY => To get all the plans active in database from plans table.
USED ON FRONTEND=> /overview
o API ENDPOINT => /verify-coupon
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getCustomerSubscribedPlan
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
 ROUTER ENDPOINT => /api/embed
o API ENDPOINT => /getUrl
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
FUNCTIONALITY => Fetch data from qs_user_arn_details table, basically used to
fetch data from Amazon’s quick sight.
USED ON FRONTEND=> /integratedBi
o API ENDPOINT => /inviteUser
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdminWithBasePlan
o API ENDPOINT => /getInvitedUser
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /updateInvitedUser
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /updateInvitedUserStatus
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /deleteInvitedUser
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/asinGroup

o API ENDPOINT => /addAsinGroup
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getAsinGroup
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getStoredAsinForGroup
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getStoredAsins/:country
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /assignAsinToAsinGroup
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /deleteAsinGroup
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /updateAsinGroup
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /updateAsinGroupDetails
HTTP METHOD => PUT
 MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getAsinGroupWithDetails/:asingroupid
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getAsinsStats
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /getAsinsStatsForTable
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
 ROUTER ENDPOINT => /api/bid
o API ENDPOINT => /portfolio-group-details/:amsprofileid
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /available-date-for-stored-bid/:amsprofileid
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /restore
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /bulk-update
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin, upload.single(‘file’)
o API ENDPOINT => /count-history
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /download-history/:date
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /trigger-download-recent-bid
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /available-recent-bid
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /download-available-recent-bid/:reportType/:time
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /quick-asin-update
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /quick-update
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/day-part

 o API ENDPOINT => /details
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details/:dayPartId
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/campaign-console

o API ENDPOINT => /details/:campaignType/:status/:endDate/:startDate/:limit/:page
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details/default-bid
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/keyword-automation

o API ENDPOINT => /process
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /process
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /process
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /process/:keywordAutomationItemId
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /process/queue-approve
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /process/upload
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin, upload.single(‘file’)
o API ENDPOINT => /execution-history/:keywordAutomationId/:campaignId/:date
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
 ROUTER ENDPOINT => /api/goal-tracker
o API ENDPOINT => /details
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
FUNCTIONALITY => To get data from goal_tracker.
USED ON FRONTEND=> /goal
o API ENDPOINT => /details
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details/:goalTrackerId
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /refresh-actuals
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin

 ROUTER ENDPOINT => /api/dashboard

o API ENDPOINT => /currency-rates
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
o API ENDPOINT => /sales-spend
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
FUNCTIONALITY => To get sales spend data, only fetched if account is active i.e.
when base plan is subscribed or in trial period, default we fetch data of last week.
USED ON FRONTEND=> /overview
o API ENDPOINT => /acos-over-time
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
o API ENDPOINT => /sales-by-location
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
o API ENDPOINT => /manual-spend
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
FUNCTIONALITY => To get manual spend data, only fetched if account is active i.e.
when base plan is subscribed or in trial period, default we fetch data of last week.
USED ON FRONTEND=> /overview
o API ENDPOINT => /top-keywords
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
o API ENDPOINT => /top-asins
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
 o API ENDPOINT => /top-portfolio
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer
o API ENDPOINT => /keywords-sales-rank
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdminOrViewer

 ROUTER ENDPOINT => /api/label

o API ENDPOINT => /details
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details/chart
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details/download
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details/:labelId
HTTP METHOD => DELETE
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /details
HTTP METHOD => PUT
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /associate-labels
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /add-default-label
HTTP METHOD => GET
MIDDLEWARE => NONE
o API ENDPOINT => /upload
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin, upload.single(‘file’)

 ROUTER ENDPOINT => /api/admin-portal

o API ENDPOINT => /upload
HTTP METHOD => POST
MIDDLEWARE => auth.requiresAdmin, upload.single(‘file’)
o API ENDPOINT => /download
HTTP METHOD => GET
MIDDLEWARE => auth.requiresAdmin
o API ENDPOINT => /create-invoice
HTTP METHOD => GET
MIDDLEWARE => NONE