Partilhar via


Shopranos (Preview)

Elevate your business with Shopranos, linking ERP to B2B eCommerce. Trigger notifications and streamline approvals effortlessly, boosting efficiency and control. Unleash automation possibilities, driving success through seamless integration.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Shopranos
URL https://www.shopranos.eu
Email support@shopranos.eu
Connector Metadata
Publisher SoftOne Technologies S.A
Website https://www.shopranos.eu
Privacy Policy https://www.shopranos.eu/privacy-policy
Categories Commerce

Shopranos Power Automate Connector

Welcome to the Shopranos Power Automate Connector! This connector seamlessly integrates your company's ERP system with B2B eCommerce operations, empowering you to automate critical tasks and streamline workflows.

Publisher: Softone Technologies S.A.

Prerequisites

A Valid Shopranos subscription.

How to get credentials

To access your company's data using the Shopranos connector, follow these steps:

  1. Visit the Shopranos Platform login page at platform.shopranos.eu.
  2. After logging in, navigate to the menu and select "User API Keys."
  3. Generate a new API key from the options provided.
  4. Utilize this newly generated API key within the Shopranos connector to gain access to your company's data.

Get started with your connector

To get started with the Shopranos Power Automate Connector, follow these steps:

  1. Installation: Install the connector in your Power Automate environment.

  2. Configuration: Enter your Api Key in order to connect to Shopranos.

  3. Usage: Start automating tasks and workflows seamlessly.

Known issues and limitations

You can find a comprehensive list of all known issues by visiting the following link on GitHub:

Shopranos Issue Tracker

Common errors and remedies

Error 1: Invalid API Key

Symptom: When configuring the connector, you receive an error indicating that the API key is invalid. Remedy: Double-check that you have generated a valid API key in your Shopranos account. Ensure that there are no leading or trailing spaces in the API key when entering it in the connector configuration.

Error 2: Unable to Connect

Symptom: You are unable to establish a connection with the Shopranos platform when configuring the connector. Remedy: Ensure that you have correctly configured the connector with the API key. Verify that the Shopranos platform (platform.shopranos.eu) is accessible and not experiencing downtime. Check your network settings to confirm that there are no restrictions preventing the connector from connecting to external services.

Error 3: Missing Permissions

Symptom: You encounter permission-related errors when attempting to perform certain actions using the connector. Remedy: Verify that the API key you generated has the necessary permissions to access the specific resources or perform the actions you are trying to automate. Review the Shopranos documentation to understand the required permissions for various operations.

Error 4: Connector Installation Issues

Symptom: You face difficulties during the installation of the connector in your Power Automate environment. Remedy: Ensure that you follow the installation instructions provided for the Shopranos connector carefully. Check your Power Automate environment for any restrictions or policies that might be affecting the installation process. If the issue persists, reach out to Power Automate support for assistance.

Error 5: Unexpected Behavior

Symptom: The connector is not behaving as expected, or you are encountering unexplained errors during workflow execution. Remedy: Review your workflow configuration and ensure that the inputs and outputs are correctly mapped. Check for any changes or updates in the Shopranos API or connector documentation that might affect your workflow. If the issue persists, consult the Shopranos Issue Tracker on GitHub or contact Shopranos support.

Error 6: Limited Functionality

Symptom: You find that the connector has limited functionality or does not support certain actions. Remedy: Refer to the Shopranos Issue Tracker on GitHub to check if the limitations you are experiencing are known issues. If not, consider reaching out to Shopranos support to inquire about planned updates or workarounds for the limitations.

Error 7: Slow Performance

Symptom: The connector or workflows are experiencing slow performance. Remedy: Check your network connection and ensure that your Shopranos account is not experiencing performance issues. Additionally, review your workflow design to optimize it for efficiency. If the issue persists, consider reaching out to Shopranos support for assistance. These common errors and their corresponding remedies should help users troubleshoot and resolve issues when using the Shopranos Power Automate Connector. If you encounter any other specific errors or issues, don't hesitate to reach out to Shopranos support for personalized assistance.

FAQ

How can I get support if I encounter issues or have questions?

A: If you encounter any issues or have questions, please reach out to our support team at support@shopranos.eu. We are here to assist you in making the most of Shopranos to streamline your business processes and enhance efficiency.

What are the key benefits of using Shopranos?

Shopranos offers several key benefits, including:

Effortless Integration: Seamlessly connect your ERP system to B2B eCommerce, enhancing data flow and operational efficiency. Event-Driven Automation: Respond to critical events, such as order creation, with precision. Trigger instant notifications and automate approval processes with ease. Microsoft Power Automate Integration: Leverage the power of Microsoft Power Automate to unlock a wide array of automation possibilities. Send important messages, drive approval workflows, and simplify complex processes.

Deployment Instructions

As Shopranos operates as a Platform as a Service (PaaS), there is no manual deployment process required. The platform handles all aspects of deployment and infrastructure management, allowing users to focus directly on utilizing its services and features for their applications.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Assortment Create

Create an assortment

Assortment Delete

Delete an assortment by customer Id

Assortment Get By Customer Id

Get an assortment by customer Id

Assortment Update

Update an assortment by customer Id

Assortment Update Combinations

Update an assortment combinations by customer Id

Assortment Value Delete By Customer Id and Assortment Id

Delete assortment values by customer Id and assortment Id

Assortment Values Append By Customer Id

Append assortment values by customer Id

Assortment Values Delete By Customer Id

Delete assortment values by customer Id

Assortment Values Delete By Customer Source Id

Delete assortment values by customer Id and source

Assortment Values Get By Customer Id

Get assortment values by customer Id

Assortment Values Rebuild By Customer Id

Rebuild assortment values by customer Id

Assortment Values Update By Customer Id and Assortment Id

Update assortment values by customer Id and assortment Id

Assortments Query

Get all assortments

Attribute Create

Create attribute

Attribute Delete

Delete attribute

Attribute Get By Code

Get attribute by code

Attribute Get By Id

Get attribute by id

Attribute Query

Get attributes by search criteria

Attribute Set Create

Create attribute set

Attribute Set Delete

Delete attribute set

Attribute Set Get By Id

Get attribute set by id

Attribute Set Import

Import attribute sets

Attribute Set Query

Get attribute sets by search criteria

Attribute Set Update

Update attribute set

Attribute Update

Update attribute

Attributes Import

Import attributes

Brand Create

Create brand

Brand Delete

Delete brand

Brand Delete Additional Content

Delete additional content by brand id

Brand Get Additional Content By Id

Get additional content by brand id

Brand Get Additional Content By Id (HTML)

Get additional content by brand id

Brand Get by Alias

Get brand by alias

Brand Get by Id

Get brand by id

Brand Import

Import brands

Brand Import By Code

Import brands by codes

Brand Query

Get brands by search criteria

Brand Update

Update brand

Brand Update Additional Content

Update additional content by brand id

Cart Add Product

Add product to cart

Cart Create

Create Cart

Cart Delete

Delete Cart by token

Cart Get By Token

Get Cart by token

Cart Remove Product

Remove product from cart

Cart Update

Update Cart by token

Category Create

Create category

Category Delete

Delete category

Category Delete Additional Content

Delete additional content by category id

Category Get Additional Content By Id

Get additional content by category id

Category Get Additional Content By Id (HTML)

Get additional content by category id

Category Get By alias

Get category by alias

Category Get By Id

Get category by id

Category Import

Import categories

Category Query

Get categories by search criteria

Category Update

Update category

Category Update Additional Content

Update additional content by category id

Checkout Complete

Complete a checkout by token

Checkout Complete Payment

Complete a payment for a checkout by token

Checkout Create

Create a checkout by token

Checkout Get By Token

Get a checkout by token

Checkout Initiate Payment

Initiate a payment for a checkout by token

Checkout Recalculate

Recalculate a checkout by token

Checkout Update

Update a checkout by token

Collection Create

Create collection

Collection Delete

Delete collection

Collection Delete Additional Content

