API Methods
|
API end point |
Method type |
Section |
Details |
|
|
/api/PublicGeneral/Ping |
GET |
Common |
Ping to check the API server status |
|
|
/api/PublicGeneral/GetSettings |
GET |
Common |
To get all applicable settings. |
|
|
/api/PublicGeneral/GetSettingsByName |
GET |
Common |
To get settings by name |
|
|
/api/PublicGeneral/GetLocaleStringResources |
GET |
Common |
To get all applicable resource strings per language. |
|
|
/api/PublicGeneral/GetAllTopics |
GET |
Common |
To get all topics |
|
|
/api/PublicGeneral/GetTopic |
GET |
Common |
To get the specific topic (page) by topic identifier |
|
|
/api/PublicGeneral/GetTopic |
GET |
Common |
To get the specific topic (page) by system name |
|
|
/api/PublicCommon/GetStates |
GET |
Common |
States - To get all states of specific country |
|
|
/api/PublicCommon/GetEntityBySlug |
GET |
Common |
Entity Slug - To find entity |
|
|
/api/PublicGeneral/AuthenticateTopic |
POST |
Common |
Authenticate the topic (page) |
|
|
12 |
/api/PublicCommon/GetSitemap |
GET |
Common |
Prepare the sitemap model |
|
/api/PublicCommon/GetTaxTypes |
GET |
Header |
TaxTypeSelector - To provide tax selector drop-down. |
|
|
/api/PublicCommon/SetTaxType |
POST |
Header |
TaxTypeSelector - To set default tax type for current customer. |
|
|
/api/PublicCommon/GetCurrencies |
GET |
Header |
CurrencySelector - To provide currency selector drop-down. |
|
|
/api/PublicCommon/SetCurrency |
POST |
Header |
CurrencySelector - To set default currency for current customer. |
|
|
/api/PublicCommon/GetLanguages |
GET |
Header |
LanguagesSelector - To provide language selector drop-down. |
|
|
/api/PublicCommon/SetLanguage |
POST |
Header |
LanguagesSelector - To set default language for current customer. |
|
|
/api/PublicGeneral/GetHeaderInfo |
GET |
Header |
HeaderInfo - To get header link information |
|
|
/api/PublicCategory/GetTopMenu |
GET |
Header |
TopMenu - To get top menu |
|
|
/api/PublicGeneral/GetNivoSlider |
GET |
Home |
To get Nivo Slider |
|
|
/api/PublicCategory/GetHomepageCategories |
GET |
Home |
HomePageCategories - To get all home page categories |
|
|
/api/PublicProduct/GetHomepageProducts |
GET |
Home |
HomePageProducts - To get all home page products |
|
|
/api/PublicProduct/GetBestSellers |
GET |
Home |
BestSellers - To get all best seller products |
|
|
/api/PublicNews/GetHomepageNews |
GET |
Home |
HomePageNews - To get all home page news |
|
|
/api/PublicGeneral/GetHomepagePolls |
GET |
Home |
HomePagePolls - To get all home page polls |
|
|
/api/PublicGeneral/PollsVote |
POST |
Home |
HomePagePolls - To vote poll by poll answer id |
|
|
/api/PublicGeneral/GetFooterInfo |
GET |
Footer |
FooterInfo - To get all footer information |
|
|
/api/PublicGeneral/GetSubscribeNewsletter |
GET |
Newsletter |
Newsletter - To prepare newsletter |
|
|
/api/PublicGeneral/SubscribeNewsletter |
POST |
Newsletter |
Newsletter - To subscribe to the news letters |
|
|
/api/PublicCustomer/GetLogin |
GET |
Login |
Login - To get login details |
|
|
/api/PublicCustomer/GetGuestToken |
GET |
Login |
Guest token - to get guest token (guest login) |
|
|
/api/PublicCustomer/RefreshToken |
GET |
Login |
Refresh token - to refresh access token on expiration |
|
|
/api/PublicCustomer/Login |
POST |
Login |
Login - To login with any customer |
|
|
/api/PublicCustomer/GetRegister |
GET |
Register |
Register - To get register details |
|
|
/api/PublicCustomer/Register |
POST |
Register |
Register - To registered customer with fill customer all details |
|
|
/api/PublicCustomer/GetPasswordRecovery |
GET |
Forgot password |
To prepared customer password recovery |
|
|
/api/PublicCustomer/PasswordRecovery |
POST |
Forgot password |
To submit customer password recovery |
|
|
/api/PublicCustomer/Impersonate |
POST |
Impersonate |
Impersonate - To impersonated customer |
|
|
/api/PublicCustomer/Logout |
POST |
Logout |
Logout - To logout current customer |
|
|
/api/PublicCustomer/GetCustomerNavigation |
GET |
Customer navigation |
To get customer navigation |
|
|
/api/Publiccustomer/GetInfo |
GET |
Customer info |
Customer info - To get a customer information |
|
|
/api/PublicCustomer/UpdateInfo |
PUT |
Customer info |
Customer info - To update customer information |
|
|
/api/PublicCustomer/CheckUsernameAvailability |
POST |
Customer info |
Customer info - To check username availability |
|
|
/api/PublicCustomer/GetAddresses |
GET |
Customer Address |
Customer Address - To get customer address list |
|
|
/api/PublicCustomer/GetAddress |
GET |
Customer Address |
Customer Address - To get customer address by address id |
|
|
/api/PublicCustomer/GetAddAddress |
GET |
Customer Address |
Customer Address - To prepared add customer address |
|
|
/api/PublicCustomer/AddAddress |
POST |
Customer Address |
Customer Address - To add a new customer address |
|
|
/api/PublicCustomer/UpdateAddress |
PUT |
Customer Address |
Customer Address - To update a customer address |
|
|
/api/PublicCustomer/DeleteAddress |
DELETE |
Customer Address |
Customer Address - To delete a customer address |
|
|
/api/PublicCustomer/GetChangePassword |
GET |
Change password |
Change password - To prepare change password |
|
|
/api/PublicCustomer/ChangePassword |
POST |
Change password |
Change password - To submit the change password request |
|
|
/api/PublicCustomer/GetCheckGiftCardBalance |
GET |
Gift card balance |
Gift card balance - To prepare check gift card balance |
|
|
/api/PublicCustomer/CheckGiftCardBalance |
POST |
Gift card balance |
Gift card balance - To check gift card balance |
|
|
/api/PublicCustomer/GetDownloadableProducts |
GET |
Downloadable products |
Downloadable products - To get a customer all downloadable products |
|
|
/api/PublicCustomer/GetUserAgreement |
GET |
User agreement |
User agreement - To get user agreement by item guid |
|
|
/api/PublicCustomer/GetAvatar |
GET |
Avatar |
Customer avatar - To get customer avatar |
|
|
/api/PublicCustomer/UploadAvatar |
POST |
Avatar |
Customer avatar - To upload customer avatar |
|
|
/api/PublicCustomer/DeleteAvatar |
DELETE |
Avatar |
Customer avatar - To delete customer avatar |
|
|
/api/PublicCustomer/GetGdprTools |
GET |
Customer GDPR |
Customer GDPR - To prepare GDPR tools |
|
|
/api/PublicCustomer/ExportGdprTools |
POST |
Customer GDPR |
Customer GDPR - To export customer GDPR information |
|
|
/api/PublicCustomer/DeleteGdprTools |
DELETE |
Customer GDPR |
Customer GDPR - To delete request of customer GDPR information |
|
|
/api/PublicCustomer/DeleteExternalAssociation |
DELETE |
External authentication |
To delete the external authentication record |
|
|
/api/PublicCategory/GetCategory |
GET |
Category |
Get category - To get category by category id |
|
|
/api/PublicCategory/GetSubCategories |
GET |
Category |
Get subcategory - To get subcategory by category id |
|
|
/api/PublicCategory/GetCategoryProducts |
GET |
Category |
Get category product - To get category products by category id |
|
|
/api/PublicCategory/GetRootCategories |
GET |
Category |
Root categories - To get all root categories (Common to use for display root navigation) |
|
|
/api/PublicManufacturer/GetManufacturers |
GET |
Manufacturer |
Get manufacturer - To get all manufacturers |
|
|
/api/PublicManufacturer/GetManufacturer |
GET |
Manufacturer |
Get manufacturer - To get manufacturer by manufacturer id |
|
|
/api/PublicManufacturer/GetManufacturerProducts |
GET |
Manufacturer |
Get manufacturer products - To get manufacturer all products by manufacturer id |
|
|
/api/PublicNews/GetAllNews |
GET |
News |
News - To get all news of the current store |
|
|
/api/PublicNews/GetNewsItem |
GET |
News |
News - To get specific news item by news item |
|
|
/api/PublicNews/AddNewsComment |
POST |
News |
News - To add a new news item comment by news item |
|
|
/api/PublicBlog/GetBlogs |
GET |
Blog |
Blog - To get all blog posts |
|
|
/api/PublicBlog/GetBlogMonths |
GET |
Blog |
Blog - To get all blog post tags |
|
|
/api/PublicBlog/GetBlogTags |
GET |
Blog |
Blog - To get all blog post months |
|
|
/api/PublicBlog/GetBlogPost |
GET |
Blog |
Blog - To get blog post |
|
|
/api/PublicBlog/AddBlogComment |
POST |
Blog |
Blog - To add comment to a blog post |
|
|
/api/PublicVendor/GetVendors |
GET |
Vendor |
Vendor - To get all vendors |
|
|
/api/PublicVendor/GetVendor |
GET |
Vendor |
Vendor - To get a vendor by vendor id |
|
|
/api/PublicVendor/GetApplyVendor |
GET |
Vendor |
Vendor - To prepare apply for vendor |
|
|
/api/PublicVendor/ApplyVendor |
POST |
Vendor |
Vendor - To submit apply for vendor request |
|
|
/api/PublicVendor/GetVendorProducts |
GET |
Vendor |
Vendor - To get a vendor all products by vendor id |
|
|
/api/PublicVendor/GetInfo |
GET |
Vendor |
Vendor - To prepare vendor info |
|
|
/api/PublicVendor/UpdateInfo |
PUT |
Vendor |
Vendor - To update a vendor info |
|
|
/api/PublicVendor/DeletePicture |
GET |
Vendor |
Vendor - To remove vendor picture |
|
|
/api/PublicProduct/GetProductDetails |
GET |
Product |
Product details - To get a product details by product id |
|
|
/api/PublicProduct/GetProductCombinations/ |
GET |
Product |
Product combinations - To get product combinations by product id |
|
|
/api/PublicProduct/ChangeProductAttribute |
POST |
Product |
Change product attributes - To change product attributes by product id |
|
|
/api/PublicShoppingCart/UploadFileProductAttribute |
POST |
Product |
Upload product attributes - To upload product attribute file |
|
|
/api/PublicProduct/EstimateShipping |
POST |
Product |
Estimate shipping - To get product shipping estimations by product id |
|
|
/api/PublicProduct/GetProductReviews |
GET |
Product |
Product review - To get all product relate reviews by product id |
|
|
/api/PublicProduct/AddProductReviews |
POST |
Product |
Add product review - To add product relate review by product id |
|
|
/api/PublicProduct/SetProductReviewHelpfulness |
POST |
Product |
To set product review helpfulness |
|
|
/api/PublicProduct/GetCustomerProductReviews |
GET |
Product |
To get product customer reviews |
|
|
/api/PublicProduct/GetProductEmailAFriend |
GET |
Product |
To prepared product email a friend |
|
|
/api/PublicProduct/ProductEmailAFriend |
POST |
Product |
To email the product to a friend |
|
|
/api/PublicProduct/GetRelatedProducts |
GET |
Product |
Related products - To get all related products |
|
|
/api/PublicProduct/GetProductsAlsoPurchased |
GET |
Product |
To get also purchased all products |
|
|
100 |
/api/PublicProduct/GetCrossSellProducts |
GET |
Product |
To get cross sell products |
|
/api/PublicProduct/GetNewProducts |
GET |
Product |
To get marked as new products |
|
|
102 |
/api/PublicProduct/GetProductOverview |
GET |
Product |
To prepare the product overview models |
|
/api/PublicProduct/GetPopularProductTags |
GET |
Product tags |
Product tags - To get all popular product tags |
|
|
/api/PublicProduct/GetTagProducts |
GET |
Product tags |
Product tags - Get products by product tag id |
|
|
/api/PublicShoppingCart/AddToCart |
POST |
Add to cart |
Add to cart - add product to cart by product id |
|
|
/api/PublicShoppingCart/AddToWishlist |
POST |
Add to wishlist |
Add to cart - Add product to wishlist by product id |
|
|
/api/PublicShoppingCart/GetWishlist |
GET |
Wishlist |
Wishlist - To get customer wishlist |
|
|
/api/PublicShoppingCart/GetEmailWishlist |
GET |
Wishlist |
Wishlist - To prepare email wishlist |
|
|
/api/PublicShoppingCart/EmailWishlist |
POST |
Wishlist |
Wishlist - To send wish list link on email |
|
|
/api/PublicShoppingCart/UpdateWishlistItemsQuantity |
PUT |
Wishlist |
Wishlist - To update quantities of wish list items |
|
|
/api/PublicShoppingCart/DeleteWishlistItems |
DELETE |
Wishlist |
Wishlist - To delete wish list items |
|
|
/api/PublicShoppingCart/MoveWishlistItemsToCart |
POST |
Wishlist |
Wishlist - To move wish list items to cart |
|
|
/api/PublicShoppingCart/GetCart |
GET |
ShoppingCart |
ShoppingCart - To get customer cart |
|
|
/api/PublicShoppingCart/DeleteCartItems |
DELETE |
ShoppingCart |
ShoppingCartItems - To delete cart items |
|
|
/api/PublicShoppingCart/UpdateCartItemsQuantity |
PUT |
ShoppingCart |
ShoppingCartItems - To update quantities of the cart items |
|
|
/api/PublicShoppingCart/GetEstimateShipping |
GET |
ShoppingCart |
Estimate shipping - To prepare estimate shipping on the cart |
|
|
/api/PublicShoppingCart/EstimateShipping |
POST |
ShoppingCart |
Estimate shipping - To set estimate shipping on the cart |
|
|
/api/PublicShoppingCart/SelectShippingOption |
POST |
ShoppingCart |
Estimate shipping option - To select shipping option by shipping option name |
|
|
/api/PublicShoppingCart/GetSelectedCheckoutAttributes |
GET |
ShoppingCart |
Checkout attribute - To get selected checkout attributes |
|
|
/api/PublicShoppingCart/ChangeCheckoutAttribute |
POST |
ShoppingCart |
Checkout attribute - To change and apply checkout attributes |
|
|
/api/PublicShoppingCart/UploadFileCheckoutAttribute |
POST |
ShoppingCart |
Checkout attribute - To upload product attribute file by attribute id |
|
|
/api/PublicShoppingCart/ApplyGiftCard |
POST |
ShoppingCart |
Gift card - To apply gift card coupon |
|
|
/api/PublicShoppingCart/RemoveGiftCardCode |
POST |
ShoppingCart |
Gift card - To remove gift card coupon |
|
|
/api/PublicShoppingCart/ApplyDiscountCoupon |
POST |
ShoppingCart |
Discount - To apply discount coupon |
|
|
/api/PublicShoppingCart/RemoveDiscountCoupon |
POST |
ShoppingCart |
Discount - To apply discount coupon |
|
|
/api/PublicShoppingCart/GetOrderTotals |
GET |
ShoppingCart |
Order total - To get order totals |
|
|
/api/PublicShoppingCart/StartCheckout |
POST |
ShoppingCart |
Start checkout - To validate cart and go on checkout page |
|
|
/api/PublicCheckout/GetOrderSummary |
GET |
Checkout |
Order summary - To get order summary |
|
|
/api/PublicCheckout/GetBillingAddresses |
GET |
Checkout |
Billing address - To get all billing addresses |
|
|
/api/PublicCheckout/SelectBillingAddress |
GET |
Checkout |
Billing address - To select billing address |
|
|
/api/PublicCheckout/AddBillingAddress |
POST |
Checkout |
Billing address - To add a new billing address |
|
|
/api/PublicCheckout/GetShippingAddresses |
GET |
Checkout |
Shipping address - To get all shipping addresses |
|
|
/api/PublicCheckout/SelectShippingAddress |
GET |
Checkout |
Shipping address - To select shipping address |
|
|
/api/PublicCheckout/AddShippingAddress |
POST |
Checkout |
Shipping address - To add a new shipping address |
|
|
/api/PublicCheckout/GetPickupPoints |
GET |
Checkout |
Pickup point - To get all pickup points |
|
|
/api/PublicCheckout/GetShippingMethods |
GET |
Checkout |
Shipping method - To get all shipping methods |
|
|
/api/PublicCheckout/SelectShippingMethod |
POST |
Checkout |
Shipping method - To select shipping method |
|
|
/api/PublicCheckout/GetPaymentMethods |
GET |
Checkout |
Payment method - To get all payment methods |
|
|
/api/PublicCheckout/SelectPaymentMethod |
GET |
Checkout |
Payment method - To select payment method |
|
|
/api/PublicCheckout/GetPaymentInfo |
GET |
Checkout |
Payment info - To prepare payment info |
|
|
/api/PublicCheckout/ValidatePaymentInfo |
POST |
Checkout |
Payment info - To validate the payment info |
|
|
/api/PublicCheckout/GetConfirmOrder |
GET |
Checkout |
Confirm order - To prepare confirm order |
|
|
/api/PublicCheckout/ConfirmOrder |
POST |
Checkout |
Confirm order - To confirm and pay the orde |
|
|
/api/PublicCheckout/GetOrderCompleted |
GET |
Checkout |
Order complete - To get completed order info |
|
|
/api/PublicOrder/GetCustomerOrders |
GET |
Order |
Order - To get current customer all orders |
|
|
/api/PublicOrder/GetOrderDetails |
GET |
Order |
Order - To get specific order details by order id |
|
|
/api/PublicOrder/GetShipmentDetails |
GET |
Order |
Shipment - To get specific shipment details by shipment id |
|
|
/api/PublicOrder/GetPdfInvoice |
GET |
Order |
Pdf invoice - To get order invoice in pdf format by order id |
|
|
/api/PublicOrder/ReOrder |
POST |
Order |
Order - To re-purchase / re-order |
|
|
/api/PublicOrder/RetryPayment |
POST |
Order |
Order - To only redirection payment method type supported by nopCommerce |
|
|
/api/PublicOrder/CancelRecurringPayment |
POST |
Order |
Recurring payment - To cancel recurring payment |
|
|
/api/PublicOrder/RetryLastRecurringPayment |
POST |
Order |
Recurring payment - Retry last recurring payment |
|
|
/api/PublicSearch/GetSearchTermAutoComplete |
GET |
Search |
Search - To get search term auto complete response |
|
|
/api/PublicSearch/GetSearch |
GET |
Search |
Search - To prepare search page. |
|
|
/api/PublicSearch/SearchProducts |
GET |
Search |
Search - To get searched products. |
|
|
/api/PublicGeneral/GetContactUs |
GET |
Contact us |
Contact us - To prepare contact us |
|
|
/api/PublicGeneral/ContactUs |
POST |
Contact us |
Contact us - Submit the contact us request |
|
|
/api/PublicDownload/GetProductSample |
GET |
Download |
To download product sample |
|
|
/api/PublicDownload/GetFileUpload |
GET |
Download |
To download the file upload file |
|
|
/api/PublicDownload/GetDownloadableProduct |
GET |
Download |
To download the downloadable product |
|
|
/api/PublicDownload/GetOrderItemLicense |
GET |
Download |
To download the order license |
|
|
/api/PublicDownload/GetOrderNoteFile |
GET |
Download |
To download the order note file |
|
|
/api/PublicBackInStockSubscription/GetSubscribe |
GET |
Back in stock subscription |
To prepare back in stock subscription model by product id |
|
|
/api/PublicBackInStockSubscription/Subscribe |
POST |
Back in stock subscription |
Subscribe to back in stock product |
|
|
/api/PublicBackInStockSubscription/GetCustomerSubscriptions |
GET |
Back in stock subscription |
To get customer back in stock subscriptions |
|
|
/api/PublicBackInStockSubscription/RemoveCustomerSubscriptions |
POST |
Back in stock subscription |
To out from back in stock subscriptions |
|
|
/api/PublicForum/GetCustomerProfile |
GET |
Forums |
Prepare customer profile |
|
|
/api/PublicForum/GetCustomerForumSubscriptions |
GET |
Forums |
Get customer forum subscriptions |
|
|
/api/PublicForum/GetForums |
GET |
Forums |
To get all forums |
|
|
/api/PublicForum/GetForum |
GET |
Forum |
To get a forums by forum id |
|
|
/api/PublicForum/GetForumGroup |
GET |
Forum |
To get specific forum group |
|
|
/api/PublicForum/SearchForum |
GET |
Forum |
To search into forum |
|
|
/api/PublicForum/GetLastPost |
GET |
Forum |
To get last/latest post |
|
|
/api/PublicForum/GetActiveDiscussionsSmall |
GET |
Forum |
To get active discussions in small for forum's index page |
|
|
/api/PublicForum/GetActiveDiscussions |
GET |
Forum |
Get all active discussions |
|
|
/api/PublicForum/GetCreateTopic |
GET |
Forum |
Prepare create topic |
|
|
/api/PublicForum/GetCreatePost |
GET |
Forum |
Prepare create post |
|
|
/api/PublicForum/GetUpdatePost |
GET |
Forum |
Prepare edit post |
|
|
/api/PublicForum/GetTopic |
GET |
Forum |
Get specific forum topic |
|
|
/api/PublicForum/GetUpdateTopic |
GET |
Forum |
Prepare edit topic |
|
|
/api/PublicForum/GetMoveTopic |
GET |
Forum |
Prepare the move topic |
|
|
/api/PublicForum/WatchForum |
POST |
Forum |
Watch/Unwatch forum |
|
|
/api/PublicForum/WatchTopic |
POST |
Forum |
Watch/Unwatch forum topic |
|
|
/api/PublicForum/CreateTopic |
POST |
Forum |
Create a new forum topic |
|
|
/api/PublicForum/CreatePost |
POST |
Forum |
Create a new forum topic post |
|
|
/api/PublicForum/VotePost |
POST |
Forum |
Vote the post |
|
|
/api/PublicForum/UpdatePost |
PUT |
Forum |
Update the post |
|
|
/api/PublicForum/UpdateTopic |
PUT |
Forum |
Update the topic |
|
|
/api/PublicForum/MoveTopic |
PUT |
Forum |
Move topic to another forum |
|
|
/api/PublicForum/DeleteCustomerForumSubscriptions |
DELETE |
Forum |
Delete customer forum subscriptions |
|
|
/api/PublicForum/DeleteTopic |
DELETE |
Forum |
Delete the topic |
|
|
/api/PublicForum/DeletePost |
DELETE |
Forum |
Delete the post |
|
|
/api/PublicPrivateMessages/GetMessage |
GET |
Message |
Get specific private message |
|
|
/api/PublicPrivateMessages/GetInboxMessages |
GET |
Message |
Get all inbox messages |
|
|
/api/PublicPrivateMessages/GetSentMessages |
GET |
Message |
Get all sent messages |
|
|
/api/PublicPrivateMessages/GetSendMessage |
GET |
Message |
Prepare send message |
|
|
/api/PublicPrivateMessages/SendMessage |
POST |
Message |
Send private message |
|
|
/api/PublicPrivateMessages/MarkAsUnread |
PUT |
Message |
Mark messages as unread (selected) |
|
|
/api/PublicPrivateMessages/DeleteInboxMessages |
DELETE |
Message |
Delete inbox messages (selected) |
|
|
/api/PublicPrivateMessages/DeleteSentMessages |
DELETE |
Message |
Delete sent messages (selected) |
|
|
/api/PublicPrivateMessages/DeleteMessage |
DELETE |
Message |
Delete a private message |
|
|
/api/PublicReturnRequest/GetCustomerReturnRequests |
GET |
Return request |
Get customer return requests |
|
|
/api/PublicReturnRequest/GetReturnRequest |
GET |
Return request |
Prepare return request |
|
|
/api/PublicReturnRequest/UploadFileReturnRequest |
POST |
Return request |
Upload a return request file |
|
|
/api/PublicReturnRequest/ReturnRequest |
POST |
Return request |
Submit a return request |