« Viskan ETM - General information
  • General Information
  • eStore API
  • Content management API
  • In-store pickup API
  • My pages API
  • Product information API
  • Order management API
  • Warehouse management API
  • Customer relations API
  • Back to Top
  1. Home

General information

API Connection

In order to connect to development API you need to configure following.

Host (development)

Following API host is pure development and may not always work properly. But it contains all latest features which are under development or test.

https://api.dev.viskanetm.com

API key

Please supply given API key in X-Instance-Id header when making calls. If you are a customer looking to obtain your API token, please contact your customer manager. If you are a partner integrating our API, it is essential to obtain an API token on behalf of the customer you are integrating towards, so please coordinate with the customer to get in contact with the customer manager for this.

Certificate

Viskan use encrypted connection for external API calls. If you are a customer looking to obtain your certificate, please contact your customer manager. If you are a partner integrating our API, it is essential to obtain certificate on behalf of the customer you are integrating towards, so please coordinate with the customer to get in contact with the customer manager for this.

Example

Here is the example API call which returns all products:

GET /product-information/product/products?resultsPerPage=10&europeanArticleNumber=7393197173521 HTTP/1.1
Host: api.dev.viskanetm.com
X-Instance-Id: 98705fc1-6570-BBBB-AAAA-4d1ece14d233
X-Language: en

FAQ

How modifiedAfter query parameter works?

Use this query parameter to filter result objects which were modified after specified date and time. The query parameter date value format is: YYYY-MM-DDThh:mm:ss[{+|-}hh:mm]. For example it's needed to get all products which were changed after 01-01-2020 10:00. So if you call API from New York then query parameter should look like &modifiedAfter=2020-01-01T10:10:00.000-04:00 where the -04:00 is time offset of the New York. Also note that this parameter also checks modification date of "child" objects. For example if product price was modified in the requested period then the product will be included in search results.

How searchId query parameter works?

Every search (GET) call to API is paginated and contains searchId reference which may be used on subsequent API calls for navigation over search results. The searchId has limited life time and is removed after a while. Query parameter searchId should be used together with page query parameter to refer to specific result page.

How searchAfterId query parameter works?

Every search (GET) call to API which supports this parameter contains searchAfterId reference on every item in search result. Use this parameter to get next batch of results instantly from given searchAfterId. Use resultsPerPage parameter to specify how much items should be returned after searchAfterId. In order to get next page of results just use top searchAfterId which is returned before results (this is a reference to the next page). Note, that searchAfterId is a permanent ID and may be used anytime.

Generated by Enunciate.