- Back to home
- 4. Apis
- Authentication
- Catalog
- Attributes
- AttributeSets
- Brands
- Categories
- Collections
- 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
- ExtentedCollections
- Filters
- IcoTags
- PrivacyGroups
- Products
- ProductsQuery
- ProductVariants
- RelatedProducts
- StockAvailability
- Tags
- Units
- Automation
- Infobip
- WebHook
- WorkflowDefinition
- WorkflowExecution
- Cart
- Checkout
- Communicator
- Connector
- Atlantis
- /api/Atlantis/check/connection/{channelId}
- /api/Atlantis/command/{method}/{channelId}
- /api/Atlantis/signalr/{method}/{channelId}
- /api/Atlantis/signalr/{method}/{channelId}
- Get Sales series
- Get payment methods
- Get Companies
- /api/Atlantis/script/updated/{channelId}
- /api/Atlantis/import/{method}/{importType}/{channelId}
- /api/Atlantis/reset/{channelId}
- /api/Atlantis/test/{version}/{method}/{channelId}
- /api/Atlantis/test/queries/{channelId}
- AtlantisChannel
- Channels
- Connector
- Datapump
- DatapumpChannels
- Export
- 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
- Regate
- Check SignalR Connection
- /api/Regate/command/{method}/{channelId}
- /api/Regate/signalr/{method}/{channelId}
- /api/Regate/signalr/{method}/{channelId}
- NOTE! THIS IS USED BY ALL CHANNELS WHEN A CONFIG UPDATE IS INITIATED. NEEDS TO CHANGE FROM UI
- /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
- 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
- Softone
- Get Softone Warehouses
- Get Softone Customers
- Get Softone Payment providers
- Get Softone Carriers
- Get series
- Get series
- Get printForm data
- Get expenses
- Get Order 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
- Atlantis
- Content
- Announcements
- AppSettings
- Assets
- Blog
- BlogCategory
- 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
- Components
- Menus
- Migration
- 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
- Template
- 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 js
- create or update custom css new version
- 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
- Feeder
- Inventory
- Quote
- Quotes
- Returns a detailed (pricing-applied) view of the quote.
- 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.).
- 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.
- Eshop user accepts a quote, and proceeds to checkout. Methods is idempotent, re-accepting an accepted quote has no effect.
- Changes an item Discount by rate(e.g. 0.2 for 20%). Can only be called from supplier/salesman.
- Scheduler
- Data Migration
- Image Tranformation
- Notification
- Offer
- Proxy
- Payment
- Banks
- CardLinkPayments
- CashOnDelivery
- CashOnDeliveryPaymentsSFA
- CashOnDeliveryRetail
- Certificate
- Configurations
- CreditCards
- CreditPayments
- CreditPaymentsRetail
- CreditPaymentsSFA
- DepositPayments
- DepositPaymentsRetail
- DepositPaymentsSFA
- EDPSPayments
- JCCPayments
- KlarnaConfiguration
- KlarnaPayments
- MoneyCollection
- MoneyCollectionSeries
- OnePayPayments
- Options
- PayPalPayments
- PaygatePayments
- SFAConfiguration
- StripeConfiguration
- StripePayments
- Report
- Pdf
- PdfTemplate
- Generates an example order PDF with sample data
- Generates an example offer PDF with sample data
- Previews order PDF template as html with sample data
- Previews offer PDF template as html with sample data
- Gets a json with the schema of the templates view model
- Gets a json with the schema of the templates view model
- Shipping
- AfterSalesPro
- Carriers
- GlobalAddress
- ManualCarriers
- SFAManualCarrierContoller
- 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
- Zones
- Retrieves configured status of Delivery Zones feature for requested Company
- AI
- Translation
- 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
- Get SubscriptionDetails for company
- Updates a domain
- CustomerApiKeys
- CustomerRoles
- DemoData
- Import
- RegistrationSettings
- RetailUsers
- Roles
- Settings
- Token
- 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
- Accounts
- Pricing
- Queue
- Task
- Opportunity
- Attachment
- ForecastCategory
- LossReasonType
- Note
- 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
- OpportunityType
- Retrieve all opportunities without pagination.
- Lead
- Order
- Customer
- Account
- AccountAttachment
- AccountNote
- AccountSourceType
- Assortment
- 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
- Contact
- ContactAttachment
- ContactNote
- ContactRole
- CustomerGroupings
- CustomerGroups
- Customers
- GenderType
- GeneralCommercialRegistry
- IndustryType
- OwnershipType
- PronounceType
- RoleType
- SalutationType
- Tags
- Activities
- Carriers
- WorkflowDefinition
- 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
- Manage Contacts Import
- Import Contacts (From Scheduler)
- Files
- Scripts
- ThirdPartyApp
- ThirdPartyInstall
- Sitemap
- Template
- Themes
- Copies theme per store
- /api/Themes/{themeName}/componentsjs
- /api/Themes/{themeName}/{path}
- Clear theme cache js
- Get the custom Metas partial
- Create or update the custom Metas partial
- Delete the custom Metas partial
- Get the theme's default Metas partial
- Get the custom CssVariables partial
- Create or update the custom CssVariables partial
- Delete the custom CssVariables partial
- Get the theme's default CssVariables partial
- Get the custom GoogleTagManager partial
- Create or update the custom GoogleTagManager partial
- Delete the custom GoogleTagManager partial
- Get the theme's default GoogleTagManager partial
- 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
- Gets the configured currency for the current company/store (resolved from the x-companyid / x-storeid headers). Used by service-to-service callers (e.g. Checkout.Api) to stamp the currency on downstream documents.
- OAuth
- PaymentMethods
- Categories
- Acs
- ShoppingList
- AssortmentValue
- Brands
- OutlookCalendar
- Robots
- CustomerGroupValues
- CustomerGroupings
- Epay
- Migration
- CallResult
- EventResult
- PendingProducts
- UserCart
- UserCart_GET_GetAllCompanyCarts
- Calculate quantity constraints for products based on the user's cart
- Resolve the closest valid quantity for a product, in both addition and target contexts
- Import the user's cart from a previously uploaded file (CSV/Excel). The caller is expected to have uploaded the source file to DataMigration storage and to pass back the resulting `FileReference` together with the file `Format`.
- Export the user's cart to a file (CSV/Excel) and return a download URL.
- Removes a single cart line by its own line id, so exactly the clicked row is removed even when other lines share the same product/variant (separate-entries carts).
- Capital
- /api/Capital/check/connection/{channelId}
- /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}
- Get Sales series
- /api/Capital/script/updated/{channelId}
- /api/Capital/import/{method}/{importType}/{channelId}
- /api/Capital/test/{version}/{method}/{channelId}
- /api/Capital/test/queries/{channelId}
- /api/Capital/reset/{channelId}
- CapitalChannel
- Account
- Contact
- Accounts
- Users
- ProductVisibility
- Reusables
- ThemeSettings
- 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}
- Export customer to connector
- /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
- LogStream
- Magento
- PrestaShop
- Shopify
- Simulation
- ThirdPartyApis
- WebHook
- WooCommerce
- Subscription
- Series
- Banks
- CreditCards
- MoneyCollectionSeries
- 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
- OpenId
- CheckoutRetail
- MoneyCollection
- CatalogPriceRules
- Bi
- Calendar
- 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
- Receives a Nexi server-to-server webhook notification. Called by Nexi when a payment outcome is determined, even if the user closed the browser. Does not require x-companyid header — resolves company from the orderId in the payload. Idempotent: safe to ca
- NexiConfiguration
- 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
- Location
- ReserveStock
- 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.
- Deletes bulk inventory groups for a company.
- Note
- ExtentedCollections
- Entersoft
- /api/Entersoft/check/connection/{channelId}
- /api/Entersoft/command/{method}/{channelId}
- /api/Entersoft/signalr/{method}/{channelId}
- /api/Entersoft/signalr/{method}/{channelId}
- Get Sales series
- /api/Entersoft/script/updated/{channelId}
- /api/Entersoft/reset/{channelId}
- 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
- ApiKeys
- BackofficeUsers
- Get all backoffice users
- Retrieve a backoffice user by ID
- Updates self as a backoffice user (e.g. a user updating his first name or last name)
- 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 users from backoffice. Invalid or failing invitations are reported per item instead of failing the whole batch.
- 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
- Updates a user's access for the caller's customer/store connection. The target user must already have an existing access for the caller's customer/store. Only non-null properties in the request body are applied (partial update possible).
- Updates a user's active status from the storefront.
- Updates an Eshop User's profile (first name, last name) from eshop
- Get a trimmed-down view of eshop users. Called from eshop blogs in order to display user info in comments, etc.
- Manager
- ThirdPartyApps
- VsCodeAuth
- Customers
- Teams
- Reservation
- Reserve stock for a cart in eshop
- Release stock based on the token
- Checks whether the requested cart lines can be reserved without actually reserving stock. Performs an in-memory sequential reservation simulation, where each line reduces the available stock for subsequent lines (same as the real reservation flow). Return
- Adjust reserved stock for a cart in eshop
- CardLinkPayments
- PdfTemplate
- NegotiationQuotes
- Eshop user can set extra details that will be viewable only by him.
- Deletes a negotiation quote by its id.
- The supplier sets an expiry date before submitting the quote. The eshop user will need to accept the quote before it has been expired.
- Returns a detailed (pricing-applied) view of the quote, including item price before discount and line value after discount.
- Updates the pricing of a quote in a single call. Every line item of the quote must be provided: each line's discount (rate and/or value) and price are applied authoritatively. The expiration date is applied when supplied; the remaining body members identi
- Returns an administrator (backoffice) view of the quote where the only monetary value is the personalized price of the quote's customer.
- 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.
- Adds a new line item to a sales quotation.
- ReportData
- Address
- SoftoneChannels
- CustomLookUps
- ListView
- LookUps
- ObjectInfo
- 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
- CartValidation
- DataBackfilling
- RelatedProducts
- Datapump
- Check if DataPump needs to be updated
- Get Datapump's latest version
- Report the result of a DataPump update (success or failure). Called by the DatapumpUpdater after an installation attempt completes.
- Download the latest datapump version
- Get Datapump's installer
- Get the latest version of the datapump installer
- Components
- LegacyVue
- Liquid
- FormDesigner
- Timeline
- Attributes
- OutlookAccount
- Operation
- AIBrand
- AICategory
- AICollection
- AIProduct
- Chat
- Fragment
- ImageGeneration
- Infobip
- WorkflowExecution
- AnonymousCart
- Calculate quantity constraints for products based on the anonymous user's cart. The cart token is optional; when omitted the calculation assumes an empty cart.
- Calculate quantity constraints for products based on the anonymous user's cart. The cart token is optional; when omitted the calculation assumes an empty cart.
- Resolve the closest valid quantity for a product, in both addition and target contexts
- Removes a single cart line by its own line id, so exactly the clicked row is removed even when other lines share the same product/variant (separate-entries carts).
- AttributeSets
- Collections
- Documentations
- ExtendedProducts
- Filters
- IcoTags
- PrivacyGroups
- ProductsQuery
- ProductVariants
- StockAvailability
- Tags
- Units
- CustomerProductMix
- Returns a paginated list of customer product mix records. Supports filtering and sorting using Gridify syntax.
- Adds a product to a customer's mix manually.
- Returns a paginated list of customer product mix records enriched with product details. Supports filtering and sorting using Gridify syntax. Includes product title, SKU, and image URL for UI display.
- Returns a paginated list of the authenticated customer's product mix, enriched with product details for storefront display. CustomerId is resolved automatically from the authenticated storefront actor.
- Adds multiple products (using each product's first variant) to a customer's mix in bulk.
- Adds multiple products to a customer's mix in bulk (useful for testing and ERP imports).
- Gets a customer product mix record by id.
- Patches a customer product mix record.
- Deletes a customer product mix record.
- Deletes all product mix records for a specific customer (useful for testing and cleanup).
- Deletes ALL product mix records for the current company (across every customer). Intended for destructive maintenance/reset operations and must be confirmed by the caller.
- Bulk deletes specific product mix records for a customer by their IDs.
- CustomerProductMixSettings
- Upserts the product mix settings for the current company. Can only be called by backoffice users
- Returns the settings for the product mix of the current company. Can only be called by backoffice users.
- Returns the PUBLIC storefront settings for the product mix of the current company. This endpoint is accessible without authentication and returns only the minimal data needed for storefront behavior. Scoped by x-companyid header.
- HistoricalSync
- CheckoutWebhook
- EmailTemplate
- AtlantisImport
- CapitalImport
- EntersoftImport
- GetByIdImportNotifications
- GetUnreadCountImportNotifications
- ResetCounterImportNotification
- ImportData
- Notifications
- RegateImport
- Sap
- /api/Sap/check/connection/{channelId}
- /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 payment methods
- Get Sales series
- Get Companies
- /api/Sap/test/{version}/{method}/{channelId}
- /api/Sap/test/queries/{channelId}
- SapImport
- Softone
- TickerQ
- /api/options
- /api/cron-tickers
- /api/time-tickers
- /api/time-tickers/{graph-data-range}
- /api/time-tickers/{graph-data}
- /api/time-tickers/set-batch-parent
- /api/time-tickers/unbatch
- /api/cron-tickers/{graph-data-range}
- /api/cron-tickers/{graph-data-range-id}
- /api/cron-tickers/{graph-data}
- /api/cron-ticker-occurrences/{cronTickerId}
- /api/cron-ticker-occurrences/{cronTickerId}/{graph-data}
- /api/ticker/{cancel}
- /api/time-ticker/{delete}
- /api/cron-ticker/{delete}
- /api/cron-ticker-occurrence/{delete}
- /api/ticker-request/{id}
- /api/ticker-functions
- /api/time-ticker/{update}
- /api/time-ticker/{add}
- /api/cron-ticker/{add}
- /api/cron-ticker/{update}
- /api/cron-ticker/{run}
- /api/ticker-host/{next-ticker}
- /api/ticker-host/{stop}
- /api/ticker-host/{start}
- /api/ticker-host/{restart}
- /api/ticker-host/{status}
- /api/ticker/statuses/{get-last-week}
- /api/ticker/statuses/{get}
- /api/ticker/machine/{jobs}
- ActivateContract
- Approve
- Cancel
- ChangeAddressType
- CreateAddress
- GetAddresses
- CreateContract
- QueryContracts
- CreateContractType
- QueryContractTypes
- DeleteAddress
- GetAddressById
- UpdateAddress
- DeleteContract
- GetContractById
- DeleteContractType
- GetContractTypeById
- DeleteDocuments
- ESignatureDocuSignWebhook
- GetDefaultAddresses
- GetFinancials
- UpdateFinancials
- ImportCustomers
- ManageESignatureSettings
- ManageTags
- PutOnHold
- Reject
- RemoveOwner
- SetOwner
- RenewContract
- RequestContractSignature
- Resume
- SetDefaultAddress
- SetInvoiceRequirement
- SubmitForApproval
- TerminateContract
- UnlinkPrimaryContact
- UpdateDates
- UpdateDescription
- UpdateExtraFields
- UpdateRenewalSettings
- UpdateTerms
- UpdateTitle
- UploadContractDocument
- OrderHistoryInternal
- Checkouts
- BoxNow
- Retrieves a BoxNow carrier configuration
- Updates a BoxNow carrier configuration
- Creates a BoxNow carrier configuration
- Creates a BoxNow delivery request (voucher) for an order
- Creates a BoxNow delivery request (voucher) from an existing order. Fetches order details from Order API and maps them to a BoxNow delivery request. Idempotent: returns existing voucher if one already exists for the order.
- Downloads a shipping label PDF for a BoxNow parcel
- CreateCall
- QueryCalls
- CreateEvent
- QueryEvents
- CreateTask
- QueryTasks
- DeleteCall
- GetByIdCall
- UpdateCall
- DeleteEvent
- GetByIdEvent
- UpdateEvent
- DeleteTask
- GetByIdTask
- UpdateTask
- ImportCalls
- ImportEvents
- ImportTasks
- QueryCallsV2
- QueryEventsV2
- QueryTasksV2
- CaptchaConfiguration
- ThemeFiles
- List all syncable file paths for the tenant's staging theme folder.
- Download a single file by relative path.
- Upload/overwrite a single file by relative path.
- Delete a file by relative path.
- Trigger recompilation of staging compiled files. If a path is provided, only the compilations relevant to that path are executed. If no path is provided, all staging compilations are executed (scripts + components).
- Trigger recompilation of staging compiled files. If a path is provided, only the compilations relevant to that path are executed. If no path is provided, all staging compilations are executed (scripts + components).
- CompanyCopy
- KlarnaPayments
- Creates a Klarna Payments session for the merchant's configured mode and returns either an in-line `client_token` or an HPP `redirect_url`.
- In-line flow: confirms a browser-side authorization by exchanging the Klarna `authorization_token` for a real Klarna order, server-side.
- HPP flow: called by the storefront when the customer returns from the Klarna Hosted Payment Page; we read the HPP session status and finalise.
- Cancels a Klarna Payments session. Used both by the in-line widget when the customer closes the modal and by the HPP cancel/back/failure redirect. Mirrors the existing Nexi and CardLink cancel endpoints.
- KlarnaPaymentsConfiguration
- Certificate
- CatalogPricingConfiguration
- CategoryCounts
- Pages
- PayHub
- Initiates a PayHub payment request and returns the hosted payment page URL (Paylink). The shopper pays via bank RF or mobile app, then is redirected back to the shop.
- Receives a PayHub server-to-server settlement webhook. Requires the `x-companyid` header (forwarded by the Shop BFF, which resolves the tenant from the storefront domain); it scopes the ReferenceCode/PendingPayment lookup to the tenant partition. Idempote
- Success return: resolves a PayHub payment request to its checkout and settlement state. PayHub appends `paymentRequestId` to the registration's returnUrlOk and forwards the `ref` the platform appended to the Paylink. When the payment is still pending loca
- Cancel return: cancels the payment request at PayHub and locally so the shopper can retry the checkout. Nothing is cancelled when PayHub reports the request paid or cannot be reached. When the returned status carries a cancelled `payment`, the caller must
- PayHubConfiguration
- PaymentTransactions
- NewsletterProvider
- Returns a provider together with its embed code.
- Replaces every editable field of a provider.
- Removes a provider. Storefront components that still point at it render nothing.
- Returns the embed code a storefront renders for the provider.
- Browses the company's providers, newest first.
- Registers a new provider.
- NewsletterSubscription
- Signs an address up for the newsletter, treating the submission as consent.POST
- Browses the company's newsletter list, newest consent first.GET
- Removes the given entries. Ids that are not on the list are ignored.POST
- Removes every entry that has already been exported at least once, leaving anything that
arrived since the last export untouched.DELETE
- Clears the company's whole newsletter list.DELETE
- Exports the list to a downloadable file and marks the exported entries.POST
- Signs an address up for the newsletter, treating the submission as consent.
- StockAlert
- Subscribes a shopper email to be notified when a product/variant is back in stock. Re-subscribing with an already-notified email re-opens a new notification cycle. Anonymous and reachable directly through the gateway, so rate limiting and the module/store
- Admin-only: aggregated pending/total subscriber counts per product/variant, for the Ecom.Admin BFF.
- Admin-only: every variant row for one product, unpaginated. Unlike M:Communicator.Api.Controllers.StockAlertController.Search(System.Int32,System.Int32,System.String,System.Threading.CancellationToken), this can't split a product's variants across pages,
- Admin-only: the full subscription history (both Pending and already-Notified rows) for one product/variant, used to power the admin's subscribers drill-down - its Status column/filter and its per-subscriber "resend" action both depend on Notified rows bei
- Admin-only: manually notify currently pending subscribers of a product/variant right now, without waiting for an inventory-changed event.
- Admin-only: manually (re)notify a single subscriber right now. "subscriberId" is the stable subscription row Id. Returns 404 if no matching subscription exists (unknown id, wrong product/variant), or if it's already Notified and force is false.
- Admin-only: dashboard metrics for one product - aggregate summary plus a 30-day subscription/notification timeline, for the Ecom.Admin BFF's Stock Alert detail page.
- Public unsubscribe link target embedded in back-in-stock emails. No auth - the token itself encodes exactly which (CompanyId, ProductId, ProductVariantId, Email) to remove.
- FaqCategories
- Get a page of FAQ categories, including inactive ones, each with the number of FAQ lists linked to it.
- Create a FAQ category.
- Get a page of active FAQ categories for the storefront.
- Get a FAQ category by id, whatever its status.
- Replace a FAQ category.
- Delete a FAQ category. Its FAQ lists are kept and become uncategorized.
- Faqs
- Get a page of FAQ lists, including drafts and archived ones.
- Create a FAQ list.
- Get a page of active FAQ lists for the storefront.
- Get a FAQ list by id, whatever its status.
- Replace a FAQ list, including its full set of items.
- Delete a FAQ list. Components referencing it render nothing afterwards.
- Get an active FAQ list by id for the storefront; inactive lists are reported as not found.
Exports the list to a downloadable file and marks the exported entries.
POST
/api/newsletter/subscriptions/export
ids empty to export the whole list.Request
Body Params
application/json-patch+json
Example
{
"format": "Csv",
"ids": [
"string"
]
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://platform.shopranos.eu/api/newsletter/subscriptions/export' \
--header 'Content-Type: application/json-patch+json' \
--data '{
"format": "Csv",
"ids": [
"string"
]
}'Responses
🟢200
application/json
Body
Example
{
"fileUrl": "string",
"fileName": "string",
"exportedCount": 0
}🟠400
🟠401
🟠403
Modified at 2026-10-06 09:58:21
Previous
Clears the company's whole newsletter list.
Next
Subscribes a shopper email to be notified when a product/variant is back in stock.
Re-subscribing with an already-notified email re-opens a new notification cycle.
Anonymous and reachable directly through the gateway, so rate limiting and the
module/store