\Moxws_Service

All the webservice calls

Summary

Methods
Properties
Constants
authenticateUser()
sendResponse()
sendError()
translateMessage()
startService()
service()
loginUser()
requestModule()
storeAppRegistration()
removeAppRegistration()
fetchOrdersByColumns()
fetchOrderByColumns()
fetchAllOrders()
fetchOrderArticles()
fetchOrder()
insertOrder()
insertOrders()
insertOrderArticles()
updateOrder()
updateOrders()
updateOrderArticles()
deleteOrder()
deleteOrders()
deleteOrderArticles()
fetchLastOrder()
fetchTopOrder()
fetchLatestOrder()
fetchLastMonthOrders()
fetchThisMonthOrders()
fetchTodayOrders()
getShopRevenueOverall()
getShopRevenueToday()
getShopRevenueYesterday()
getShopRevenueWeek()
getShopRevenueLastWeek()
getShopRevenueMonth()
getShopRevenueLastMonth()
getShopRevenueYear()
getShopRevenueLastYear()
insertUser()
insertUsers()
assignUsers2Group()
fetchUser()
fetchUsers()
deleteUser()
deleteUsers()
updateUser()
updateUsers()
getUserOrderHistory()
getTopOrderedUser()
getMostOrderedUser()
fetchAllArticles()
fetchArticle()
fetchArticleByColumns()
insertArticles()
insertArticleByColumns()
updateArticles()
updateArticleByColumns()
updateStock()
getNetPrice()
getGrossPrice()
fetchVariantArticles()
getParentArticle()
getLongDesc()
setArticleLongDesc()
setArticleShortDesc()
getVat()
getImages()
fetchSeoUrl()
fetchAllParentArticles()
fetchCategoryTitles()
fetchManufacturers()
fetchArticleTags()
fetchVariantValues()
fetchAttributeValues()
fetchThumbNailUrl()
fetchIconUrl()
fetchArticleLink()
fetchCategoryIds()
fetchVariantIds()
isArticleExist()
fetchVariantsMinPrice()
fetchVariantsStock()
getMostOrderedArticle()
getMostOrderedArticleMonth()
getMostOrderedArticleDay()
getMostOrderedArticleYear()
updateArticlePicture()
searchArticle()
fetchLowStockArticlesMinMax()
fetchLowStockArticles()
fetchArticleByEAN()
fetchLowStockArticlesCount()
fetchLowStockArticlesCountMinMax()
fetchArticleReviews()
fetchAllReviews()
fetchReviewByOxid()
updateArticleReview()
insertArticleReview()
deleteArticleReviews()
deleteArticlesReviews()
deleteReview()
deleteReviews()
fetchArticleAvgRating()
fetchArticleRatings()
fetchAllRatings()
updateArticleRating()
insertArticleRating()
deleteArticleRatings()
deleteArticlesRatings()
deleteRating()
deleteRatings()
assignCategory()
unassignCategory()
fetchCatArticles()
fetchCategories()
insertCategory()
updateCategory()
getCategory()
getSubCats()
getParentCategory()
setParentCategory()
getMostOrderedCategory()
getMostOrderedCategoryDay()
getMostOrderedCategoryMonth()
getMostOrderedCategoryYear()
fetchGroupsAssigned()
insertUserGroup()
updateUserGroup()
deleteUserGroup()
unAssignUsers()
fetchGroupUsers()
getMostOrderedUserGroup()
getMostOrderedUserGroupDay()
getMostOrderedUserGroupMonth()
getMostOrderedUserGroupYear()
getUserGroupOrders()
insertNotes()
insertNote()
updateNotes()
updateNote()
deleteNotes()
deleteNote()
fetchThankyouNotes()
fetchRatingRequestTemplates()
fetchThankyouNoteById()
fetchRatingRequestTemplateById()
updateThankyouNotes()
updateRatingRequestTemplate()
deleteThankyouNotes()
deleteRatingRequestTemplate()
sendThankyouNote()
sendRatingRequest()
loadVisitors()
getFrequentVisitorsMonth()
loadUsers()
loadOrders()
getRegisteredUsersToday()
getRegisteredUsersYesterday()
getRegisteredUsersWeek()
getRegisteredUsersLastWeek()
getRegisteredUsersMonth()
getRegisteredUsersLastMonth()
getRegisteredUsersYear()
getRegisteredUsersLastYear()
getDashboardData()
fetchPreviousOrderId()
fetchNextOrderId()
fetchCouponSeries()
fetchCouponCodes()
fetchShopLogo()
No public properties found
No constants found
No protected methods found
$iLang
N/A
No private methods found
No private properties found
N/A

Properties

$iLang

$iLang : 

to store language id

Type

Methods

authenticateUser()

authenticateUser(array  $headers) : integer

authenticating Admin user

Parameters

array $headers

array of details for user credentials (username and password)

Returns

integer

sendResponse()

sendResponse(array  $data = null) : null

function to send response to the request

Parameters

array $data

array of details to be send as response

Returns

null

sendError()

sendError(string  $code, string  $message = null) : null

function to send error response to the request

Parameters

string $code

error code

string $message

error message

Returns

null

translateMessage()

translateMessage(array  $iLang) : null

function to load error messages

Parameters

array $iLang

id of the language

Returns

null

startService()

startService(array  $headers, \JSONstring  $client_data) : null

Starts service by authenticating the user

Parameters

array $headers

array of details for user credentials (username and password)

\JSONstring $client_data

JSON data which are required as parameters for service calls.

Returns

null

service()

service(\JSONstring  $client_data, string  $methodName) : null

Servicing the response by calling respective web service call

Parameters

\JSONstring $client_data

JSON data which are required as parameters for service calls.

string $methodName

name of the method to be called

Returns

null

