There is a WADL document available that describes the resources API.
| name | path | methods | description |
|---|---|---|---|
| Article/category API |
|
|
Article category eStore-related features, such as article listing, breadcrumbs etc. |
| Category API |
|
|
Categories and their hierarchical tree is an easy way to design the web shop in a way that it is easy to navigate and find interesting articles. |
| Checkout API |
|
|
The checkout is where consumers finalize their purchases. They enter their shipping details and pay through a payment method, usually through a third party payment service provider. ETM also has service providers that host the entire checkout, for example Klarna Checkout. |
| Common API |
|
|
Common eStore-related features, such as referrals or newsletter subscriptions. |
| Country API |
|
|
A country defines a market where products are sold.
A country has a single currency, meaning you can't use any other currency when placing orders for that country. For example, if you are ordering goods in the Swedish market, you must pay with SEK. A country has a default language, however any language can in theory be used for any country when browsing goods, as long as there are translations for that specific language. Languages and countries are in other words not really connected in any important way. |
| Delivery method API |
|
|
Delivery methods are different ways of transporting physical goods from warehouses to consumers. A delivery method is connected to a specific logistics provider, meaning multiple methods can have the same provider, but with different properties. Delivery methods can have various requirements (such as weight limits) and different carriage costs for different countries. A delivery method is mandatory in the order chain. |
| Delivery point API |
|
|
A delivery point is a physical location where shipped goods can be picked up. These can be of arbitrary type, for example physical stores or post offices. These delivery points are bound to a logistics provider. For example, 'Posten' have different delivery points than 'In-store pickup'. |
| Delivery time slot API |
|
|
A delivery time slot is day and time where the customer can choose to have their delivery. |
| Navigation API |
|
|
The navigation is the central core of the eStore platform. A path is simply the path of a URL. For example, the path of the URL
https://www.viskan.com/some/category would be /some/path. A path can be translated to various different kinds of targets:
|
| Payment method API |
|
|
Payment methods are different ways of handling the payments of orders and subscriptions. Some payment methods handle recurring payments (subscriptions), while some do not. A payment method is typically connected to a payment service provider that defines the logic that needs to be performed. When using a payment service provider, communication with the third party often takes place. |
| Product API |
|
|
Provides RESTful endpoints for product-related data in estore |
| Purchase API |
|
|
A purchase is the core part of the eStore API and is created by converting an existing shopcart, including its rows and settings. A purchase can be created with or without customer information, depending on if a third party payment service provider can provide customer information. |
| |
|
|
|
| Raw purchase API |
|
|
Raw purchases are exactly the same as regular purchases made through the eStore endpoints, except for the fact that they are not based on shopping carts from the eStore endpoints. Raw purchases can come from any kind of external source or system. |
| Receipt API |
|
|
A receipt contains all information about a created purchase and is typically used to show final information about a purchase to a consumer. Receipts can have different states and they can in some cases exist but not be returned, typically because they are awaiting further details from a third party payment service provider. |
| Seller API |
|
|
Provides methods for retrieving sellers. A seller is a person or company that sell products/services to customers. |
| Service provider API |
|
|
A service provider configuration is a vendor that provides IT solutions and/or services to end users and organizations. They can for example be payment service providers like Klarna. |
| Store API |
|
|
A store can be either physical or virtual. A physical store is typically a regular store with cashiers etc., where a virtual store is typically an online shop. Stores can be provide useful information in various ways. They can for example be used as delivery points, using ETM's In-store pickup module, or they can be used simply to provide information about stock balances in each physical store. |
| Streamline Express API |
|
|
Streamline Express is a simplified and combined version of the shopcart and purchase APIs. Streamline Express pages are preconfigured in ETM. The
name of a page is passed in to the service along with customer information to create a purchase.
For simplicity, Streamline Express is traditionally used directly from a browser. However, this API provides a way of calling Streamline Express using a regular server-to-server REST API. |