Account
Allows authenticated user to manage personal information
GET /api/Account Gets the account information for authenticated user ReturnsThe user object |
Addresses
Allows users to manage addresses
POST /api/Addresses Saves an address to the database Parameters
ReturnsA success response object |
GET /api/Addresses/{addressId} Gets a single address for authenticated user Parameters
ReturnsThe address object along with availableCountries and availableAddressTypes as items lists. |
POST /api/Addresses/{addressId} Deletes an address Parameters
ReturnsA success response object |
GET /api/account/addresses Gets the addresses of authenticated user ReturnsA list of addresses |
Authentication
Provides authentication related services including registration, login, password recovery etc.
POST /api/Authentication/login Authenticates a user Parameters
ReturnsAn 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
Returnsa success response object and sends password reset email to the user |
POST /api/Authentication/password-change Resets the password of the user Parameters
ReturnsA success response object |
GET /api/Authentication/register Gets the consents(if any) required to complete the registration ReturnsSuccess |
POST /api/Authentication/register Registers a new user on the site Parameters
ReturnsA success response object |
GET /api/Authentication/logout Logs the current user out. Valid only for cookie authentication ReturnsSuccess |
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
ReturnsA list of suggestion objects |
GET /admin/api/AvailableAttributes/values/suggestions/{attributeId} Gets suggestions for values corresponding to an attribute Parameters
ReturnsA list of suggestion objects |
GET /admin/api/AvailableAttributes Gets the available attributes Parameters
ReturnsA list of attributes objects |
POST /admin/api/AvailableAttributes Saves the available attribute to the database Parameters
ReturnsA success response object |
GET /admin/api/AvailableAttributes/{availableAttributeId} Gets a single attribute Parameters
ReturnsThe attribute object with specified availableAttributeId |
POST /admin/api/AvailableAttributes/delete Deletes an available attribute Parameters
ReturnsA success response object |
Cart
Allows authenticated user to manage cart
POST /api/Cart/add Adds a product to the cart of authenticated user Parameters
ReturnsA success response object |
POST /api/Cart/update Updates a cart item for authenticated user Parameters
ReturnsA success response object |
GET /api/account/wishlist Gets the wishlist of the authenticated user ReturnsThe wishlist object |
Categories
GET /admin/api/Categories/suggestions Parameters
ReturnsSuccess |
GET /admin/api/Categories Parameters
ReturnsSuccess |
POST /admin/api/Categories Parameters
ReturnsSuccess |
GET /admin/api/Categories/{categoryId} Parameters
ReturnsSuccess |
POST /admin/api/Categories/tree Parameters
ReturnsSuccess |
POST /admin/api/Categories/displayorder Parameters
ReturnsSuccess |
POST /admin/api/Categories/delete Parameters
ReturnsSuccess |
Checkout
Allows authenticated users to perform checkout activities
POST /api/Checkout/billing-shipping Saves the address information for the authenticated user's cart Parameters
ReturnsA success response object |
POST /api/Checkout/payment Saves the payment information for the authenticated user's cart Parameters
ReturnsA success response object |
POST /api/Checkout/confirm Completes the checkout process ReturnsDepending 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
ReturnsThe contentPage object. |
GET /admin/api/ContentPages Parameters
ReturnsSuccess |
POST /admin/api/ContentPages Parameters
ReturnsSuccess |
GET /admin/api/ContentPages/{contentPageId} Parameters
ReturnsSuccess |
POST /admin/api/ContentPages/delete Parameters
ReturnsSuccess |
Countries
GET /api/Countries/{countryId}/states Gets the states for a country Parameters
ReturnsA list of states of the country |
GET /admin/api/Countries Parameters
ReturnsSuccess |
POST /admin/api/Countries Parameters
ReturnsSuccess |
GET /admin/api/Countries/{countryId} Parameters
ReturnsSuccess |
GET /admin/api/Countries/{countryId}/states Parameters
ReturnsSuccess |
POST /admin/api/Countries/{countryId}/states Parameters
ReturnsSuccess |
GET /admin/api/Countries/{countryId}/states/{stateId} Parameters
ReturnsSuccess |
POST /admin/api/Countries/states/delete Parameters
ReturnsSuccess |
Cultures
GET /admin/api/Cultures/currencieslist Parameters
ReturnsSuccess |
GET /admin/api/Cultures/{currencyId} Parameters
ReturnsSuccess |
POST /admin/api/Cultures Parameters
ReturnsSuccess |
POST /admin/api/Cultures/delete Parameters
ReturnsSuccess |
Dashboard
GET /api/Dashboard/templates Parameters
ReturnsSuccess |
POST /api/Dashboard/rawview Parameters
ReturnsSuccess |
POST /api/Dashboard/set-active-currency Sets the active currency for user Parameters
ReturnsA success response object |
GET /admin/api/admin ReturnsSuccess |
GET /admin/api/Dashboard/templates/get Parameters
ReturnsSuccess |
Discounts
GET /admin/api/Discounts Parameters
ReturnsSuccess |
POST /admin/api/Discounts Parameters
ReturnsSuccess |
GET /admin/api/Discounts/{discountId} Parameters
ReturnsSuccess |
POST /admin/api/Discounts/{discountId} Parameters
ReturnsSuccess |
POST /admin/api/Discounts/restriction/delete Parameters
ReturnsSuccess |
Emails
GET /admin/api/Emails/emailtemplates Parameters
ReturnsSuccess |
POST /admin/api/Emails/emailtemplates Parameters
ReturnsSuccess |
GET /admin/api/Emails/emailtemplates/{emailTemplateId} Parameters
ReturnsSuccess |
POST /admin/api/Emails/emailtemplates/delete Parameters
ReturnsSuccess |
GET /admin/api/Emails/emailaccounts ReturnsSuccess |
POST /admin/api/Emails/emailaccounts Parameters
ReturnsSuccess |
GET /admin/api/Emails/emailaccounts/{emailAccountId} Parameters
ReturnsSuccess |
POST /admin/api/Emails/emailaccounts/delete Parameters
ReturnsSuccess |
POST /admin/api/Emails/emailaccounts/test Parameters
ReturnsSuccess |
GET /admin/api/Emails/emailmessages Parameters
ReturnsSuccess |
POST /admin/api/Emails/emailmessages Parameters
ReturnsSuccess |
GET /admin/api/Emails/emailmessages/{emailMessageId} Parameters
ReturnsSuccess |
POST /admin/api/Emails/emailmessages/delete Parameters
ReturnsSuccess |
Gdpr
GET /api/account/privacy Gets the current GDPR consents for authenticated user ReturnsA list of consentGroups objects |
POST /api/Gdpr/save-consents Saves the GDPR consents for authenticated users Parameters
ReturnsA success response object. |
GET /admin/api/Gdpr/consent-groups ReturnsSuccess |
POST /admin/api/Gdpr/consent-groups Parameters
ReturnsSuccess |
GET /admin/api/Gdpr/consent-groups/{consentGroupId} Parameters
ReturnsSuccess |
POST /admin/api/Gdpr/consent-groups/delete Parameters
ReturnsSuccess |
POST /admin/api/Gdpr/consent-groups/display-order Parameters
ReturnsSuccess |
GET /admin/api/Gdpr/{consentGroupId}/consents Parameters
ReturnsSuccess |
GET /admin/api/Gdpr/{consentGroupId}/consents/{consentId} Parameters
ReturnsSuccess |
POST /admin/api/Gdpr/consents Parameters
ReturnsSuccess |
POST /admin/api/Gdpr/consents/delete Parameters
ReturnsSuccess |
POST /admin/api/Gdpr/consents/display-order Parameters
ReturnsSuccess |
GET /admin/api/Gdpr/consent-logs/{userId} Parameters
ReturnsSuccess |
Manufacturers
GET /admin/api/Manufacturers/suggestions Parameters
ReturnsSuccess |
GET /admin/api/Manufacturers Parameters
ReturnsSuccess |
POST /admin/api/Manufacturers Parameters
ReturnsSuccess |
GET /admin/api/Manufacturers/{manufacturerId} Parameters
ReturnsSuccess |
POST /admin/api/Manufacturers/delete Parameters
ReturnsSuccess |
Media
POST /admin/api/Media/upload Parameters
ReturnsSuccess |
POST /admin/api/Media/displayorder Parameters
ReturnsSuccess |
POST /admin/api/Media/delete Parameters
ReturnsSuccess |
Navigation
GET /admin/api/Navigation ReturnsSuccess |
POST /admin/api/Navigation Parameters
ReturnsSuccess |
GET /admin/api/Navigation/{menuId} Parameters
ReturnsSuccess |
POST /admin/api/Navigation/delete Parameters
ReturnsSuccess |
GET /admin/api/Navigation/{menuId}/menuitems/{parentMenuItemId} Parameters
ReturnsSuccess |
GET /admin/api/Navigation/{menuId}/menuitem/{menuItemId} Parameters
ReturnsSuccess |
POST /admin/api/Navigation/{menuId}/menuitems Parameters
ReturnsSuccess |
POST /admin/api/Navigation/menuitems Parameters
ReturnsSuccess |
POST /admin/api/Navigation/{menuId}/menuitems/displayorder Parameters
ReturnsSuccess |
POST /admin/api/Navigation/menuitems/bulk Parameters
ReturnsSuccess |
Orders
GET /api/Orders/{orderGuid} Gets the order with provided order identifier Parameters
ReturnsThe order object |
GET /api/account/orders Gets orders for the authenticated user Parameters
ReturnsA list of orders objects. |
GET /admin/api/Orders Parameters
ReturnsSuccess |
GET /admin/api/Orders/{orderId} Parameters
ReturnsSuccess |
GET /admin/api/Orders/{orderId}/shipments Parameters
ReturnsSuccess |
POST /admin/api/Orders/{orderId}/shipments Parameters
ReturnsSuccess |
GET /admin/api/Orders/{orderId}/shipments/{shipmentId} Parameters
ReturnsSuccess |
POST /admin/api/Orders/{orderId}/shipments/{shipmentId} Parameters
ReturnsSuccess |
POST /admin/api/Orders/{orderId}/shipment-history Parameters
ReturnsSuccess |
POST /admin/api/Orders/{orderId}/shipment-history/delete Parameters
ReturnsSuccess |
PaypalWithRedirect
POST /admin/api/PaypalWithRedirect/settings Parameters
ReturnsSuccess |
Plugins
GET /admin/api/Plugins ReturnsSuccess |
POST /admin/api/Plugins Parameters
ReturnsSuccess |
GET /admin/api/Plugins/widgets ReturnsSuccess |
POST /admin/api/Plugins/widgets Parameters
ReturnsSuccess |
POST /admin/api/Plugins/widgets/displayorder Parameters
ReturnsSuccess |
POST /admin/api/Plugins/widgets/delete Parameters
ReturnsSuccess |
Products
GET /api/s Searches for specific products in the catalog Parameters
ReturnsA list of products objects |
GET /api/Products Gets products from catalog. Parameters
ReturnsA list of products objects |
GET /admin/api/Products Parameters
ReturnsSuccess |
POST /admin/api/Products Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId} Parameters
ReturnsSuccess |
POST /admin/api/Products/{productId}/delete Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/attributes Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/attributes/{productAttributeId} Parameters
ReturnsSuccess |
POST /admin/api/Products/attributes Parameters
ReturnsSuccess |
POST /admin/api/Products/attributes/delete Parameters
ReturnsSuccess |
POST /admin/api/Products/attributes/values/delete Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/variants Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/variants/{productVariantId} Parameters
ReturnsSuccess |
POST /admin/api/Products/variants Parameters
ReturnsSuccess |
POST /admin/api/Products/variants/delete Parameters
ReturnsSuccess |
POST /admin/api/Products/categories/displayorder Parameters
ReturnsSuccess |
POST /admin/api/Products/categories/delete Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/specifications Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/specifications/{groupId} Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/specifications/{productSpecificationId}/{productSpecificationGroupId} Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/specifications-group/{productSpecificationId} Parameters
ReturnsSuccess |
POST /admin/api/Products/specifications Parameters
ReturnsSuccess |
POST /admin/api/Products/specifications-group Parameters
ReturnsSuccess |
POST /admin/api/Products/specifications/delete Parameters
ReturnsSuccess |
POST /admin/api/Products/specifications/values/delete Parameters
ReturnsSuccess |
GET /admin/api/Products/suggestions Parameters
ReturnsSuccess |
GET /admin/api/Products/{productId}/relations/{relationType} Parameters
ReturnsSuccess |
POST /admin/api/Products/relations Parameters
ReturnsSuccess |
POST /admin/api/Products/relations/delete Parameters
ReturnsSuccess |
Reports
GET /admin/api/Reports/stock-report Parameters
ReturnsSuccess |
GET /admin/api/Reports/orders-report Parameters
ReturnsSuccess |
GET /admin/api/Reports/user-orders-report Parameters
ReturnsSuccess |
GET /admin/api/Reports/products-report Parameters
ReturnsSuccess |
Reviews
POST /api/Reviews/reviews Saves a product review Parameters
ReturnsA success response object |
POST /api/Reviews/reviews/{reviewId} Deletes a product review Parameters
ReturnsA success response object |
GET /api/Reviews/reviews/{productId} Gets product reviews Parameters
ReturnsA 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
Returns |
GET /api/Reviews/reviews/user/pending Gets pending reviews for authenticated user ReturnsA list of pendingReviews objects. |
GET /admin/api/Reviews Parameters
ReturnsSuccess |
POST /admin/api/Reviews Parameters
ReturnsSuccess |
POST /admin/api/Reviews/delete Parameters
ReturnsSuccess |
GET /admin/api/Reviews/{reviewId} Parameters
ReturnsSuccess |
Roles
GET /admin/api/Roles ReturnsSuccess |
POST /admin/api/Roles Parameters
ReturnsSuccess |
POST /admin/api/Roles/delete Parameters
ReturnsSuccess |
GET /admin/api/Roles/{roleId} Parameters
ReturnsSuccess |
ScheduledTasks
GET /admin/api/ScheduledTasks Parameters
ReturnsSuccess |
POST /admin/api/ScheduledTasks Parameters
ReturnsSuccess |
GET /admin/api/ScheduledTasks/{scheduledTaskId} Parameters
ReturnsSuccess |
POST /admin/api/ScheduledTasks/run Parameters
ReturnsSuccess |
Settings
GET /admin/api/Settings/{settingType} Parameters
ReturnsSuccess |
POST /admin/api/Settings/{settingType} Parameters
ReturnsSuccess |
Taxes
GET /admin/api/Taxes Parameters
ReturnsSuccess |
POST /admin/api/Taxes Parameters
ReturnsSuccess |
GET /admin/api/Taxes/{taxId} Parameters
ReturnsSuccess |
POST /admin/api/Taxes/delete Parameters
ReturnsSuccess |
GET /admin/api/Taxes/{taxId}/taxrates Parameters
ReturnsSuccess |
POST /admin/api/Taxes/{taxId}/taxrates Parameters
ReturnsSuccess |
GET /admin/api/Taxes/{taxId}/taxrates/{taxRateId} Parameters
ReturnsSuccess |
POST /admin/api/Taxes/taxrates/delete Parameters
ReturnsSuccess |
UiSlider
GET /admin/api/UiSlider/configure ReturnsSuccess |
GET /admin/api/UiSlider/{slideId} Parameters
ReturnsSuccess |
GET /admin/api/UiSlider/list ReturnsSuccess |
POST /admin/api/UiSlider Parameters
ReturnsSuccess |
POST /admin/api/UiSlider/{slideId}/delete Parameters
ReturnsSuccess |
POST /admin/api/UiSlider/displayorder Parameters
ReturnsSuccess |
Users
POST /api/Users Saves authenticated user's information Parameters
ReturnsA success response object |
GET /admin/api/Users Parameters
ReturnsSuccess |
POST /admin/api/Users Parameters
ReturnsSuccess |
GET /admin/api/Users/{userId} Parameters
ReturnsSuccess |
POST /admin/api/Users/delete Parameters
ReturnsSuccess |
GET /admin/api/Users/{userId}/addresses Parameters
ReturnsSuccess |
GET /admin/api/Users/{userId}/addresses/{addressId} Parameters
ReturnsSuccess |
POST /admin/api/Users/addresses Parameters
ReturnsSuccess |
POST /admin/api/Users/addresses/delete Parameters
ReturnsSuccess |
GET /admin/api/Users/{userId}/orders Parameters
ReturnsSuccess |
GET /admin/api/Users/{userId}/capabilities Parameters
ReturnsSuccess |
POST /admin/api/Users/{userId}/capabilities Parameters
ReturnsSuccess |
GET /admin/api/Users/{userId}/cart Parameters
ReturnsSuccess |
POST /admin/api/Users/{userId}/anonymize Parameters
ReturnsSuccess |
Vendors
GET /admin/api/Vendors Parameters
ReturnsSuccess |
POST /admin/api/Vendors Parameters
ReturnsSuccess |
GET /admin/api/Vendors/{vendorId} Parameters
ReturnsSuccess |
POST /admin/api/Vendors/{vendorId} Parameters
ReturnsSuccess |
Widget
GET /admin/api/Widget/configure Parameters
ReturnsSuccess |
POST /admin/api/Widget/configure Parameters
ReturnsSuccess |