loginUser()

loginUser(\JSONstring  $client_data) : null

Function to login the admin user

Parameters

\JSONstring $client_data

json array with 'registrationId'=>registration id of the app, 'deviceId'=>unique id of the device, 'name'=>name of the device

Returns

null

requestModule()

requestModule(\JSONstring  $client_data) : integer

Function to request moxws module for download

Parameters

\JSONstring $client_data

json array with 'emailid'=>email address to which module should be sent

Returns

integer

storeAppRegistration()

storeAppRegistration(\JSONstring  $client_data) : \JSONstring

Function to store app registration ids

Parameters

\JSONstring $client_data

json array with 'registrationId'=>registration id of the app, 'deviceId'=>unique id of the device, 'name'=>name of the device

Returns

\JSONstring

removeAppRegistration()

removeAppRegistration(\JSONstring  $client_data) : \JSONstring

Function to store app registration ids

Parameters

\JSONstring $client_data

json array with 'registrationId'=>registration id of the app, 'deviceId'=>unique id of the device, 'name'=>name of the device

Returns

\JSONstring

fetchOrdersByColumns()

fetchOrdersByColumns(\JSONstring  $client_data) : \JSONstring

Function to fetch orders with specified columns

Parameters

\JSONstring $client_data

json array with 'orders'=> required column names of oxorder table with (,) seperated and 'items'=> required column names of oxorderarticles table with (,) seperated.

Returns

\JSONstring

fetchOrderByColumns()

fetchOrderByColumns(\JSONstring  $client_data) : \JSONstring

Function to find order with specified columns based on orderid

Parameters

\JSONstring $client_data

json array with 'orderid'=> order id to be fetched, 'orders'=> required column names of oxorder table with (,) seperated and 'items'=> required column names of oxorderarticles table with (,) seperated.

Returns

\JSONstring

fetchAllOrders()

fetchAllOrders(\JSONstring  $client_data = null) : \JSONstring

Function to fetch all the orders (fetches all columns)

Parameters

\JSONstring $client_data

json array with 'start'=> start index of the fetchOrders result and 'offset'=> offset index of the fetchOrders result

Returns

\JSONstring

fetchOrderArticles()

fetchOrderArticles(\JSONstring  $client_data) : \JSONstring

Function to fetch order articles based on order id

Parameters

\JSONstring $client_data

json string with 'orderId'=> order id of the order whose items to be fetched.

Returns

\JSONstring

fetchOrder()

fetchOrder(\JSONstring  $client_data) : \JSONstring

Function to fetch order details based on orderid

Parameters

\JSONstring $client_data

json string with 'orderId'=> order id of the order whose details to be fetched.

Returns

\JSONstring

insertOrder()

insertOrder(\JSONstring  $client_data) : \JSONstring

Function to insert a new order

Parameters

\JSONstring $client_data

json string with order details as key=>value pairs to insert. Ex: 'oxordernr'=>'xxxxxx', 'oxorderdate'=>'xxxxx'.

Returns

\JSONstring

insertOrders()

insertOrders(\JSONstring  $client_data) : \JSONstring

Function to insert new orders

Parameters

\JSONstring $client_data

json string with order details as key=>value pairs to insert. Ex: 'oxordernr'=>'xxxxxx', 'oxorderdate'=>'xxxxx'.

Returns

\JSONstring

insertOrderArticles()

insertOrderArticles(\JSONstring  $client_data) : \JSONstring

Function to insert new order article

Parameters

\JSONstring $client_data

json string with order article details as key=>value pairs to insert. Ex: 'oxorderid'=>'xxxxxx', 'oxamount'=>'xxxxx'.

Returns

\JSONstring

updateOrder()

updateOrder(\JSONstring  $client_data) : \JSONstring

Function to update order

Parameters

\JSONstring $client_data

json string with order details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxordernr'=>'xxxxx'.

Returns

\JSONstring

updateOrders()

updateOrders(\JSONstring  $client_data) : \JSONstring

Function to update multiple orders

Parameters

\JSONstring $client_data

json string with orders details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxordernr'=>'xxxxx'.

Returns

\JSONstring

updateOrderArticles()

updateOrderArticles(\JSONstring  $client_data) : \JSONstring

Function to update order article

Parameters

\JSONstring $client_data

json string with order article details as key=>value pairs to update. Ex: 'oxorderid'=>'xxxxxx', 'oxamount'=>'xxxxx'.

Returns

\JSONstring

deleteOrder()

deleteOrder(\JSONstring  $client_data) : \JSONstring

Function to delete order based on order oxid

Parameters

\JSONstring $client_data

json string with 'orderId'=>oxid of order to be deleted

Returns

\JSONstring

deleteOrders()

deleteOrders(\JSONstring  $client_data) : \JSONstring

Function to delete multiple orders

Parameters

\JSONstring $client_data

json straing with 'orderIds'=> oxids with (,) seperated of orders to be deleted.

Returns

\JSONstring

deleteOrderArticles()

deleteOrderArticles(\JSONstring  $client_data) : \JSONstring

Function to delete order articles

Parameters

\JSONstring $client_data

json string with 'orderArtIds'=> oxids of the orderarticles which needs to be deleted

Returns

\JSONstring

fetchLastOrder()

fetchLastOrder() : \JSONstring

Function to fetch last order

Returns

\JSONstring

fetchTopOrder()

fetchTopOrder() : \JSONstring

Function to fetch top order

Returns

\JSONstring

fetchLatestOrder()

fetchLatestOrder() : \JSONstring

Function to fetch latest order

Returns

\JSONstring

fetchLastMonthOrders()

fetchLastMonthOrders() : \JSONstring

Function to fetch last month orders

Returns

\JSONstring

fetchThisMonthOrders()

