API EndPoints

Account

Allows authenticated user to manage personal information

GET /api/Account
Gets the account information for authenticated user

Returns

The user object

Addresses

Allows users to manage addresses

POST /api/Addresses
Saves an address to the database

Parameters
name
string		 The name of the addressee
address1
string		 House number, apartment/building name
address2
string		 Street name, locality
landmark
string		 A nearby landmark for easy location
stateProvinceId
integer		 The state or province id
stateProvinceName
string		 The state or province name if state or province id is not known
city
string		 The name of city
zipPostalCode
string		 The postal code
countryId
integer		 The country id. See Country endpoints to get country info.
countryName
string		 The name of the country
phone
string		 The phone number of the addressee
website
string		 The website address of the addressee
email
string		 The emai laddress of the addressee
addressType
string		 The address type

Can be one of home, office
id
integer		 The unique id of the resource
Returns

A success response object
GET /api/Addresses/{addressId}
Gets a single address for authenticated user

Parameters
addressId(required)

integer

 The id of the address to retrieve
Returns

The address object along with availableCountries and availableAddressTypes as items lists.
POST /api/Addresses/{addressId}
Deletes an address

Parameters
addressId(required)

integer

 The identifier of the address to be deleted
Returns

A success response object
GET /api/account/addresses
Gets the addresses of authenticated user

Returns

A list of addresses

Authentication

Provides authentication related services including registration, login, password recovery etc.

POST /api/Authentication/login
Authenticates a user

Parameters
email
string		 The email of the user
password
string		 The password of the user
rememberMe
boolean		 If a long live cookie should be created. The parameter is ignored if token is set to true
returnUrl
string		 The url where the user be redirected after login. The parameter is sent with response.
token
boolean		 If true sends an authentication token in the response. If false, sends an authentication cookie.
Returns

An authentication cookie if token was set to false. Returns a token string if token parameter was sent as true.
POST /api/Authentication/password-reset
Sends a password recovery email to the user

Parameters
email
string		 The email whose password needs to be recovered.
Returns

a success response object and sends password reset email to the user
POST /api/Authentication/password-change
Resets the password of the user

Parameters
currentPassword
string		 The current password of the user. Ignore if a valid code parameter is being passed
code
string		 The code for changing the password. Ignore if currentPassword parameter is being passed
password
string		 The new password for the user
confirmPassword
string		 The confirm password for the user. Should be same as password field
Returns

A success response object
GET /api/Authentication/register
Gets the consents(if any) required to complete the registration

Returns

Success
POST /api/Authentication/register
Registers a new user on the site

Parameters
email
string		 The email of new user
password
string		 The password that'll be used for login. It is case sensitive.
confirmPassword
string		 The password that'll be used for login. This should be same as and is case sensitive.
consents
array		 The consents that the user has agreed or denied to.
Returns

A success response object
GET /api/Authentication/logout
Logs the current user out. Valid only for cookie authentication

Returns

Success

AvailableAttributes

Available attributes are the attributes which are available for creation of product attributes. An available attribute can have multiple pre-defined values.

GET /admin/api/AvailableAttributes/suggestions
Get attribute suggestions based on the query parameter

Parameters
q
string		 The search string for query
Returns

A list of suggestion objects
GET /admin/api/AvailableAttributes/values/suggestions/{attributeId}
Gets suggestions for values corresponding to an attribute

Parameters
attributeId(required)

integer

 The id of the attribute
Returns

A list of suggestion objects
GET /admin/api/AvailableAttributes
Gets the available attributes

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

A list of attributes objects
POST /admin/api/AvailableAttributes
Saves the available attribute to the database

Parameters
name
string		 The name of the attribute
description
string		 The description of the attribute
attributeValues
array		 A list of attributeValues objects
id
integer		 The unique id of the resource
Returns

A success response object
GET /admin/api/AvailableAttributes/{availableAttributeId}
Gets a single attribute

Parameters
availableAttributeId(required)

integer

 The id of available attribute
Returns

The attribute object with specified availableAttributeId
POST /admin/api/AvailableAttributes/delete
Deletes an available attribute

Parameters
attributeId
integer		 The id of the attribute to be deleted
Returns

A success response object

Cart

Allows authenticated user to manage cart

POST /api/Cart/add
Adds a product to the cart of authenticated user

Parameters
productId
integer		 The id of product to be added
attributeJson
string		 The list of product attributes as json. Ignored for POST requests.
comparePrice
number		 The price that'll be used for comparison. Ignored for POST requests.
price
number		 The price of the product
quantity
integer		 The quantity that needs to be added to the cart.
tax
number		 The calculated tax for the product. Ignored for POST requests.
taxPercent
number		 The tax percent for product. Ignored for POST requests.
discount
number		 The discount for the product. Ignored for POST requests.
finalPrice
number		 The final price of the product. Ignored for POST requests.
isWishlist
boolean		 Set to true if product should be added to wishlist instead of cart.
attributes
array		 A collection of attributes that identify a product variant
Returns