Delete additional content by collection id

Collection Extended Get by Alias

Get extended collection by alias

Collection Extended Get by Id

Get extended collection by id

Collection Extended Query

Query extended collections

Collection Get Additional Content By Id

Get additional content by collection id

Collection Get Additional Content By Id (HTML)

Get additional content by collection id

Collection Get by Id

Get collection by id

Collection Query

Get collections by search criteria

Collection Update

Update collection

Collection Update Additional Content

Update additional content by collection id

Customer Create

Create a customer

Customer Delete

Delete a customer by Id

Customer Get By Id

Get a customer by Id

Customer Group Create

Create a customer group

Customer Group Delete

Delete a customer group by Id

Customer group Get by Customer Id

Get a customer group by customer Id

Customer Group Get By Id

Get a customer group by Id

Customer Group Query

Get all customer groups

Customer Group Update

Update a customer group by Id

Customer Import

Import customers

Customer Query

Get all customers

Customer Update

Update a customer by Id

Filters Purge

Purge filters

Get all flat product variants

Get all flat product variants

Inventory Check Stock Availability

Check stock availability

Inventory Level Create

Create a inventory level

Inventory Level Delete

Delete a inventory level by Id

Inventory Level Get By Id

Get a inventory level by Id

Inventory Level Get By Variant Id

Get a inventory level by variant Id

Inventory Level Import

Import inventory levels

Inventory Level Query

Get all inventory levels

Inventory Level Update

Update a inventory level by Id

Inventory Reserve Stock Availability

Reserve stock availability

Inventory Unreserve Stock Availability

Unreserve stock availability

Location Create

Create a location

Location Delete

Delete a location by Id

Location Get All

Get all locations

Location Get By Id

Get a location by Id

Location Update

Update a location by Id

Order Create

Create a order

Order Delete

Delete a order by Id

Order Get By Id

Get a order by Id

Order Import

Import orders

Order Query

Get all orders

Order Update

Update a order by Id

Privacy Group Create

Create privacy group

Privacy Group Delete

Delete privacy group by id

Privacy Group Get By Id

Get privacy group by id

Privacy Group Query

Query privacy groups

Privacy Group Update

Update privacy group by id

Product Create

Create product

Product Delete

Delete product by id

Product Delete Additional Content

Delete additional content by product id

Product Extended Get By Alias

Get extended product by alias

Product Extended Query

Query extended products

Product Get Additional Content By Id

Get additional content by product id

Product Get Additional Content By Id (HTML)

Get additional content by product id

Product Get By Alias

Get product by alias

Product Get By Id

Get product by id

Product Import

Import products

Product Import By SKU

Import products by SKU

Product Label Create

Create product label

Product Label Delete

Delete product label by id

Product Label Get By Id

Get product label by id

Product Label Query

Query product labels

Product Label Update

Update product label by id

Product Query

Query products

Product Update

Update product by id

Product Updates Additional Content

Update additional content by product id

Related Products Create

Create related products

Related Products Delete

Delete related products

Related Products Update

Update related products

Shopping List Create

Create a shopping list

Shopping List Delete

Delete a shopping list by alias

Shopping List Get All

Get all shopping lists

Shopping List Get By Alias

Get a shopping list by alias

Shopping List Update

Update a shopping list by alias

Source Tag Product Import

Import source tag products

Stock Availability Create

Create stock availability

Stock Availability Delete

Delete stock availability by id

Stock Availability Get By Id

Get stock availability by id

Stock Availability Query

Query stock availability

Stock Availability Update

Update stock availability by id

Unit Create

Create unit

Unit Delete

Delete unit by id

Unit Get By Id

Get unit by id

Unit Import

Import units

Unit Query

Query units

Unit Update

Update unit by id

Assortment Create

Create an assortment

Parameters

Name Key Required Type Description
CustomerId
customerId string
Name
name string
Name
name string

Returns

Assortment Delete

Delete an assortment by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Delete an assortment by customer Id

Assortment Get By Customer Id

Get an assortment by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Get an assortment by customer Id

Returns

Assortment Update

Update an assortment by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Update an assortment by customer Id

Id
id string
Name
name string
Id
id string
Name
name string

Returns

Assortment Update Combinations

Update an assortment combinations by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Update an assortment combinations by customer Id

BranchId
branchId string
CategoryId
categoryId string
TypeId
typeId string

Returns

Assortment Value Delete By Customer Id and Assortment Id

Delete assortment values by customer Id and assortment Id

Parameters

Name Key Required Type Description
Customer Id
customerid True string

Delete assortment values by customer Id and assortment Id

Id
id string

Delete assortment values by id

Assortment Values Append By Customer Id

Append assortment values by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerid True string

Append assortment values by customer Id

ProductId
productId string
CategoryId
categoryId string
TypeId
typeId string
Status
status string
Source
source string

Returns

Assortment Values Delete By Customer Id

Delete assortment values by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerid True string

Delete assortment values by customer Id

Assortment Values Delete By Customer Source Id

Delete assortment values by customer Id and source

Parameters

Name Key Required Type Description
Customer Id
customerid True string

Delete assortment values by customer Id and source

Source
source True string

Delete assortment values by source

Assortment Values Get By Customer Id

Get assortment values by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerid True string

Get assortment values by customer Id

Status
Status string

Get assortment values by status

Source
Source string

Get assortment values by source

Type
Type string

Get assortment values by type

Category
Category string

Get assortment values by category

Id
Id string

Get assortment values by id

Product Id
ProductId string

Get assortment values by product id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Assortment Values Rebuild By Customer Id

Rebuild assortment values by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Rebuild assortment values by customer Id

Assortment Values Update By Customer Id and Assortment Id

Update assortment values by customer Id and assortment Id

Parameters

Name Key Required Type Description
Id
id True string

Update assortment values by id

Customer Id
customerId True string

Update assortment values by customer Id and assortment Id

Status
status string

Assortments Query

Get all assortments

Parameters

Name Key Required Type Description
Customer Id
CustomerId string

Get all assortments by customer Id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Attribute Create

Create attribute

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Name
name True string
Code
code True string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Type
type string
Slug
slug string
Position
position integer
Status
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Id
id string
Code
code string
ColorCode
colorCode string
Value
value string
Position
position integer
Slug
slug string
Translation
translation
Translation
translation

Returns

Attribute Delete

Delete attribute

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the attribute

Attribute Get By Code

Get attribute by code

Parameters

Name Key Required Type Description
Code
code True string

Set the code of the attribute

Returns

Attribute Get By Id

Get attribute by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the attribute

Returns

Attribute Query

Get attributes by search criteria

Parameters

Name Key Required Type Description
Status
Status string

Set the status of the attribute

Type
Type string

Set the type of the attribute

Is Filterable
IsFilterable boolean

Set the is filterable of the attribute

Display On Product
DisplayOnProduct boolean

Set the display on product of the attribute

Display In List
DisplayInList boolean

Set the display in list of the attribute

Search
Search string

Set the search of the attribute

Id
Id string

Set the id of the attribute

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Attribute Set Create

Create attribute set

Parameters

Name Key Required Type Description
Title
title string
Description
description string
Title
title string
Id
id string
Position
position integer
Id
id string
Position
position integer

Returns

Attribute Set Delete

Delete attribute set

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the attribute set

Attribute Set Get By Id

Get attribute set by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the attribute set

Returns

Attribute Set Import

Import attribute sets

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Title
title string
Description
description string
Title
title string
Id
id string
Position
position integer
Id
id string
Position
position integer
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Attribute Set Query

Get attribute sets by search criteria

Parameters

Name Key Required Type Description
Title
Title string

Query by title

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Attribute Set Update

Update attribute set

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the attribute set

Title
title string
Description
description string
Title
title string
Id
id string
Position
position integer
Id
id string
Position
position integer

Returns

Attribute Update

Update attribute

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the attribute

