Sleekshop JS SDK 2.1

This is the official Sleekshop JS SDK for the Sleekshop API. It is a wrapper around the Sleekshop API, which provides a simple way to interact with the API.

Sleekshop is a cloudbased e-commerce platform which allows you to deploy e-commerce functionality via API into your projects no matter what kind of programming - language you want to use, or which devices you want to address.

More about Sleekshop can be found at https://www.sleekshop.io

Documentation

For more information about the Sleekshop API, please refer to the official documentation.

Installation

# Using npm
npm install sleekshop-js-sdk

# Using yarn
yarn add sleekshop-js-sdk

# Using pnpm
pnpm add sleekshop-js-sdk

# Using bun
bun add sleekshop-js-sdk

Usage

1. Setup SDK

First you need to initialize the sdk:

import Sleekshop from 'sleekshop-js-sdk';

const sleekshop = new Sleekshop(
    "https://yourinstance.sleekshop.net/srv/service/", // Sleekshop API URL
    "yourinstance_jYkL7fPmQw2eVtNgHs3S", // licence username
    "jYkL7fPmQw2eVtNgHs3S", // licence password
    "jYkL7fPmQw2eVtNgHs3S" // optional licence secret key - required for some API calls
);

2. Interact with the API

Now you can use the sdk to interact with the API. For example, to get a new session:

ESM:

const session = await sleekshop.sessions.getNewSession();

CommonJS:

sleekshop.sessions.getNewSession().then((session) => {
    console.log(session);
});

Available Methods

+-- aggregation
|  +-- .aggregate()
+-- applications
|  +-- .applicationApiCall()
+-- cart
|  +-- .addToCart()
|  +-- .subFromCart()
|  +-- .delFromCart()
|  +-- .clearCart()
|  +-- .getCart()
+-- categories
|  +-- .getCategories()
|  +-- .getProductsInCategory()
|  +-- .getContentsInCategory()
|  +-- .getShopobjectsInCategory()
|  +-- .dumpCategory()
|  +-- .seoGetProductsInCategory()
|  +-- .seoGetContentsInCategory()
|  +-- .seoGetShopobjectsInCategory()
|  +-- .createCategory()
|  +-- .updateCategory()
|  +-- .deleteCategory()
+-- classes
|  +-- .getClassDetails()
|  +-- .createClass()
|  +-- .deleteClass()
|  +-- .createClassAttributes()
|  +-- .deleteClassAttributes()
+-- coupons
|  +-- .addCoupons()
|  +-- .createCoupons()
+-- orders
|  +-- .setOrderDetails()
|  +-- .getDeliveryCountries()
|  +-- .updateOrderDetails()
|  +-- .getOrderDetails()
|  +-- .getOrderById()
|  +-- .checkout()
|  +-- .getInvoice()
|  +-- .getOrderConfirmation()
+-- payment
|  +-- .getPaymentMethods()
|  +-- .doPayment()
|  +-- .addDeliveryCosts()
+-- search
|  +-- .searchProducts()
|  +-- .searchContents()
|  +-- .searchDistinctProducts()
|  +-- .searchOrders()
|  +-- .searchUsers()
|  +-- .searchWarehouseEntities()
+-- server
|  +-- .getStatus()
|  +-- .createChannel()
+-- sessions
|  +-- .getNewSession()
+-- shopobjects
|  +-- .getProductDetails()
|  +-- .getContentDetails()
|  +-- .seoGetProductDetails()
|  +-- .seoGetContentDetails()
|  +-- .createProduct()
|  +-- .updateProduct()
|  +-- .createVariation()
|  +-- .deleteProduct()
|  +-- .deleteContent()
|  +-- .updateContent()
+-- user
|  +-- .registerUser()
|  +-- .verifyUser()
|  +-- .loginUser()
|  +-- .logoutUser()
|  +-- .setUserPassword()
|  +-- .resetUserPasswordInit()
|  +-- .resetUserPasswordSuccess()
|  +-- .getUserOrders()
|  +-- .getUserData()
|  +-- .getUserById()
|  +-- .setUserData()
|  +-- .updateUserData()
|  +-- .instantLogin()
+-- warehouse
|  +-- .createWarehouseEntity()
|  +-- .updateWarehouseEntity()
|  +-- .deleteWarehouseEntity()
|  +-- .inventoryPlace()
|  +-- .inventoryTake()
|  +-- .addBinding()
|  +-- .deleteBinding()
+-- webhooks
|  +-- .createWebhook()
|  +-- .updateWebhook()