A success response object
POST /api/Cart/update
Updates a cart item for authenticated user

Parameters
discountCoupon
string		 The discount coupon to be applied to the cart
giftCode
string		 The gift card to be applied to the cart
cartItemId
integer		 If a cart item is being updated, the id of cart item
quantity
integer		 The updated quantity of the cart item to be updated
removeCoupon
boolean		 Set to true if an already applied coupon needs to be removed from the cart
isWishlist
boolean		 Set to true if updates are being done on wishlist. Set to false if updates are being done on cart
Returns

A success response object
GET /api/account/wishlist
Gets the wishlist of the authenticated user

Returns

The wishlist object

Categories

GET /admin/api/Categories/suggestions

Parameters
q
string
Returns

Success
GET /admin/api/Categories

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Categories

Parameters
fullCategoryPath
string
name
string
description
string
displayOrder
integer
imageUrl
string
parentCategoryId
integer
mediaId
integer
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Categories/{categoryId}

Parameters
categoryId(required)

integer
Returns

Success
POST /admin/api/Categories/tree

Parameters
categories
string
Returns

Success
POST /admin/api/Categories/displayorder

Parameters
categoryModels
array
Returns

Success
POST /admin/api/Categories/delete

Parameters
categoryId
integer
Returns

Success

Checkout

Allows authenticated users to perform checkout activities

POST /api/Checkout/billing-shipping
Saves the address information for the authenticated user's cart

Parameters
useDifferentShippingAddress
boolean		 Set to true to use a different shipping address than the billing address
billingAddress.Name
string		 The name of the addressee
billingAddress.Address1
string		 House number, apartment/building name
billingAddress.Address2
string		 Street name, locality
billingAddress.Landmark
string		 A nearby landmark for easy location
billingAddress.StateProvinceId
integer		 The state or province id
billingAddress.StateProvinceName
string		 The state or province name if state or province id is not known
billingAddress.City
string		 The name of city
billingAddress.ZipPostalCode
string		 The postal code
billingAddress.CountryId
integer		 The country id. See Country endpoints to get country info.
billingAddress.CountryName
string		 The name of the country
billingAddress.Phone
string		 The phone number of the addressee
billingAddress.Website
string		 The website address of the addressee
billingAddress.Email
string		 The emai laddress of the addressee
billingAddress.AddressType
string		 The address type

Can be one of home, office
billingAddress.Id
integer		 The unique id of the resource
shippingAddress.Name
string		 The name of the addressee
shippingAddress.Address1
string		 House number, apartment/building name
shippingAddress.Address2
string		 Street name, locality
shippingAddress.Landmark
string		 A nearby landmark for easy location
shippingAddress.StateProvinceId
integer		 The state or province id
shippingAddress.StateProvinceName
string		 The state or province name if state or province id is not known
shippingAddress.City
string		 The name of city
shippingAddress.ZipPostalCode
string		 The postal code
shippingAddress.CountryId
integer		 The country id. See Country endpoints to get country info.
shippingAddress.CountryName
string		 The name of the country
shippingAddress.Phone
string		 The phone number of the addressee
shippingAddress.Website
string		 The website address of the addressee
shippingAddress.Email
string		 The emai laddress of the addressee
shippingAddress.AddressType
string		 The address type

Can be one of home, office
shippingAddress.Id
integer		 The unique id of the resource
shippingMethod.SystemName
string
shippingMethod.FriendlyName
string
shippingMethod.Description
string
shippingMethod.Fee
number
Returns

A success response object
POST /api/Checkout/payment
Saves the payment information for the authenticated user's cart

Parameters
systemName
string		 The payment method system name
friendlyName
string		 The friendly name for payment method. Ignored for POST requests.
description
string		 The description of payment method. Ignored for POST requests.
fee
number		 The additional fee for payment method. Ignored for POST requests.
url
string		 The url to redirect for payment method processing. Ignored for POST requests.
formCollection
array		 The payment information in key-value format.
orderGuid
string		 The order guid for which this payment method is being used. This is used only for retrying a previously failed order.
Returns

A success response object
POST /api/Checkout/confirm
Completes the checkout process

Returns

Depending on the payment method type, user may be returned with a url to complete the payment with redirection. Returns a unique orderGuid otherwise.

ContentPages

GET /api/ContentPages/contentpages/{contentPageId}
Gets the content page with provided identifier

Parameters
contentPageId(required)

integer

 The id of the page to retrieve.
Returns

The contentPage object.
GET /admin/api/ContentPages

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/ContentPages

Parameters
name
string
content
string
published
boolean
private
boolean
password
string
systemName
string
createdOn
string
updatedOn
string
publishedOn
string
userId
integer
seoMeta.PageTitle
string
seoMeta.MetaDescription
string
seoMeta.MetaKeywords
string
seoMeta.EntityId
integer
seoMeta.EntityName
string
seoMeta.Slug
string
seoMeta.LanguageCultureCode
string
seoMeta.Id
integer		 The unique id of the resource
user.Name
string
user.Id
integer		 The unique id of the resource
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/ContentPages/{contentPageId}