Id
id string
CompanyId
companyId string
Name
name True string
Code
code True string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Type
type string
Slug
slug string
Position
position integer
Status
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Id
id string
Code
code string
ColorCode
colorCode string
Value
value string
Position
position integer
Slug
slug string
Translation
translation
Translation
translation

Returns

Attributes Import

Import attributes

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Name
name True string
Code
code True string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Type
type string
Slug
slug string
Position
position integer
Status
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Id
id string
Code
code string
ColorCode
colorCode string
Value
value string
Position
position integer
Slug
slug string
Translation
translation
Translation
translation

Brand Create

Create brand

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Code
code True string
Name
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescription
metaDescription string
Status
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Returns

Body
BrandDTO

Brand Delete

Delete brand

Parameters

Name Key Required Type Description
Brand Id
brandId True string

Set the id of the brand

Brand Delete Additional Content

Delete additional content by brand id

Parameters

Name Key Required Type Description
Brand Id
brandId True string

Set the id of the brand

Brand Get Additional Content By Id

Get additional content by brand id

Parameters

Name Key Required Type Description
Brand Id
brandId True string

Set the id of the brand

Returns

Brand Get Additional Content By Id (HTML)

Get additional content by brand id

Parameters

Name Key Required Type Description
Brand Id
brandId True string

Set the id of the brand

Returns

Brand Get by Alias

Get brand by alias

Parameters

Name Key Required Type Description
Brand Alias
brandAlias True string

Set the alias of the brand

Returns

Body
BrandDTO

Brand Get by Id

Get brand by id

Parameters

Name Key Required Type Description
Brand Id
brandId True string

Set the id of the brand

Returns

Body
BrandDTO

Brand Import

Import brands

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Code
code True string
Name
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescription
metaDescription string
Status
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Brand Import By Code

Import brands by codes

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Code
code True string
Name
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescription
metaDescription string
Status
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Brand Query

Get brands by search criteria

Parameters

Name Key Required Type Description
Status
Status string

Set the status of the brand

Search
Search string

Set the search of the brand

Code
Code string

Set the code of the brand

Id
Id string

Set the id of the brand

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Brand Update

Update brand

Parameters

Name Key Required Type Description
Brand Id
brandId True string

Set the id of the brand

Id
id string
CompanyId
companyId string
Code
code True string
Name
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescription
metaDescription string
Status
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Brand Update Additional Content

Update additional content by brand id

Parameters

Name Key Required Type Description
Brand Id
brandId True string

Set the id of the brand

Id
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Id
id string
Title
title string
Description
description string
Position
position integer
MediaItem
mediaItem
Translation
translation

Cart Add Product

Add product to cart

Parameters

Name Key Required Type Description
token
token True string

Get Cart by token

Id
id string
ProductId
productId string
ProductVariantId
productVariantId string
Quantity
quantity double
Sku
sku string
Mode
mode string

Returns

Body
CartDTO

Cart Create

Create Cart

Parameters

Name Key Required Type Description
Currency
currency string
Id
id string
ProductId
productId string
ProductVariantId
productVariantId string
Quantity
quantity double
Sku
sku string
Mode
mode string

Returns

Body
CartDTO

Cart Delete

Delete Cart by token

Parameters

Name Key Required Type Description
token
token True string

Delete Cart by token

Cart Get By Token

Get Cart by token

Parameters

Name Key Required Type Description
token
token True string

Get Cart by token

Returns

Body
CartDTO

Cart Remove Product

Remove product from cart

Parameters

Name Key Required Type Description
token
token True string

Get Cart by token

productVariantId
productVariantId True string

Get Cart by token

Cart Update

Update Cart by token

Parameters

Name Key Required Type Description
token
token True string

Update Cart by token

Currency
currency string
Id
id string
ProductId
productId string
ProductVariantId
productVariantId string
Quantity
quantity double
Sku
sku string
Mode
mode string

Returns

Body
CartDTO

Category Create

Create category

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Title
title True string
Code
code True string
Alias
alias string
Description
description string
Position
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Path
path string
MediaItem
mediaItem
Translation
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Status
status string

Returns

Category Delete

Delete category

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the category

Category Delete Additional Content

Delete additional content by category id

Parameters

Name Key Required Type Description
Category Id
categoryId True string

Set the id of the category

Category Get Additional Content By Id

Get additional content by category id

Parameters

Name Key Required Type Description
Category Id
categoryId True string

Set the id of the category

Returns

Category Get Additional Content By Id (HTML)

Get additional content by category id

Parameters

Name Key Required Type Description
Category Id
categoryId True string

Set the id of the category

Returns

Category Get By alias

Get category by alias

Parameters

Name Key Required Type Description
Alias
alias True string

Set the alias of the category

Returns

Category Get By Id

Get category by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the category

Returns

Category Import

Import categories

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Title
title True string
Code
code True string
Alias
alias string
Description
description string
Position
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Path
path string
MediaItem
mediaItem
Translation
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Status
status string

Category Query

Get categories by search criteria

Parameters

Name Key Required Type Description
Title
Title string

Set the title of the category

Id
Id string

Set the id of the category

Search
Search string

Set the search keyword for the category

Code
Code string

Set the code of the category

Parent Id
ParentId string

Set the parent id of the category

Path
Path string

Set the path of the category

Parent Ids
ParentIds string

Set the parent ids of the category

Status
Status string

Set the status of the category

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Category Update

Update category

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the category

Id
id string
CompanyId
companyId string
Title
title True string
Code
code True string
Alias
alias string
Description
description string
Position
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Path
path string
MediaItem
mediaItem
Translation
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Status
status string

Returns

Category Update Additional Content

Update additional content by category id

Parameters

Name Key Required Type Description
Category Id
categoryId True string

Set the id of the category

Id
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Id
id string
Title
title string
Description
description string
Position
position integer
MediaItem
mediaItem
Translation
translation

Checkout Complete

Complete a checkout by token

Parameters

Name Key Required Type Description
Token
token True string

Complete a checkout by token

Notes
notes string
ReferenceCode
referenceCode string
ShippingAddress
shippingAddress
ShippingLine
shippingLine
Payment
payment
CustomerBranchId
customerBranchId string
Name
name string
Value
value
Id
id string
Name
name string
Address
address
DeliveryDate
deliveryDate date-time

Returns

Checkout Complete Payment

Complete a payment for a checkout by token

Parameters

Name Key Required Type Description
Token
token True string

Complete a payment for a checkout by token

Id
id string
CompanyId
companyId string
CustomerId
customerId string
CheckoutToken
checkoutToken string
Amount
amount double
CommissionAmount
commissionAmount double
RemittanceInformation
remittanceInformation string
Provider
provider string
Status
status string
PaymentDate
paymentDate date-time
CreationDate
creationDate date-time
ApprovalCode
approvalCode string
CardType
cardType string
CardNumber
cardNumber string
PostDating
postDating integer
Installments
installments integer
BankId
bankId string
TransactionId
transactionId string

Returns

Checkout Create

Create a checkout by token

Parameters

Name Key Required Type Description
Token
token True string

Create a checkout by token

Language
lang string

Language

Returns

Checkout Get By Token

Get a checkout by token

Parameters

Name Key Required Type Description
Token
token True string

Get a checkout by token

Returns

Checkout Initiate Payment

Initiate a payment for a checkout by token

Parameters

Name Key Required Type Description
Token
token True string

Initiate a payment for a checkout by token

ProviderId
providerId True string

Set a payment provider for a checkout by token

Returns

Checkout Recalculate

Recalculate a checkout by token

Parameters

Name Key Required Type Description
Token
token True string

Recalculate a checkout by token

Language
lang string

Language

Returns

Checkout Update

Update a checkout by token

Parameters

Name Key Required Type Description
Token
token True string

Upate a checkout by token

Notes
notes string
ReferenceCode
referenceCode string
ShippingAddress
shippingAddress
ShippingLine
shippingLine
Payment
payment
CustomerBranchId
customerBranchId string
Name
name string
Value
value
Id
id string
Name
name string
Address
address
DeliveryDate
deliveryDate date-time