fetchThisMonthOrders() : \JSONstring

Function to fetch this month orders

Returns

\JSONstring

fetchTodayOrders()

fetchTodayOrders() : \JSONstring

Function to fetch today's orders

Returns

\JSONstring

getShopRevenueOverall()

getShopRevenueOverall() : \JSONstring

Function to fetch total shop revenue overall

Returns

\JSONstring

getShopRevenueToday()

getShopRevenueToday() : \JSONstring

Function to fetch total shop revenue for current day

Returns

\JSONstring

getShopRevenueYesterday()

getShopRevenueYesterday() : \JSONstring

Function to fetch total shop revenue for yesterday

Returns

\JSONstring

getShopRevenueWeek()

getShopRevenueWeek() : \JSONstring

Function to fetch total shop revenue for current week

Returns

\JSONstring

getShopRevenueLastWeek()

getShopRevenueLastWeek() : \JSONstring

Function to fetch total shop revenue for last week

Returns

\JSONstring

getShopRevenueMonth()

getShopRevenueMonth() : \JSONstring

Function to fetch total shop revenue for current month

Returns

\JSONstring

getShopRevenueLastMonth()

getShopRevenueLastMonth() : \JSONstring

Function to fetch total shop revenue for last month

Returns

\JSONstring

getShopRevenueYear()

getShopRevenueYear() : \JSONstring

Function to fetch total shop revenue for current year

Returns

\JSONstring

getShopRevenueLastYear()

getShopRevenueLastYear() : \JSONstring

Function to fetch total shop revenue for last year

Returns

\JSONstring

insertUser()

insertUser(\JSONstring  $client_data) : \JSONstring

Function to insert user

Parameters

\JSONstring $client_data

json string with user details as key=>value pairs to insert. Ex: 'oxactive'=>'xxxxxx', 'oxfname'=>'xxxxxx'.

Returns

\JSONstring

insertUsers()

insertUsers(\JSONstring  $client_data) : \JSONstring

Function to insert users

Parameters

\JSONstring $client_data

json string with multiple user details as key=>value pairs to insert. Ex: 'oxactive'=>'xxxxxx', 'oxfname'=>'xxxxxx'.

Returns

\JSONstring

assignUsers2Group()

assignUsers2Group(\JSONstring  $client_data) : \JSONstring

Function to assign users to group

Parameters

\JSONstring $client_data

json string with 'Users' =>oxids of the users to add with (,)comma seperated and 'GroupId'=>groupid to which users to be added

Returns

\JSONstring

fetchUser()

fetchUser(\JSONstring  $client_data) : \JSONstring

Function to fetch user details based on user oxid

Parameters

\JSONstring $client_data

JSON string with 'userId'=> user oxid to fetch user details

Returns

\JSONstring

fetchUsers()

fetchUsers(\JSONstring  $client_data) : \JSONstring

Function to fetch users

Parameters

\JSONstring $client_data

json string with 'start'=> start index of the fetchUsers result and 'offset'=> offset index of the fetchUsers result

Returns

\JSONstring

deleteUser()

deleteUser(\JSONstring  $client_data) : \JSONstring

Function to delete user details based on user oxid

Parameters

\JSONstring $client_data

JSON string with 'userId'=> user oxid to delete user details

Returns

\JSONstring

deleteUsers()

deleteUsers(\JSONstring  $client_data) : \JSONstring

Function to delete multiple users details based on user oxid

Parameters

\JSONstring $client_data

JSON string with 'userIds'=> users oxid with (,) seperated to delete user details

Returns

\JSONstring

updateUser()

updateUser(\JSONstring  $client_data) : \JSONstring

Function to update user

Parameters

\JSONstring $client_data

json string with user details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxfname'=>'xxxxxx'.

Returns

\JSONstring

updateUsers()

updateUsers(\JSONstring  $client_data) : \JSONstring

Function to update multiple users

Parameters

\JSONstring $client_data

json string with multiple user details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxfname'=>'xxxxxx'.

Returns

\JSONstring

getUserOrderHistory()

getUserOrderHistory(\JSONstring  $client_data) : \JSONstring

Function to fetch all the orders of an user based on user oxid

Parameters

\JSONstring $client_data

JSON string with 'userId'=> user oxid to fetch user order details

Returns

\JSONstring

getTopOrderedUser()

getTopOrderedUser() : \JSONstring

Function to fetch user who ordered with most price.

Returns

\JSONstring

getMostOrderedUser()

getMostOrderedUser() : \JSONstring

Function to fetch user who ordered most number of times.

Returns

\JSONstring

fetchAllArticles()

fetchAllArticles(\JSONstring  $client_data) : \JSONstring

Function to fetch all articles

Parameters

\JSONstring $client_data

json array with 'start'=> start index of the fetchAllArticles result and 'offset'=> offset index of the fetchAllArticles result 'columns'=> columns to be fetched for each article (optional) 'langId'=> in which language columns to be fetched for each article (optional)

Returns

\JSONstring

fetchArticle()

fetchArticle(\JSONstring  $client_data) : \JSONstring

Function to fetch article details

Parameters

\JSONstring $client_data

json string with 'articleId'=> oxid of the article whose details to be fetched.

Returns

\JSONstring

fetchArticleByColumns()

fetchArticleByColumns(\JSONstring  $client_data) : \JSONstring

Function to fetch specified fields of article details

Parameters

\JSONstring $client_data

json array with 'articleId'=> oxid of the article to be fetched, 'columns'=> required column names of oxarticle table with (,) seperated (Ex: OXID,OXARTNUM,OXTITLE) 'langId'=> in which language columns to be fetched for each article (optional)

Returns

\JSONstring

insertArticles()

insertArticles(\JSONstring  $client_data) : \JSONstring

Function to insert articles