Parameters
contentPageId(required)

integer
Returns

Success
POST /admin/api/ContentPages/delete

Parameters
contentPageId
integer
Returns

Success

Countries

GET /api/Countries/{countryId}/states
Gets the states for a country

Parameters
countryId(required)

integer

 The id of country for which states to be retrieved
Returns

A list of states of the country
GET /admin/api/Countries

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Countries

Parameters
name
string
code
string
published
boolean
shippingEnabled
boolean
displayOrder
integer
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Countries/{countryId}

Parameters
countryId(required)

integer
Returns

Success
GET /admin/api/Countries/{countryId}/states

Parameters
countryId(required)

integer
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Countries/{countryId}/states

Parameters
countryId(required)

integer
name
string
published
boolean
shippingEnabled
boolean
displayOrder
integer
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Countries/{countryId}/states/{stateId}

Parameters
countryId(required)

integer
stateId(required)

integer
Returns

Success
POST /admin/api/Countries/states/delete

Parameters
stateId
integer
Returns

Success

Cultures

GET /admin/api/Cultures/currencieslist

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
GET /admin/api/Cultures/{currencyId}

Parameters
currencyId(required)

integer
Returns

Success
POST /admin/api/Cultures

Parameters
name
string
isoCode
string
exchangeRate
number
cultureCode
string
customFormat
string
flag
string
published
boolean
roundingType
string
Can be one of default, rounddot00, rounddot99, rounddot99or49, rounddot50or00, rounddotx5, rounddotx0
numberOfDecimalPlaces
integer
flagUrl
string
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Cultures/delete

Parameters
currencyId
integer
Returns

Success

Dashboard

GET /api/Dashboard/templates

Parameters
context
string
Returns

Success
POST /api/Dashboard/rawview

Parameters
viewPath
string
Returns

Success
POST /api/Dashboard/set-active-currency
Sets the active currency for user

Parameters
currencyId
integer		 The id of the currency
Returns

A success response object
GET /admin/api/admin

Returns

Success
GET /admin/api/Dashboard/templates/get

Parameters
context
string
Returns

Success

Discounts

GET /admin/api/Discounts

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Discounts

Parameters
name
string
hasCouponCode
boolean
couponCode
string
numberOfTimesPerUser
integer
totalNumberOfTimes
integer
maximumDiscountAmount
number
calculationType
string
Can be one of percentage, fixedamount
discountValue
number
startDate
string
endDate
string
excludeAlreadyDiscountedProducts
boolean
expired
boolean
enabled
boolean
restrictionType
string
Can be one of products, categories, users, usergroups, roles, vendors, manufacturers, paymentmethods, shippingmethods, ordertotal, ordersubtotal
restrictionValues
array
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Discounts/{discountId}

Parameters
discountId(required)

integer
Returns

Success
POST /admin/api/Discounts/{discountId}

Parameters
discountId(required)

integer
Returns

Success
POST /admin/api/Discounts/restriction/delete

Parameters
discountId
integer
restrictionIdentifier
string
Returns

Success

Emails

GET /admin/api/Emails/emailtemplates

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Emails/emailtemplates

Parameters
templateName
string
templateSystemName
string
template
string
isMaster
boolean
parentEmailTemplateId
integer
emailAccountId
integer
subject
string
administrationEmail
string
parentEmailTemplate.TemplateName
string
parentEmailTemplate.TemplateSystemName
string
parentEmailTemplate.Template
string
parentEmailTemplate.IsMaster
boolean
parentEmailTemplate.ParentEmailTemplateId
integer
parentEmailTemplate.EmailAccountId
integer
parentEmailTemplate.Subject
string
parentEmailTemplate.AdministrationEmail
string
parentEmailTemplate.ParentEmailTemplate
object
parentEmailTemplate.EmailAccount.Email
string
parentEmailTemplate.EmailAccount.FromName
string
parentEmailTemplate.EmailAccount.Host
string
parentEmailTemplate.EmailAccount.Port
integer
parentEmailTemplate.EmailAccount.UserName
string
parentEmailTemplate.EmailAccount.Password
string
parentEmailTemplate.EmailAccount.UseSsl
boolean
parentEmailTemplate.EmailAccount.UseDefaultCredentials
boolean
parentEmailTemplate.EmailAccount.IsDefault
boolean
parentEmailTemplate.EmailAccount.TestEmail
string
parentEmailTemplate.EmailAccount.Id
integer		 The unique id of the resource
parentEmailTemplate.Id
integer		 The unique id of the resource
emailAccount
object
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Emails/emailtemplates/{emailTemplateId}

Parameters
emailTemplateId(required)

integer
Returns

Success
POST /admin/api/Emails/emailtemplates/delete

Parameters
id
integer
Returns

Success
GET /admin/api/Emails/emailaccounts