Returns

Collection Create

Create collection

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Status
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ProductCount
productCount integer
ProductIds
productIds array of string
Id
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
Id
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
Width
width integer
Height
height integer
Id
id string
ProductId
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
Quantity
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Expected
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time
Id
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Status
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ProductCount
productCount integer
ProductIds
productIds array of string
Id
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
Id
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
Width
width integer
Height
height integer
Id
id string
ProductId
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
Quantity
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Expected
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Tags
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Translation
translation
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Tags
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Translation
translation
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string

Collection Delete

Delete collection

Parameters

Name Key Required Type Description
Collection Id
collectionId True string

Set the id of the collection

Collection Delete Additional Content

Delete additional content by collection id

Parameters

Name Key Required Type Description
Collection Id
collectionId True string

Set the id of the collection

Collection Extended Get by Alias

Get extended collection by alias

Parameters

Name Key Required Type Description
Language
lang string

Set the language

Alias
alias True string

Set the alias of the collection

Returns

Collection Extended Get by Id

Get extended collection by id

Parameters

Name Key Required Type Description
Language
lang string

Set the language

Id
id True string

Set the id of the collection

Returns

Collection Extended Query

Query extended collections

Parameters

Name Key Required Type Description
Status
Status string

Set the status

Title
Title string

Set the title

Id
Id string

Set the id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Language
lang string

Set the language

Returns

Collection Get Additional Content By Id

Get additional content by collection id

Parameters

Name Key Required Type Description
Collection Id
collectionId True string

Set the id of the collection

Returns

Collection Get Additional Content By Id (HTML)

Get additional content by collection id

Parameters

Name Key Required Type Description
Collection Id
collectionId True string

Set the id of the collection

Returns

Collection Get by Id

Get collection by id

Parameters

Name Key Required Type Description
Collection Id
collectionId True string

Set the id of the collection

Returns

Collection Query

Get collections by search criteria

Parameters

Name Key Required Type Description
Status
Status string

Set the status of the collection

Title
Title string

Set the title of the collection

Id
Id string

Set the id of the collection

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Collection Update

Update collection

Parameters

Name Key Required Type Description
Collection Id
collectionId True string

Set the id of the collection

Id
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Status
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ProductCount
productCount integer
ProductIds
productIds array of string
Id
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
Id
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
Width
width integer
Height
height integer
Id
id string
ProductId
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
Quantity
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Expected
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time
Id
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Status
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ProductCount
productCount integer
ProductIds
productIds array of string
Id
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
Id
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
Width
width integer
Height
height integer
Id
id string
ProductId
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
Quantity
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Expected
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Tags
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Translation
translation
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Tags
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Translation
translation
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string

Collection Update Additional Content

Update additional content by collection id

Parameters

Name Key Required Type Description
Collection Id
collectionId True string

Set the id of the collection

Id
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Id
id string
Title
title string
Description
description string
Position
position integer
MediaItem
mediaItem
Translation
translation

Customer Create

Create a customer

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Code
code string
Name
name string
Tin
tin string
Email
email string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Tags
tags array of string
SourceTags
sourceTags array of string
Address
address
Notes
notes string
Status
status string
Id
id string
SourceId
sourceId string
Code
code string
Name
name string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
Address
address
Status
status string
AdditionalFeatures
additionalFeatures
Name
name string
Value
value
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
Name
name string
Address
address

Returns

Customer Delete

Delete a customer by Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Delete a customer by Id

Customer Get By Id

Get a customer by Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Get a customer by Id

Returns

Customer Group Create

Create a customer group

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Title
title True string
Status
status string
Rule
rule
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Returns

Customer Group Delete

Delete a customer group by Id

Parameters

Name Key Required Type Description
Id
Id True string

Delete a customer group by Id

Customer group Get by Customer Id

Get a customer group by customer Id

Parameters

Name Key Required Type Description
Customer Id
customerId string

Get a customer group by customer Id

Returns

Customer Group Get By Id

Get a customer group by Id

Parameters

Name Key Required Type Description
Id
Id True string

Get a customer group by Id

Returns

Customer Group Query

Get all customer groups

Parameters

Name Key Required Type Description
Status
Status string

Get all customer groups by status

Title
Title string

Get all customer groups by title

Id
Id string

Get all customer groups by id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Customer Group Update

Update a customer group by Id

Parameters

Name Key Required Type Description
Id
Id True string

Update a customer group by Id

Id
id string
CompanyId
companyId string
Title
title True string
Status
status string
Rule
rule
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Customer Import

Import customers

Parameters

Name Key Required Type Description
Address1
address1 string
Address2
address2 string
City
city string
State
state string
Country
country string
CountryCode
countryCode string
PostalCode
postalCode string
Id
id string
SourceId
sourceId string
Code
code string
Name
name string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
Address
address
VatType
vatType string
Status
status string
ContactLanguage
contactLanguage string
Address1
address1 string
Address2
address2 string
City
city string
State
state string
Country
country string
CountryCode
countryCode string
PostalCode
postalCode string
Id
id string
CompanyId
companyId string
Code
code string
Name
name string
Tin
tin string
Email
email string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Tags
tags array of string
SourceTags
sourceTags array of string
Address
address
Notes
notes string
Status
status string
AdditionalFeatures
additionalFeatures
Name
name string
Value
value
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
Name
name string
Address
address

Customer Query

Get all customers

Parameters

Name Key Required Type Description
Status
Status string

Get all customers by status

Search
Search string

Get all customers by search text

Name
Name string

Get all customers by name

Salesman Id
SalesmanId string

Get all customers by salesman id

Id
Id string

Get all customers by id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Customer Update

Update a customer by Id

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Update a customer by Id

Id
id string
CompanyId
companyId string
Code
code string
Name
name string
Tin
tin string
Email
email string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Tags
tags array of string
SourceTags
sourceTags array of string
Address
address
Notes
notes string
Status
status string
Id
id string
SourceId
sourceId string
Code
code string
Name
name string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
Address
address
Status
status string
AdditionalFeatures
additionalFeatures
Name
name string
Value
value
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
Name
name string
Address
address

Filters Purge

Purge filters

Get all flat product variants

Get all flat product variants

Parameters

Name Key Required Type Description
Price
Price string

Set the price

Max Price
MaxPrice double

Set the max price

Size 1
Size1 string

Set the size 1

Size 2
Size2 string

Set the size 2

Size 3
Size3 string

Set the size 3

Insert Date
InsertDate string

Set the insert date

Date 1
Date1 string

Set the date 1

Date 2
Date2 string

Set the date 2

Date 3
Date3 string

Set the date 3

Date 1 Date Range
Date1DateRange string

Set the date 1 date range

Date 2 Date Range
Date2DateRange string

Set the date 2 date range

Date 3 Date Range
Date3DateRange string

Set the date 3 date range

Insert Date Range
InsertDateRange string

Set the insert date range

Search
Search string

Set the search

Min Price
MinPrice double

Set the min price

Status
Status string

Set the status

Availability
Availability string

Set the availability

Tag
Tag string

Set the tag

Source Tag
SourceTag string

Set the source tag

Privacy Rule
PrivacyRule string

Set the privacy rule

Rule
Rule string

Set the rule

Condition
Condition string

Set the condition

Ids
Ids string

Set the ids

Id
Id string

Set the id

Price Range
PriceRange string

Set the price range

Brand Code
BrandCode string

Set the brand code

Brand Id
BrandId string

Set the brand id

Attribute
Attribute string

Set the attribute

Path Category
PathCategory string

Set the path category

Category Id
CategoryId string

Set the category id

Additional Category Id
AdditionalCategoryId string

Set the additional category id

Stock Availability Id
StockAvailabilityId string

Set the stock availability id

Attribute Set Id
AttributeSetId string

Set the attribute set id

Price Category Id
PriceCategoryId string

Set the price category id

Has Media
HasMedia boolean

Set the has media

Master Id
MasterId string