Parameters

\JSONstring $client_data

json string with article details as key=>value pairs to insert. Ex: 'oxactive'=>'xxxxxx', 'oxtitle'=>'xxxxxx'.

Returns

\JSONstring

insertArticleByColumns()

insertArticleByColumns(\JSONstring  $client_data) : \JSONstring

Function to insert specified fields of an article to create

Parameters

\JSONstring $client_data

json string with article details as key=>value pairs to insert. Ex: 'oxactive'=>'xxxxxx', 'oxtitle'=>'xxxxxx'.

Returns

\JSONstring

updateArticles()

updateArticles(\JSONstring  $client_data) : \JSONstring

Function to update articles

Parameters

\JSONstring $client_data

json string with article details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxtitle'=>'xxxxxx'.

Returns

\JSONstring

updateArticleByColumns()

updateArticleByColumns(\JSONstring  $client_data) : \JSONstring

Function to update specified fields of an article

Parameters

\JSONstring $client_data

json string with article details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxtitle'=>'xxxxxx'.

Returns

\JSONstring

updateStock()

updateStock(\JSONstring  $client_data) : \JSONstring

Function to update stock of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>articleId for which stock needs to be updated , 'stock'=>stock to update

Returns

\JSONstring

getNetPrice()

getNetPrice(\JSONstring  $client_data) : \JSONstring

Function to get net price of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get the net price

Returns

\JSONstring

getGrossPrice()

getGrossPrice(\JSONstring  $client_data) : \JSONstring

Function to get gross price of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get the gross price

Returns

\JSONstring

fetchVariantArticles()

fetchVariantArticles(\JSONstring  $client_data) : \JSONstring

Function to get variant articles for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get the variant articles

Returns

\JSONstring

getParentArticle()

getParentArticle(\JSONstring  $client_data) : \JSONstring

Function to get parent article of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get the parent article

Returns

\JSONstring

getLongDesc()

getLongDesc(\JSONstring  $client_data) : \text

Function to get description of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get long description

Returns

\text

setArticleLongDesc()

setArticleLongDesc(\JSONstring  $client_data) : \JSONstring

Function to set long description for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to set description , 'longDesc'=>description to set

Returns

\JSONstring

setArticleShortDesc()

setArticleShortDesc(\JSONstring  $client_data) : \JSONstring

Function to set short description for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to set description , 'shortDesc'=>short description to set

Returns

\JSONstring

getVat()

getVat(\JSONstring  $client_data) : \JSONstring

Function to get vat for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get vat

Returns

\JSONstring

getImages()

getImages(\JSONstring  $client_data) : \JSONstring

Function to get images for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get images

Returns

\JSONstring

fetchSeoUrl()

fetchSeoUrl(\JSONstring  $client_data) : \JSONstring

Function to get seo url for an object

Parameters

\JSONstring $client_data

json string with 'objectId'=>objectId to get seo url

Returns

\JSONstring

fetchAllParentArticles()

fetchAllParentArticles(\JSONstring  $client_data) : \JSONstring

Function to fetch all the parent articles

Parameters

\JSONstring $client_data

json array with 'start'=> start index of the fetchAllParentArticles result and 'offset'=> offset index of the fetchAllParentArticles result

Returns

\JSONstring

fetchCategoryTitles()

fetchCategoryTitles(\JSONstring  $client_data) : \JSONstring

Function to get category titles for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>OXID of the article to get category titles

Returns

\JSONstring

fetchManufacturers()

fetchManufacturers(\JSONstring  $client_data) : \JSONstring

Function to get manufacturers for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>OXID of the article to get manufacturers details

Returns

\JSONstring

fetchArticleTags()

fetchArticleTags(\JSONstring  $client_data) : \JSONstring

Function to get tags for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>OXID of the article to get tags

Returns

\JSONstring

fetchVariantValues()

fetchVariantValues(\JSONstring  $client_data) : \JSONstring

Function to get variant values for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>OXID of the article to get variant values

Returns

\JSONstring

fetchAttributeValues()

fetchAttributeValues(\JSONstring  $client_data) : \JSONstring

Function to get attribute values for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>OXID of the article to get attribute values

Returns

\JSONstring

fetchThumbNailUrl()

fetchThumbNailUrl(\JSONstring  $client_data) : \JSONstring

Function to get thumbnail url for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>OXID of the article to get thumbnail url

Returns

\JSONstring

fetchIconUrl()

fetchIconUrl(\JSONstring  $client_data) : \JSONstring

Function to get icon url for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>OXID of the article to get icon url

Returns

\JSONstring

fetchArticleLink()

fetchArticleLink(\JSONstring  $client_data) : \JSONstring

Function to get article link for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=> OXID of the article to get article link, 'lang'=>language id to get the link

Returns

\JSONstring

fetchCategoryIds()

fetchCategoryIds(\JSONstring  $client_data) : \JSONstring

Function to get category ids for an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to get the category ids

Returns

\JSONstring

fetchVariantIds()

fetchVariantIds(\JSONstring  $client_data) : \JSONstring

Function to fetch oxid's of the variants of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=> oxid of the article whose variants stock to be fetched.

Returns

\JSONstring

isArticleExist()

isArticleExist(\JSONstring  $client_data) : \JSONstring

Function to check whether an article exists or not

Parameters

\JSONstring $client_data

json string with 'articleId'=> oxid of the article to check it's existance.

Returns

\JSONstring

fetchVariantsMinPrice()

fetchVariantsMinPrice(\JSONstring  $client_data) : \JSONstring

Function to fetch minimum price of the variants of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=> oxid of the article whose variants minimum price to be fetched.

Returns

\JSONstring

fetchVariantsStock()

fetchVariantsStock(\JSONstring  $client_data) : \JSONstring