Returns

Success
POST /admin/api/Emails/emailaccounts

Parameters
email
string
fromName
string
host
string
port
integer
userName
string
password
string
useSsl
boolean
useDefaultCredentials
boolean
isDefault
boolean
testEmail
string
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Emails/emailaccounts/{emailAccountId}

Parameters
emailAccountId(required)

integer
Returns

Success
POST /admin/api/Emails/emailaccounts/delete

Parameters
id
integer
Returns

Success
POST /admin/api/Emails/emailaccounts/test

Parameters
email
string
fromName
string
host
string
port
integer
userName
string
password
string
useSsl
boolean
useDefaultCredentials
boolean
isDefault
boolean
testEmail
string
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Emails/emailmessages

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Emails/emailmessages

Parameters
tos
array
ccs
array
bccs
array
replyTos
array
subject
string
emailBody
string
isEmailBodyHtml
boolean
sendingDate
string
isSent
boolean
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Emails/emailmessages/{emailMessageId}

Parameters
emailMessageId(required)

integer
Returns

Success
POST /admin/api/Emails/emailmessages/delete

Parameters
emailMessageId
integer
Returns

Success

Gdpr

GET /api/account/privacy
Gets the current GDPR consents for authenticated user

Returns

A list of consentGroups objects
POST /api/Gdpr/save-consents
Saves the GDPR consents for authenticated users

Parameters
consents
array		 List of consent objects that need to be saved
Returns

A success response object.
GET /admin/api/Gdpr/consent-groups

Returns

Success
POST /admin/api/Gdpr/consent-groups

Parameters
name
string
description
string
displayOrder
integer
isSystemGroup
boolean
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Gdpr/consent-groups/{consentGroupId}

Parameters
consentGroupId(required)

integer
Returns

Success
POST /admin/api/Gdpr/consent-groups/delete

Parameters
consentGroupId
integer
Returns

Success
POST /admin/api/Gdpr/consent-groups/display-order

Parameters
groupModels
array
Returns

Success
GET /admin/api/Gdpr/{consentGroupId}/consents

Parameters
consentGroupId(required)

integer
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
GET /admin/api/Gdpr/{consentGroupId}/consents/{consentId}

Parameters
consentGroupId(required)

integer
consentId(required)

integer
Returns

Success
POST /admin/api/Gdpr/consents

Parameters
title
string
description
string
isPluginSpecificConsent
boolean
pluginSystemName
string
isRequired
boolean
displayOrder
integer
languageCultureCode
string
enableLogging
boolean
published
boolean
consentGroup.Name
string
consentGroup.Description
string
consentGroup.DisplayOrder
integer
consentGroup.IsSystemGroup
boolean
consentGroup.Id
integer		 The unique id of the resource
oneTimeSelection
boolean
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Gdpr/consents/delete

Parameters
consentId
integer
Returns

Success
POST /admin/api/Gdpr/consents/display-order

Parameters
consentModels
array
Returns

Success
GET /admin/api/Gdpr/consent-logs/{userId}

Parameters
userId(required)

integer
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success

Manufacturers

GET /admin/api/Manufacturers/suggestions

Parameters
q
string
Returns

Success
GET /admin/api/Manufacturers

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Manufacturers

Parameters
name
string
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Manufacturers/{manufacturerId}

Parameters
manufacturerId(required)

integer
Returns

Success
POST /admin/api/Manufacturers/delete

Parameters
manufacturerId
integer
Returns

Success

Media

POST /admin/api/Media/upload

Parameters
mediaFile
file
entityName
string
entityId
integer
Returns

Success
POST /admin/api/Media/displayorder

Parameters
media
array
Returns

Success
POST /admin/api/Media/delete

Parameters
mediaId
integer
Returns

Success

Navigation

GET /admin/api/Navigation

Returns

Success
POST /admin/api/Navigation

Parameters
name
string
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Navigation/{menuId}

Parameters
menuId(required)

integer
Returns

Success
POST /admin/api/Navigation/delete

Parameters
menuId
integer
Returns

Success
GET /admin/api/Navigation/{menuId}/menuitems/{parentMenuItemId}

Parameters
menuId(required)

integer
parentMenuItemId(required)

integer
Returns

Success
GET /admin/api/Navigation/{menuId}/menuitem/{menuItemId}

Parameters
menuId(required)

integer
menuItemId(required)

integer
Returns

Success
POST /admin/api/Navigation/{menuId}/menuitems

Parameters
menuId(required)

integer
menuId
integer
parentMenuItemId
integer
name
string
seoMetaId
integer
url
string
displayOrder
integer
cssClass
string
seoMetaTargetName
string
isGroup
boolean
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Navigation/menuitems

Parameters
menuItemId
integer
Returns

Success
POST /admin/api/Navigation/{menuId}/menuitems/displayorder

Parameters
menuId(required)

integer
menuItemModel
array
Returns

Success
POST /admin/api/Navigation/menuitems/bulk

