Skip to content

Viskan API documentation

Main Navigation Home Get started API reference API examples

Appearance

Sidebar Navigation

API reference

Admin

Job configuration API

POSTExecute a job configuration

GETList job configurations

GETGet a job configuration

PATCHUpdate a job configuration

PATCHUpdate multiple job configurations

Job execution exclusion API

POSTCreate a job execution exclusion

DELETEDelete a job execution exclusion

GETFind job execution exclusions

GETGet a job execution exclusion

PATCHUpdate a job execution exclusion

Job history API

POSTAcknowledge a failure

GETSearch job history

GETGet a job history entry

User API

POSTCheck availability

POSTCreate user

DELETEDelete user

GETFind users

GETGet connected tenants

GETGet user

POSTSend invitation email

PATCHUpdate user

User group API

POSTCreate new user group

DELETEDelete a user group

GETFind user groups

GETGet all reports

GETGet members of group

GETGet a user group

PATCHUpdate a user group

Common

Profile API

GETGet own profile

GETGet profile

Config

Campaign property API

POSTCreate campaign property key

DELETERemove property value from campaign

DELETEDelete campaign property key

GETGet campaign property key

GETList campaign property keys

GETGet property values for campaign

PUTSet property value on campaign

PUTUpdate campaign property key

Multi brand API

POSTCreate a multi brand

DELETEDelete a multi brand

GETFind multi brands

GETGet a multi brand

PATCHUpdate a multi brand

Physical store API

GETFind physical stores

GETGet a physical store

PATCHUpdate a physical store

Price list API

POSTCreate a price list

DELETEDelete a price list

GETFind price lists

GETGet a price list

PATCHUpdate a price list

Product category property API

POSTCreate product category property key

DELETERemove property value from product category

DELETEDelete product category property key

GETFind product categories by property key

GETGet product category property key

GETList product category property keys

GETGet property values for product category

PUTSet property value on product category

PUTUpdate product category property key

Return reason API

POSTCreate a return reason

DELETEDelete a return reason

GETFind return reasons

GETGet a return reason

PATCHUpdate a return reason

Service provider configuration API

GETFind service provider configurations

Customer

Customer property API

POSTCreate customer property key

DELETERemove property value from customer

DELETEDelete customer property key

GETGet customer property key

GETList customer property keys

GETGet property values for customer

PUTSet property value on customer

PUTUpdate customer property key

Developer

API request log API

GETFind request logs

Finance

Accounting journal API

GETGet accounting journals

Global

Information

Tenant API

POSTCreate new tenant

DELETEDelete tenant

GETFind tenants

GETGet tenant

PATCHUpdate tenant

User API

POSTAdd user to tenant

GETFind users

GETGet user

POSTReplays user events

POSTSynchronizes users

PATCHUpdate user

Helpdesk

Helpdesk label API

GETFind labels

GETGet a label

Ticket API

GETGet ticket aggregations

POSTCreate ticket

POSTDisconnect customer

GETDownload attachment

GETGet message

GETGet ticket

GETFind tickets

POSTUnassign ticket

PATCHUpdate ticket

In-store pickup

Parcel API

POSTCreate parcels

GETFind parcels

PATCHUpdate parcels

Order management

Order API

GETFind orders

Order property API

POSTCreate order property key

DELETERemove property value from order

DELETEDelete order property key

GETGet order property key

GETList order property keys

GETGet property values for order

PUTSet property value on order

PUTUpdate order property key

Return API

GETFind return reasons

POSTCreate a return

GETFind returns

PATCHUpdate a return

Shipment API

POSTCancel in-store shipment

POSTMark as being picked in store

GETFind shipments

PATCHUpdate a shipment

Product

Attribute API

POST2. Create or update an attribute1 group

GET1. Find attribute1 groups

Category API

GETGet a category tree

Media API

POSTDisconnect product media

POSTCreate product media

GETFind product media

Price API

PATCHUpdate prices

Product API

POST4. Create or update related products

POST6. Create a flexible package product

POST3. Deactivate a product

POST5. Delete related products

GET1. Find products

POST2. Create or update products

Product property API

POSTCreate product property key

DELETERemove property value from product

DELETEDelete product property key

GETGet product property key

GETList product property keys

GETGet property values for product

PUTSet property value on product

PUTUpdate product property key

Product variant property API

POSTCreate variant property key

DELETERemove property value from variant

DELETEDelete variant property key

GETGet variant property key

GETList variant property keys

GETGet property values for variant

PUTSet property value on variant

PUTUpdate variant property key

Shopping

Raw purchase API

POSTCalculate tax rates

POSTCreate purchase

Warehouse management

Purchase order API

GETFind purchase orders

PATCHUpdate a purchase order

Shipping method API

GETFind shipping methods

Stock balance API

POSTCreate/update balances

POSTCreate/update reservations

POSTRun order reservation for stock keeping units

GETFind stock balances

Stock Location API

GETFind stock locations

Supplier API

GETFind suppliers

Warehouse API

GETFind warehouses

Warehouse API V2

POSTCreate a warehouse

DELETEDelete a warehouse

GETFind warehouses

GETGet a warehouse

PATCHUpdate a warehouse

Web page

Category API

POSTCreate category

DELETEDelete category

GETRetrieve category

PATCHUpdate category

Category Tree API

GETGet a category tree

Draft API

POSTCreate draft

DELETEDelete draft

GETFind drafts

POSTPublish draft

GETRetrieve draft

PATCHUpdate draft

Layout API

POSTCreate layout

DELETEDelete layout

GETFind layouts

GETGet layout

GETRetrieve a layout

PATCHUpdate layout

Locale API

DELETEDelete locale

GETFind locales

GETGet locale

PATCHUpdate locale

Page API

POSTCreate page

DELETEDelete page

POSTSearch pages

POSTSearch for a page

GETGet page

PATCHUpdate page

Product API

POSTConnect product

DELETEDelete product

GETList products

GETList products with unique layout connections

GETRetrieve product

PATCHUpdate product

Section API

POSTCreate section

DELETEDelete section

GETFind sections

GETGet section

PATCHUpdate section

Store Setting API

POSTCreate store setting

DELETEDelete store setting

GETFind store settings

GETGet store setting

PATCHUpdate store setting

Tree API

GETGet category tree

Web store

Product API

POSTGet product details

POSTGet product feed

POSTGet product list

POSTSearch for products

Voucher API

POSTLook up a voucher

Web store API

POSTCreate web store

DELETEDelete web store

GETGet web store

PATCHUpdate web store

Web stores

The web-store APIs provide functionality for managing web stores.

Pager

Next pageAPI reference

www.viskan.com

Web stores ​

Web stores