Set the master id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Inventory Check Stock Availability

Check stock availability

Parameters

Name Key Required Type Description
ProductId
productId string
ProductVariantId
productVariantId string
Quantity
quantity double

Returns

Inventory Level Create

Create a inventory level

Parameters

Name Key Required Type Description
Id
id string
ProductVariantId
productVariantId string
ProductId
productId string
CompanyId
companyId string
LocationId
locationId string
Quantity
quantity double
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double
UpdateDate
updateDate date-time

Returns

Inventory Level Delete

Delete a inventory level by Id

Parameters

Name Key Required Type Description
Id
id True string

Delete a inventory level by Id

Inventory Level Get By Id

Get a inventory level by Id

Parameters

Name Key Required Type Description
Id
id True string

Get a inventory level by Id

Returns

Inventory Level Get By Variant Id

Get a inventory level by variant Id

Parameters

Name Key Required Type Description
Variant Id
variantId True string

Get a inventory level by variant Id

Returns

Inventory Level Import

Import inventory levels

Parameters

Name Key Required Type Description
Id
id string
ProductVariantId
productVariantId string
ProductId
productId string
CompanyId
companyId string
LocationId
locationId string
Quantity
quantity double
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double
UpdateDate
updateDate date-time

Inventory Level Query

Get all inventory levels

Parameters

Name Key Required Type Description
Location
Location string

Get all inventory levels by location

Variant Ids
VariantIds string

Get all inventory levels by variant ids

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Inventory Level Update

Update a inventory level by Id

Parameters

Name Key Required Type Description
Id
id True string

Update a inventory level by Id

Id
id string
ProductVariantId
productVariantId string
ProductId
productId string
CompanyId
companyId string
LocationId
locationId string
Quantity
quantity double
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double
UpdateDate
updateDate date-time

Inventory Reserve Stock Availability

Reserve stock availability

Parameters

Name Key Required Type Description
Token
token string
ProductId
productId string
ProductVariantId
productVariantId string
Quantity
quantity double

Returns

Inventory Unreserve Stock Availability

Unreserve stock availability

Parameters

Name Key Required Type Description
Token
token True string

Unreserve stock availability by token

Returns

Location Create

Create a location

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Name
name string
IsActive
isActive boolean
Address
address
Phone
phone string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Returns

Location Delete

Delete a location by Id

Parameters

Name Key Required Type Description
Location Id
locationId True string

Delete a location by Id

Location Get All

Get all locations

Returns

Location Get By Id

Get a location by Id

Parameters

Name Key Required Type Description
Location Id
locationId True string

Get a location by Id

Returns

Location Update

Update a location by Id

Parameters

Name Key Required Type Description
Location Id
locationId True string

Update a location by Id

Id
id string
CompanyId
companyId string
Name
name string
IsActive
isActive boolean
Address
address
Phone
phone string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Order Create

Create a order

Parameters

Name Key Required Type Description
Id
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Status
status string
CustomerId
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
CustomerName
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Currency
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
DiscountRate
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
Id
id string
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantity
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Price
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
UnitPrice
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
DiscountRate
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double
Tags
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Notes
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notify
notify string
Notified
notified array of string
Name
name string
Value
value
ShippingLine
shippingLine
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
Quantity
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string
Id
id string
NetValue
netValue double
VatValue
vatValue double
Payment
payment
SeriesId
seriesId string

Order Delete

Delete a order by Id

Parameters

Name Key Required Type Description
Id
id True string

Delete a order by Id

Order Get By Id

Get a order by Id

Parameters

Name Key Required Type Description
Id
id True string

Get a order by Id

Returns

Body
OrderDTO

Order Import

Import orders

Parameters

Name Key Required Type Description
Id
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Status
status string
CustomerId
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
CustomerName
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Currency
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
DiscountRate
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
Id
id string
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantity
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Price
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
UnitPrice
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
DiscountRate
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double
Tags
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Notes
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notify
notify string
Notified
notified array of string
Name
name string
Value
value
ShippingLine
shippingLine
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
Quantity
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string
Id
id string
NetValue
netValue double
VatValue
vatValue double
Payment
payment
SeriesId
seriesId string

Order Query

Get all orders

Parameters

Name Key Required Type Description
Search
Search string

Search text

Code
Code string

Get all orders by code

Customer Id
CustomerId string

Get all orders by customer id

Order Status
OrderStatus string

Get all orders by order status

Status
Status string

Get all orders by status

Tag
Tag string

Get all orders by tag

Customer Code
CustomerCode string

Get all orders by customer code

Customer Tin
CustomerTin string

Get all orders by customer tin

Insert Date
InsertDate string

Get all orders by insert date

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Order Update

Update a order by Id

Parameters

Name Key Required Type Description
Id
id True string

Update a order by Id

Id
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Status
status string
CustomerId
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
CustomerName
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Currency
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
DiscountRate
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
Id
id string
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantity
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Price
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
UnitPrice
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
DiscountRate
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double
Tags
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Notes
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notify
notify string
Notified
notified array of string
Name
name string
Value
value
ShippingLine
shippingLine
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
Quantity
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string
Id
id string
NetValue
netValue double
VatValue
vatValue double
Payment
payment
SeriesId
seriesId string

Privacy Group Create

Create privacy group

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Title
title string
Status
status string
Mode
mode string
ProductIds
productIds array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Rule
rule
CustomerGroupIds
customerGroupIds array of string
CustomerIds
customerIds array of string

Returns

Privacy Group Delete

Delete privacy group by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the privacy group

Privacy Group Get By Id

Get privacy group by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the privacy group

Returns

Privacy Group Query

Query privacy groups

Parameters

Name Key Required Type Description
Title
Title string

Set the title

Status
Status string

Set the status

Customer Ids
CustomerIds string

Set the customer ids

Customer Group Ids
CustomerGroupIds string

Set the customer group ids

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Privacy Group Update

Update privacy group by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the privacy group

Id
id string
CompanyId
companyId string
Title
title string
Status
status string
Mode
mode string
ProductIds
productIds array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Rule
rule
CustomerGroupIds
customerGroupIds array of string
CustomerIds
customerIds array of string

Product Create

Create product

Parameters

Name Key Required Type Description
Id
id string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
Id
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time

Returns

Body
ProductDTO

Product Delete

Delete product by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the product

Product Delete Additional Content

Delete additional content by product id

Parameters

Name Key Required Type Description
Product Id
productId True string

Set the id of the product

Product Extended Get By Alias

Get extended product by alias

Parameters

Name Key Required Type Description
Language
lang string

Set the language

Extend
extend string

Set the fields to extend

Alias
alias True string

Set the alias of the product

Returns

Product Extended Query

Query extended products

Parameters

Name Key Required Type Description
Language
lang string

Set the language

Extend
extend string

Set the fields to extend

Price
Price string

Set the price

Max Price
MaxPrice double

Set the max price

Size 1
Size1 string

Set the size 1

Size 2
Size2 string

Set the size 2

Size 3
Size3 string

Set the size 3

Insert Date
InsertDate string

Set the insert date

Date 1
Date1 string

Set the date 1

Date 2
Date2 string

Set the date 2

Date 3
Date3 string

Set the date 3

Date 1 Date Range
Date1DateRange string

Set the date 1 date range

Date 2 Date Range
Date2DateRange string

Set the date 2 date range

Date 3 Date Range
Date3DateRange string

Set the date 3 date range

Insert Date Range
InsertDateRange string

Set the insert date range

Search
Search string

Set the search text

Min Price
MinPrice double

Set the min price

Status
Status string

Set the status

Availability
Availability string

Set the availability

Tag
Tag string

Set the tag

Source Tag
SourceTag string

Set the source tag

Privacy Rule
PrivacyRule string

Set the privacy rule

Rule
Rule string

Set the rule

Condition
Condition string

Set the condition

Ids
Ids string

Set the ids

Id
Id string

Set the id

Price Range
PriceRange string

Set the price range

Brand Code
BrandCode string