Parameters
categoryIds
array
name
string
url
string
contentPageIds
array
menuId
integer
parentMenuItemId
integer
isGroup
boolean
Returns

Success

Orders

GET /api/Orders/{orderGuid}
Gets the order with provided order identifier

Parameters
orderGuid(required)

string

 The unique order identifier. It's a guid.
Returns

The order object
GET /api/account/orders
Gets orders for the authenticated user

Parameters
fromDate
string		 The start date to search the orders from. Defaults to 6 months old
toDate
string		 The end date to search the orders to. Defaults to today.
orderStatus
string		 The status of order. Can be one of all, open, closed, returned or cancelled
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

A list of orders objects.
GET /admin/api/Orders

Parameters
orderIds
array
vendorIds
array
userId
integer
email
string
productIds
array
orderStatus
array
paymentStatus
array
fromDate
string
toDate
string
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
GET /admin/api/Orders/{orderId}

Parameters
orderId(required)

integer
Returns

Success
GET /admin/api/Orders/{orderId}/shipments

Parameters
orderId(required)

integer
Returns

Success
POST /admin/api/Orders/{orderId}/shipments

Parameters
orderId(required)

integer
trackingNumber
string
remarks
string
shippingMethodName
string
shipmentStatus
string
Can be one of preparing, packaged, intransit, outfordelivery, deliveryfailed, delivered, returned
shipmentItems
array
shipmentHistoryItems
array
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Orders/{orderId}/shipments/{shipmentId}

Parameters
orderId(required)

integer
shipmentId(required)

integer
Returns

Success
POST /admin/api/Orders/{orderId}/shipments/{shipmentId}

Parameters
orderId(required)

integer
shipmentId(required)

integer
Returns

Success
POST /admin/api/Orders/{orderId}/shipment-history

Parameters
shipmentId
integer
shipmentStatus
string
Can be one of preparing, packaged, intransit, outfordelivery, deliveryfailed, delivered, returned
createdOn
string
id
integer		 The unique id of the resource
orderId(required)

string
Returns

Success
POST /admin/api/Orders/{orderId}/shipment-history/delete

Parameters
shipmentId
integer
shipmentStatus
string
Can be one of preparing, packaged, intransit, outfordelivery, deliveryfailed, delivered, returned
createdOn
string
id
integer		 The unique id of the resource
orderId(required)

string
Returns

Success

PaypalWithRedirect

POST /admin/api/PaypalWithRedirect/settings

Parameters
enableSandbox
boolean
clientId
string
clientSecret
string
Returns

Success

Plugins

GET /admin/api/Plugins

Returns

Success
POST /admin/api/Plugins

Parameters
name
string
description
string
version
string
systemName
string
author
string
authorUri
string
pluginUri
string
assemblyName
string
installed
boolean
active
boolean
configurationUrl
string
Returns

Success
GET /admin/api/Plugins/widgets

Returns

Success
POST /admin/api/Plugins/widgets

Parameters
zoneName
string
widgetName
string
widgetSystemName
string
pluginName
string
pluginSystemName
string
displayOrder
integer
widgetZones
array
id
string
hasConfiguration
boolean
configurationUrl
string
Returns

Success
POST /admin/api/Plugins/widgets/displayorder

Parameters
widgetModels
array
Returns

Success
POST /admin/api/Plugins/widgets/delete

Parameters
id
string
Returns

Success

Products

GET /api/s
Searches for specific products in the catalog

Parameters
fromPrice
number		 The lowest price for price range search
toPrice
number		 The highest price for price range search
manufacturerIds
array		 A list of manufacturer ids to restrict the search to
vendorIds
array		 A list of vendor ids to restrict the search to
categoryId
integer		 The category id if the search is restricted to a category
sortColumn
string		 The order of sorting the result. Can be one of name, createdon, price or popularity
sortOrder
string		 The sort order of result

Can be one of ascending, descending
filters
string		 The filter string to filter products. The format should be encoded string of attribute-name1:value1,value2 attribute-name2:value3
search
string
page
integer
count
integer
Returns

A list of products objects
GET /api/Products
Gets products from catalog.

Parameters
fromPrice
number		 The lowest price for price range search
toPrice
number		 The highest price for price range search
manufacturerIds
array		 A list of manufacturer ids to restrict the search to
vendorIds
array		 A list of vendor ids to restrict the search to
categoryId
integer		 The category id if the search is restricted to a category
sortColumn
string		 The order of sorting the result. Can be one of name, createdon, price or popularity
sortOrder
string		 The sort order of result

Can be one of ascending, descending
filters
string		 The filter string to filter products. The format should be encoded string of attribute-name1:value1,value2 attribute-name2:value3
search
string
page
integer
count
integer
viewName
string
Returns

A list of products objects
GET /admin/api/Products

Parameters
categoryIds
array
manufacturerIds
array
vendorIds
array
sortColumn
string
sortOrder
string
Can be one of ascending, descending
published
boolean
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Products