Function to fetch stock of the variants of an article

Parameters

\JSONstring $client_data

json string with 'articleId'=> oxid of the article whose variants stock to be fetched.

Returns

\JSONstring

getMostOrderedArticle()

getMostOrderedArticle(\JSONstring  $client_data) : \JSONstring

Function to fetch article which ordered most number of times.

Parameters

\JSONstring $client_data

json string with 'limit'=> limit count of articles to be fetched.

Returns

\JSONstring

getMostOrderedArticleMonth()

getMostOrderedArticleMonth(\JSONstring  $client_data) : \JSONstring

Function to fetch article which ordered most number of times in current month.

Parameters

\JSONstring $client_data

json string with 'limit'=> limit count of articles to be fetched.

Returns

\JSONstring

getMostOrderedArticleDay()

getMostOrderedArticleDay(\JSONstring  $client_data) : \JSONstring

Function to fetch article which ordered most number of times in current day.

Parameters

\JSONstring $client_data

json string with 'limit'=> limit count of articles to be fetched.

Returns

\JSONstring

getMostOrderedArticleYear()

getMostOrderedArticleYear(\JSONstring  $client_data) : \JSONstring

Function to fetch article which ordered most number of times in current year.

Parameters

\JSONstring $client_data

json string with 'limit'=> limit count of articles to be fetched.

Returns

\JSONstring

updateArticlePicture()

updateArticlePicture(\JSONstring  $client_data) : \JSONstring

Function to update article picture

Parameters

\JSONstring $client_data

json string with 'articleId'=> Article OXId to update picture, 'pictureId'=> picture number, 'pictureStr'=> picture binary data, 'title'=> article title for picture

Returns

\JSONstring

searchArticle()

searchArticle(\JSONstring  $client_data) : \JSONstring

Function to fetch article based on search keyword related to title and article number.

Parameters

\JSONstring $client_data

json string with 'searchKey'=>search keyword to fetch the article details based on title and article number

Returns

\JSONstring

fetchLowStockArticlesMinMax()

fetchLowStockArticlesMinMax(\JSONstring  $client_data) : \JSONstring

Function to fetch articles details which are in low stock

Parameters

\JSONstring $client_data

json string with 'minlimit'=> minimum threshold value to define the low stock articles, 'maxlimit'=> maximum threshold value to define the low stock articles 'start'=> start index of the fetchLowStockArticles result and 'offset'=> offset index of the fetchLowStockArticles result 'langId'=> language id to get the article details 'columns'=> required columns to get the data seperated by , (Ex: columns=>'oxtitle,oxartnum,oxid,...')

Returns

\JSONstring

fetchLowStockArticles()

fetchLowStockArticles(\JSONstring  $client_data) : \JSONstring

Function to fetch articles details which are in low stock

Parameters

\JSONstring $client_data

json string with 'limit'=> minimum threshold value to define the low stock articles, 'start'=> start index of the fetchLowStockArticles result and 'offset'=> offset index of the fetchLowStockArticles result 'langId'=> language id to get the article details 'columns'=> required columns to get the data seperated by , (Ex: columns=>'oxtitle,oxartnum,oxid,...')

Returns

\JSONstring

fetchArticleByEAN()

fetchArticleByEAN(\JSONstring  $client_data) : array

Function to fetch article details based on EAN

Parameters

\JSONstring $client_data

json string with 'articleEAN'=> article EAN to fetch article details

Returns

array

fetchLowStockArticlesCount()

fetchLowStockArticlesCount(\JSONstring  $client_data) : \JSONstring

Function to fetch articles count which are in low stock

Parameters

\JSONstring $client_data

json string with 'minlimit'=> minimum threshold value to define the low stock articles 'maxlimit'=> maximum threshold value to define the low stock articles

Returns

\JSONstring

fetchLowStockArticlesCountMinMax()

fetchLowStockArticlesCountMinMax(\JSONstring  $client_data) : \JSONstring

Function to fetch articles count which are in low stock

Parameters

\JSONstring $client_data

json string with 'limit'=> minimum threshold value to define the low stock articles

Returns

\JSONstring

fetchArticleReviews()

fetchArticleReviews(\JSONstring  $client_data) : \JSONstring

Function to fetch all the reviews of an article based on article oxid.

Parameters

\JSONstring $client_data

json string with 'articleId'=>oxid of article to fetch its reviews

Returns

\JSONstring

fetchAllReviews()

fetchAllReviews() : \JSONstring

Function to fetch all the reviews.

Returns

\JSONstring

fetchReviewByOxid()

fetchReviewByOxid(\JSONstring  $client_data) : \JSONstring

Function to fetch a review based on oxid of the review.

Parameters

\JSONstring $client_data

json string with 'reviewId'=>oxid of article to fetch its reviews

Returns

\JSONstring

updateArticleReview()

updateArticleReview(\JSONstring  $client_data) : \JSONstring

Function to update a review based on oxid of the review.

Parameters

\JSONstring $client_data

json string with review details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxtext'=>'xxxxxx'.

Returns

\JSONstring

insertArticleReview()

insertArticleReview(\JSONstring  $client_data) : \JSONstring

Function to insert a review based on oxid of the review.

Parameters

\JSONstring $client_data

json string with review details as key=>value pairs to insert. Ex: 'oxobjectid'=>'xxxxxx', 'oxtext'=>'xxxxxx'.

Returns

\JSONstring

deleteArticleReviews()

deleteArticleReviews(\JSONstring  $client_data) : \JSONstring

Function to delete reviews of an article based on oxid of the article.

Parameters

\JSONstring $client_data

json string with 'articleId'=>oxid of an article whose reviews to be deleted.

Returns

\JSONstring

deleteArticlesReviews()

deleteArticlesReviews(\JSONstring  $client_data) : \JSONstring