Set the brand code

Brand Id
BrandId string

Set the brand id

Attribute
Attribute string

Set the attribute

Path Category
PathCategory string

Set the path category

Category Id
CategoryId string

Set the category id

Additional Category Id
AdditionalCategoryId string

Set the additional category id

Stock Availability Id
StockAvailabilityId string

Set the stock availability id

Attribute Set Id
AttributeSetId string

Set the attribute set id

Price Category Id
PriceCategoryId string

Set the price category id

Has Media
HasMedia boolean

Set the has media

Master Id
MasterId string

Set the master id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Product Get Additional Content By Id

Get additional content by product id

Parameters

Name Key Required Type Description
Product Id
productId True string

Set the id of the product

Returns

Product Get Additional Content By Id (HTML)

Get additional content by product id

Parameters

Name Key Required Type Description
Product Id
productId True string

Set the id of the product

Returns

Product Get By Alias

Get product by alias

Parameters

Name Key Required Type Description
Alias
alias True string

Set the alias of the product

Returns

Body
ProductDTO

Product Get By Id

Get product by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the product

Returns

Body
ProductDTO

Product Import

Import products

Parameters

Name Key Required Type Description
Id
id string
CategoryCode
categoryCode string
Id
id string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
Id
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time

Product Import By SKU

Import products by SKU

Parameters

Name Key Required Type Description
Id
id string
CategoryCode
categoryCode string
Id
id string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
Id
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time

Product Label Create

Create product label

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Name
name string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Icon
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string
ProductIds
productIds array of string
RuleEnabled
ruleEnabled boolean
DateFrom
dateFrom date-time
DateTo
dateTo date-time
Mode
mode string
Status
status string
Rule
rule
Translation
translation

Returns

Body
IcoTagDTO

Product Label Delete

Delete product label by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the product label

Product Label Get By Id

Get product label by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the product label

Returns

Body
IcoTagDTO

Product Label Query

Query product labels

Parameters

Name Key Required Type Description
Name
Name string

Set the name

Status
Status string

Set the status

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Product Label Update

Update product label by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the product label

Id
id string
CompanyId
companyId string
Name
name string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Icon
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string
ProductIds
productIds array of string
RuleEnabled
ruleEnabled boolean
DateFrom
dateFrom date-time
DateTo
dateTo date-time
Mode
mode string
Status
status string
Rule
rule
Translation
translation

Product Query

Query products

Parameters

Name Key Required Type Description
Price
Price string

Set the price

Max Price
MaxPrice double

Set the max price

Size 1
Size1 string

Set the size 1

Size 2
Size2 string

Set the size 2

Size 3
Size3 string

Set the size 3

Insert Date
InsertDate string

Set the insert date

Date 1
Date1 string

Set the date 1

Date 2
Date2 string

Set the date 2

Date 3
Date3 string

Set the date 3

Date 1 Date Range
Date1DateRange string

Set the date 1 date range

Date 2 Date Range
Date2DateRange string

Set the date 2 date range

Date 3 Date Range
Date3DateRange string

Set the date 3 date range

Insert Date Range
InsertDateRange string

Set the insert date range

Search
Search string

Set the search text

Min Price
MinPrice double

Set the min price

Status
Status string

Set the status

Availability
Availability string

Set the availability

Tag
Tag string

Set the tag

Source Tag
SourceTag string

Set the source tag

Privacy Rule
PrivacyRule string

Set the privacy rule

Rule
Rule string

Set the rule

Condition
Condition string

Set the condition

Ids
Ids string

Set the ids

Id
Id string

Set the id

Price Range
PriceRange string

Set the price range

Brand Code
BrandCode string

Set the brand code

Brand Id
BrandId string

Set the brand id

Attribute
Attribute string

Set the attribute

Path Category
PathCategory string

Set the path category

Category Id
CategoryId string

Set the category id

Additional Category Id
AdditionalCategoryId string

Set the additional category id

Stock Availability Id
StockAvailabilityId string

Set the stock availability id

Attribute Set Id
AttributeSetId string

Set the attribute set id

Price Category Id
PriceCategoryId string

Set the price category id

Has Media
HasMedia boolean

Set the has media

Master Id
MasterId string

Set the master id

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Product Update

Update product by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the product

Id
id string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation
Id
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Name
name string
Value
value
Translation
translation
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time

Product Updates Additional Content

Update additional content by product id

Parameters

Name Key Required Type Description
Product Id
productId True string

Set the id of the product

Id
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Id
id string
Title
title string
Description
description string
Position
position integer
MediaItem
mediaItem
Translation
translation

Create related products

Parameters

Name Key Required Type Description
Product Id
productId True string

Set the product id

Variant Id
variantId True string

Set the variant id

Returns

Delete related products

Parameters

Name Key Required Type Description
Product Id
productId True string

Set the product id

Variant Id
variantId True string

Set the variant id

Update related products

Parameters

Name Key Required Type Description
Product Id
productId True string

Set the product id

Variant Id
variantId True string

Set the variant id

Id
id string
ProductId
productId string
CompanyId
companyId string
Dimension1ItemIds
dimension1ItemIds array of string
Dimension2ItemIds
dimension2ItemIds array of string
Dimension3ItemIds
dimension3ItemIds array of string

Shopping List Create

Create a shopping list

Parameters

Name Key Required Type Description
Id
id string
Title
title string
CompanyId
companyId string
CustomerId
customerId string
UserId
userId string
Alias
alias string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time
ProductId
productId string
ProductVariantId
productVariantId string

Returns

Shopping List Delete

Delete a shopping list by alias

Parameters

Name Key Required Type Description
Alias
alias True string

Get a shopping list by alias

Shopping List Get All

Get all shopping lists

Returns

Shopping List Get By Alias

Get a shopping list by alias

Parameters

Name Key Required Type Description
Alias
alias True string

Alias

Returns

Shopping List Update

Update a shopping list by alias

Parameters

Name Key Required Type Description
Alias
alias True string

Set a shopping list by alias

Id
id string
Title
title string
CompanyId
companyId string
CustomerId
customerId string
UserId
userId string
Alias
alias string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time
ProductId
productId string
ProductVariantId
productVariantId string

Source Tag Product Import

Import source tag products

Parameters

Name Key Required Type Description
Id
id string
Name
name string

Stock Availability Create

Create stock availability

Parameters

Name Key Required Type Description
Code
code string
Title
title string
Translation
translation
MediaItem
mediaItem
Message
message string
Quantity
quantity integer
Color
color string
Translation
translation

Returns

Stock Availability Delete

Delete stock availability by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the stock availability

Stock Availability Get By Id

Get stock availability by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the stock availability

Returns

Stock Availability Query

Query stock availability

Parameters

Name Key Required Type Description
Title
Title string

Set the title

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

Stock Availability Update

Update stock availability by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the stock availability

Code
code string
Title
title string
Translation
translation
MediaItem
mediaItem
Message
message string
Quantity
quantity integer
Color
color string
Translation
translation

Unit Create

Create unit

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Code
code True string
Name
name True string
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Returns

Body
UnitDTO

Unit Delete

Delete unit by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the unit

Unit Get By Id

Get unit by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the unit

Returns

Body
UnitDTO

Unit Import

Import units

Parameters

Name Key Required Type Description
Id
id string
CompanyId
companyId string
Code
code True string
Name
name True string
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Unit Query

Query units

Parameters

Name Key Required Type Description
Name
Name string

Set the name

Page
Page integer

Set the page number

Page Size
PageSize integer

Set the page size

Sort
Sort string

Set sort field and direction

Returns

response
array of UnitDTO

Unit Update

Update unit by id

Parameters

Name Key Required Type Description
Id
id True string

Set the id of the unit

Id
id string
CompanyId
companyId string
Code
code True string
Name
name True string
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Triggers

When a Brand is Created

This operation triggers when a new brand is created

When a Brand is Deleted

This operation triggers when a brand is deleted

When a Brand is Updated