Parameters
name
string
summary
string
description
string
isShippable
boolean
isDownloadable
boolean
isFeatured
boolean
isVisibleIndividually
boolean
trackInventory
boolean
stockQuantity
integer
canOrderWhenOutOfStock
boolean
comparePrice
number
price
number
sku
string
gtin
string
mpn
string
minimumPurchaseQuantity
integer
maximumPurchaseQuantity
integer
parentProductId
integer
displayOrder
integer
chargeTaxes
boolean
published
boolean
manufacturerId
integer
taxId
integer
manufacturerName
string
hasVariants
boolean
media
array
categories
array
seoMeta.PageTitle
string
seoMeta.MetaDescription
string
seoMeta.MetaKeywords
string
seoMeta.EntityId
integer
seoMeta.EntityName
string
seoMeta.Slug
string
seoMeta.LanguageCultureCode
string
seoMeta.Id
integer		 The unique id of the resource
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Products/{productId}

Parameters
productId(required)

integer
Returns

Success
POST /admin/api/Products/{productId}/delete

Parameters
productId(required)

integer
Returns

Success
GET /admin/api/Products/{productId}/attributes

Parameters
productId(required)

integer
Returns

Success
GET /admin/api/Products/{productId}/attributes/{productAttributeId}

Parameters
productId(required)

integer
productAttributeId(required)

integer
Returns

Success
POST /admin/api/Products/attributes

Parameters
productId
integer
name
string
inputFieldType
string
Can be one of text, textarea, wyswyg, number, email, password, checkbox, datetime, radiobutton, color, dropdown, imageupload, fileupload
label
string
displayOrder
integer
isRequired
boolean
values
array
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Products/attributes/delete

Parameters
productAttributeId
integer
Returns

Success
POST /admin/api/Products/attributes/values/delete

Parameters
productAttributeValueId
integer
Returns

Success
GET /admin/api/Products/{productId}/variants

Parameters
productId(required)

integer
Returns

Success
GET /admin/api/Products/{productId}/variants/{productVariantId}

Parameters
productId(required)

integer
productVariantId(required)

integer
Returns

Success
POST /admin/api/Products/variants

Parameters
productId
integer
attributes
array
sku
string
gtin
string
mpn
string
price
number
stockQuantity
integer
trackInventory
boolean
canOrderWhenOutOfStock
boolean
mediaId
integer
productId
integer
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Products/variants/delete

Parameters
productVariantId
integer
Returns

Success
POST /admin/api/Products/categories/displayorder

Parameters
productId
integer
categories
array
Returns

Success
POST /admin/api/Products/categories/delete

Parameters
productId
integer
categories
array
Returns

Success
GET /admin/api/Products/{productId}/specifications

Parameters
productId(required)

integer
Returns

Success
GET /admin/api/Products/{productId}/specifications/{groupId}

Parameters
productId(required)

integer
groupId(required)

integer
Returns

Success
GET /admin/api/Products/{productId}/specifications/{productSpecificationId}/{productSpecificationGroupId}

Parameters
productId(required)

integer
productSpecificationId(required)

integer
productSpecificationGroupId(required)

integer
Returns

Success
GET /admin/api/Products/{productId}/specifications-group/{productSpecificationId}

Parameters
productId(required)

integer
productSpecificationGroupId
integer
productSpecificationId(required)

string
Returns

Success
POST /admin/api/Products/specifications

Parameters
productId
integer
name
string
label
string
displayOrder
integer
isVisible
boolean
isFilterable
boolean
productSpecificationGroupId
integer
productSpecificationGroup.Name
string
productSpecificationGroup.DisplayOrder
integer
productSpecificationGroup.ProductId
integer
productSpecificationGroup.Id
integer		 The unique id of the resource
values
array
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Products/specifications-group

Parameters
name
string
displayOrder
integer
productId
integer
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Products/specifications/delete

Parameters
productSpecificationId
integer
Returns

Success
POST /admin/api/Products/specifications/values/delete

Parameters
productSpecificationValueId
integer
Returns

Success
GET /admin/api/Products/suggestions

Parameters
q
string
Returns

Success
GET /admin/api/Products/{productId}/relations/{relationType}

Parameters
productId(required)

integer
relationType(required)

string
Can be one of relatedproduct, crosssell, upsell, frequentlyboughttogether
Returns

Success
POST /admin/api/Products/relations

Parameters
productId
integer
relationType
string
Can be one of relatedproduct, crosssell, upsell, frequentlyboughttogether
destinationProductIds
array
isReciprocal
boolean
Returns

Success
POST /admin/api/Products/relations/delete

Parameters
productRelationId
integer
Returns

Success

Reports

GET /admin/api/Reports/stock-report

Parameters
productSearch
string
published
boolean
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
GET /admin/api/Reports/orders-report

Parameters
orderStatus
array
paymentStatus
array
startDate
string
endDate
string
groupBy
string
Can be one of days, weeks, months, years
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
GET /admin/api/Reports/user-orders-report