Function to delete reviews of multiple articles based on oxid of the articles.

Parameters

\JSONstring $client_data

json string with 'articleIds'=>oxids of multiple articles whose reviews to be deleted with (,) seperated.

Returns

\JSONstring

deleteReview()

deleteReview(\JSONstring  $client_data) : \JSONstring

Function to delete a review based on oxid of the review.

Parameters

\JSONstring $client_data

json string with 'reviewId'=>oxid of a review which needs to be deleted.

Returns

\JSONstring

deleteReviews()

deleteReviews(\JSONstring  $client_data) : \JSONstring

Function to delete multiple reviews based on oxid of the reviews.

Parameters

\JSONstring $client_data

json string with 'reviewIds'=>oxids of multiple reviews which needs to be deleted with (,) seperated.

Returns

\JSONstring

fetchArticleAvgRating()

fetchArticleAvgRating(\JSONstring  $client_data) : \JSONstring

Function to fetch average of ratings of an article based on article oxid

Parameters

\JSONstring $client_data

json string with 'articleId'=> oxid of the article to fetch average ratings.

Returns

\JSONstring

fetchArticleRatings()

fetchArticleRatings(\JSONstring  $client_data) : \JSONstring

Function to fetch all the ratings of an article based on article oxid

Parameters

\JSONstring $client_data

json string with 'articleId'=> oxid of the article to fetch all ratings.

Returns

\JSONstring

fetchAllRatings()

fetchAllRatings() : \JSONstring

Function to fetch all the ratings of all the articles

Returns

\JSONstring

updateArticleRating()

updateArticleRating(\JSONstring  $client_data) : \JSONstring

Function to update a rating.

Parameters

\JSONstring $client_data

json string with rating details as key=>value pairs to update. Ex: 'oxid'=>'xxxxxx', 'oxrating'=>'x'.

Returns

\JSONstring

insertArticleRating()

insertArticleRating(\JSONstring  $client_data) : \JSONstring

Function to insert a rating.

Parameters

\JSONstring $client_data

json string with rating details as key=>value pairs to insert. Ex: 'oxobjectid'=>'xxxxxx', 'oxrating'=>'x'.

Returns

\JSONstring

deleteArticleRatings()

deleteArticleRatings(\JSONstring  $client_data) : \JSONstring

Function to delete all the ratings of an article based on oxid of the article.

Parameters

\JSONstring $client_data

json string with 'articleId'=>oxid of an article to delete all its ratings.

Returns

\JSONstring

deleteArticlesRatings()

deleteArticlesRatings(\JSONstring  $client_data) : \JSONstring

Function to delete all the ratings of multiple articles based on oxid of the article.

Parameters

\JSONstring $client_data

json string with 'articleIds'=>oxids of the articles whose ratings needs to be deleted with (,) seperated.

Returns

\JSONstring

deleteRating()

deleteRating(\JSONstring  $client_data) : \JSONstring

Function to delete a rating based on oxid of the rating.

Parameters

\JSONstring $client_data

json string with 'ratingId'=>oxid of a rating to delete.

Returns

\JSONstring

deleteRatings()

deleteRatings(\JSONstring  $client_data) : \JSONstring

Function to delete multiple ratings based on oxid of the ratings.

Parameters

\JSONstring $client_data

json string with 'ratingIds'=>oxids of the ratings to be deleted with (,) seperated.

Returns

\JSONstring

assignCategory()

assignCategory(\JSONstring  $client_data) : \JSONstring

Function to assign category to an article

Parameters

\JSONstring $client_data

json string with 'oxid'=>OXID, 'articleId'=>ArticleId to be assigned, 'catId'=>Category Id to assign

Returns

\JSONstring

unassignCategory()

unassignCategory(\JSONstring  $client_data) : \JSONstring

Function to unassign category to an article

Parameters

\JSONstring $client_data

json string with 'articleId'=>ArticleId to be unassigned, 'catId'=>Category Id to unassign

Returns

\JSONstring

fetchCatArticles()

fetchCatArticles(\JSONstring  $client_data) : \JSONstring

Function to get articles of a category

Parameters

\JSONstring $client_data

json string with 'catId'=>Category Id to get its articles.

Returns

\JSONstring

fetchCategories()

fetchCategories(\JSONstring  $client_data) : \JSONstring

Function to get categories

Parameters

\JSONstring $client_data

json string with 'start'=>start index of the fetchCategories result, and 'offset'=>offset index of the fetchCategories result

Returns

\JSONstring

insertCategory()

insertCategory(\JSONstring  $client_data) : \JSONstring

Function to insert a category

Parameters

\JSONstring $client_data

json string with category details as key=>value pairs to insert. Ex: 'oxactive'=>'xxxxx', 'oxtitle'=>'xxxxx'.

Returns

\JSONstring

updateCategory()

updateCategory(\JSONstring  $client_data) : \JSONstring

Function to update a category

Parameters

\JSONstring $client_data

json string with category details as key=>value pairs to update. Ex: 'oxid'=>'xxxxx', 'oxtitle'=>'xxxxx'.

Returns

\JSONstring

getCategory()

getCategory(\JSONstring  $client_data) : \JSONstring

Function to get a category details

Parameters

\JSONstring $client_data

json string with 'categoryId'=> category Id to get the details

Returns

\JSONstring

getSubCats()

getSubCats(\JSONstring  $client_data) : \JSONstring

Function to sub categories a category

Parameters

\JSONstring $client_data

json string with 'categoryId'=> category Id to get its sub categories

Returns

\JSONstring

getParentCategory()

getParentCategory(\JSONstring  $client_data) : \JSONstring

Function to get parent category of a category

Parameters

\JSONstring $client_data

json string with 'categoryId'=> category Id to get its parent category.