Definitions

aggregation

.aggregate()

public async aggregate(pipe: object): Promise<object> {

- **Parameter**: `pipe` (Object) - 
- **Returns**: Object Object of aggregated data.
- **Returns**: object

applications

.applicationApiCall()

public async applicationApiCall(application: string,app_request: string,args: object): Promise<object> {

- **Parameter**: `application` (String) - 
- **Parameter**: `app_request` (String) - 
- **Parameter**: `args` (Object) - 
- **Returns**: Object Object of application api call.
- **Returns**: object

cart

.addToCart()

public async addToCart(session: string,id_shopobject: number,element_type: string,id_parent_element: number = 0,quantity: number = 1,price_field: string = "price",name_field: string = "name",description_field: string,language: string = this.default_language,country: string = "DE"): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `id_shopobject` (Number) - 
- **Parameter**: `element_type` (String) - 
- **Parameter**: `id_parent_element` (Number) - 
- **Parameter**: `quantity` (Number) - 
- **Parameter**: `price_field` (String) - 
- **Parameter**: `name_field` (String) - 
- **Parameter**: `description_field` (String) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `country` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.subFromCart()

public async subFromCart(session: string,id_element: number): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `id_element` (Number) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.delFromCart()

public async delFromCart(session: string,id_element: number): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `id_element` (Number) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.clearCart()

public async clearCart(session: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getCart()

public async getCart(session: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

categories

.getCategories()

public async getCategories(id_parent: number,language: string = this.default_language,): Promise<ICategories | object> {

- **Parameter**: `id_parent` (Number) - 
- **Parameter**: `language` (String) - 
- **Returns**: ISession Object of session with either an existing or new session.
- **Returns**: ICategories | object

.getProductsInCategory()

public async getProductsInCategory(id_category: number,language: string = this.default_language,country: string = 'DE',order_columns: Array<string> = [],order: string = 'ASC',left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = [],): Promise<IProductsInCategory | object> {

- **Parameter**: `id_category` (Number) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `country` (String) - 
- **Parameter**: `order_columns` (Array) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array) - 
- **Returns**: IProductsInCategory Object of products in category.
- **Returns**: IProductsInCategory | object

.getContentsInCategory()

public async getContentsInCategory(id_category: number,language: string = this.default_language,order_columns: Array<string> = [],order: string = 'ASC',left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = [],): Promise<IContentsInCategory | object> {

- **Parameter**: `id_category` (Number) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `order_columns` (Array) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array) - 
- **Returns**: IContentsInCategory Object of products in category.
- **Returns**: IContentsInCategory | object

.getShopobjectsInCategory()

public async getShopobjectsInCategory(id_category: number,language: string = this.default_language,country: string = 'DE',order_columns: Array<string> = [],order: string = 'ASC',left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = [],): Promise<IShopobjectsInCategory | object> {

- **Parameter**: `id_category` (Number) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `country` (String) - 
- **Parameter**: `order_columns` (Array) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array) - 
- **Returns**: IShopobjectsInCategory Object of products in category.
- **Returns**: IShopobjectsInCategory | object

.dumpCategory()

public async dumpCategory(id_category: number,language: string = 'de_DE',country: string = 'DE',order_columns: Array<string> = ['prio'],order: string = 'ASC',left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = [],): Promise<IDumpCategory | object> {

- **Parameter**: `id_category` (Number) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `country` (String) - 
- **Parameter**: `order_columns` (Array) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array) - 
- **Returns**: IDumpCategory Object of products in category.
- **Returns**: IDumpCategory | object

.seoGetProductsInCategory()

public async seoGetProductsInCategory(permalink: string,language: string = this.default_language,country: string = 'DE',order_columns: Array<string> = [],order: string = 'ASC',left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = [],): Promise<object> {

- **Parameter**: `permalink` (String) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `country` (String) - 
- **Parameter**: `order_columns` (Array) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array) - 
- **Returns**: Object Object of products in category.
- **Returns**: object

.seoGetContentsInCategory()

public async seoGetContentsInCategory(permalink: string,order_columns: Array<string> = [],order: string = 'ASC',left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = [],): Promise<object> {

- **Parameter**: `permalink` (String) - 
- **Parameter**: `order_columns` (Array) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array) - 
- **Returns**: Object Object of products in category.
- **Returns**: object

.seoGetShopobjectsInCategory()

public async seoGetShopobjectsInCategory(permalink: string,order_columns: Array<string> = [],order: string = 'ASC',left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = [],): Promise<object> {

- **Parameter**: `permalink` (String) - 
- **Parameter**: `order_columns` (Array) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array) - 
- **Returns**: Object Object of products in category.
- **Returns**: object

.createCategory()

public async createCategory(id_parent: number,name: string,labels: object = {},seo: object = {},): Promise<object> {

- **Parameter**: `id_parent` (Number) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `labels` (Object) - 
- **Parameter**: `seo` (Object) - 
- **Returns**: Object Object of products in category.
- **Returns**: object

.updateCategory()

public async updateCategory(id_parent: number,name: string,labels: object = {},attributes: object = {},seo: object = {},): Promise<object> {

- **Parameter**: `id_parent` (Number) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `labels` (Object) - 
- **Parameter**: `attributes` (Object) - 
- **Parameter**: `seo` (Object) - 
- **Returns**: Object Object of products in category.
- **Returns**: object

.deleteCategory()

public async deleteCategory(id_category: number,): Promise<object> {

- **Parameter**: `id_category` (Number) - 
- **Returns**: Object Object of products in category.
- **Returns**: object

classes

.getClassDetails()

public async getClassDetails(id_class: number,language: string = this.default_language,): Promise<object> {

- **Parameter**: `id_class` (Number) - 
- **Parameter**: `language` (String) - 
- **Returns**: object Object of session with either an existing or new session.
- **Returns**: object

.createClass()

public async createClass(name: string,type: string,): Promise<object> {

- **Parameter**: `name` (String) - 
- **Parameter**: `type` (String) - 
- **Returns**: object Object of created class.
- **Returns**: object

.deleteClass()

public async deleteClass(id_class: number,): Promise<object> {

- **Parameter**: `id_class` (Number) - 
- **Returns**: object Object of deleted class.
- **Returns**: object

.createClassAttributes()

public async createClassAttributes(id_class: number,attributes: Array<object>,): Promise<object> {

- **Parameter**: `id_class` (Number) - 
- **Parameter**: `attributes` (Array<Object>) - 
- **Returns**: object Object of created class attributes.
- **Returns**: object

.deleteClassAttributes()

public async deleteClassAttributes(id_class: number,attributes: Array<string>,): Promise<object> {

- **Parameter**: `id_class` (Number) - 
- **Parameter**: `attributes` (Array<String>) - 
- **Returns**: object Object of deleted class attributes.
- **Returns**: object

coupons

.addCoupons()

public async addCoupons(session: string,coupons: Array<string>): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `coupons` (Array) - 
- **Returns**: Object Object of added coupons.
- **Returns**: object

.createCoupons()

public async createCoupons(count: number,name: string,amount: number): Promise<object> {

- **Parameter**: `count` (Number) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `amount` (Number) - 
- **Returns**: Object Object of created coupons.
- **Returns**: object

orders

.setOrderDetails()

public async setOrderDetails(session: string,id_payment_method: number,id_delivery_method: number,delivery_companyname: string,delivery_department: string,delivery_salutation: string,delivery_firstname: string,delivery_lastname: string,delivery_street: string,delivery_number: string,delivery_zip: string,delivery_state: string,delivery_city: string,delivery_country: string,invoice_companyname: string,invoice_department: string,invoice_salutation: string,invoice_firstname: string,invoice_lastname: string,invoice_street: string,invoice_number: string,invoice_zip: string,invoice_state: string,invoice_city: string,invoice_country: string,note: string,email: string,phone: string,attributes: Array<object> = []): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `id_payment_method` (Number) - 
- **Parameter**: `id_delivery_method` (Number) - 
- **Parameter**: `delivery_companyname` (String) - 
- **Parameter**: `delivery_department` (String) - 
- **Parameter**: `delivery_salutation` (String) - 
- **Parameter**: `delivery_firstname` (String) - 
- **Parameter**: `delivery_lastname` (String) - 
- **Parameter**: `delivery_street` (String) - 
- **Parameter**: `delivery_number` (String) - 
- **Parameter**: `delivery_zip` (String) - 
- **Parameter**: `delivery_state` (String) - 
- **Parameter**: `delivery_city` (String) - 
- **Parameter**: `delivery_country` (String) - 
- **Parameter**: `invoice_companyname` (String) - 
- **Parameter**: `invoice_department` (String) - 
- **Parameter**: `invoice_salutation` (String) - 
- **Parameter**: `invoice_firstname` (String) - 
- **Parameter**: `invoice_lastname` (String) - 
- **Parameter**: `invoice_street` (String) - 
- **Parameter**: `invoice_number` (String) - 
- **Parameter**: `invoice_zip` (String) - 
- **Parameter**: `invoice_state` (String) - 
- **Parameter**: `invoice_city` (String) - 
- **Parameter**: `invoice_country` (String) - 
- **Parameter**: `note` (String) - 
- **Parameter**: `email` (String) - 
- **Parameter**: `phone` (String) - 
- **Parameter**: `attributes` (Array<Object>) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getDeliveryCountries()

public async getDeliveryCountries(): Promise<object> {

- **Returns**: Object Object of delivery countries.

.updateOrderDetails()

public async updateOrderDetails(id_order: number,id_payment_method: number,id_delivery_method: number,order_state: string,order_payment_state: string,order_delivery_state: string,delivery_companyname: string,delivery_department: string,delivery_salutation: string,delivery_firstname: string,delivery_lastname: string,delivery_street: string,delivery_number: string,delivery_zip: string,delivery_state: string,delivery_city: string,delivery_country: string,invoice_companyname: string,invoice_department: string,invoice_salutation: string,invoice_firstname: string,invoice_lastname: string,invoice_street: string,invoice_number: string,invoice_zip: string,invoice_state: string,invoice_city: string,invoice_country: string,note: string,email: string,phone: string,attributes: Array<object> = []): Promise<object> {

- **Parameter**: `id_order` (Number) - 
- **Parameter**: `id_payment_method` (Number) - 
- **Parameter**: `id_delivery_method` (Number) - 
- **Parameter**: `order_state` (String) - 
- **Parameter**: `order_payment_state` (String) - 
- **Parameter**: `order_delivery_state` (String) - 
- **Parameter**: `delivery_companyname` (String) - 
- **Parameter**: `delivery_department` (String) - 
- **Parameter**: `delivery_salutation` (String) - 
- **Parameter**: `delivery_firstname` (String) - 
- **Parameter**: `delivery_lastname` (String) - 
- **Parameter**: `delivery_street` (String) - 
- **Parameter**: `delivery_number` (String) - 
- **Parameter**: `delivery_zip` (String) - 
- **Parameter**: `delivery_state` (String) - 
- **Parameter**: `delivery_city` (String) - 
- **Parameter**: `delivery_country` (String) - 
- **Parameter**: `invoice_companyname` (String) - 
- **Parameter**: `invoice_department` (String) - 
- **Parameter**: `invoice_salutation` (String) - 
- **Parameter**: `invoice_firstname` (String) - 
- **Parameter**: `invoice_lastname` (String) - 
- **Parameter**: `invoice_street` (String) - 
- **Parameter**: `invoice_number` (String) - 
- **Parameter**: `invoice_zip` (String) - 
- **Parameter**: `invoice_state` (String) - 
- **Parameter**: `invoice_city` (String) - 
- **Parameter**: `invoice_country` (String) - 
- **Parameter**: `note` (String) - 
- **Parameter**: `email` (String) - 
- **Parameter**: `phone` (String) - 
- **Parameter**: `attributes` (Array<Object>) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getOrderDetails()

public async getOrderDetails(session: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getOrderById()

public async getOrderById(id_order: number,language: string = this.default_language): Promise<object> {

- **Parameter**: `id_order` (Number) - 
- **Parameter**: `language` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.checkout()

public async checkout(session: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getInvoice()

public async getInvoice(id_order: number): Promise<object> {

- **Parameter**: `id_order` (Number) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getOrderConfirmation()

public async getOrderConfirmation(id_order: number,args: object = {}): Promise<object> {

- **Parameter**: `id_order` (Number) - 
- **Parameter**: `args` (Object) - 
- **Returns**: Object Object of product details.
- **Returns**: object

payment

.getPaymentMethods()

public async getPaymentMethods(): Promise<object> {

- **Returns**: Object Object of payment methods.

.doPayment()

public async doPayment(id_order: number,args: Array<any> = []): Promise<object> {

- **Parameter**: `id_order` (Number) - 
- **Parameter**: `args` (Array) - 
- **Returns**: Object Object of payment details.
- **Returns**: object

.addDeliveryCosts()

public async addDeliveryCosts(session: string,delivery_costs: Array<any> = []): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `delivery_costs` (Array) - 
- **Returns**: Object Object of delivery costs.
- **Returns**: object

search

.searchProducts()

public async searchProducts(constraint: object = {},language: string = this.default_language,country: string = "DE",order_columns: Array<string> = [],order_type: string = "ASC",left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = []): Promise<object> {

- **Parameter**: `constraint` (Object) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `country` (String) - 
- **Parameter**: `order_columns` (Array<String>) - 
- **Parameter**: `order_type` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array<String>) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.searchContents()

public async searchContents(constraint: object = {},language: string = this.default_language,order_columns: Array<string> = [],order_type: string = "ASC",left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = []): Promise<object> {

- **Parameter**: `constraint` (Object) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `order_columns` (Array<String>) - 
- **Parameter**: `order_type` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array<String>) - 
- **Returns**: Object Object of content details.
- **Returns**: object

.searchDistinctProducts()

public async searchDistinctProducts(field: string,constraint: object = {},language: string = this.default_language): Promise<object> {

- **Parameter**: `field` (String) - 
- **Parameter**: `constraint` (Object) - 
- **Parameter**: `language` (String) - 
- **Returns**: Object Object of distinct product details.
- **Returns**: object

.searchOrders()

public async searchOrders(constraint: object = {},language: string = this.default_language,left_limit: number = 0,right_limit: number = 0): Promise<object> {

- **Parameter**: `constraint` (Object) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Returns**: Object Object of order details.
- **Returns**: object

.searchUsers()

public async searchUsers(constraint: object = {},order_columns: Array<string> = [],order: string = "ASC",left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = []): Promise<object> {

- **Parameter**: `constraint` (Object) - 
- **Parameter**: `order_columns` (Array<String>) - 
- **Parameter**: `order` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array<String>) - 
- **Returns**: Object Object of user details.
- **Returns**: object

.searchWarehouseEntities()

public async searchWarehouseEntities(constraint: object = {},language: string = this.default_language,order_columns: Array<string> = [],order_type: string = "",left_limit: number = 0,right_limit: number = 0,needed_attributes: Array<string> = []): Promise<object> {

- **Parameter**: `constraint` (Object) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `order_columns` (Array<String>) - 
- **Parameter**: `order_type` (String) - 
- **Parameter**: `left_limit` (Number) - 
- **Parameter**: `right_limit` (Number) - 
- **Parameter**: `needed_attributes` (Array<String>) - 
- **Returns**: object

server

.getStatus()

public async getStatus(): Promise<object> {

- **Returns**: Object Object of status.

.createChannel()

public async createChannel(name: string,description: string,shop_active: number,server_output: string = 'json'): Promise<object> {

- **Parameter**: `name` (String) - 
- **Parameter**: `description` (String) - 
- **Parameter**: `shop_active` (Number) - 
- **Parameter**: `server_output` (String) - 'json' | 'xml'
- **Returns**: Object Object of created channel.
- **Returns**: object

sessions

.getNewSession()

public async getNewSession(): Promise<ISession | object> {

- **Returns**: ISession Object of session with either an existing or new session.

shopobjects

.getProductDetails()

public async getProductDetails(id_product: number,language: string = this.default_language,country: string = "DE",needed_attributes: Array<string> = []): Promise<object> {

- **Parameter**: `id_product` (Number) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `country` (String) - 
- **Parameter**: `needed_attributes` (Array<String>) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getContentDetails()

public async getContentDetails(id_content: number,language: string = this.default_language): Promise<object> {

- **Parameter**: `id_content` (Number) - 
- **Parameter**: `language` (String) - 
- **Returns**: Object Object of content details.
- **Returns**: object

.seoGetProductDetails()

public async seoGetProductDetails(permalink: string,country: string = "DE",needed_attributes: Array<string> = []): Promise<object> {

- **Parameter**: `permalink` (String) - 
- **Parameter**: `country` (String) - 
- **Parameter**: `needed_attributes` (Array<String>) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.seoGetContentDetails()

public async seoGetContentDetails(permalink: string): Promise<object> {

- **Parameter**: `permalink` (String) - 
- **Returns**: Object Object of content details.
- **Returns**: object

.createProduct()

public async createProduct(class_: string,name: string,shop_active: number = 1,attributes: object = {},metadata: object = {},seo: object = {},availability: object = {}): Promise<object> {

- **Parameter**: `class_` (String) - escaped since class is a reserved keyword
- **Parameter**: `name` (String) - 
- **Parameter**: `shop_active` (Number) - 
- **Parameter**: `attributes` (Object) - 
- **Parameter**: `metadata` (Object) - 
- **Parameter**: `seo` (Object) - 
- **Parameter**: `availability` (Object) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.updateProduct()

public async updateProduct(id_product: number,name: string,shop_active: number = 1,attributes: object = {},metadata: object = {},seo: object = {},availability: object = {}): Promise<object> {

- **Parameter**: `id_product` (Number) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `shop_active` (Number) - 
- **Parameter**: `attributes` (Object) - 
- **Parameter**: `metadata` (Object) - 
- **Parameter**: `seo` (Object) - 
- **Parameter**: `availability` (Object) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.createVariation()

public async createVariation(id_product: number,name: string,shop_active: number = 1,attributes: object = {},metadata: object = {},seo: object = {},availability: object = {}): Promise<object> {

- **Parameter**: `id_product` (Number) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `shop_active` (Number) - 
- **Parameter**: `attributes` (Object) - 
- **Parameter**: `metadata` (Object) - 
- **Parameter**: `seo` (Object) - 
- **Parameter**: `availability` (Object) - 
- **Returns**: Object Object of variation details.
- **Returns**: object

.deleteProduct()

public async deleteProduct(id_product: number): Promise<object> {

- **Parameter**: `id_product` (Number) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.deleteContent()

public async deleteContent(id_content: number): Promise<object> {

- **Parameter**: `id_content` (Number) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.updateContent()

public async updateContent(id_content: number,name: string,shop_active: number = 1,attributes: object = {},seo: object = {}): Promise<object> {

- **Parameter**: `id_content` (Number) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `shop_active` (Number) - 
- **Parameter**: `attributes` (Object) - 
- **Parameter**: `seo` (Object) - 
- **Returns**: Object Object of content details.
- **Returns**: object

user

.registerUser()

public async registerUser(username: string,passwd1: string,passwd2: string,email: string,language: string = this.default_language,class_: string = "user"): Promise<object> {

- **Parameter**: `username` (String) - 
- **Parameter**: `passwd1` (String) - 
- **Parameter**: `passwd2` (String) - 
- **Parameter**: `email` (String) - 
- **Parameter**: `language` (String) - 
- **Parameter**: `undefined` (class_) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.verifyUser()

public async verifyUser(id_user: number,session_id: string): Promise<object> {

- **Parameter**: `id_user` (Number) - 
- **Parameter**: `session_id` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.loginUser()

public async loginUser(username: string,password: string,session: string): Promise<object> {

- **Parameter**: `username` (String) - 
- **Parameter**: `password` (String) - 
- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.logoutUser()

public async logoutUser(session: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.setUserPassword()

public async setUserPassword(session: string,old_passwd: string,new_passwd1: string,new_passwd2: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `old_passwd` (String) - 
- **Parameter**: `new_passwd1` (String) - 
- **Parameter**: `new_passwd2` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.resetUserPasswordInit()

public async resetUserPasswordInit(email: string): Promise<object> {

- **Parameter**: `email` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.resetUserPasswordSuccess()

public async resetUserPasswordSuccess(session_id: string,id_user: number,new_passwd1: string,new_passwd2: string): Promise<object> {

- **Parameter**: `session_id` (String) - 
- **Parameter**: `id_user` (Number) - 
- **Parameter**: `new_passwd1` (String) - 
- **Parameter**: `new_passwd2` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getUserOrders()

public async getUserOrders(session: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getUserData()

public async getUserData(session: string): Promise<object> {

- **Parameter**: `session` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.getUserById()

public async getUserById(id_user: number): Promise<object> {

- **Parameter**: `id_user` (Number) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.setUserData()

public async setUserData(session: string,attributes: object): Promise<object> {

- **Parameter**: `session` (String) - 
- **Parameter**: `attributes` (Object) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.updateUserData()

public async updateUserData(id_user: number,attributes: object): Promise<object> {

- **Parameter**: `id_user` (Number) - 
- **Parameter**: `attributes` (Object) - 
- **Returns**: Object Object of product details.
- **Returns**: object

.instantLogin()

public async instantLogin(token: string,application_token: string): Promise<object> {

- **Parameter**: `token` (String) - 
- **Parameter**: `application_token` (String) - 
- **Returns**: Object Object of product details.
- **Returns**: object

warehouse

.createWarehouseEntity()

public async createWarehouseEntity(class_: string,name: string,id_manufacturer: number,attributes: object,metadata: object): Promise<object> {

- **Parameter**: `class_` (String) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `id_manufacturer` (Number) - 
- **Parameter**: `attributes` (Object) - 
- **Parameter**: `metadata` (Object) - 
- **Returns**: Object Object of created warehouse entity.
- **Returns**: object

.updateWarehouseEntity()

public async updateWarehouseEntity(id_warehouse_entity: number,name: string,id_manufacturer: number,attributes: object,metadata: object): Promise<object> {

- **Parameter**: `id_warehouse_entity` (Number) - 
- **Parameter**: `name` (String) - 
- **Parameter**: `id_manufacturer` (Number) - 
- **Parameter**: `attributes` (Object) - 
- **Parameter**: `metadata` (Object) - 
- **Returns**: Object Object of updated warehouse entity.
- **Returns**: object

.deleteWarehouseEntity()

public async deleteWarehouseEntity(id_warehouse_entity: number): Promise<object> {

- **Parameter**: `id_warehouse_entity` (Number) - 
- **Returns**: Object Object of deleted warehouse entity.
- **Returns**: object

.inventoryPlace()

public async inventoryPlace(storage: string,element_number: string,quantity: number,note: string): Promise<object> {

- **Parameter**: `storage` (String) - 
- **Parameter**: `element_number` (String) - 
- **Parameter**: `quantity` (Number) - 
- **Parameter**: `note` (String) - 
- **Returns**: Object Object of inventory place.
- **Returns**: object

.inventoryTake()

public async inventoryTake(storage: string,element_number: string,quantity: number,note: string): Promise<object> {

- **Parameter**: `storage` (String) - 
- **Parameter**: `element_number` (String) - 
- **Parameter**: `quantity` (Number) - 
- **Parameter**: `note` (String) - 
- **Returns**: Object Object of inventory take.
- **Returns**: object

.addBinding()

public async addBinding(id_product: number,element_number: string,quantity: number = 1): Promise<object> {

- **Parameter**: `id_product` (Number) - 
- **Parameter**: `element_number` (String) - 
- **Parameter**: `quantity` (Number) - Default is 1.
- **Returns**: Object Object of added binding.
- **Returns**: object

.deleteBinding()

public async deleteBinding(id_product: number,element_number: string): Promise<object> {

- **Parameter**: `id_product` (Number) - 
- **Parameter**: `element_number` (String) - 
- **Returns**: Object Object of deleted binding.
- **Returns**: object

webhooks

.createWebhook()

public async createWebhook(name: string,event: string): Promise<object> {

- **Parameter**: `name` (String) - 
- **Parameter**: `event` (String) - 
- **Returns**: Object Object of created webhook.
- **Returns**: object

.updateWebhook()

public async updateWebhook(name: string,url: string,parameter: string): Promise<object> {

- **Parameter**: `name` (String) - 
- **Parameter**: `url` (String) - 
- **Parameter**: `parameter` (String) - 
- **Returns**: Object Object of updated webhook.
- **Returns**: object