Parameters
orderStatus
array
paymentStatus
array
startDate
string
endDate
string
groupBy
string
Can be one of days, weeks, months, years
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
GET /admin/api/Reports/products-report

Parameters
startDate
string
endDate
string
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success

Reviews

POST /api/Reviews/reviews
Saves a product review

Parameters
rating
integer		 The rating value between 1 and 5
title
string		 The title of the review
description
string		 The description of the review
verifiedPurchase
boolean		 Specifies if the review was posted by the user who bought from the store. Ignored for POST requests.
createdOn
string		 The creation date of review. Ignored for POST requests.
private
boolean		 Specifies if user information should be kept private or public
displayName
string		 The display name of user for review. Ignored for POST requests.
productId
integer		 The id of product for which review is being posted
orderId
integer		 The id of order for which review is being posted
product.Name
string
product.Summary
string
product.Description
string
product.IsShippable
boolean
product.IsDownloadable
boolean
product.IsFeatured
boolean
product.IsVisibleIndividually
boolean
product.CanOrderWhenOutOfStock
boolean
product.ComparePrice
number
product.Price
number
product.Sku
string
product.Gtin
string
product.Mpn
string
product.MinimumPurchaseQuantity
integer
product.MaximumPurchaseQuantity
integer
product.CreatedOn
string
product.UpdatedOn
string
product.DisplayOrder
integer
product.ChargeTaxes
boolean
product.Published
boolean
product.Deleted
boolean
product.ManufacturerId
integer
product.TaxId
integer
product.HasVariants
boolean
product.IsAvailable
boolean
product.SeName
string
product.ReviewSummary.AverageRating
number
product.ReviewSummary.TotalReviews
integer
product.ReviewSummary.TotalRatings
integer
product.Media
array
product.ProductAttributes
array
product.ProductSpecificationGroups
array
product.Id
integer		 The unique id of the resource
id
integer		 The unique id of the resource
Returns

A success response object
POST /api/Reviews/reviews/{reviewId}
Deletes a product review

Parameters
reviewId(required)

integer

 The id of the review
Returns

A success response object
GET /api/Reviews/reviews/{productId}
Gets product reviews

Parameters
productId(required)

integer

 The id of the product
verifiedPurchase
boolean		 true if only reviews with verified purchase should be returned. false otherwise.
rating
integer		 Set to a value to search reviews of that rating value
search
string
page
integer
count
integer
Returns

A list of reviews objects, a best and a worst review object, a product object and a summary object.
GET /api/account/reviews
Gets the reviews by authenticated user

Parameters
productId
integer		 The id of the product
verifiedPurchase
boolean		 true if only reviews with verified purchase should be returned. false otherwise.
rating
integer		 Set to a value to search reviews of that rating value
search
string
page
integer
count
integer
Returns

A list of reviews objects and a summary object.
GET /api/Reviews/reviews/user/pending
Gets pending reviews for authenticated user

Returns

A list of pendingReviews objects.
GET /admin/api/Reviews

Parameters
published
boolean
productId
integer
productSearch
string
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Reviews

Parameters
rating
integer
title
string
description
string
verifiedPurchase
boolean
createdOn
string
private
boolean
displayName
string
productId
integer
orderId
integer
productName
string
userId
integer
userName
string
published
boolean
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Reviews/delete

Parameters
reviewId
integer
Returns

Success
GET /admin/api/Reviews/{reviewId}

Parameters
reviewId(required)

integer
Returns

Success

Roles

GET /admin/api/Roles

Returns

Success
POST /admin/api/Roles

Parameters
name
string
systemName
string
isActive
boolean
isSystemRole
boolean
capabilities
array
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Roles/delete

Parameters
roleId
integer
Returns

Success
GET /admin/api/Roles/{roleId}

Parameters
roleId(required)

integer
Returns

Success

ScheduledTasks

GET /admin/api/ScheduledTasks

Parameters
enableStatus
boolean
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/ScheduledTasks

Parameters
name
string
seconds
integer
systemName
string
enabled
boolean
isRunning
boolean
lastStartDateTime
string
lastEndDateTime
string
lastSuccessDateTime
string
stopOnError
boolean
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/ScheduledTasks/{scheduledTaskId}

Parameters
scheduledTaskId(required)

integer
Returns

Success
POST /admin/api/ScheduledTasks/run

Parameters
scheduledTaskSystemName
string
Returns

Success

Settings

GET /admin/api/Settings/{settingType}

Parameters
settingType(required)

string
Returns

Success
POST /admin/api/Settings/{settingType}

Parameters
storeName
string
storeDomain
string
defaultTimeZoneId
string
logoId
integer
faviconId
integer
enableBreadcrumbs
boolean
primaryNavigationId
integer
enableJsBundling
boolean
enableCssBundling
boolean
enableHtmlMinification
boolean
settingType(required)

string
Returns

Success

Taxes