This operation triggers when a brand is updated

When a Category is Created

This operation triggers when a new category is created

When a Category is Deleted

This operation triggers when a product is deleted

When a Category is Updated

This operation triggers when a category is updated

When a Checkout is Completed

This operation triggers when a product is updated

When a Checkout is Created

This operation triggers when a new checkout is created

When a Customer is Created

This operation triggers when a new Customer is created

When a Customer is Deleted

This operation triggers when a Customer is deleted

When a Payment is Completed

This operation triggers when a payment is deleted

When a Payment is Initiated

This operation triggers when a payment is initiated

When a Product is Created

This operation triggers when a new product is created

When a Product is Deleted

This operation triggers when a product is deleted

When a Product is Updated

This operation triggers when a product is updated

When a Unit is Created

This operation triggers when a new unit is created

When a Unit is Deleted

This operation triggers when a unit is deleted

When a Unit is Updated

This operation triggers when a unit is updated

When an Attibute is Deleted

This operation triggers when an attribute is deleted

When an AttibuteSet is Deleted

This operation triggers when an attributeSet is deleted

When an Attribute is Created

This operation triggers when a new attribute is created

When an Attribute is Updated

This operation triggers when an attribute is updated

When an AttributeSet is Created

This operation triggers when a new attributeSet is created

When an AttributeSet is Updated

This operation triggers when an attributeSet is updated

When an Customer is Updated

This operation triggers when a customer is updated

When an Inventory Level is Created

This operation triggers when a new inventory level is created

When an Inventory Level is Deleted

This operation triggers when an inventory level is deleted

When an Inventory Level is Updated

This operation triggers when an inventory level is updated

When an Order is Created

This operation triggers when a new order is created

When an Order is Deleted

This operation triggers when an order is deleted

When an Order is Updated

This operation triggers when an order is updated

When a Brand is Created

This operation triggers when a new brand is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
BrandDTO

When a Brand is Deleted

This operation triggers when a brand is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
BrandDTO

When a Brand is Updated

This operation triggers when a brand is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
BrandDTO

When a Category is Created

This operation triggers when a new category is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When a Category is Deleted

This operation triggers when a product is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When a Category is Updated

This operation triggers when a category is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When a Checkout is Completed

This operation triggers when a product is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When a Checkout is Created

This operation triggers when a new checkout is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When a Customer is Created

This operation triggers when a new Customer is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When a Customer is Deleted

This operation triggers when a Customer is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When a Payment is Completed

This operation triggers when a payment is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
PaymentDTO

When a Payment is Initiated

This operation triggers when a payment is initiated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
PaymentDTO

When a Product is Created

This operation triggers when a new product is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
ProductDTO

When a Product is Deleted

This operation triggers when a product is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
ProductDTO

When a Product is Updated

This operation triggers when a product is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
ProductDTO

When a Unit is Created

This operation triggers when a new unit is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
UnitDTO

When a Unit is Deleted

This operation triggers when a unit is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
UnitDTO

When a Unit is Updated

This operation triggers when a unit is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
UnitDTO

When an Attibute is Deleted

This operation triggers when an attribute is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an AttibuteSet is Deleted

This operation triggers when an attributeSet is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an Attribute is Created

This operation triggers when a new attribute is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an Attribute is Updated

This operation triggers when an attribute is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an AttributeSet is Created

This operation triggers when a new attributeSet is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an AttributeSet is Updated

This operation triggers when an attributeSet is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an Customer is Updated

This operation triggers when a customer is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an Inventory Level is Created

This operation triggers when a new inventory level is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an Inventory Level is Deleted

This operation triggers when an inventory level is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an Inventory Level is Updated

This operation triggers when an inventory level is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

When an Order is Created

This operation triggers when a new order is created

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
OrderDTO

When an Order is Deleted

This operation triggers when an order is deleted

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
OrderDTO

When an Order is Updated

This operation triggers when an order is updated

Parameters

Name Key Required Type Description
Title
Title True string

Title

Returns

Body
OrderDTO

Definitions

AttributeDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Name
name string
Code
code string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Type
type string
Slug
slug string
Position
position integer
Status
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Items
items array of AttributeItemDTO
Translation
translation

AttributeItemDTO

Name Path Type Description
Id
id string
Code
code string
ColorCode
colorCode string
Value
value string
Position
position integer
Slug
slug string
Translation
translation

AttributeSetDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Title
title string
Description
description string
Groups
groups array of AttributeSetGroupDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

AttributeSetGroupDTO

Name Path Type Description
Title
title string
Id
id string
Position
position integer
Items
items array of AttributeSetItemDTO

AttributeSetItemDTO

Name Path Type Description
Id
id string
Position
position integer

BrandDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Code
code string
Name
name string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescription
metaDescription string
Status
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

CategoryDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Title
title string
Code
code string
Alias
alias string
Description
description string
Position
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Path
path string
MediaItem
mediaItem
Translation
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Status
status string

CollectionDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Status
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ProductCount
productCount integer
ProductIds
productIds array of string
Products
products array of ProductDTO
SubCollections
subCollections array of CollectionDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Tags
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Translation
translation
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string

DocumentationDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Lines
lines array of DocumentationLineDTO

DocumentationLineDTO

Name Path Type Description
Id
id string
Title
title string
Description
description string
Position
position integer
MediaItem
mediaItem
Translation
translation

ExtendedProductDTO

Name Path Type Description
ProductVariants
productVariants array of ProductVariantExtendedDTO
Attributes
attributes array of ProductAttributeExtendedDTO
AttributeSet
attributeSet
IcoTags
icoTags array of ProductIcoTagExtendedDTO
ExtraFields
extraFields
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
Id
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
MediaItems
mediaItems array of MediaItemDTO
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
CustomFields
customFields array of ProductCustomFieldDTO
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time

IcoTagDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Name
name string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Icon
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string
ProductIds
productIds array of string
RuleEnabled
ruleEnabled boolean
DateFrom
dateFrom date-time
DateTo
dateTo date-time
Mode
mode string
Status
status string
Rule
rule
Translation
translation

MediaItemDTO

Name Path Type Description
Id
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Position
position integer
Alt
alt string
MediaType
mediaType string
Width
width integer
Height
height integer

PrivacyGroupDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Title
title string
Status
status string
Mode
mode string
ProductIds
productIds array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Rule
rule
CustomerGroupIds
customerGroupIds array of string
CustomerIds
customerIds array of string

ProductAttributeDTO

Name Path Type Description
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation

ProductAttributeExtendedDTO

Name Path Type Description
Name
name string
Slug
slug string
Code
code string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Translation
translation

ProductCustomFieldDTO

Name Path Type Description
Name
name string
Value
value
Translation
translation

ProductDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
MediaItems
mediaItems array of MediaItemDTO
ProductVariants
productVariants array of ProductVariantDTO
Attributes
attributes array of ProductAttributeDTO
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimension1
dimension1
Dimension2
dimension2
Dimension3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
SubTitle
subTitle string
Description
description string
Alias
alias string
Status
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Tags
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Availability
availability string
Translation
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescription
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
CustomFields
customFields array of ProductCustomFieldDTO
AttributeSetId
attributeSetId string
SortDate
sortDate date-time
Assortments
assortments array of string
MasterId
masterId string
Size1
size1 double
Size2
size2 double
Size3
size3 double
Size4
size4 double
Size5
size5 double
Size6
size6 double
Priority
priority integer
Date1
date1 date-time
Date2
date2 date-time
Date3
date3 date-time

ProductIcoTagExtendedDTO

Name Path Type Description
Id
id string
Name
name string
Icon
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string

ProductVariantDTO

Name Path Type Description
Id
id string
ProductId
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
Quantity
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Expected
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double

ProductVariantExtendedDTO

Name Path Type Description
StockAvailability
stockAvailability
Id
id string
ProductId
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
UnitPrice
unitPrice double
Price
price double
Msrp
msrp double
Quantity
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
ShippingWeight
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Translation
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Expected
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double

