HomeWiki
HomeWiki
  1. Authentication
  • Back to home
  • 4. Apis
  • Authentication
    • Getting Started
  • Catalog
    • Attributes
      • Attribute Get By id
      • Attribute Update
      • Attribute Delete
      • Attribute Get By Code
      • Attribute Query
      • Attribute Create
      • Attributes Import
      • Attributes_POST_Import
    • AttributeSets
      • Attribute Set Create
      • Attribute Set Query
      • Attribute Set Get By Id
      • Attribute Set Update
      • Attribute Set Delete
      • Attribute Set Import
      • AttributeSets_POST_Import
    • Brands
      • Brand Create
      • Brand Query
      • Brand Delete
      • Brand Get by id
      • Brand Update
      • Brand Get by Alias
      • Brand Import
      • Brands_POST_Import
      • Brand Import By Code
    • Categories
      • Category Get By id
      • Category Update
      • Category Delete
      • Category Get By alias
      • Category Query
      • Category Create
      • Category Import
      • Categories_POST_Import
    • Collections
      • Collection Query
      • Collection Create
      • Collection Get by Id
      • Collection Update
      • Collection Delete
    • Documentations
      • Product Get Additional Content By Id
      • Product Updates Additional Content
      • Product Delete Additional Content
      • Product Get Additional Content By Id (HTML)
      • Category Get Additional Content By Id
      • Category Update Additional Content
      • Category Delete Additional Content
      • Category Get Additional Content By Id (HTML)
      • Collection Get Additional Content By Id
      • Collection Update Additional Content
      • Collection Delete Additional Content
      • Collection Get Additional Content By Id (HTML)
      • Brand Get Additional Content By Id
      • Brand Update Additional Content
      • Brand Delete Additional Content
      • Brand Get Additional Content By Id (HTML)
    • ExtendedProducts
      • Product Extended Get By Alias
      • Product Extended Query
      • ExtendedProducts_GET_GetAllWithoutPrivacy
    • ExtentedCollections
      • Collection Extended Get by Alias
      • Collection Extended Get by Id
      • Collection Extended Query
    • Filters
      • Filters Purge
    • IcoTags
      • Product Label Get By Id
      • Product Label Update
      • Product Label Delete
      • Product Label Query
      • Product Label Create
    • PrivacyGroups
      • Privacy Group Create
      • Privacy Group Query
      • Privacy Group Get By Id
      • Privacy Group Delete
      • Privacy Group Update
    • Products
      • Product Create
      • Product Update
      • Product Delete
      • Product Import By SKU
      • Product Import
      • Products_POST_ImportWithSettings
    • ProductsQuery
      • Product Query
      • Product Get By id
      • Product Get By Alias
    • ProductVariants
      • Get all flat product variants
    • RelatedProducts
      • Related Products Create
      • Related Products Update
      • Related Products Delete
      • Related Products Mass update
    • StockAvailability
      • Stock Availability Create
      • Stock Availability Query
      • Stock Availability Delete
      • Stock Availability Get By Id
      • Stock Availability Update
    • Tags
      • Source Tag Product Import
    • Units
      • Unit Create
      • Unit Query
      • Unit Delete
      • Unit Get By id
      • Unit Update
      • Unit Import
      • Units_POST_Import
  • Automation
    • Infobip
      • /api/Infobip/people
      • /api/Infobip/seed
    • WebHook
      • Get a webhook by id
      • Updates a WebHook
      • Get all WebHooks
      • Register a WebHook <param name="webhookEntity"></param><param name="event"></param><param name="cancellationToken"></param>
      • Deletes a WebHook
    • WorkflowDefinition
      • /api/WorkflowDefinition/{id}
      • /api/WorkflowDefinition/{id}
      • /api/WorkflowDefinition
      • /api/WorkflowDefinition
    • WorkflowExecution
      • /api/WorkflowExecution/{definitionId}
      • /api/WorkflowExecution/{executionId}/status
      • /api/WorkflowExecution/{executionId}/report
  • Cart
    • AnonymousCart
      • AnonymousCart_GET_GetCart
      • AnonymousCart_POST_UpdateAnonymousCart
      • AnonymousCart_DELETE_DeleteUserCart
      • AnonymousCart_POST_CreateAnonymousCart
      • AnonymousCart_PUT_AddToCart
      • AnonymousCart_PUT_AddToCartBySku
      • AnonymousCart_DELETE_RemoveFromCart
    • ShoppingList
      • Shopping List Get By Alias
      • Shopping List Update
      • Shopping List Delete
      • Shopping List Get All
      • Shopping List Create
    • UserCart
      • UserCart_GET_GetAllUserCarts
      • UserCart_GET_GetUserCart
      • UserCart_POST_SetUserCart
      • UserCart_DELETE_DeleteUserCart
      • UserCart_PUT_AddToCart
      • UserCart_PUT_AddToCartBySku
      • UserCart_DELETE_RemoveFromCart
  • Checkout
    • Checkout
      • Checkout Get By Token
      • Checkout Update
      • Checkout Create
      • Checkout Create
      • Checkout Create for Quote
      • Checkout Recalculate
      • Checkout Initiate Payment
      • Checkout Complete Payment
      • Checkout Complete
    • CheckoutRetail
      • Checkout Create
      • Checkout Update
      • Checkout Complete
    • Checkout Create
  • Communicator
    • AlertSettings
      • Get Alert settings
      • Updates Alert settings
    • EmailProfile
      • Creates a new email profile
      • Get a list of all email profiles
      • Get email profile by id
      • Updates an email profile
      • Deletes an email profile by id
    • EmailSettings
      • Get communication settings
      • Updates communication settings
    • EmailTemplate
      • Get an email Template
      • Get an email Template by name
      • update email template
      • Create an email Template
      • Delete an email Template
      • Get email template's Translations
      • Save email template's Translations
      • Compiles all emails
    • FormCommunication
      • Send Form Email
      • Uploads file to storage with chunks
    • OutlookAccount
      • /api/outlook/account/signinUrl
      • /api/outlook/account/signin/{signInStateCode}
      • /api/outlook/account/signinCallback
      • /api/outlook/account/userInfo
    • OutlookCalendar
      • /api/outlook/calendar
    • OutlookContacts
      • /api/outlook/contacts
    • OutlookEmail
      • /api/outlook/email
      • /api/outlook/email
    • Subscribe
      • Adds a user email to the sunbcription list
      • Get all newsletter emails
      • Deletes all newsletter emails
  • Connector
    • Atlantis
      • Get script
      • /api/Atlantis/command/{method}/{channelId}
      • /api/Atlantis/signalr/{method}/{channelId}
      • /api/Atlantis/signalr/{method}/{channelId}
      • /api/Atlantis/script/updated/{channelId}
      • /api/Atlantis/reset/{channelId}
      • Get Views
      • /api/Atlantis/import/{method}/{importType}/{channelId}
      • Get Sales series
      • Get Companies
      • /api/Atlantis/test/{version}/{method}/{channelId}
      • /api/Atlantis/test/queries/{channelId}
    • AtlantisChannel
      • Creates a new Channel
      • Get a channel by id
      • Updates a Channel
      • Deletes Channel
      • /api/channel/atlantis/script/{channelId}
      • Get script default
      • Set script
      • Set script
      • Get staging script
    • Channels
      • Get a channel by id
      • Get All Channels
      • Deletes Channel
    • Connector
      • Calculate connector prices
      • Calculate catalog connector prices
      • Gets last updated times
      • Get customer transactions
      • Get customer transactions with details Used for SFA
      • Get customer balance
    • Datapump
      • Get script
      • Get script default
      • Set script
      • Get script
      • /api/Datapump/reset/{channelId}
      • /api/Datapump/encrypt/certificate
      • /api/Datapump/disconnect
    • DatapumpChannels
      • Creates a new Channel
      • Get a channel by id
      • Updates a Channel
      • Deletes Channel
    • Export
      • Export to connector
    • Import
      • Import Quantities
      • Managing quantities
      • Import Quantities
      • Managing products
      • /api/connector/Import/manage/products/categories/{channelId}/{importType}
      • /api/connector/Import/manage/products/brands/{channelId}/{importType}
      • /api/connector/Import/manage/products/units/{channelId}/{importType}
      • /api/connector/Import/manage/products/attributes/{channelId}/{importType}
      • /api/connector/Import/manage/products/product/{channelId}/{importType}
      • /api/connector/Import/manage/sourcetags/ProductTags/{channelId}
      • /api/connector/Import/manage/sourcetags/CustomerTags/{channelId}
      • Import Source Tags
      • Managing source tags
      • Import Quantities
      • Managing documents
      • Managing documents
      • Managing documents
      • Import Quantities
      • Import Pricing
      • Managing customers
      • Managing pricing
      • Managing source tags
    • LogStream
      • /api/channels/{channelId}/log
      • /api/channels/{channelId}/logStream/start
      • /api/channels/{channelId}/logStream/stop
      • /api/channels/{channelId}/logStream/status
    • Regate
      • Get script
      • /api/Regate/command/{method}/{channelId}
      • /api/Regate/signalr/{method}/{channelId}
      • /api/Regate/signalr/{method}/{channelId}
      • /api/Regate/config/updated/{channelId}
      • /api/Regate/script/updated/{channelId}
      • /api/Regate/reset/{channelId}
      • Get Views
      • /api/Regate/import/{method}/{importType}/{channelId}
      • /api/Regate/test/{version}/{method}/{channelId}
      • /api/Regate/test/queries/{channelId}
    • RegateChannel
      • Creates a new Channel
      • Get a channel by id
      • Updates a Channel
      • Deletes Channel
      • /api/channel/regate/script/{channelId}
      • Get script default
      • Set script
      • Set script
      • Get staging script
      • /api/channel/regate/mock/script/payloads
    • SAP
      • Get script
      • /api/SAP/command/{method}/{channelId}
      • /api/SAP/signalr/{method}/{channelId}
      • /api/SAP/signalr/{method}/{channelId}
      • /api/SAP/script/updated/{channelId}
      • /api/SAP/reset/{channelId}
      • Get Views
      • /api/SAP/import/{method}/{importType}/{channelId}
      • Get Sales series
      • Get Companies
      • /api/SAP/test/{version}/{method}/{channelId}
      • /api/SAP/test/queries/{channelId}
    • SAPChannel
      • Creates a new SAP Channel
      • Get a SAP channel by id
      • Updates SAP a Channel
      • Deletes SAP Channel
      • Get script by Channel Id
      • Get script default
      • Set script
      • Set script
      • Get staging script
    • Softone
      • Get Softone Warehouses
      • Get Softone Customers
      • Get Softone Payment providers
      • Get Softone Carriers
      • Get series
      • Get series
      • Get printForm data
      • Get expenses
      • Get Views
      • Get Views
      • Get softone customers rules
      • Get softone customer product categories rules
      • Get softone customer categories product categories rules
      • Softone Login
      • Check softone login, returns no content on success, throws exception on failure
      • Softone Login and update channel with login selections
      • /api/Softone/test/{version}/{method}/{channelId}
      • /api/Softone/test/queries/{channelId}
    • SoftoneChannels
      • Creates a new Channel
      • Get a channel by id
      • Updates a Channel
      • Deletes Channel
      • Get script
      • Get script default
      • Set script
      • Set script
      • Get staging script
      • /api/channel/softone/mock/script/payloads
  • Content
    • Announcements
      • Creates a new Announcement record.
      • Get a list of AnnouncementDTO records.
      • Get Announcement by its Id
      • Updates an announcement record specified by the Id parameter.
      • Deletes an announcement record specified by the Id parameter.
      • Marks specified announcements as "Read" for a specific shop user.
    • AppSettings
      • get app settings
      • update app settings
      • get app settings
    • Assets
      • get assets
      • create or update custom layout
      • Uploads file to the given path
      • get assets
      • delete asset
      • create or update custom layout
    • Blog
      • Creates a new Blog record.
      • Get a list of BlogDTO records.
      • Get a Blog by its Id
      • Updates a blogs record specified by the Id parameter.
      • /api/Blog/{id}
      • Get a Blog by its alias
      • Get a Blog's content by its Id
    • BlogCategory
      • Creates a new Blog Category record.
      • Get a list of BlogCategoryDTO records.
      • Get a Blog Category by its Id
      • Updates a blog category's record specified by the Id parameter.
      • Deletes a blog category record specified by the Id parameter.
      • /api/blog/category/alias/{alias}
    • BlogComment
      • Creates a new comment record for a specific blog specified by its id.
      • Get a list of BlogCommentDTO records for a specific blog.
      • Updates the status of a list of blog comments specified by their ids
      • Get a Blog comment's content specified by the blogId and commentId parameters.
      • /api/blog/{blogId}/comment/{commentId}
      • Deletes a specific blog comment's record specified by the blogId and commentId parameters.
    • CategoriesList
      • Get Menu by id
    • Components
      • Get Component Views
      • Set Component View template by type
      • Set Component View template by type
      • Set Component View script by type
      • Get Component
      • Delete Component
      • Get Component's Translations
      • Save Component's Translations
      • Get Component
      • Get Theme Component DTO
    • Menus
      • Creates a new Menu
      • Get Menu by id
      • Get By Menu Type
      • Get compiled By Menu Type
      • Updates a Menu
      • Create Category Navigation Tree
    • Migration
      • Get urls by companyid
      • Delete url
      • Add redirect urls
    • Pages
      • Creates a new Page
      • Get a list of Pages
      • Get Page by id
      • Updates a Page
      • Delete a page
      • Get Page by alias
      • Get Page by alias
      • Get Page by alias
      • Get Page by alias
      • Get Page by alias
      • Get a list of changes of a page
      • Get a Page instance that was edited in the past
      • Restores a previous page revision
      • Select a theme by name
      • Select a theme by name
      • Select a theme by name
      • Update and publish a page
      • Update and publish a page new version
    • Reusables
      • Get Reusable Component's Translations
      • Save Reusable Component's Translations
      • Get All Reusable Components
      • Get All Reusable Components
      • Create a reusable Component
      • Set Reusable Component by name
      • Delete Reusable Component by name
      • Set Reusable Component Template by name
      • Set Reusable Component Script by name
    • Template
      • Get Template by Company
      • Updates a Template or creates a new one if it does not exist
      • Get Template by Company
      • Get Template by Company
      • Updates info
    • ThemeSettings
      • /api/ThemeSettings
      • /api/ThemeSettings
      • /api/ThemeSettings
    • Themes
      • Get theme by name
      • Select a theme by name
      • Get a list of Themes
      • Select a theme by name
      • Get Version of theme
      • Set Prototype Data to Theme
      • Select a theme by name
      • Select a theme by name
      • create or update custom css
      • Get custom css
      • Delete custom css
      • create or update custom css new version
      • create or update custom js
      • Get custom js
      • Delete custom js
      • create or update custom layout
      • create or update custom layout
      • create or update custom layout
      • Get a file's text by specifying its path
      • Saves a file by specifying its path
      • Get current theme layout
      • Get default theme layouts
      • Get a list of changes applied to the theme
      • Restores a previous theme revision
  • Designer
    • CustomFields
      • Create a new custom field asynchronously.
      • Get custom field by entity.
      • Delete a custom field in an entity asynchronously.
    • FilterDesigner
      • Creates a new Filter Design
      • Get All Filter Designs
      • Get filter design by id
      • Delete Filter Design
      • Update Filter Design by id
    • FormDesigner
      • Create a form design asynchronously.
      • Get all form designs asynchronously based on search criteria.
      • Get a form design by ID asynchronously.
      • Delete a form design by ID asynchronously.
      • Update a form design by ID asynchronously.
    • ListDesigner
      • Create a list design asynchronously.
      • Get all list designs asynchronously based on search criteria.
      • Get all list designs created by a specific user.
      • Get a list design by ID asynchronously.
      • Delete a list design by ID asynchronously.
      • Update a list design by ID asynchronously.
    • ObjectInfo
      • /api/designer/objectinfo
    • RouteTemplate
      • Creates a new route template.
      • Gets all route templates.
      • Gets a route template by its ID.
      • Updates an existing route template.
      • Deletes a route template by its ID.
    • UserDefault
      • Create a user default designs record.
      • Get a user default design options .
      • Updates a user default designs record.
      • Deletes a user default design by entity.
      • Get a user default desigs.
  • Feeder
    • Feeders
      • Creates a new Feeder
      • Get All feeders
      • Get a Feeder by id
      • Updates a feeder
      • Deletes a Feeder
      • Get feed By type
      • Simulate feed with transformation
      • Manual Update
      • /api/Feeders/createall
      • Manual Update
    • Google
      • /api/Google/oauth2callback
      • /api/Google/googlecategories
      • /api/Google/{id}
      • /api/Google/{id}
    • Meta
      • /api/Meta/oauth2callback
      • /api/Meta/refreshall
      • /api/Meta/{id}
      • /api/Meta/{id}
    • Skroutz
      • /api/Skroutz/webhook/{ApiKey}/{ChannelId}
      • /api/Skroutz/{id}
      • /api/Skroutz/{id}
    • ThirdPartyApis
      • /api/ThirdPartyApis
      • Creates a new Channel
      • Deletes a Party
    • Transformations
      • Creates a new Transformation
      • Get all Transformations
      • Get a Transformation by id
      • Updates a Transformation
      • Deletes Transformation
  • Inventory
    • InventoryLevels
      • Inventory Check Stock Availability
      • Inventory Reserve Stock Availability
      • Inventory Unreserve Stock Availability
      • Inventory Level Get By id
      • Inventory Level Update
      • Inventory Level Delete
      • Inventory Level Query
      • Inventory Level Create
      • Inventory Level Get By Variant id
      • Inventory Level Import
    • Location
      • Location Get By id
      • Location Update
      • Location Delete
      • Retrieve all locations for the specified company.
      • Location Create
  • Quote
    • Quotes
      • Customer creates a new Quote
      • Get All Quotes
      • Admin creates a new Quote
      • Customer updates a quote by ID.
      • Deletes a quote.
      • Get Quote by Id
      • Admin updates a quote by ID.
      • Customer closes a quote by ID.
      • Admin closes a quote by ID.
      • Calculate Quote Prices
    • Supplier(Eshop administrator) can suggest a quote, so the eshop user will be notified to make a decision of whether to accept or reject the quote. The authorization token, must have a 'CustomerId' claim in order to identify the user making the suggestio
    • E-shop user requests a quote for some items that he wants to receive better prices for. The authorization token, must have a 'UserId' claim in order to identify the user requesting the quote.
    • Eshop user is not satisfied with the provided prices so he requests a counter from the supplier in order to lower the prices. The authorization token, must have a 'UserId' claim in order to identify the user making the suggestion.
    • The eshop user can reject a quote when he no longer want to negotiate for it.
    • Retrieves a list of all quotes (Crm, Eshop, etc.) for a company. Intended use is for backoffice user(salesman, supplier, etc.).
    • Returns a detailed (pricing-applied) view of the quote.
    • Changes total quote price. Can only be called from supplier/salesman.
    • Changes quote total discount. Can only be called by supplier/salesman, when he is trying to make a better offer to the eshop customer.
    • Changes item unit price. Can only be called from supplier/salesman.
    • Changes an item Discount by rate(e.g. 0.2 for 20%). Can only be called from supplier/salesman.
    • Eshop user accepts a quote, and proceeds to checkout. Methods is idempotent, re-accepting an accepted quote has no effect.
  • Scheduler
  • Data Migration
    • Image Tranformation
    • Notification
      • Messages
        • Creates a new Message
        • Get All Messages
        • Get message user list
        • Updates a Message entry
        • reads user message
        • Deletes a message entry
        • Get unread messages count
      • Notifications
        • Creates a new Notification
        • Get All Notifications
        • Get a Notification by id
        • Updates a Notification entry
        • Deletes a notification entry
        • Get unread notifications count
        • Resets counter
    • Offer
      • Offers
        • Creates a new Offer
        • /api/Offers
        • Get All Customer Offers
        • Creates a new Offer
        • /api/Offers/{id}
        • /api/Offers/{id}
        • /api/Offers/{id}
    • Proxy
      • Proxies
        • Creates a new Proxy
        • Get All proxies
        • Get a Proxy by id
        • Updates a proxy
        • Deletes a Proxy
        • route proxy call
        • route proxy call
        • route proxy call
        • route proxy call
    • Payment
      • Banks
        • Creates a new Bank Entity
        • Get Bank by Id
        • Get All Banks
        • Deletes a Bank Entity
        • Updates Bank Entity
      • CardLinkPayments
        • Initiates payment
        • Finalize Cardlink payment -- from redirect url
        • Creates a new CardLink Configuration
        • Updates a CardLink Configuration Record
        • Get a CardLink Configuration Records By Id
      • CashOnDelivery
        • Initiates and create payment
        • Creates a new COD Configuration
        • Updates a COD Configuration Record
        • Get a COD Configuration Records By Id
      • CashOnDeliveryPaymentsSFA
        • Initiates and create payment for SFA
        • Creates a new SFA Credit Configuration
        • Updates an SFA Credit Configuration Record
        • Get am SFA Credit Configuration Records By Id
      • CashOnDeliveryRetail
        • Initiates and create payment
      • Certificate
        • Uploads file to the given path
      • Configurations
        • Delete a Configuration Record
        • Get all configurations per company
        • Enables the OnePay Configuration
      • CreditCards
        • Creates a new Credit Card Entity
        • Get All Credit Cards
        • Deletes a Credit Card Entity
        • Get Credit Card by Id
        • Updates a Credit Card Entity
      • CreditPayments
        • Initiates and create payment
        • Creates a new Credit Configuration
        • Updates a Credit Configuration Record
        • Get a Credit Configuration Records By Id
      • CreditPaymentsRetail
        • Initiates and create payment
      • CreditPaymentsSFA
        • Initiates and create payment for SFA
        • Creates a new SFA Credit Configuration
        • Updates an SFA Credit Configuration Record
        • Get an SFA Credit Configuration Records By Id
      • DepositPayments
        • Initiates and create payment
        • Creates a new Deposit Configuration
        • Updates a Deposit Configuration Record
        • Get a Deposit Configuration Records By Id
      • DepositPaymentsRetail
        • Initiates and create payment
      • DepositPaymentsSFA
        • Initiates and create payment
        • Creates a new Deposit SFA Configuration
        • Updates a Deposit SFA Configuration Record
        • Get a Deposit SFA Configuration Records By Id
      • EDPSPayments
        • Initiates payment
        • Create EDPS payment
        • Creates a new EDPS Configuration
        • Updates a EDPS Configuration Record
        • Get a EDPS Configuration Records By Id
        • Delete an EDPS Configuration
      • JCCPayments
        • Initiates payment
        • Finalize JCC payment -- from redirect url
        • Creates a new JCC Configuration
        • Updates a JCC Configuration Record
        • Get a JCC Configuration Records By Id
        • Delete a JCC Configuration
      • KlarnaConfiguration
        • Creates a new Klarna Configuration
        • Updates a Klarna Configuration Record
        • Get a Klarna Configuration Record By Id
      • KlarnaPayments
        • Initiates payment
        • Finalize klarna payment
      • MoneyCollection
        • Creates a new Money Collection
        • Get All Money Collections
        • Deletes a money collecton record
        • Get money collection by Id
        • Updates a Money Collection
      • MoneyCollectionSeries
        • Creates a Money Collection Series Entity
        • Get All Money Collection Series
        • Deletes a Money Collection Series Entity
        • Get a money collection series by Id
        • Updates a Money Collection Series
      • OnePayPayments
        • Initiates payment
        • Creates OnePay payement - webhook from OnePay
        • Creates a new OnePay Configuration
        • Updates a OnePay Configuration Record
        • Get a OnePay Configuration Records By Id
        • Delete a Credit Configuration
      • Options
        • Upserts Options
        • Get a company's Options
        • Get a customer's Options
        • Get retail Options
      • PayPalPayments
        • Initiates a payment
        • Create PayPal payment -- from redirect
        • Creates a new PayPal Configuration
        • Updates a PayPal Configuration Record
        • Get a PayPal Configuration Records By Id
        • Delete a PayPal Configuration
      • PaygatePayments
        • Initiates a payment
      • SFAConfiguration
        • Delete a SFA Configuration Record
        • Get all SFA configurations per company
      • StripeConfiguration
        • Creates a new Stripe Configuration
        • Updates a Stripe Configuration Record
        • Get a Stripe Configuration Record By Id
      • StripePayments
        • Initiates a Stripe payment
        • Finalize Stripe payment -- from redirect url
    • Report
      • BalanceSheet
        • /api/BalanceSheet/{customerId}
        • /api/BalanceSheet
      • Checkouts
        • Get cart
        • Get All Carts
      • CustomerConfiguration
        • Updates company's customer configuration
        • Gets company customer configuration
      • CustomerTab
        • Gets customer transactions for eshop
        • Gets customer transactions
        • Gets customer transactions with line details Used for SFA
        • Gets customer balances for eshop
        • Gets customer balances
      • Dashboard
        • Get Default Dashboard
        • Set Default Dashboard
        • Get Dashboard By Id
        • Set Dashboard By Id
        • Delete Dashboard By Id
        • Create Dashboard
        • List Dashboards
        • Rearrange Widgets On Dashboard
        • Add Widget To Dashboard
        • Delete Widget From Dashboard
        • Update Widget On Dashboard
      • Digest
        • Send weekly email digest
        • /api/Digest/weekly/{companyId}
      • DigestParams
        • /api/DigestParams
        • /api/DigestParams
      • Documents
        • Get all customer documents
        • Get all customer flat documentlines
        • Get all customer flat documentlines
        • Get all customer flat documentlines
        • Get totals of documents
        • Deletes documents
      • Insights
        • Get Insights
        • Get Insights
        • Get customer by id Insights
        • Get customer carts by id Insights
        • Get product Insights
        • Get product by id Insights
        • Overview
        • Get Cart Insights
      • Report
        • Get power bi login
      • ReportData
        • Loads numeric data for a specified widget on a dashboard.
  • Pdf
    • Pdf
      • Creates a pdf
      • Creates a pdf from OrderDTO
      • Creates a pdf from ΟfferDTO
    • PdfTemplate
      • Get all pdf templates filenames
      • Get pdf template
      • Update pdf template
      • Get pdf template's Translations
      • Save pdf template's Translations
  • Shipping
    • AfterSalesPro
      • Creates a new Carrier
      • Get Carrier by Id
      • Updates a Carrier
      • Get after sales pro carriers
    • Carriers
      • Delete a Carrier
      • Get All Company Carriers
    • GlobalAddress
      • Get all addresses
      • Get All Company Cities
      • Get All Company States
      • Get All Company PostalCodes
      • Get All Company States
    • ManualCarriers
      • Creates a new Carrier
      • Get Carrier by Id
      • Updates a Carrier
    • SFAManualCarrierContoller
      • Creates a new SFA Carrier
      • Get All Company Carriers
      • Get a SFA Carrier by Id
      • Updates a SFA Carrier
      • Delete a Carrier
    • Shipping
      • Creates a new Shipping Configuration
      • Retrieves a Shipping Configuration
      • Upserts a Shipping Config
      • Deletes a Shipping Configuration
      • Uploads file to cloud
      • Imports addresses from file
      • Imports country from address file
      • Imports postal codes from addresses file
      • Imports cities from addresses file
      • Imports states from addresses file
      • Calculates shipping
    • ShippingRetail
      • Calculates shipping
    • Zones
      • Get Zone by Id
      • Updates a Shipping Zone
      • Delete a Zone
      • Creates a new Zone
      • Get All Company Zones
    • Retrieves configured status of Delivery Zones feature for requested Company
  • AI
    • AI
      • Write a given text better
    • AIBrand
      • Generate description
      • Generate description
      • Generate meta title
      • Generate meta description
      • Generate meta keywords
      • Generate seo description
      • Generate seo title
    • AICategory
      • Generate description
      • Generate description
      • Generate meta title
      • Generate meta description
      • Generate meta keywords
      • Generate seo description
      • Generate seo title
    • AICollection
      • Generate description
      • Generate description
      • Generate seo description
      • Generate seo title
      • Generate meta title
      • Generate meta description
      • Generate meta keywords
    • AIProduct
      • Generate mass content for product
      • Generate markdown description
      • Generate description
      • Generate meta title
      • Generate meta description
      • Generate seo description
      • Generate seo title
      • Generate meta keywords
      • Generates an offer description for the products provided.
    • Chat
      • Query Chatbot
      • Get Chat History By UserId
      • Get Chat History By Token Id
      • Get all chats
      • Create chat profile
      • Get all profiles
      • Update chat profile
      • Delete chat profile by id
      • Get profile by id
      • Get a random active profile
    • Fragment
      • Create new Fragment
      • Get All Fragments
      • Get Fragment by Id
      • Get Fragment by Id
      • Delete Fragment by Id
      • Bulk import fragments
    • ImageGeneration
      • /api/ImageGeneration
    • PendingProducts
      • Get pending products
      • Delete all pending products
      • Delete a pending product
      • Accept a pending product
      • Accept all pending products
    • Write a given text better
  • Translation
    • PendingProducts
      • Get all pending products
      • Delete all pending products
      • Delete a pending translation product
      • Accept a pending translation product
      • Update a pending translation product
      • Accept all pending products
    • Products
      • /api/translation/product/generate
    • Translation
      • Translate from translateRequest
      • Translate from dictionary
      • Translate a prompt using a specified language.
  • Tracking
  • Identity
    • Accounts
      • Registers a new user
      • Registers a new user for retail
      • Send verification email
      • Confirm Email
      • Forgot Password
      • Forgot Password
      • Change Password
      • Change Password
      • User Login
      • Company Login
      • User Login
      • Customer Login
      • Impersonate Customer Login
      • Customer Login
      • User Login
      • Register Customer User
      • Sales one time token
      • Apps one time token
      • Autologin
      • Manager Login
      • Create a login code flow
      • Get login auth from code flow id
    • Companies
      • Gets company details
      • Updates a Company
      • Gets company Operation Mode
      • Gets company info by id - Unauthorized
      • Gets by subdomain
      • Gets a Store by subdomain
      • Gets by domain
      • Gets a Store by domain
      • Checks if a subdomain already exists
      • Checks if a subdomain already exists
      • Updates a domain
      • Updates a domain
      • Get SubscriptionDetails for company
    • CustomerApiKeys
      • Get key by id
      • Update customerApiKey
      • Delete customerApiKey
      • Create new customerApiKey
      • Get All CustomerApiKeys
      • refresh api key
    • CustomerRoles
      • Creates a new customer Role
      • Get All ROles
      • Deletes a customer role.
      • Get a customer role by its id
      • Updates a Role
    • DemoData
      • Registers a new user
      • /api/DemoData
    • Import
      • User import by id
    • RegistrationSettings
      • Get the registration setting
      • Get the registration setting
    • RetailUsers
      • Get All Users
      • Get a retail user
      • unlinks a retail user
      • Updates a user
    • Roles
      • Creates a new Role
      • Get All ROles
      • Deletes a ROle
      • Get Role by id.
      • Updates a Role
    • Settings
      • Get Identity Settings
      • Update Identity Settings
    • Token
      • refreshes the access token
      • refreshes the access token
      • refreshes the access token
    • UserApiKeys
      • Get key by id
      • Update ApiKey
      • Delete ApiKey
      • Create new ApiKey
      • Get All Keys
      • refresh api key
      • Get All UserApiKeys
    • Users
      • Get All Accounts
      • unlinks a user
      • Get user by Id
      • Updates a user
      • User Invite
      • User Invite
      • Unregistered Users Invite
      • User Invite
      • User Change Email
      • User Change Password
      • User Change Password
      • User Change Role
      • Get All Customer Users
      • Get All Customer Users
      • Updates a Customer User
      • Deletes a Customer User
      • Fetches a Customer User
      • /api/Users/customerusers/{userId}
      • Deletes a Customer User
      • Updates a Customer User
      • Get customer login user
      • Get login user
      • Get All Customer Accounts
      • Get All Customer Accounts
      • User import by email/id
  • Pricing
    • CartPriceRules
      • Creates a new Cart Price Rule
      • Get all price lists
      • Get a Cart Price Rule by id
      • Deletes a Cart Price Rule
      • Updates a Cart Price Rule
    • CartPricingConfiguration
      • Updates company pricing configuration
      • Gets company pricing
    • CatalogPriceCategories
      • Creates a new Catalog Price Category
      • Get all catalog price categories
      • Get a Catalog Price Category by id
      • Deletes a catalog price category
      • Updates a Catalog price category
    • CatalogPriceRules
      • Creates a new Catalog Price Rule
      • Get all Catalogue Price Rules
      • Get a Catalog Price Rule by id
      • Deletes a Catalog Price Rule
      • Updates a Catalog Price Rule
      • Calculates Catalog Price Rules
      • Calculates Catalog Price Rules
      • Calculates Catalog Price Rules
    • CatalogPricingConfiguration
      • Updates company Catalogue configuration
      • Gets company Catalogue
      • Expire Cache
    • CustomerPriceCategories
      • Creates a new Customer Price Category
      • Get all customer price categories
      • Get a Customer Price Category by id
      • Deletes a customer price category
      • Updates a Customer price category
    • Pricing
      • Calculate Pricing
      • Calculate Pricing
      • Static Calculate Pricing Skroutz
      • Calculate Pricing
      • Calculate by customer
    • ProductsPriceRule
      • Create a product price rule
      • Get all product price rules
      • Get a product price rule by id
      • Deletes a product price rule
      • Updates a product price rule
      • Deletes products price rules
    • Vats
      • Vat Update
      • Get single vat by id
      • Delete Vat
      • Vat Create
      • Get All vats
      • Vats Import
      • Vats Import with settings
    • Calculate Pricing
    • Calculate by customer
    • Calculate by customer
  • Queue
    • Queue
      • Create a new queue.
      • Retrieve all queues.
      • Retrieve a queue by ID.
      • Delete a queue by ID.
      • Update a queue by ID.
  • Task
    • Call
      • Create a new task.
      • Retrieve all calls.
      • Retrieve a call task by ID.
      • Update a task by ID.
      • Delete a call by ID.
      • Call Import
      • /api/task/Call/import/with-settings
    • Email
      • Create a new task.
      • Retrieve a email by ID.
      • Update a task by ID.
      • Email Import
    • Event
      • Create a new event.
      • Retrieve all events.
      • Retrieve a task by ID.
      • Delete a task by ID.
      • Update a task by ID.
      • Event Import
    • PriorityType
      • Create a new priority asynchronously.
      • Get all priorities asynchronously.
      • Get priority by id.
      • Priority Update.
      • Delete a priority by ID asynchronously.
    • ScheduleVisit
      • Create a new scheduleVisit.
      • Retrieve all scheduled visits.
      • Retrieve a scheduled visit by ID.
      • Delete a scheduled visit by ID.
      • Update a task by ID.
      • Schedule Visit Import
      • Imports schedule visits with specified settings.
    • Task
      • Create a new task.
      • Retrieve all tasks.
      • Retrieve a task by ID.
      • Delete a task by ID.
      • Update a task by ID.
      • Task Import
      • /api/Task/import/with-settings
    • Timeline
      • Retrieve all tasks.
      • Retrieve all calendar tasks.
      • Brings un-paginated filtered tasks, including overdue and completed.
      • Retrieve to do tasks (calls,events and tasks).
    • Visit
      • Create a new visit.
      • Retrieve all visits.
      • Retrieve a visit by ID.
      • Delete a visit by ID.
      • Update a visit by ID.
      • Visit Import
      • Imports visits with specified settings.
  • Opportunity
    • Attachment
      • Uploads new File for Attachment
      • Creates a new Attachment
      • Get all attachments asynchronously based on search criteria.
      • Update an attachment by ID asynchronously.
      • Get an attachment by ID asynchronously.
      • Delete an attachment by ID asynchronously.
      • Get SAS Url
    • ForecastCategory
      • Create a new foreacast category asynchronously.
      • Get all forecast categories by search criteria.
      • Get forecast category by id.
      • Forecast category Update.
      • Delete a foreacast category by ID asynchronously.
    • LossReasonType
      • Get all loss reason types by search criteria.
      • Create a new loss reason type asynchronously.
      • Get loss reason type by id.
      • Loss reason type Update.
      • Delete a loss reason type by ID asynchronously.
    • Note
      • Create a new note.
      • Retrieve all notes.
      • Retrieve a note by ID.
      • Delete a note by ID.
      • Update a note by ID.
    • Opportunity
      • Create a new opportunity asynchronously.
      • Get all opportunities asynchronously based on search criteria.
      • Get an opportunity by ID asynchronously.
      • Delete an opportunity by ID asynchronously.
      • Update an opportunity by ID asynchronously.
      • Opportunity Import
      • /api/Opportunity/import/with-settings
      • Create an opportunity from a lead
      • Update an opportunity from a lead
      • Get all opportunities asynchronously based on search criteria.
    • OpportunityStatus
      • Create a new opportunity status asynchronously.
      • Get all opportunity status asynchronously.
      • Get opportunity status by id.
      • /api/opportunity/status/{id}
      • /api/opportunity/status/{id}
    • OpportunityType
      • Get all opportunity types by search criteria.
      • Create a new opportunity type asynchronously.
      • Get opportunity type by id.
      • Opportunity type Update.
      • Delete a opportunity type by ID asynchronously.
    • Retrieve all opportunities without pagination.
  • Lead
    • Attachment
      • Create a new attachment.
      • Retrieve all attachments.
      • Retrieve a attachment by ID.
      • Delete a attachment by ID.
      • Update a attachment by ID.
      • Upload Attachment file.
      • Get the file's blob uri.
    • Lead
      • Create a new lead.
      • Retrieve all leads.
      • Retrieve a lead by ID.
      • Delete a lead by ID.
      • Update a lead by ID.
      • Lead Import
      • /api/Lead/import/with-settings
      • Convert a lead to a contact with ID.
    • LeadStatus
      • Create a new lead status.
      • Retrieve all lead status.
      • Retrieve a lead status by ID.
      • Update a lead status by ID.
      • Delete a lead status by ID.
    • Note
      • Create a new note.
      • Retrieve all notes.
      • Retrieve a note by ID.
      • Delete a note by ID.
      • Update a note by ID.
    • RatingType
      • Create a new rating type.
      • Retrieve all rating Type.
      • Retrieve a rating type by ID.
      • Update a rating type by ID.
      • Delete a rating type by ID.
    • Retrieve all leads without pagination.
  • Order
    • Order
      • Order Get By id
      • Order Delete
      • Order Update
      • Order Query
      • Order Create
      • Order Import
      • Order Import
    • Series
      • Retrieves a series by its ID.
      • Retrieves all series.
      • Creates a new series.
      • Updates a series.
      • Deletes a series by its ID.
    • Create Order for SFA
  • Customer
    • Account
      • Account Get By Id
      • Account Query
      • Account Create
      • Account Update
      • Account Delete
      • Account Import
      • Create account from a lead
      • Update account from lead
    • AccountAttachment
      • Creates a new Attachment
      • Get all attachments asynchronously based on search criteria.
      • Uploads new File for Attachment
      • Update an attachment by ID asynchronously.
      • Get an attachment by ID asynchronously.
      • Delete an attachment by ID asynchronously.
      • Get SAS Url
    • AccountNote
      • Create a new note.
      • Retrieve all notes.
      • Retrieve a note by ID.
      • Delete a note by ID.
      • Update a note by ID.
    • AccountSourceType
      • Get all Account Source Types by search criteria.
      • Create a new Account Source Type asynchronously.
      • Get Account source type by id.
      • Delete an Account Source Type type by ID asynchronously.
      • Account Source Type Update.
    • Assortment
      • Assortment Get By Customer Id
      • Assortment Update
      • Assortment Delete
      • Assortment Create
      • Assortments Query
      • Assortment Update Combinations
    • AssortmentValue
      • Assortment Values Get By Customer Id
      • Assortment Values Append By Customer Id
      • Assortment Value Delete By Customer Id and Assortment Id
      • Assortment Values Delete By Customer Id
      • Assortment Values Delete By Customer Source Id
      • Assortment Values Update By Customer Id and Assortment Id
      • Assortment Values Rebuild By Customer Id
    • ClassificationType
      • Create a new classification type asynchronously.
      • Get all classifications by search criteria.
      • Get classifications by id.
      • Classifications Update.
      • Delete a classification by ID asynchronously.
    • Contact
      • Contact Get By Id
      • Contact Query
      • Contact Create
      • Contact Update
      • Contact Delete
      • Contact Import
      • Contact_POST_Import
      • Create a contact from a lead
      • Update a contact from a lead
    • ContactAttachment
      • Creates a new Attachment
      • Get all attachments asynchronously based on search criteria.
      • Uploads new File for Attachment
      • Update an attachment by ID asynchronously.
      • Get an attachment by ID asynchronously.
      • Delete an attachment by ID asynchronously.
      • Get SAS Url
    • ContactNote
      • Create a new note.
      • Retrieve all notes.
      • Retrieve a note by ID.
      • Delete a note by ID.
      • Update a note by ID.
    • ContactRole
      • Create a new contact role asynchronously.
      • Get all contact roles asynchronously based on search criteria.
      • Get a contact role by ID asynchronously.
      • Delete an contact role by ID asynchronously.
      • Update an contact role by ID asynchronously.
    • CustomerGroupings
      • CustomerGrouping Update
      • Get single customerGrouping by id
      • Delete a CustomerGrouping
      • CustomerGrouping Create
      • Get All customergroups
      • Bulk insert customer groups.
    • CustomerGroups
      • Customer Group Query
      • Customer Group Create
      • Customer Group Get By Id
      • Customer Group Update
      • Customer Group Delete
      • Customer group Get by Customer Id
      • Customer Get By Customer Group
    • Customers
      • Customer Get By Id
      • Customer Delete
      • Customer Update
      • Customer Query
      • Customer Create
      • Customer Import
      • Customers_POST_Import
      • Customer Update
    • GenderType
      • Create a new gender type asynchronously.
      • Get all genders by search criteria.
      • Get gender by id.
      • Genders Update.
      • Delete a gender by ID asynchronously.
    • GeneralCommercialRegistry
      • GeneralCommercialRegistry_POST_StartImport
      • GeneralCommercialRegistry_POST_StartImportFromLastGemyNumber
    • IndustryType
      • Create a new industry type asynchronously.
      • Get all Industry types by search criteria.
      • Get industry type by id.
      • Industry Types Update.
      • Delete an industry type by ID asynchronously.
    • OwnershipType
      • Create a new ownership type asynchronously.
      • Get all Ownership types by search criteria.
      • Get ownership type by id.
      • Ownership Types Update.
      • Delete an ownership type by ID asynchronously.
    • PronounceType
      • Create a new pronounce type asynchronously.
      • Get all pronounce types by search criteria.
      • Get pronounce type by id.
      • Pronounce Types Update.
      • Delete an pronounce type by ID asynchronously.
    • RoleType
      • Create a new role type asynchronously.
      • Get all role types by search criteria.
      • Get role type by id.
      • Role Types Update.
      • Delete an role type by ID asynchronously.
    • SalutationType
      • Create a new salutation type asynchronously.
      • Get all salutation types by search criteria.
      • Get salutation type by id.
      • Salutation Types Update.
      • Delete a salutation type by ID asynchronously.
    • Tags
      • Customer Source Tags Import
  • Activities
    • Get All Notifications
  • Carriers
    • Import (Manual) Carriers (Shipment Methods)
  • WorkflowDefinition
    • /api/WorkflowDefinition/{id}/pretty
  • Import
    • /api/SalesChannels/Import/orders/workflow
    • /api/SalesChannels/Import/orders/workflow/{channelId}
    • Managing payment methods
    • Import Payment Methods
    • Managing shipment methods
    • Import Shipment Methods
    • Managing assortment values
    • Import Assortment Values
    • Managing Order Series Import
    • Import Order Series
    • Managing Banks Import
    • Import Banks
    • Manage Credit Cards Import
    • Import Credit Cards
    • Manage Money Collection Series Import
    • Import Money Collections Series
  • Files
    • Uploads logo to cloud
  • Scripts
    • Uploads script to cloud
    • Scripts_GET_GetScriptContent
    • Get ThirdPartyApp Production Script Version History
  • ThirdPartyApp
    • Thrird Party App Search Own
    • Thrird Party App Search Market Place
    • Category Third Party By Id
    • ThirdParty Update
    • Third Party App Delete
    • ThirdParty App Create
    • ThirdParty Update Access
    • Third Party App Change Status
    • Login Third Party App
    • Publish Third Party App
    • Change Third Party App Version
  • ThirdPartyInstall
    • Install Third Party App
    • UnInstall Third Party App
    • Get Third Party Apps per Company
    • Add Installation Info on Installed App
  • Sitemap
    • Sitemap Create
    • Sitemap Create
    • Sitemap Get
    • Sitemap Get
  • Template
    • Copies Template Data for a Company's Store
  • Themes
    • Copies theme per store
    • /api/Themes/{themeName}/componentsjs
    • /api/Themes/{themeName}/{path}
  • Companies
    • Gets all the stores of the company. The parameter storeListType determines whether to include the company as a default store
    • Gets Store Object (company/store) details
    • Gets Store Object domain info
  • OAuth
    • /api/OAuth/token
  • PaymentMethods
    • PaymentMethods_GET_GetPaymentMethods
    • Import Payment Methods
  • Categories
    • Category Query
  • Acs
    • Retrieves an Acs carrier Record
    • Updates an Acs carrier Record
    • Creates an Acs carrier Record
    • Prints ACS Voucher
    • Prints ACS List
    • Deletes ACS Voucher
    • Prints All Pickup Lists
  • ShoppingList
    • Shopping List Create Retail
    • Shopping List Update
  • AssortmentValue
    • Import operation for Scheduled operation
    • Upsert Assortment Values for all customers.
    • Removes all assortment values of source type "Import"
    • Assortment Values Get By Customer Id
    • Purges stale data from all the companies. This endpoint should be accessed by the scheduler service.
  • Brands
    • Brand Query
  • OutlookCalendar
    • /api/outlook/calendar
  • Robots
    • get assets
    • Set robots.txt content
  • CustomerGroupValues
    • CustomerGroup Values Upsert
    • Get All customergroup values
    • Bulk customer group values upsert
    • Get all customer data belonging to a segment
  • CustomerGroupings
    • Bulk insert customers into groups.
    • Get Customers by Customer Group Segment
    • Get Customer membership by CustomerId
  • Epay
    • Retrieves an Epay Configuration By Id
    • Updates an Epay Configuration
    • Deletes an Epay Configuration
    • Creates a new Epay Configuration
    • Initiates payment
    • Create Epay payment
  • Migration
    • /api/Migration
  • CallResult
    • Retrieves all call results based on the provided search criteria.
    • Creates a new call result.
    • Retrieves a call result by its ID.
    • Updates an existing call result.
    • Deletes a call result by its ID.
  • EventResult
    • Retrieves all event results based on the provided search criteria.
    • Creates a new event result.
    • Retrieves a event result by its ID.
    • Updates an existing event result.
    • Deletes a event result by its ID.
  • PendingProducts
    • Update a pending product
  • UserCart
    • UserCart_GET_GetAllCompanyCarts
  • Capital
    • Check Connection
    • /api/Capital/check/db/{channelId}
    • /api/Capital/command/{method}/{channelId}
    • /api/Capital/signalr/{method}/{channelId}
    • /api/Capital/signalr/{method}/{channelId}
    • Get Companies
    • /api/Capital/branches/{channelId}
    • /api/Capital/script/updated/{channelId}
    • /api/Capital/reset/{channelId}
    • /api/Capital/import/{method}/{importType}/{channelId}
    • Get Sales series
    • /api/Capital/test/{version}/{method}/{channelId}
    • /api/Capital/test/queries/{channelId}
  • CapitalChannel
    • Creates a new Capital Channel
    • Get a channel by id
    • Updates a Channel
    • Deletes Channel
    • Gets a Channel's Script
    • Sets a Channel's Script
    • Gets a Channel's Staging Script
    • Sets a Channel's Staging Script
    • Get script default
  • Account
    • Merges 2 accounts
    • Account_PUT_SetSentiment
  • Contact
    • Merges 2 contacts
  • Accounts
    • Customer Login
    • Customer Login
  • Users
    • /api/Users/customeruser-membership/{userId}
    • Deletes a Customer User
    • Get All Customers User has Permissions
  • ProductVisibility
    • Product Visibility Create
    • Product Visibility Get By Company or Store Id
    • Product Visibility Update
  • Reusables
    • Bulk insert Reusable Component's Translations.
  • ThemeSettings
    • Get theme's global setting from themesettings.json
  • Export
    • /api/SalesChannels/Export/product/all
    • /api/SalesChannels/Export/product/all/workflow/{channelId}
    • /api/SalesChannels/Export/partial
    • /api/SalesChannels/Export/product/all/workflow
    • /api/SalesChannels/Export/categories/all/workflow/{channelId}
    • /api/SalesChannels/Export/categories/all
    • /api/SalesChannels/Export/categories/all/workflow
    • /api/SalesChannels/Export/attributes/all/workflow/{channelId}
    • /api/SalesChannels/Export/attributes/all/workflow
    • /api/SalesChannels/Export/inventory/workflow/{channelId}
    • /api/SalesChannels/Export/inventory/all
    • /api/SalesChannels/Export/attributes/all
    • /api/SalesChannels/Export/catalog/all
    • /api/SalesChannels/Export/partial/catalog
  • Feeders
    • /api/Feeders/createall
  • LogStream
    • /api/SalesChannels/{channelId}/logStream/status
    • /api/SalesChannels/{channelId}/log
    • /api/SalesChannels/{channelId}/logStream/start
    • /api/SalesChannels/{channelId}/logStream/stop
  • Magento
    • /api/Magento/{id}
    • /api/Magento/{id}
  • PrestaShop
    • /api/PrestaShop/{id}
    • /api/PrestaShop/{id}
  • Shopify
    • /api/Shopify/{id}
    • /api/Shopify/{id}
  • Simulation
    • /api/SalesChannels/Simulation/product
    • /api/SalesChannels/Simulation/category
    • /api/SalesChannels/Simulation/attribute
  • ThirdPartyApis
    • /api/ThirdPartyApis/{id}
    • /api/ThirdPartyApis/{id}
    • /api/ThirdPartyApis/{id}/script
    • /api/ThirdPartyApis/{id}/script
    • /api/ThirdPartyApis/{id}/publish
  • WebHook
    • /api/SalesChannels/WebHook/{companyId}/{salesChannelType}/{id}
    • /api/SalesChannels/WebHook/{companyId}/woocommerce/{id}
    • /api/SalesChannels/WebHook/{companyId}/shopify/{id}
    • /api/SalesChannels/WebHook/{companyId}/skroutz/{id}
  • WooCommerce
    • /api/WooCommerce/{id}
    • /api/WooCommerce/{id}
  • Subscription
    • Get SubscriptionDetails for company
  • Series
    • Retrieves a series by its ID.
    • Retrieves all series.
    • Creates a new series.
    • Updates a series.
    • Deletes a series by its ID.
    • Series Import
  • Banks
    • Banks Import
  • CreditCards
    • /api/payments/CreditCards/{id}
    • Credit Cards Import
  • MoneyCollectionSeries
    • Get a money collection series by id
    • /api/payments/MoneyCollectionSeries/{id}
    • Money Collection Series Import
    • /api/payments/MoneyCollectionSeries/numbering/update/{id}
    • /api/payments/MoneyCollectionSeries/numbering/reset/{id}
  • GenikiTaxidromikiCarrier
    • Gets a GenikiTaxidromiki Carrier
    • Updates a GenikiTaxidromiki Carrier
    • Creates a GenikiTaxidromiki Carrier
    • /api/carriers/GenikiTaxidromiki/voucher/options
    • Create a Geniki Taxidromiki Voucher
    • Createn Pickup Order for Geniki Taxidromiki
    • Get Voucher Details
    • Returns a PDF url for the voucher
    • Cancel a Geniki Taxidromiki Voucher
    • Reactive a cancelled voucher
    • Returns All the Jobs From Geniki Taxidromiki
    • Close pending jobs for Geniki Taxidromiki
    • /api/carriers/GenikiTaxidromiki/delivery/status
    • /api/carriers/GenikiTaxidromiki/delivery/information
  • PagesTemplate
    • Retrieves the page template for the specified alias and environment.
  • OpenId
    • /api/OpenId/signinUrl/{appName}
    • /api/OpenId/signin-oidc
    • /api/OpenId/companies
    • /api/OpenId/login
    • /api/OpenId/signoutUrl/{appName}
  • CheckoutRetail
    • Checkout Create
    • Checkout Complete Payment
  • MoneyCollection
    • Get money collection by Id
  • CatalogPriceRules
    • Calculates Catalog Price for the first variant
  • Bi
    • /api/Bi
  • Calendar
    • Retrieve all calendar tasks.
  • Nexi
    • Initiates a new payment with Nexi. This will return a URL to redirect the user to.
    • Finalize a Nexi payment and create Payment record -- from redirect
    • Cancel Nexi payment
  • NexiConfiguration
    • Creates a new Nexi Configuration Record
    • Updates an existing Nexi Configuration Record
    • Retrieves a Nexi Configuration Record by ID
    • Deletes a Nexi Configuration Record by ID
  • InventoryLevel
    • Get product quantities for products.
    • Sets an inventory level record for a specified product variant at a specific location.
    • Get product quantities for products.
    • Reserve stock for a cart in eshop
    • Retrieve an inventory level by its unique identifier.
    • Release stock based on the token
    • Imports inventory levels.
    • Adjust reserved stock for a cart in eshop
    • Calculates the total quantity of a specific item variant across all locations.
    • Retrieve a list of inventory levels with optional cursor-based pagination.
    • Creates an inventory level record for a specified product variant at a specific location.
    • Retrieves the inventory level of the first location for a specified product variant.
    • Get product quantities for products.
    • Deletes all inventory levels for a company.
  • InventorySettings
    • Upserts the inventory settings for a company.
    • Upserts the inventory settings for a company.
    • Retrieves the inventory settings for the specified company.
    • Retrieves the inventory settings for the specified company.
  • Location
    • Location Create
    • Imports Locations.
    • Retrieve a single location By location id
    • Location Delete
    • Imports Locations.
    • Retrieve the first location By location id
  • ReserveStock
    • Inventory Reserve Stock Availability
    • Inventory Unreserve Stock Availability
  • InventoryGroup
    • Updates an inventory Group record for a company.
    • Updates an inventory Group record for a company.
    • Retrieve an inventory group by its unique identifier.
    • Retrieve an inventory group by its unique identifier.
    • Deletes an inventory Group record for a company.
    • Deletes an inventory Group record for a company.
    • Retrieve a list of inventory Groups with optional cursor-based pagination.
    • Retrieve a list of inventory Groups with optional cursor-based pagination.
    • Creates an inventory Group record for a company.
    • Creates an inventory Group record for a company.
  • Note
    • Create a new note.
    • Retrieve all notes.
    • Retrieve a note by ID.
    • Delete a note by ID.
    • Update a note by ID.
  • ExtentedCollections
    • Collection Extended Get by Id, with products
  • Entersoft
    • Checks if the SignalR connection for the specified channel is active.
    • Sends a command message to the SignalR connection.
    • Sends a message to the SignalR connection and returns the result.
    • Sends a message with a payload to the SignalR connection and returns a result.
    • Get Sales series
    • Updates the script for the given channel.
    • Resets the job timestamp for the specified job.
    • Handles import operations with an optional reset of timestamp and returns the result.
    • Get Companies
    • /api/Entersoft/test/{version}/{method}/{channelId}
    • /api/Entersoft/test/queries/{channelId}
  • EntersoftChannel
    • Creates a new Channel
    • Get a channel by id
    • Updates a Channel
    • Deletes Channel
    • Get script default
    • Set script
    • Set script
    • Get staging script
    • Get a script by Channel ID
  • ApiKeys
    • Exchanges Api Key for token with company claims.
    • Autologin
    • Exchanges api key for token with customer claims
  • BackofficeUsers
    • Get all backoffice users
    • Get backoffice user by id
    • Delete a user from the current authorized company
    • Invite backoffice user
    • Updates self as a backoffice user (e.g. a user updating his first name or last name)
    • Changes user's email from backoffice
    • Change backoffice user role
    • Backoffice change password while logged in
    • refreshes the access token
    • /api/users/permissions/{userId}
    • User import by email/id
    • /api/users/permissions/{userId}
  • EshopUsersAuthentication
    • Login customer by email and password
    • Login customer by email and password
    • Select customer id after multi login
    • An eshop user of a retail shop, self-registers.
    • An eshop user of a retail shop, self-registers.
    • Eshop user confirms his email, following an invitation.
    • Eshop user requests a password reset email
    • Eshop user resets his password, after forgot password.
    • refreshes the access token
    • Confirms user email after self registration. Used in B2C flows, were eshop users can self register in storefront.
  • EshopUsersBackofficeManagement
    • Get All Customer Users from backoffice
    • Fetches a Customer User from backoffice (somewhere in SingleOrder.jsx, check if it can be removed)
    • Fetches a Customer User from backoffice (somewhere in SingleOrder.jsx, check if it can be removed)
    • Get All Eshop Users from backoffice
    • Invites eshop user from backoffice
    • Update customer user membership from backoffice
    • Deletes an Eshop User membership from backoffice (called from eshop but doesn't work due to permissions)
    • Re-Invite eshop users that have never logged in.
  • EshopUsersManagement
    • Invite eshop user from eshop (e.g. from kitchenware.shopranos.eu)
    • Get All Customer Users from eshop (e.g. from kitchenware.shopranos.eu)
    • Get All Customer Users from eshop (e.g. from kitchenware.shopranos.eu)
    • Get All Customers User from eshop, in order to select user for login when multiCustomer login is used.
    • Eshop user change's his password while logged in.
    • Get user from eshop, it is used only in order's view to display username
    • Deletes a Customer User membership from eshop (before multi customer login was introduced)
    • Updates an Eshop User from eshop (e.g. from kitchenware.shopranos.eu)
    • Get the logged in Eshop user's information Used in profile page in eshop
    • Impersonate Customer Login
    • Get a trimmed-down view of eshop users. Called from eshop blogs in order to display user info in comments, etc.
  • Manager
    • Login for manager app
    • /api/accounts/login/v2/manager
    • refreshes the access token
  • ThirdPartyApps
    • Apps one time token
  • VsCodeAuth
    • /api/accounts/login
    • /api/accounts/login/company
  • Customers
    • Update authenticated customer's address
  • Teams
    • Get all teams in the company with optional search parameters.
    • Create a new team.
    • Get a team by ID.
    • Update an existing team.
    • Delete a team by ID.
  • Reservation
    • Reserve stock for a cart in eshop
    • Release stock based on the token
    • Adjust reserved stock for a cart in eshop
  • CardLinkPayments
    • Cancel cardlink payment
  • PdfTemplate
    • Get pdf template's translations
    • Update pdf template's translations
  • NegotiationQuotes
    • The supplier sets an expiry date before submitting the quote. The eshop user will need to accept the quote before it has been expired.
    • Eshop user can set extra details that will be viewable only by him.
  • SalesQuotes
    • Edits the personal information (name, email, job title, phone number) of the Buyer, the receiver of the sales quotation.
    • Edits the Company information (name, address) of the Buyer, the receiver of the sales quotation.
    • Returns a preview of the quote.
    • Publish or ask approval to publish a sales quote making it visible in a public url.
    • A Public URL at which an HTML preview of the sales quotation can be found.
    • A Public URL at which an HTML preview of the sales quotation can be found.
    • Links a sales quotation to an opportunity.
    • Retrieves a list of all sales quotes for a company. Intended use is for backoffice user(salesman).
    • Initializes a new Sales Quotation as Draft.
    • Gets a detailedsales quotation by its ID including calculated line items.
    • /api/v1/sales-quotes/{quoteId}
    • Amends the template details of a sales quotation (comments, terms,language, expiration date).
    • Edits the personal information (name, email, job title, phone number) of the Sales Representative of a sales quotation.
    • Edits the company information (name, address) of the Sales Representative of a sales quotation.
    • Deletes a line item from the sales quotation.
    • Amends a specific line of a sales quotation.
    • Converts a sales quotation into an order.
    • Approves the publishing of a sales quotation.
    • Adds a new line item to a sales quotation.
  • ReportData
    • Loads chart data for a specified widget on a dashboard.
    • Loads funnel data for a specified widget on a dashboard.
  • Address
    • Checks whether provided Address is valid to be used in Shipping for specific Company
  • SoftoneChannels
    • Create default channels for companies
  • CustomLookUps
    • /api/designer/CustomLookUps/{id}
    • /api/designer/CustomLookUps/{id}
    • /api/designer/CustomLookUps/{id}
    • /api/designer/CustomLookUps/{id}
    • /api/designer/CustomLookUps
    • /api/designer/CustomLookUps
    • /api/designer/CustomLookUps/{id}/{optionId}
    • /api/designer/CustomLookUps/{id}/{optionId}
  • ListView
    • /api/designer/views/list/{entity}
    • /api/designer/views/list/all/{entity}
    • /api/designer/views/list/{listViewId}
    • /api/designer/views/list/{listViewId}
    • /api/designer/views/list/{listViewId}
  • LookUps
    • /api/designer/LookUps/{type}
    • /api/designer/LookUps/{type}/options
    • /api/designer/LookUps/{type}/options
    • /api/designer/LookUps
    • /api/designer/LookUps/{type}/options/{optionId}
    • /api/designer/LookUps/{type}/options/{optionId}
  • ObjectInfo
    • /api/designer/objectinfo
    • /api/designer/objectinfo
    • /api/designer/objectinfo/{fieldName}
  • PreviewView
    • /api/designer/views/preview/{entity}
    • /api/designer/views/preview/all/{entity}
    • /api/designer/views/preview/default/{entity}
    • /api/designer/views/preview/{viewId}
    • /api/designer/views/preview/{viewId}
    • /api/designer/views/preview/{viewId}
    • Add a widget to a tab on a preview view.
    • Deletes a widget from a preview view.
    • /api/designer/views/preview/{viewId}/widgets/{widgetId}
    • Rearranges the widgets on a specified view.
  • SingleView
    • /api/designer/views/single/{entity}
    • /api/designer/views/single/all/{entity}
    • /api/designer/views/single/default/{entity}
    • /api/designer/views/single/{viewId}
    • /api/designer/views/single/{viewId}
    • /api/designer/views/single/{viewId}
    • /api/designer/views/single/{viewId}/tabs
    • /api/designer/views/single/{viewId}/tabs/{tabId}
    • /api/designer/views/single/{viewId}/tabs/{tabId}
    • Add a widget to a tab on a single view.
    • Deletes a widget from a tab on a single view.
    • /api/designer/views/single/{viewId}/tabs/{tabId}/widgets/{widgetId}
    • Rearranges the widgets on a specified view.
  • Products
    • InitializeProductsEndpoint
  1. Authentication

Getting Started

Authentication#

Shopranos API uses API keys for authentication. You can generate an API key from Settings -> User Permissions -> User API Keys. You must include your API key in the header of each request to access the API.
image.png
While generating the API key, you can set the permissions and validity date.
image.png
Example:

Base URL#

The base URL for all API requests is:
https://platform.shopranos.com/
Modified at 2024-07-22 12:22:07
Next
Attribute Get By id
Built with