GET /admin/api/Taxes

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Taxes

Parameters
name
string
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Taxes/{taxId}

Parameters
taxId(required)

integer
Returns

Success
POST /admin/api/Taxes/delete

Parameters
taxId
integer
Returns

Success
GET /admin/api/Taxes/{taxId}/taxrates

Parameters
taxId(required)

integer
Returns

Success
POST /admin/api/Taxes/{taxId}/taxrates

Parameters
taxId(required)

integer
countryId
integer
stateOrProvinceId
integer
zipOrPostalCode
string
countryName
string
stateOrProvinceName
string
rate
number
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Taxes/{taxId}/taxrates/{taxRateId}

Parameters
taxId(required)

integer
taxRateId(required)

integer
Returns

Success
POST /admin/api/Taxes/taxrates/delete

Parameters
taxRateId
integer
Returns

Success

UiSlider

GET /admin/api/UiSlider/configure

Returns

Success
GET /admin/api/UiSlider/{slideId}

Parameters
slideId(required)

integer
Returns

Success
GET /admin/api/UiSlider/list

Returns

Success
POST /admin/api/UiSlider

Parameters
title
string
mediaId
integer
displayOrder
integer
visible
boolean
imageUrl
string
url
string
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/UiSlider/{slideId}/delete

Parameters
slideId(required)

integer
Returns

Success
POST /admin/api/UiSlider/displayorder

Parameters
slideModels
array
Returns

Success

Users

POST /api/Users
Saves authenticated user's information

Parameters
firstName
string		 The first name of the user
lastName
string		 The last name of the user
name
string		 The full name of the user. Ignored for POST requests.
email
string		 The email of the user
companyName
string		 The company name of the user
mobileNumber
string		 The mobile number of the user
dateOfBirth
string		 The date of birth of the user
referrer
string		 The referrer of the user. Ignored for POST requests.
newslettersEnabled
boolean		 true if user has subscribed to newsletters. false otherwise.
id
integer		 The unique id of the resource
Returns

A success response object
GET /admin/api/Users

Parameters
roleIds
array
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Users

Parameters
firstName
string
lastName
string
name
string
email
string
companyName
string
mobileNumber
string
guid
string
active
boolean
dateCreated
string
dateUpdated
string
lastLoginDate
string
remarks
string
lastLoginIpAddress
string
referrerId
integer
roles
array
password
string
confirmPassword
string
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Users/{userId}

Parameters
userId(required)

integer
Returns

Success
POST /admin/api/Users/delete

Parameters
userId
integer
Returns

Success
GET /admin/api/Users/{userId}/addresses

Parameters
userId(required)

integer
Returns

Success
GET /admin/api/Users/{userId}/addresses/{addressId}

Parameters
userId(required)

integer
addressId(required)

integer
Returns

Success
POST /admin/api/Users/addresses

Parameters
userId
integer
name
string
address1
string
address2
string
landmark
string
stateProvinceId
integer
stateProvinceName
string
city
string
zipPostalCode
string
countryId
integer
countryName
string
phone
string
website
string
email
string
addressType
string
Can be one of home, office
id
integer		 The unique id of the resource
Returns

Success
POST /admin/api/Users/addresses/delete

Parameters
addressId
integer
Returns

Success
GET /admin/api/Users/{userId}/orders

Parameters
userId(required)

integer
orderIds
array
vendorIds
array
userId
integer
email
string
productIds
array
orderStatus
array
paymentStatus
array
fromDate
string
toDate
string
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
GET /admin/api/Users/{userId}/capabilities

Parameters
userId(required)

integer
Returns

Success
POST /admin/api/Users/{userId}/capabilities

Parameters
userId(required)

integer
capabilityIds
array
Returns

Success
GET /admin/api/Users/{userId}/cart

Parameters
userId(required)

integer
Returns

Success
POST /admin/api/Users/{userId}/anonymize

Parameters
userId(required)

integer
Returns

Success

Vendors

GET /admin/api/Vendors

Parameters
searchPhrase
string		 The text to search within the query
current
integer		 The page being requested in a paginated request. Default is 1.
rowCount
integer		 The total number of result rows to be returned
Returns

Success
POST /admin/api/Vendors

Parameters
name
string
gstNumber
string
tin
string
pan
string
address
string
stateProvinceId
integer
stateProvinceName
string
city
string
countryId
integer
zipPostalCode
string
phone
string
email
string
id
integer		 The unique id of the resource
Returns

Success
GET /admin/api/Vendors/{vendorId}

Parameters
vendorId(required)

integer
Returns

Success
POST /admin/api/Vendors/{vendorId}

Parameters
vendorId(required)

integer
Returns

Success

Widget

GET /admin/api/Widget/configure

Parameters
id
string
Returns

Success
POST /admin/api/Widget/configure

Parameters
id
string
Returns

Success

ON THIS PAGE
© 2022 Sojatia Infocrafts Pvt. Ltd. All rights reserved. Powered by onlyDoc.