RelatedProductVariantDTO

Name Path Type Description
Id
id string
ProductId
productId string
CompanyId
companyId string
Dimension1ItemIds
dimension1ItemIds array of string
Dimension2ItemIds
dimension2ItemIds array of string
Dimension3ItemIds
dimension3ItemIds array of string

StockAvailabilityDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Code
code string
Title
title string
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Lines
lines array of StockAvailabilityLineDTO

StockAvailabilityLineDTO

Name Path Type Description
MediaItem
mediaItem
Message
message string
Quantity
quantity integer
Color
color string
Translation
translation

UnitDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Code
code string
Name
name string
Translation
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

CartDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Token
token string
Currency
currency string
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
CartItems
cartItems array of CartItemDTO

CartItemDTO

Name Path Type Description
Id
id string
ProductId
productId string
ProductTitle
productTitle string
ProductVariantId
productVariantId string
Quantity
quantity double
ImageLink
imageLink string
NetValue
netValue double
InitialUnitPrice
initialUnitPrice double
UnitPrice
unitPrice double
InitialPrice
initialPrice double
Price
price double
LineValue
lineValue double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Link
link string
Sku
sku string
OrderQuantityStep
orderQuantityStep double
SalesUnitId
salesUnitId string

ShoppingListDTO

Name Path Type Description
Id
id string
Title
title string
CompanyId
companyId string
CustomerId
customerId string
UserId
userId string
Alias
alias string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time
Items
items array of ShoppingListItemDTO

ShoppingListItemDTO

Name Path Type Description
ProductId
productId string
ProductVariantId
productVariantId string

CheckoutAddressDTO

Name Path Type Description
Id
id string
Name
name string
Address
address

OrderCustomFieldDTO

Name Path Type Description
Name
name string
Value
value

PaymentDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
CustomerId
customerId string
CheckoutToken
checkoutToken string
Amount
amount double
CommissionAmount
commissionAmount double
RemittanceInformation
remittanceInformation string
Provider
provider string
Status
status string
PaymentDate
paymentDate date-time
CreationDate
creationDate date-time
ApprovalCode
approvalCode string
CardType
cardType string
CardNumber
cardNumber string
PostDating
postDating integer
Installments
installments integer
BankId
bankId string
TransactionId
transactionId string

CalculatedShippingDTO

Name Path Type Description
Carrier
carrier
ShippingLine
shippingLine

CheckoutDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
CustomerId
customerId string
CustomerName
customerName string
UserEmail
userEmail string
UserFirstName
userFirstName string
UserLastName
userLastName string
UserId
userId string
CustomerBranchId
customerBranchId string
CartToken
cartToken string
Token
token string
ReferenceCode
referenceCode string
Notes
notes string
Status
status string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
BuyerAcceptsMarketing
buyerAcceptsMarketing boolean
Email
email string
Phone
phone string
Currency
currency string
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
DiscountRate
discountRate double
DiscountValue
discountValue double
CompletedDate
completedDate date-time
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
CartItems
cartItems array of CheckoutItemDTO
GiftLines
giftLines array of CheckoutGiftLineDTO
VatAnalysis
vatAnalysis array of VatAnalysisDTO
ExpenseLines
expenseLines array of ExpenseLineDTO
ShippingLine
shippingLine
OrderId
orderId string
OrderCode
orderCode string
Payment
payment
Customer
customer
ShippingOptions
shippingOptions array of CalculatedShippingDTO
PaymentMethods
paymentMethods
Settings
settings
CustomFields
customFields array of OrderCustomFieldDTO
Addresses
addresses array of CheckoutAddressDTO
DeliveryDate
deliveryDate date-time

CheckoutGiftLineDTO

Name Path Type Description
VatCode
vatCode string
ImageLink
imageLink string
ProductTitle
productTitle string
ProductAlias
productAlias string
ProductId
productId string
ProductVariantId
productVariantId string
Quantity
quantity double

CheckoutItemDTO

Name Path Type Description
Id
id string
ProductId
productId string
ProductTitle
productTitle string
ProductVariantId
productVariantId string
Quantity
quantity double
Unit
unit string
ImageLink
imageLink string
Color
color string
Material
material string
Pattern
pattern string
Size
size string
NetValue
netValue double
ExpenseValue
expenseValue double
InitialUnitPrice
initialUnitPrice double
UnitPrice
unitPrice double
InitialPrice
initialPrice double
Price
price double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
LineValue
lineValue double
DiscountValue
discountValue double
DiscountRate
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
CustomDim1Value
customDim1Value string
CustomDim2Value
customDim2Value string
CustomDim3Value
customDim3Value string
Link
link string
Sku
sku string
SalesUnitId
salesUnitId string

CustomerBranchDTO

Name Path Type Description
Id
id string
SourceId
sourceId string
Code
code string
Name
name string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
Address
address
Status
status string

CustomerShippingAddressDTO

Name Path Type Description
Name
name string
Address
address

ExpenseLineDTO

Name Path Type Description
Id
id string
NetValue
netValue double
VatValue
vatValue double

VatAnalysisDTO

Name Path Type Description
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double

AssortmentCombinationDTO

Name Path Type Description
BranchId
branchId string
CategoryId
categoryId string
TypeId
typeId string

AssortmentDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
CustomerId
customerId string
Categories
categories array of CustomerCategoryDTO
Types
types array of CustomerTypeDTO
Combinations
combinations array of AssortmentCombinationDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

AssortmentValueDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
CustomerId
customerId string
ProductId
productId string
CategoryId
categoryId string
TypeId
typeId string
Status
status string
Source
source string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time

CustomerCategoryDTO

Name Path Type Description
Id
id string
Name
name string

CustomerCustomFieldDTO

Name Path Type Description
Name
name string
Value
value
Translation
translation

CustomerDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Code
code string
Name
name string
Tin
tin string
Email
email string
Contact
contact string
ContactPhone
contactPhone string
Phone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Tags
tags array of string
SourceTags
sourceTags array of string
Address
address
Notes
notes string
Status
status string
Branches
branches array of CustomerBranchDTO
AdditionalFeatures
additionalFeatures
CustomFields
customFields array of CustomerCustomFieldDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
ShippingAddresses
shippingAddresses array of CustomerShippingAddressDTO

CustomerGroupDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Title
title string
Status
status string
Rule
rule
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

CustomerTypeDTO

Name Path Type Description
Id
id string
Name
name string

ExpectedInventoryLineDTO

Name Path Type Description
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double

InventoryLevelDTO

Name Path Type Description
Id
id string
ProductVariantId
productVariantId string
ProductId
productId string
CompanyId
companyId string
LocationId
locationId string
Quantity
quantity double
ExpectedInventoryLines
expectedInventoryLines array of ExpectedInventoryLineDTO
UpdateDate
updateDate date-time

LocationDTO

Name Path Type Description
Id
id string
CompanyId
companyId string
Name
name string
IsActive
isActive boolean
Address
address
Phone
phone string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

InventoryAvailabilityDTO

Name Path Type Description
Token
token string
Available
available boolean
Lines
lines array of StockAvailabilityLineDTO

GiftLineDTO

Name Path Type Description
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
Quantity
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string

OrderDTO

Name Path Type Description
Id
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Status
status string
CustomerId
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
CustomerName
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Currency
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
DiscountRate
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
Lines
lines array of OrderLineDTO
VatAnalysis
vatAnalysis array of VatAnalysisDTO
Tags
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Notes
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notify
notify string
Notified
notified array of string
CustomFields
customFields array of OrderCustomFieldDTO
ShippingLine
shippingLine
GiftLines
giftLines array of GiftLineDTO
ExpenseLines
expenseLines array of ExpenseLineDTO
Payment
payment
SeriesId
seriesId string

OrderLineDTO

Name Path Type Description
Id
id string
ProductId
productId string
ProductVariantId
productVariantId string
ProductTitle
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantity
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Price
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
UnitPrice
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
DiscountRate
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string