Returns

\JSONstring

setParentCategory()

setParentCategory(\JSONstring  $client_data) : \JSONstring

Function to set parent category for a category

Parameters

\JSONstring $client_data

json string with 'subcategoryId'=>category Id to set it as a child category, and 'parentcategoryId'=> category Id to set it as a parent category.

Returns

\JSONstring

getMostOrderedCategory()

getMostOrderedCategory() : \JSONstring

Function to fetch category which ordered most number of times.

Returns

\JSONstring

getMostOrderedCategoryDay()

getMostOrderedCategoryDay() : \JSONstring

Function to fetch category which ordered most number of times in current day.

Returns

\JSONstring

getMostOrderedCategoryMonth()

getMostOrderedCategoryMonth() : \JSONstring

Function to fetch category which ordered most number of times in current month.

Returns

\JSONstring

getMostOrderedCategoryYear()

getMostOrderedCategoryYear() : \JSONstring

Function to fetch category which ordered most number of times in current year.

Returns

\JSONstring

fetchGroupsAssigned()

fetchGroupsAssigned(\JSONstring  $client_data) : \JSONstring

Function to fetch groups assigned for an user

Parameters

\JSONstring $client_data

json string with 'objectId'=> oxid of the user to get the groups assigned to it.

Returns

\JSONstring

insertUserGroup()

insertUserGroup(\JSONstring  $client_data) : \JSONstring

Function to insert group

Parameters

\JSONstring $client_data

json string with group details as key=>value pairs to insert. Ex: 'oxactive'=>'xxxxx', 'oxtitle'=>'xxxxx'.

Returns

\JSONstring

updateUserGroup()

updateUserGroup(\JSONstring  $client_data) : \JSONstring

Function to update group

Parameters

\JSONstring $client_data

json string with group details as key=>value pairs to update. Ex: 'oxid'=>'xxxxx', 'oxtitle'=>'xxxxx'.

Returns

\JSONstring

deleteUserGroup()

deleteUserGroup(\JSONstring  $client_data) : \JSONstring

Function to delete group

Parameters

\JSONstring $client_data

json string with 'groupId'=> oxid of the group to delete.

Returns

\JSONstring

unAssignUsers()

unAssignUsers(\JSONstring  $client_data) : \JSONstring

Function to un-assign users to a group

Parameters

\JSONstring $client_data

json string with 'groupId'=> oxid of the group to unassign all users from it.

Returns

\JSONstring

fetchGroupUsers()

fetchGroupUsers(\JSONstring  $client_data) : \JSONstring

Function to fetch group users

Parameters

\JSONstring $client_data

json string with 'groupId'=> oxid of the group to fetch it's users.

Returns

\JSONstring

getMostOrderedUserGroup()

getMostOrderedUserGroup() : \JSONstring

Function to fetch usergroup from which users ordered most number of times.

Returns

\JSONstring

getMostOrderedUserGroupDay()

getMostOrderedUserGroupDay() : \JSONstring

Function to fetch usergroup from which users ordered most number of times in current day.

Returns

\JSONstring

getMostOrderedUserGroupMonth()

getMostOrderedUserGroupMonth() : \JSONstring

Function to fetch usergroup from which users ordered most number of times in current month.

Returns

\JSONstring

getMostOrderedUserGroupYear()

getMostOrderedUserGroupYear() : \JSONstring

Function to fetch usergroup from which users ordered most number of times in current year.

Returns

\JSONstring

getUserGroupOrders()

getUserGroupOrders(\JSONstring  $client_data) : \JSONstring

Function to fetch order details which are ordered by a specific usergroup.

Parameters

\JSONstring $client_data

json string with 'groupId'=> oxid of the group whose orders to be fetched

Returns

\JSONstring

insertNotes()

insertNotes(\JSONstring  $client_data) : \JSONstring

Function to insert multiple notes

Parameters

\JSONstring $client_data

json string with remarks details as key=>value pairs to insert. Ex: 'oxparentid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

\JSONstring

insertNote()

insertNote(\JSONstring  $client_data) : \JSONstring

Function to insert note

Parameters

\JSONstring $client_data

json string with remark details as key=>value pairs to insert. Ex: 'oxparentid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

\JSONstring

updateNotes()

updateNotes(\JSONstring  $client_data) : \JSONstring

Function to update multiple notes

Parameters

\JSONstring $client_data

json string with remarks details as key=>value pairs to update. Ex: 'oxid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

\JSONstring

updateNote()

updateNote(\JSONstring  $client_data) : \JSONstring

Function to update note

Parameters

\JSONstring $client_data

json string with remark details as key=>value pairs to update. Ex: 'oxid'=>'xxxxx', 'oxtext'=>'xxxxx'.

Returns

\JSONstring

deleteNotes()

deleteNotes(\JSONstring  $client_data) : \JSONstring

Function to delete multiple notes

Parameters

\JSONstring $client_data

json string with 'noteIds'=> oxid's of the notes which needs to be deleted

Returns

\JSONstring

deleteNote()

deleteNote(\JSONstring  $client_data) : \JSONstring

Function to delete a note

Parameters

\JSONstring $client_data

json string with 'noteId'=> oxid of the note which needs to be deleted

Returns

\JSONstring

fetchThankyouNotes()

fetchThankyouNotes() : \JSONstring

Function to fetch order thankyou email templates

Returns

\JSONstring

fetchRatingRequestTemplates()

fetchRatingRequestTemplates() : \JSONstring

Function to fetch rating request email templates

Returns

\JSONstring

fetchThankyouNoteById()

fetchThankyouNoteById(\JSONstring  $client_data) : \JSONstring

Function to fetch order thankyou email template based on oxid of the template

Parameters

\JSONstring $client_data

json string with 'templateId'=> oxid of the thankyou notes email template

Returns

\JSONstring

fetchRatingRequestTemplateById()

fetchRatingRequestTemplateById(\JSONstring  $client_data) : \JSONstring

Function to fetch rating request email template based on oxid of the template

Parameters

\JSONstring $client_data

json string with 'templateId'=> oxid of the rating request email template

Returns

\JSONstring

updateThankyouNotes()

updateThankyouNotes(\JSONString  $client_data) : \JSONstring

Function to update order thankyou email template based on oxid of the template

Parameters

\JSONString $client_data

json array with 'templateTitle'=>title of the template to be edited, 'templateId'=>oxid of the template to be edited 'templateContent'=> template content

Returns

\JSONstring

updateRatingRequestTemplate()

updateRatingRequestTemplate(\JSONString  $client_data) : \JSONstring

Function to update rating request email template based on oxid of the template

Parameters

\JSONString $client_data

json array with 'templateTitle'=>title of the template to be edited, 'templateId'=>oxid of the template to be edited 'templateContent'=> template content

Returns

\JSONstring

deleteThankyouNotes()

deleteThankyouNotes(array  $client_data) : \JSONstring

Function to delete order thankyou email template based on oxid of the template

Parameters

array $client_data

json array with 'templateId'=>oxid of the template to be deleted

Returns

\JSONstring

deleteRatingRequestTemplate()

deleteRatingRequestTemplate(array  $client_data) : \JSONstring

Function to delete rating request email template based on oxid of the template

Parameters

array $client_data

json array with 'templateId'=>oxid of the template to be deleted

Returns

\JSONstring

sendThankyouNote()

sendThankyouNote(array  $client_data) : \JSONstring

Function to send thankyou email template to the user

Parameters

array $client_data

json array with 'eSubject' => subject of the email template to be sent, 'eBody' => content of the email template to be sent, 'eMailid' => email id of the user, 'orderId' => oxid of the order

Returns

\JSONstring

sendRatingRequest()

sendRatingRequest(array  $client_data) : \JSONstring

Function to send rating request email template to the user

Parameters

array $client_data

json array with 'eSubject' => subject of the email template to be sent, 'eBody' => content of the email template to be sent, 'eMailid' => email id of the user, 'orderId' => oxid of the order

Returns

\JSONstring

loadVisitors()

loadVisitors(\JSONstring  $client_data) : \JSONstring

Function to fetch frequently visited users details based on year

Parameters

\JSONstring $client_data

json array with 'year'=>year number

Returns

\JSONstring

getFrequentVisitorsMonth()

getFrequentVisitorsMonth() : \JSONstring

Function to fetch frequently visited users details of current month

Returns

\JSONstring

loadUsers()

loadUsers(\JSONstring  $client_data) : \JSONstring

Function to fetch registered users count based on year

Parameters

\JSONstring $client_data

json array with 'year'=>year number

Returns

\JSONstring

loadOrders()

loadOrders(\JSONstring  $client_data) : \JSONstring

Function to fetch number of orders and revenue details based on year

Parameters

\JSONstring $client_data

json array with 'year'=>year number

Returns

\JSONstring

getRegisteredUsersToday()

getRegisteredUsersToday() : \JSONstring

Function to fetch total registered users for current day

Returns

\JSONstring

getRegisteredUsersYesterday()

getRegisteredUsersYesterday() : \JSONstring

Function to fetch total registered users for yesterday

Returns

\JSONstring

getRegisteredUsersWeek()

getRegisteredUsersWeek() : \JSONstring

Function to fetch total registered users for current week

Returns

\JSONstring

getRegisteredUsersLastWeek()

getRegisteredUsersLastWeek() : \JSONstring

Function to fetch total registered users for last week

Returns

\JSONstring

getRegisteredUsersMonth()

getRegisteredUsersMonth() : \JSONstring

Function to fetch total registered users for current month

Returns

\JSONstring

getRegisteredUsersLastMonth()

getRegisteredUsersLastMonth() : \JSONstring

Function to fetch total registered users for last month

Returns

\JSONstring

getRegisteredUsersYear()

getRegisteredUsersYear() : \JSONstring

Function to fetch total registered users for current year

Returns

\JSONstring

getRegisteredUsersLastYear()

getRegisteredUsersLastYear() : \JSONstring

Function to fetch total registered users for last year

Returns

\JSONstring

getDashboardData()

getDashboardData() : \JSONstring

Function to fetch required details for the shopmanager dashboard fetches registered users count for current month fetches shoprevenue for current month fetches frequent visitors for current month

Returns

\JSONstring

fetchPreviousOrderId()

fetchPreviousOrderId(\JSONstring  $client_data) : \JSONstring

Function to fetch previous order details based on oxid

Parameters

\JSONstring $client_data

json array with 'orderId'=> oxid of an order to get its previous order oxid

Returns

\JSONstring

fetchNextOrderId()

fetchNextOrderId(\JSONstring  $client_data) : \JSONstring

Function to fetch next order details based on oxid

Parameters

\JSONstring $client_data

json array with 'orderId'=> oxid of an order to get its next order oxid

Returns

\JSONstring

fetchCouponSeries()

fetchCouponSeries() : \JSONstring

Function to fetch available coupon series and details

Returns

\JSONstring

fetchCouponCodes()

fetchCouponCodes(\JSONstring  $client_data) : \JSONstring

Function to fetch available coupon codes under a coupon series

Parameters

\JSONstring $client_data

json array with 'couponSeriesId'=> oxid of coupon series to fetch its coupon codes 'limit' => limit of coupons to be fetched

Returns

\JSONstring

fetchShopLogo()

fetchShopLogo() : \JSONstring

Function to fetch shop logo

Returns

\JSONstring