Home

BizBox Data Structures

In BizBox are available particular parameters, which carries objects. Every object contains properties which are used to display dynamic content on your website or template.

For example, the parameter ecommerce has its object products.

By using a function you are able to get one product object: ecommerce.products.get(‘product-code’).

This single product object has its properties, such as product.name which carries the name of the particular product. To output it on a page or template, wrap it in two double brackets {{ }} such as this {{ product.name }}.

Work with Data Structures

Display Content

To display a content of particular property, wrap it in two double brackets {{ }}:

{{ product.name }}

Note

You can use the advantage of the dump.

BizBox Parameters

All parameters are available globally.

Parameter

Short Parameter Description

messages

A group of information used to provide information from the system, widgets or components. More info >.

cms

A group of information connected with websites and its content. Mostly used for Author Tools module and navigations. More info >.

crm

A group of information connected with sales and partners. More info >.

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more). More info >.

enums

Contains all enumerations you can use on your website. More info >.

request

A group of information connected with current request. More info >.

user

A group of information about the currently logger user. More info >.

session

A group of information connected with current session. More info >.

Object Message

Short Object Description

code

String; unique message code.

field

String; the name of the field to which is this message connected.

params

Array; optional parameters for the message (depends on the specific message).

text

String; the particular message you can display on the website.

type

String; the type of the message (for more info see the messages help-page).

widget

String; the internal name of a widget which has produced the message.

Object Session

In a template the object session is available.

Methods:

  • get( key ) - gets a value according to the defined key.

  • set( key, value ) - saves the value to the defined key.

The maximum key value is 50 characters. The value has to be a string with maximum value of 500 characters.

CMS Data Structure

Object (CMS parameter)

Short Description

articles

An object with all articles existing in the Authors Module. See the functions and parcicular article data structure.

authors

An object with all information about authors from the Author tools module. See the functions page to display a particular author.

dataLists

An object with all data lists existing in your account. See the functions page to display a particular data list. For more info about data lists see its help-page.

navigation

An object uniting all information about the navigations. See the functions page to display information about particular navigation tree.

permissions

An object uniting all public user permissions.

isPreview

Boolean; used to differ between production (FALSE) and preview (TRUE).

Ecommerce Data Structure

Object Ecommerce

Short Description

branches

Object with all branches existing in the Administration Module. See the branch structure.

brands

Object with all brands existing in the Products Module. See the brand structure.

cart

Object with all information about the cart. See the cart structure.

categories

Object with information about all active categories from your account.

checkout

Object; unites all information about the checkout.

comparator

Object; unites all information about the comparator.

dailyDeals

Object; unites all information about daily deals defined in your account (in the :ref:Daily Deals`app-daily-deals` application).

gifts

Object; unites all information about available gifts (sales promotion) templates. It contains only active gifts settings.

placedOrder

Array; unites all information about the currently placed order

products

Object; unites all products from your account.

wishlist

Array; contains an array of all products from the wishlist (key is the product ID).

zoneCurrencies

Object; unites all information about available currencies.

Object CRM

Short Object Description

partner

Object; unites all information about the partner.

partnerAgreement

An object with all information about current partner agreement defined in the Administration module.

supplier

An object with all information about logged in supplier.

Object Brand

Brand

Short Object Description

active

Boolean; defines the brand activity. Only active brands are available on the website.

availability

String; the value inserted in the field availability in the brand detail.

bigImage

Object; the big image defined in the brand detail.

bigImageSourcePath

String; the big image source path.

bigImageSourceSysid

String; the big image source internal name.

customProperties

Array; the custom properties defined for the brand.

id

Integer; unique brand ID.

includeInNavigation

Boolean; defines if the brand will be included in a navigation (brand setting).

logo

Object; unites all information about the logo defined in the brand detail.

longDescription

Object; the long description of the brand.

name

String; the name of the brand.

nameUrl

String; the name in URL of the brand.

seoDescription

String; the SEO description of this brand.

seoDescriptionSource

Object; unites all information about the description SEO source.

seoKeywords

String; the SEO keywords of this brand.

seoTitle

String; the SEO title of this brand.

seoTitleSource

Object; unites all information about the title SEO source.

shortDescription

String; the short description of the brand.

smallImage

Object; unites all information about the small image conncted to this brand.

smallImageSourcePath

String; the small image source path.

smallImageSourceSysid

String; the small image source internal name.

sysid

String; the internal name of the brand.

totalItems

Integer; the number of products that are connected with this brand.

web

Object Cart

Cart

Short Description

attachments

Object; unites all information about attachments connected to the order as a whole.

containsPhysicalProduct

Boolean; defines if the cart contains a physical product.

deliveryMethod

Array; unites all information about the delivery method selected in the checkout.

discounts

Array; unites all information about discounts applied on the order.

gifts

Object; unites all information about available gifts.

handlingMethod

Array; unites all information about the handling method used in the checkout.

items

Array; unites all information about the items in the cart.

loyaltyProgram

Object; unites all information about the loyalty program applied in the cart.

packingBox

Array; unites all information about the packing box.

paymentMethod

Array; unites all information about the payment method selected in the checkout.

price

Array; unites all information about the cart price.

totalItems

Integer; the total number of items currently inserted to the cart.

Cart Discount

Short Description

discountId

Number; the unique discount ID.

discountType

String; the type of the discount.

taxes

Array; list of all taxes applied on the distount.

grossPrice

Boolean; defines if the discount is defined with or without tax added.

name

String; the discount name.

cartItemId

String; the unique cart item ID of the discount.

taxExclusiveAmount

Integer; the discount amount (without tax).

taxInclusiveAmount

Integer; the discount amount (with tax).

taxExclusiveAmountRounded

Integer; the rounded discount amount (without tax).

taxInclusiveAmountRounded

Integer; the rounded discount amount (with tax).

taxAmount

Integer; the tax amount of the discount.

taxAmountRounded

Integer; the rounded tax amount of the discount.

taxRate

Number; tax rate applied on the discount.

voucher

Number; voucher identification.

voucherCode

String; used voucher code.

Discount Tax

Short Description

name

String; the tax name.

abbreviation

String; the tax abbreviation.

rate

Number; the tax rate.

amount

Integer; the tax amount.

id

Number; the unique ID of the tax.

Cart Attachments

Short Description

description

String; the description connected to the attachment.

id

String; the attachment’s ID.

items

Array of objects; list of cart items to which is this attachment connected.

mimeType

String; the mime type of the uploaded attachment.

name

String; the name of the attachment.

note

String; the note connected to the attachment.

products

Array; list of products to which is this attachment connected.

size

Number; the attachment size.

temporaryKey

String; the value of the temporary key.

type

Object; unites all information about the attachment type.

Order Attachment Type

Short Description

id

Number; the ID of the attachment type.

name

String; the attachment type name.

sysid

String; the internal name of the attachment type.

Cart Gifts

Short Description

bySystem

Boolean; defines if the gift has been added to the cart automatically.

id

Array; unites all information about attachments connected to the order as a whole.

maxQuantity

Boolean; defines if the cart contains a physical product.

products

Array; list of available gifts (products).

  • product - object; information about the product.

  • quantity - number; defines the current quantity of this gift in the cart.

  • sysid - the system ID used to recognize this product and particular voucher template.

sale

Object; unites all information about the gift settings.

Object Cart

Short Description

baseCart

campaign

Object; unites all information about the cart.

cartId

String; the unique cart ID.

contact

Object; unties all information about the customer (contact).

country

Object; unites all information about the country.

currency

Object; unites all information about the cart currency.

displayName

String; the name of the cart (cart ID).

doc-object-ecommerce-eshop

Object; unties all information about the used e-shop settings.

firstView

frontendCreated

Date; the date when has been the cart created.

id

String; the unique ID.

items

Array; unites all information about the items in the cart.

language

Object; unites all information about the used language.

locale

Object; unites all information about the used locale.

sent

state

Object; unites all information about the current cart state.

taxExclusiveAmount

Integer; the tax exclusive amount of the cart.

taxInclusiveAmount

Integer; the tax inclusive amount of the cart.

type

Object; unites all information about the cart type.

website

Object; unties all information about the cart’s origin website.

zone

Object; unites all information about the zone of the cart.

Object Cart State

Short Description

comment

String; the comment connected to the state.

id

String; the unique ID of the state.

name

String; the name of the state.

order

Number; the order of the state.

sysid

String; the internal name of the state.

Object Cart Type

Short Description

id

Number; the unique ID of the cart type.

name

String; the name of the cart type.

sysid

String; the internal name of the cart type.

Cart Price

Short Description

taxExclusiveAmount

Integer; the sum of all items’ prices in the cart (without tax applied).

taxInclusiveAmount

Integer; the sum of all items’ prices in the cart (with tax applied).

amountDue

Integer; rounded taxInclusiveAmount (the sum the customer has to pay).

taxAmount

Integer; the sum of all taxes applied on particular items in the cart.

taxExclusiveItemAmount

Integer; the sum of all products’ prices in the cart (without tax applied).

taxInclusiveItemAmount

Integer; the sum of all products’ prices in the cart (with tax applied).

taxItemAmount

Integer; the sum od all taxes applied on particular products in the cart.

taxExclusiveAmountRounded

Integer; the sum of all items’ rounded prices in the cart (without tax applied).

taxInclusiveAmountRounded

Integer; the sum of all items’ rounded prices in the cart (with tax applied).

taxAmountRounded

Integer; the sum of all rounded taxes applied on particular items in the cart.

taxInclusiveDiscount

Integer; the sum of all discounts applied on items in the cart (without tax applied).

taxExclusiveDiscount

Integer; the sum of all discounts applied on items in the cart (with tax applied).

currency

Object; unites all information about the cart currency.

taxExclusiveTaxDocRoundAmount

Integer; the difference between amountDue and taxExclusiveAmount.

taxInclusiveTaxDocRoundAmount

Integer; the difference between amountDue and taxInclusiveAmount.

taxDocTaxRate

Integer; value = 0.

totalAmount

Integer; the sum of all items in the cart (rounded taxInclusiveAmount).

taxSummary

Array; unites all information about the cart taxation.

currencySymbol

String; the currency symbol.

taxDocRoundTaxAmount

Integer; vaue = 0.

Cart - Tax Summary

Short Description

id

Integer; the unique ID of this tax.

name

String; the name of the applied tax.

abbreviation

String; the abbreviation of the applied tax.

rate

Intger; the tax rate.

amount

Integer; the tax amount.

taxExclusiveAmount

Integer; the total tax exclusive amount.

taxInclusiveAmount

Integer; the total tax inclusive amount.

Loyalty Program

Short Description

applicablePoints

Boolean; defines the activity of the loyalty program.

earnedPoints

Integer; the amount of loyalty points of the customer.

Item in the Cart

To display all available items names, use this code:

{% for item in ecommerce.cart.items %}

        {{ item.name }}

{% endfor %}

Below is a table with all parameters connected to a particular item.

Object Item

Short Object Description

accessories

Object; unites all information about the accessories added to the item.

additionalInfo

String; additional info connected to a particular product.

album

Number; the unique number of a particular album to which the image belongs (used only for products from the Photobank).

attachments

Object; unites all information about files attached to the product.

baseItemPriceTaxExclusive

Integer; the price of the particular item - base price without tax included.

baseItemPriceTaxInclusive

Integer; the price of the particular item - base price with tax included.

boughtImages

Array; unites information about the image inserted to the cart (available only for the Photobank).

bundleVariants

Object; unites information about the variant bundle (used if the item is a variant bundle).

cartItemId

Integer; the cart item ID.

code

String; the product code.

deliveryType

Object; the type of the delivery defined for the particular product on the General tab.

discountRate

Integer; the discount applied on the product price.

discounts

Array; unites all information about the applied discounts.

isGift

Boolean; defines if the product is a gift.

giftQuantity

Integer; defines how many items of this product are a gift.

giftTemplateId

Integer; unique ID of a gift template.

grossPrice

Boolean; defines if the product price has been inserted with (YES) or without (NO) tax.

id

Integer; unique ID of this item in the cart.

itemPriceTaxExclusive

Integer; the price of the particular product without tax added.

itemPriceTaxExclusiveRounded

Integer; the rounded price of the particular product without tax added.

itemPriceTaxInclusive

Integer; the price of the particular product with tax added.

itemPriceTaxInclusiveRounded

Integer; the rounded price of the particular product without tax added.

mainPrice

Object; unites all information about the main price of the product (without Add-Ons).

name

String; the product name.

priceListItem

product

Object; unites all information about the particular product.

productGroup

Integer; defines a particular product group to which this product belongs.

productTaxCategory

Integer; defines a particular product tax category that is applied on this product.

quantity

Integer; defines how many items of this product is in the cart.

taxAmount

Integer; the total tax amount.

taxAmountRounded

Integer; the total tax amount rounded.

taxBaseAmount

Integer; the total tax amount (counted from the base product price).

taxDiscountAmount

Integer; the tax counted for the discounted amount.

taxExclusiveAmount

Integer; the price for all items of this product without tax added.

taxExclusiveAmountRounded

Integer; the rounded price for all items of this product without tax added.

taxExclusiveBaseAmount

Integer; the base price for all items of this product without tax added.

taxExclusiveBaseUnitPrice

Integer; the base unit price (one item) wihtout tax added.

taxExclusiveDiscount

taxExclusiveDiscountAmount

Integer; the discount amount without tax added.

taxExclusiveUnitPrice

Integer; price per one item of this product without tax added.

taxExclusiveUnitPriceRounded

Integer; rounded price per one item of this product without tax added.

taxInclusiveAmount

Integer; the price for all items of this product with tax aded.

taxInclusiveAmountRounded

Integer; the rounded price for all items of this product with tax added.

taxInclusiveBaseAmount

Integer; the base price for all items of this product with tax added.

taxInclusiveBaseUnitPrice

Integer; the base unit price (one item) wihtout tax added.

taxInclusiveDiscount

taxInclusiveDiscountAmount

Integer; the discount amount with tax added.

taxInclusiveUnitPrice

Integer; price per one item of this product with tax added..

taxInclusiveUnitPriceRounded

Integer; rounded price per one item of this product without tax added.

taxRate

Integer; the tax (percentage) applied on this product.

taxes

Array; unites all information about the taxes applied on this product.

Object

Short Object Description

masterProduct

Object; unites all information about the master product.

selectedProduct

Object; unites all information about the selected variant.

Order Attachment

Short Object Description

attachment

Object; unites all information about the attachment file.

description

String; the description of the attachment.

exportFilename

String; the filename of the attachment.

products

Array; unites information about all product to which this attachment belongs.

type

Object; defines the type of the attachment (order/product).

Cart Item Attachment

Short Object Description

temporaryKey

String; temporary key.

contentType

String; the type of the attached file.

size

Integer; the size of the attached file.

name

String; the name of the attached file.

Checkout Services

Used for Delivery, Payment, Handling or Packing Method.

Checkout Service

Short Object Description

carrierService

Integer; internal identification of the selected carrier service. Used only for deliveryMethod.

paymentMethod

Integer; internal identification of the selected payment method. Used only for paymentMethod.

costsEnabled

Boolean; defines if the costs settings are available for this method.

costFixed

Integer; the value inserted in the Fixed field (Pricing; costs of particular method; Fixed field).

costVariable

String; the value inserted in the Variable field (Pricing; costs of particular method; Variable field).

costTax

Integer; the value inserted in the Tax Rate field (Pricing; costs of particular method; Tax Rate field).

costGrossPrice

Boolean; defines if the costs prices are inserted with or without tax.

costCurrency

Integer; defines the costs currency selected in the Currency field (Pricing; costs of particular method; Currency field).

methodId

Integer; unique ID of the selected method.

cartItemId

priceListItem

quantity

Integer; the quantity of this service that has been added to the cart.

taxExclusiveAmount

Integer; the price of this service (without tax).

taxInclusiveAmount

Integer; the price of this service (with tax).

taxExclusiveAmountRounded

Integer; the price of this service (without tax and rounded).

taxInclusiveAmountRounded

Integer; the price of this service (with tax and rounded).

taxAmount

Integer; the price of this service (tax amount).

taxAmountRounded

Integer; the price of this service (rounded tax amount).

taxRate

Integer; the tax rate defined for this service (application Tax Rules application located in the Administration module).

taxInclusiveDiscount

Integer; the discount amount applied on the service (without tax).

taxExclusiveDiscount

Integer; the discount amount applied on the service (with tax).

discountRate

Integer; the applied discount rate.

name

String; the name of the service.

taxes

Array; unites all information about the taxes applied on this service.

productTaxCategory

Integer; internal identification of the service.

taxExclusiveBaseAmount

Integer; the base (without discount applied) price without tax.

taxInclusiveBaseAmount

Integer; the base (without discount applied) price with tax.

taxBaseAmount

Integer; the base (without discount applied) amount of tax.

taxExclusiveDiscountAmount

Integer; the discount amount price without tax.

taxInclusiveDiscountAmount

Integer; the discount amount price with tax.

taxDiscountAmount

Integer; the tax applied on the discount amount.

grossPrice

Boolean; defines if the price is added with (TRUE) or without (FALSE) the tax.

discounts

Array; unites all information about applied discounts.

id

taxInclusiveUnitPriceRounded

Integer; the price per one unit with tax, rounded.

taxExclusiveUnitPriceRounded

Integer; the price per one unit without tax, rounded.

taxInclusiveUnitPrice

Integer; the price per one unit with tax.

taxExclusiveUnitPrice

Integer; the price per one unit without tax.

taxInclusiveBaseUnitPrice

Integer; the base price (without discount applied) per unit with tax.

taxExclusiveBaseUnitPrice

Integer; the base price (without discount applied) per unit without tax.

Object Taxes

Taxes

Short Object Description

id

Integer; unique identification of the tax rate.

name

String; the name of the tax (defined in the Administration module in the Tax Rates application).

abbreviation

String; the abbreviation defined for the tax rate.

rate

Integer; the rate of the tax (defined in the Administration module in the Tax Rates application).

amount

Integer; the partiular amount defined for this tax rate (used in case there is no rate but specified amount).

Object Discount

Discount

Short Object Description

name

String; the name of the tax (defined in the Administration module in the Tax Rates application).

taxAmount

String; the abbreviation defined for the tax rate.

taxExclusiveAmount

Integer; the rate of the tax (defined in the Administration module in the Tax Rates application).

taxInclusiveAmount

Integer; the partiular amount defined for this tax rate (used in case there is no rate but specified amount).

voucher

Integer; the partiular amount defined for this tax rate (used in case there is no rate but specified amount).

voucherCode

Integer; the partiular amount defined for this tax rate (used in case there is no rate but specified amount).

Placed Order

Placed Order

Short Description

issuedVoucherCode

String; the voucher code issued for the order.

id

Number; the unique order ID.

PONumber

String; the PO number defined in the checkout.

taxAmount

Integer; the order tax amount.

amountDue

Integer; the amount the customer has to pay.

taxInclusiveAmount

Integer; the tax inclusive order amount.

taxExclusiveAmount

Integer; the tax exclusive order amount.

currency

Array; unites information about the used currency.

  • currency.symbol (string; the symbol of the currency)

  • currency.iso (string; the ISO code of the currency)

orderNumber

String; the order number generated according to the document sequence defined in the e-shop settings.

items

Array; unites all items on the order.

Particular item {% for item in ecommerce.placedOrder.items %}:

  • item.name - the product name

  • item.quantity - the product quantity

  • item.code - the product code

  • item.taxInclusiveAmount - the price for all products (with the tax included)

  • item.taxExclusiveAmount - the price for all products (without the tax included)

  • item.taxAmount - the tax amount for all products

  • item.taxInclusiveUnitPrice - the price per one item of the product (with the tax included)

  • item.taxExclusiveUnitPrice - the price per one item of the product (without the tax included)

  • item.originalProduct - object; unites all information about the original (ecommerce) product.

paymentDetail

Array; unites information about the used payment.

  • paymentDetail.paymentMethod - array; unites information about the used payent method

  • paymentDetail.paymentMethod.name - the method name

  • paymentDetail.paymentMethod.sysid - the method internal name

  • paymentDetail.taxInclusiveAmount - the price for the payment (with the tax included)

  • paymentDetail.taxAmount - the tax amout for the payment

  • paymentDetail.gatewayData - array; unites information about the payment gateway

  • paymentDetail.gatewayData.gateway - the used gateway

  • paymentDetail.gatewayData.bankName - the bank name

  • paymentDetail.gatewayData.accountNumber - the account number

  • paymentDetail.gatewayData.bankCode - the bank code

  • paymentDetail.gatewayData.address - array; unites the address defined for the gateway

  • paymentDetail.gatewayData.iban - the IBAN

  • paymentDetail.gatewayData.swift - the SWIFT

deliveryDetail

Array; unites information about the used delivery.

  • deliveryDetail.carrierService - array; unites information about the used carrier service

  • deliveryDetail.carrierService.name - the carrier service name

  • deliveryDetail.carrierService.sysid - the carrier service internal name

  • deliveryDetail.carrierService.systemCarrierService - the used carrier service

  • deliveryDetail.taxInclusiveAmount - the delivery price (with the tax included)

  • deliveryDetail.taxAmount - the tax amount for the delivery

handlingDetail

Array; unites information about the used handling.

billingAddress

Array; unites information about the billing address defined in the checkout.

  • billingAddress.firstName - the first name defined in the checkout

  • billingAddress.lastName - the last name defined in the checkout

  • billingAddress.companyName - the company name defined in the checkout

  • billingAddress.country - array; unites information about the coutry selected in the checkout

  • billingAddress.country.id - the ID of the selected country

  • billingAddress.country.name - the name of the selected country

  • billingAddress.city - the city defined in the checkout

  • billingAddress.postalCode - the postal code defined in the checkout

  • billingAddress.callingCode - the calling code defined in the checkout

  • billingAddress.companyTaxIdentity - the company tax identity defined in the checkout

  • billingAddress.companyIdentificationNumber - the compaty identification number defined in the checkout

  • billingAddress.email - the e-mail address defined in the checkout

  • billingAddress.ipAddress - the customer’s IP address

  • billingAddress.phone - the phone number defined in the checkout

  • billingAddress.street - the street address defined in the checkout

shippingAddress

Array; unites information about the shipping address defined in the checkout.

  • shippingAddress.firstName - the first name defined in the checkout

  • shippingAddress.lastName - the last name defined in the checkout

  • shippingAddress.companyName - the company name defined in the checkout

  • shippingAddress.country - array; unites information about the coutry selected in the checkout

  • shippingAddress.country.id - the ID of the selected country

  • shippingAddress.country.name - the name of the selected country

  • shippingAddress.city - the city defined in the checkout

  • shippingAddress.postalCode - the postal code defined in the checkout

  • shippingAddress.callingCode - the calling code defined in the checkout

  • shippingAddress.companyTaxIdentity - the company tax identity defined in the checkout

  • shippingAddress.companyIdentificationNumber - the compaty identification number defined in the checkout

  • shippingAddress.email - the e-mail address defined in the checkout

  • shippingAddress.ipAddress - the customer’s IP address

  • shippingAddress.phone - the phone number defined in the checkout

  • shippingAddress.street - the street address defined in the checkout

state

Object; unites information about the current order state

branchDetail

Array; unites information about the used branch.

orderDetailUrl

String; the URL generated to display the detail of this order.

variableSymbol

String; the variable symbol of the order (according to the E-shop Settings).

payments

Array; list of all payments connected to the order.

state

Object; unites all information about the current order state.

invoice

Array; unites information about the generated invoice. Particular dates are calculated according to the E-shop Settings.

  • invoice.issueDate - date; the invoice issue date

  • invoice.paymentDueDate - date; the payment due date

  • invoice.taxPointDate - date; the tax point date

Object Order

Short Description

PONumber

String; the PO number.

activateDate

activity

String; the Account Activity setting value (used for accounting software).

additionalInfo

String; the order’s additional info.

advancePayments

Array; list of all advance payments connected to this order.

allItems

Object; unites all products from the order.

amountDue

Integer; the amount a customer should pay.

attachments

Object; unites all information about attachments connected to the order.

balanceDue

Integer; balanceDue is counted as the difference between orderAmountDue and advancePaymentsAmount.

billingAddress

Object; the customer’s billing address.

branch

Object; unites all information about the branch.

campaign

Object; unties all information about the campaign applied on this order.

campaignPeriod

cancellationReason

centre

String; used for the purposes of your accounting software.

checkout

Object; unites all information about the checkout used for this order.

contract

String;

createdDate

Date and time; the date and time of the order creation.

currency

Object; unites all information about the order currency.

currencySymbol

String; the currency symbol.

current

Boolean;

customer

Object; unites all information about the customer.

customerTaxCategory

Object; unties all information about the used customer tax category.

date

Date and time;

deliveryCountry

Object; unites all information about the order to which will be this order delivered.

deliveryDetail

Object; unites all information about the delivery.

discounts

Array; list of all discounts applied to the order.

dispatchState

Object; unites all information about the current dispatch state.

document

Object; unites all information about the connected order document.

eshop

Object; unites all information about the used e-shop settings.

extension

fixedOrder

fulfillmentDate

handlingDetail

hasInvoice

Boolean; defines if there exists the invoice.

hasProformaInvoice

Boolean; defines if there exists the proforma invoice.

id

Number; the unique order ID.

introduction

String; used for the purposes of your accounting software.

invoice

Object; unites all information about the invoice.

isStockDispatchReady

issuedVoucher

Object; unites all information about the voucher issued for this order.

issuedVoucherCode

String; the voucher issued for the order.

items

Array; list of all order items.

jsonParams

JSON; use the jsonDecode filter. Contains data stored for the order in the checkout using the jsonParams field.

language

Object; unites all information about the language of the order.

locale

Object; unites all information about the used locale.

notes

Array; unites all notes defined for the order on the Notes tab (ordered according to the creation time - ascending).

number

String; the order number.

order

Object; unites all information about the order.

orderDetailUrl

String; the URL address with the order detail.

orderNumber

String; the order number.

orderCurrencyTaxSummaries

Object; tax summaries.

orderType

Object; unites all information about the order type.

originatorWebsite

Object; unites all information about the website on which has been this order placed.

pONumber

String; the PO number.

packingDetail

paymentDueDate

Date and time; the payment due date of the order (defined in the E-shop Settings).

parentOrder

Object; unites all information about the parent order.

partner

Object; unties all information about the partner.

partnerCampaign

partnerTier

Object; unites all information about the partner tier.

payment

Array; unites all information about the payment.

  • paymentMethod - the selected system payment method.

  • address - array; list of address info (city, street, postal code).

  • accountHolder - string; the account holder.

  • accountNumber - string; the account number.

  • bankName - string; the bank name.

  • bankCode - string; the bank code.

  • bankConstantSymbol - string; the bank constant symbol.

  • bankCustomerInfo - string; the information for the customer.

  • bankSpecificSymbol - string; the specific symbol.

  • iban - string; the IBAN.

  • swift - string; the SWIFT.

  • gateway - string; the selected payment gateway internal name.

payments

Array; unites all payments connected to the order.

paymentDate

Date and time; the date and time when has been this order marked as paid.

paymentDetail

Object; unites all information about the payment detail.

paymentGatewayOrderId

paymentGatewayPayerId

paymentGatewaySessionId

pohodaPaymentType

String; used for the purposes of your accounting software.

pohodaRoundingDocument

String; used for the purposes of your accounting software.

products

Array; list of order products.

productsCostHomeCurrencyTaxInclusiveAmount

Integer; the products cost in home currency (tax inclusive).

productsCostHomeCurrencyTaxExclusiveAmount

Integer; the products cost in home currency (tax exclusive).

productsCostHomeCurrencyTaxAmount

Integer; the products cost in home currency (tax amount).

refundedOrder

Object; unites all information about the refunded order.

roundingTaxAmount

Integer; the rounding tax amount.

roundingTaxRate

Number; the rounding tax rate.

shippingAddress

Object; unites all information about the shipping address.

source

Object; unites all information about the order source.

state

Object; unites all information about the current order state.

supplierOrder

tags

Array; list of tags connected to the order.

taxAmount

Integer; the order tax amount.

taxExclusiveAmount

Integer; the order amount with tax excluded.

taxExclusivePaidAmount

Integer; the paid amount with tax excluded.

taxExclusiveRoundingAmount

Integer; the rounding tax exclusive amount.

taxInclusiveAmount

Integer; the order amount with tax included.

taxInclusivePaidAmount

Integer; the paid amount with tax included.

taxInclusiveRoundingAmount

Integer; the rounding tax inclusive amount.

taxSummary

Array; the list of the tax summaries (objects) of order’s items.

text

variableSymbol

String; the order’s variable symbol (according to the E-shop Settings).

website

Object; unites all information about the website on which this order has been placed.

zone

Object; unites all information about the order’s zone.

Payment (Order)

Short Description

bkp

String; the BKP of the payment (registration of sales).

businessPremise

String; the bussines premises ID (registration of sales).

delegatedVatId

String; the delegated VAD ID (registration of sales).

fik

String; the FIK of the payment (registration of sales).

isSimplifiedRegime

Boolean; defines if the registration of sales regime.

isTest

Boolean; defines if the registration of sales test regime.

isVerifyingMode

Boolean; defines if the registration of sales veryfying regime.

notification

Object; unites all information about the payment notification.

number

Number; the number of the payment.

pkp

String; the PKP of the payment (registration of sales).

posTerminal

String; the POS terminal ID (registration of sales).

receiptTime

Date and time, the date of the payment receipt (registration of sales).

state

Object; unites all information about the current notification state.

totalPrice

Number; the total payment amount.

vatId

String; the VAT ID (registration of sales).

Payment Notification (Payment)

Short Description

attemptsCount

Number; the count of attempts (how many times has been the payment send to a registration of sales).

displayName

String; the name of the notification.

id

Number; the ID of the notification.

payment

Object; unites all information about the payment.

registrationOfSales

Object; unites all information about the used registration of sales.

state

Object; unites all information about the current notification state.

Payment Notification State

Short Description

comment

String; the commentary of the payment notification state.

id

Number; the ID of the payment notification state.

name

String; the name of the payment notification state.

sysid

String; the internal name of the payment notification state.

Registration of Sales

Short Description

active

Boolean; defines the activity of the registation of sales setting.

branch

Object; unites all information connected to this registration of sales setting.

description

String; the description connected to the registration of sales setting.

id

Number; the ID of the registration of sales setting.

label

String; the label of the registration of sales setting.

name

String; the name of the registration of sales setting.

repetitionOnFailureAllowed

Boolean; defines the value of the Repeat on Failure setting.

repetitionOnFailureCount

Number; defines the value of the Repetition Count setting.

sysid

String; the internal name of the registration of sales setting.

systemPaymentMethods

Array; unites the system payment methods selected for this registration of sales setting.

systemRegistrationOfSales

Object; unites all information about the current notification state.

System Registration of Sales

Short Description

comment

String; the commentary of the system registration of sales.

id

Number; the ID of the system registration of sales.

name

String; the name of the system registration of sales.

sysid

String; the internal name of the system registration of sales.

Order Discount

Short Description

id

Number; the unique ID of the discount.

name

String; the name of the discount.

voucherCode

String; the voucher code (used for Vouchers).

taxInclusiveAmount

Integer; the discount amount (tax included).

taxExclusiveAmount

Integer; the discount amount (tax excluded).

taxAmount

Integer; the total tax amount.

grossPrice

Boolean; defines if the discount is defined with or without tax.

taxType

Object; unites all information about the tax type.

voucher

Object; unites all information about the voucher.

order

String; the order ID.

Object Voucher

Short Description

code

String; the used voucher code.

id

Number; the unique voucher ID.

issued

Boolean; defines of the voucher code has been already issued.

template

Object; unites all information about the voucher settings.

Object Issued Voucher

Short Description

amount

Integer; the voucher code amount (the sale).

code

String; the voucher code.

currency

Object; unites all information about the voucher’s currency.

grossPrice

Boolean; defines if the amount is with or without tax defined.

rate

Number; defines the voucher rate (percentage discount).

type

Object; unites all information about the voucher type.

isRate

Boolean; defines if the voucher sale is defined as a rate.

isAmount

Boolean; defines if the voucher sale is defined as an amount.

isFreeShipping

Boolean; defines if the voucher sale is defined as the free shipping.

isBuyXGetYFree

Boolean; defines if the voucher sale is defined as a buy X get Y free.

Object Daily Deal

Short Description

comment

String; the comment defined in the daily deal settings.

currentDeal

Object; unites all information about the current daily deal.

id

Number; the ID of the daily deal setting.

image

Object; unites all information about the image connected to the daily deal.

label

String; the label defined in the daily deal setting.

name

String; the name defined in the daily deal setting.

sysid

String; the internal name defined in the daily deal setting.

zones

Array of objects; list of all zones for which is this settings available.

Object Daily Deal Product

Short Description

from

Date; the vaid from value defined for the current deal.

id

Number; the ID of the daily deal setting.

product

Object; unites all information about the discounted product.

to

Date; the valid to value defined for the current deal.

useVariantPrice

Boolean; defines if the price is set for each variant separately (available only for master products).

Object Order Note

Short Description

id

Number; the unique note ID.

note

String; the text of the note.

visible

Boolean; defines if the note is visible (true) of hidden (false).

Object Order Product (CRM)

Short Description

additionalInfo

attachment

Array; unites all information about the file attached to the product.

baseItemPriceTaxExclusive

Integer; the price of the particular product - base price without tax included.

baseItemPriceTaxInclusive

Integer; the price of the particular product - base price with tax included.

boughtContent

Array; unites information about the bought content of this product: productDocument and downloadLink (API).

boughtImages

Array; unites information about the image inserted to the cart (available only for the Photobank).

classificationVat

String; used for the purposes of your accounting software.

code

String; the product code.

couponCardDownload

Array; list of all coupon codes to download; one item contains the URL for coupon download.

createdDate

Date and time;

currency

Object; unites all information about the currency.

discounts

Array; unites all information about the applied discounts.

dispatchType

Object; unites all information about the dispatch state.

dispatches

Array; list of dispatches connected to the product.

gift

Boolean; defines if the product is a gift.

grossPrice

Boolean; defines if the product price has been inserted with (YES) or without (NO) tax.

id

Integer; unique ID of this item on the order.

isDownloadable

Boolean; defines if the product can be downloaded (images, coupon codes).

itemPriceTaxExclusive

Integer; the price of the particular product without tax added.

itemPriceTaxInclusive

Integer; the price of the particular product with tax added.

name

String; the product name.

order

Object; unites all information about the order.

originalProduct

Object; unites all information about the original product.

product

Array; list of information about the product, used to display all information about products in a bundle.

productName

String; the product name.

productTaxCategory

Object; unites all information about the product tax category.

quantity

Integer; defines how many items of this product is in the cart.

rateVat

String; rate VAT information used for the purposes of your accounting software.

tax

Object; unites all information about the type of the tax applied on this product.

taxAmount

Integer; the total tax amount.

taxBaseAmount

Integer; the total tax amount (counted from the base product price).

taxDiscountAmount

Integer; the tax counted for the discounted amount.

taxExclusiveAmount

Integer; the price for all items of this product without tax added.

taxExclusiveBaseAmount

Integer; the base price for all items of this product without tax added.

taxExclusiveBaseUnitPrice

Integer; the base unit price (one item) wihtout tax added.

taxExclusiveDiscountAmount

Integer; the discount amount without tax added.

taxExclusiveUnitPrice

Integer; price per one item of this product without tax added.

taxInclusiveAmount

Integer; the price for all items of this product with tax aded.

taxInclusiveBaseAmount

Integer; the base price for all items of this product with tax added.

taxInclusiveBaseUnitPrice

Integer; the base unit price (one item) wihtout tax added.

taxInclusiveDiscountAmount

Integer; the discount amount with tax added.

taxInclusiveUnitPrice

Integer; price per one item of this product with tax added..

taxType

Object; unites all information about the tax type applied in the products.

taxes

Array; list of all taxes applied on this product.

taxes

Array; unites all information about the taxes applied on this product.

unit

Object; unites all information about the product’s unit.

Array Order Product

Short Description

id

Integer; the product ID.

code

String; the product code.

externalId

String; the product external ID.

name

String; the product name.

description

String; the product description.

shortDescription

String; the product short description.

voucherIssuedFromKeyManagement

Boolean; defines if the voucher has been issued from the key management.

unit

Object; unites all information about the product unit.

deliveryType

Object; unites all information about the delivery type.

deliveryService

Object; unites all information about the delivery service.

originalProduct

Object; unites all information about the original product (products application).

productType

Object; unites all information about the product type.

bundleContent

Array; unites all information about the bundle content.

renewalDate

DateTime; used for subscription products. The field contains the date of the next payment. If the product is not a subscription, the value is null.

Array Bundle Content

Short Description

id

Integer; the bundle content ID.

quantity

Number; the product quantity.

bundle

Array; list of information about the bundle.

product

Array; list of information about the product.

Object Product Tax

Short Description

amount

Integer; the tax amount.

id

Number; the ID if the product tax.

orderProduct

Object; unites all information about the product.

rate

Number; the tax rate (percentage).

taxType

Object; unites all information about the tax type.

Object Delivery Type

Short Description

id

Number; the ID of the delivery service.

name

String; the name of the delivery service.

sysid

String; the internal name of the delivery service.

systemDeliveryService

Object; unites all information about the system delivery service.

Object System Carrier Service

Short Description

carrier

Object; unites all information about the system carrier.

clientServiceId

String; the client service ID.

description

String; the description of this carrier service.

id

Integer; the unique ID of the carrier service.

maxDepth

Integer; the value inserted in the depth (maximal) field on the General Limits tab.

maxHeight

Integer; the value inserted in the height (maximal) field on the General Limits tab.

maxLength

Integer; the value inserted in the length (maximal) field on the General Limits tab.

maxVolume

Integer; the value inserted in the volume (maximal) field on the General Limits tab.

maxWeight

Integer; the value inserted in the weight (maximal) field on the General Limits tab.

maxWidth

Integer; the value inserted in the width (maximal) field on the General Limits tab.

minDepth

Integer; the value inserted in the depth (minimal) field on the General Limits tab.

minHeight

Integer; the value inserted in the height (minimal) field on the General Limits tab.

minLength

Integer; the value inserted in the length (minimal) field on the General Limits tab.

minVolume

Integer; the value inserted in the volume (minimal) field on the General Limits tab.

minWeight

Integer; the value inserted in the weight (minimal) field on the General Limits tab.

minWidth

Integer; the value inserted in the width (minimal) field on the General Limits tab.

name

String; the name of the carrier service.

postalCodeLimited

Boolean.

sysid

String; the unique internal name of this carrier service.

systemShippingAddress

Boolean; defines if the customer’s shipping address will be automatically changed by the system.

Object Delivery Type

Short Description

id

Number; the ID of the delivery type.

name

String; the name of the delivery type.

sysid

String; the internal name of the delivery type.

Object Product Type

Short Description

id

Number; the ID of the product type.

name

String; the name of the product type.

sysid

String; the internal name of the product type.

Object Dispatch Type

Short Description

id

Number; the ID of the dispatch type.

name

String; the name of the dispatch type.

sysid

String; the internal name of the dispatch type.

Object Payment Detail

Short Description

accountCode

String; the account code.

accountPaymentGateway

Object; unites all information about the payment gateway.

classificationVat

String; the classification VAT used for the purposes of your accounting software.

code

String; the payment detail code.

costDefinition

discounts

Array; unites all discount applied on this payment detail.

externalId

String; the payment detail external ID.

grossPrice

Boolean; defines if the price has been defines with or withour VAT added.

id

Number; the payment detail ID.

name

String; the payment detail name.

paymentGateway

Object; unites all information about the system payment gateway.

paymentMethod

Object; unites all information about the system payment method.

productTaxCategory

Object; unites all information about the product tax category.

quantity

Number; defines the quantity.

rateVat

String; tax accounting identification used for the purposes of your accounting software.

tax

Object; unites all information about the tax type.

taxAmount

Object; unites all information about the partner tier.

taxBaseAmount

Integer; the tax base amount.

taxDiscountAmount

Integer; the tax discount amount.

taxExclusiveAmount

Integer; the tax exclusive amount.

taxExclusiveBaseAmount

Integer; the tax exclusive base amount.

taxExclusiveBaseUnitPrice

Integer; the tax exclusive base unit price.

taxExclusiveDiscountAmount

Integer; the tax exclusive discount amount.

taxExclusiveUnitPrice

Integer; the tax exclusive unit price.

taxInclusiveAmount

Integer; the tax inclusive amount.

taxInclusiveBaseAmount

Inetger; the tax inclusive base amount.

taxInclusiveBaseUnitPrice

Integer; the tax inclusive base unit price.

taxInclusiveDiscountAmount

Integer; the tax inclusive discount amount.

taxInclusiveUnitPrice

Integer; the tax inclusive unit price.

taxType

Object; unites all information about the tax type.

type

String; the payment detail type.

unit

Object; unites all information about the item unit.

Object Partner Tier Archive

Short Description

id

Number; the ID of the partner.

name

String; the name of the partner.

originalTier

Object; unites all information about the partner tier.

Object Partner Tier

Short Description

allDiscounts

Array; contains all percentage distounts sorted by priority (as in the appliaction).

comment

String; the comment connected to the partner tier.

default

Boolean; defines if the tier is set as the default one.

depth

Number; defines how deep is this tier in the partner tier tree placed.

description

String; the tier description.

discountRatePriceRule

Object; unites all information about the Discount Configuration set in the tier detail (Price Discounts tab).

id

Number; the ID of the tier.

label

String; the tier label.

name

String; the tier name.

parent

Object; unites all information about the parent partner tier.

partners

Array; list of all partners added to this tier.

persons

Object; list of all persons (contacts) added to this tier.

sysid

String; the internal name of the tier.

tree

Object; unites all information about the partner tier tree.

useLowerPrice

Boolean; the value of the Apply Lower Price setting in the tier detail.

usePartnerPriceAsDiscount

Boolean; the value of the Mark Prices as Discounts setting in the tier detail.

Object Partner Tier Price Rule

Short Description

id

Number; the ID of the partner tier price rule.

name

String; the name of the partner tier price rule.

order

Number; the order of the price rule.

pricelist

Object; unites all information about the pricelist connected to this rule.

rate

Number; the % rate defined in the tier settings.

rounding

Object; unites all information about the rounding defined in the tier settings.

type

Object; unites all information about the price type rule.

Object Price Rule Type

Short Description

description

String; the description of the price rule type.

id

Number; the ID of the price rule type.

name

String; the name of the price rule type.

sysid

String; the internal name of the price rule type.

Object Partner Tier Tree

Short Description

id

Number; the ID of the partner tier tree.

sysid

String; the internal name of the partner tier tree.

Object Partner Archive

Short Description

id

Number; the ID of the partner.

name

String; the name of the partner.

originalPartner

Object; unites all information about the partner.

Object Order Type

Short Description

id

Number; the ID of the order type.

name

String; the name of the order type.

order

Number; the order of the order type.

sysid

String; the internal name of the ordet type.

Object Locale

Short Description

id

Number; the ID of the locale.

name

String; the name of the locale.

sysid

String; the internal name of the locale.

Object Invoice

Short Description

accountCode

String; used for the purposes of your accounting software.

activity

String; used for the purposes of your accounting software.

additionalInfo

String; the order additional info.

advancePayments

Array; list of all advance payments connected to this order.

allItems

Object; unites all order items.

billingAddress

Object; unites all information about customer’s billing address.

branchDetail

Object; unites all information about the used branch.

canceled

Boolean; defines if the invoice has been canceled.

centre

String; used for the purposes of your accounting software.

classificationVat

String; used for the purposes of your accounting software.

contract

currency

Object; unites all information about the currency.

current

Boolean; defines if the invoice is current.

customer

Object; unites all information about the customer.

displayName

String; the identification of the order to which this invoice belongs.

document

Object; unites all information about the document.

exchangeRate

Number; exchange rate between the home currency and the invoice currency.

foreignCurrencyAmount

Number; the foreign currency amount.

homeCurrency

Object; unites all information about the home currency.

homeCurrencyAmount

Number; total invoice amount in home currency.

id

Number; the unique ID of the invoice.

inHomeCurrency

Boolean; determines whether the invoice is in the home currency.

introduction

String; used for the purposes of your accounting software.

inverseExchangeRate

Number; exchange rate between the invoice currency and the home currency.

invoiceNumber

String; the invoice number.

issueDate

Date and time; date and time when has been the invoice issued.

language

Object; unites all information about the used language.

locale

Object; unites all information about the locale.

number

String; the invoice number.

order

Object; unites all information about the order.

orderDate

Date and time; the date of the order creation.

orderNumber

String; the order number.

pONumber

String; the PO number.

paymentDueDate

Date and time; the payment due date (this date is defined in the e-shop settings).

pohodaPaymentType

String; used for purposes of your accounting software.

pohodaRoundingDocument

String; used for purposes of your accounting software.

shippingAddress

Object; unites all information about the customer’s shipping address.

taxPointDate

Date and time; the tax point date (this date is defined in the e-shop settings).

taxSummary

Array of objects; unites information about the tax summary used on the invoice.

text

String; text used for the purposes of your accounting software.

variableSymbol

String; the variable symbol.

website

Object; unites all information about the origin website.

zone

Object; unites all information about the used zone.

advancePayments.getAmount()

Total sum of all advance payments.

Object Invoice Tax Summary

Short Description

amount

Number; the tax amount.

currency

Object; unites all information about the currency.

id

Number; the tax summary ID.

invoice

Object; unites all information about the invoice.

taxExclusiveAmount

Number; the tax exclusive amount of the tax summary.

taxInclusiveAmount

Number; the tax inclusive amount of the tax summary.

taxType

Object; unites all information about the tax type.

Object Document

Short Description

businessCase

Object; the dispatch state ID.

checked

Boolean; defines if the particular document has been already checked.

displayName

String; the document name.

id

Number; the document ID.

invoice

Object; unites all information about the invoice.

order

Object; unites all information about the order.

storage

type

Object; unites all information about the document type.

Object Document Type

Short Description

id

Number; the document type ID.

name

String; the name of the document type.

sysid

String; the internal name of the document type.

Object Business Case

Short Description

contact

Object; unites all information about the contact.

id

Number; the business case ID.

name

String; the name of the business case.

Object Contact

Short Description

company

Object; unites all information about a connected company.

displayName

String; the name of the contact.

id

Number; the ID of the contact.

person

Object; unties all person information.

Object Person

Short Description

company

Object; unites all information about the company.

contact

Object; unites all information about the contact.

displayName

String; the full name of the person (last and first name combined).

firstName

String; the person’s first name.

group

honorific

String; the person’s honorific.

id

Number; the ID of the person.

lastName

String; the person’s last name.

priceLevel

Object; unties all information about the price level defined for the person.

tier

type

Object; unties all person type information.

user

Object Company

Short Description

addresses

Object; unites all addresses defined for the company.

Comment

String; the comment defined in the company detail.

contact

Object; unites all information about the contact to which is this company connected.

displayName

String; the name of the company.

externalId

String; the company’s external ID.

extraTaxIdentity

String; the name of the person type.

group

Object; unites all information about a connected contact group.

id

Number; the company’s ID.

identificationNumber

String; the company’s identification number.

name

String; the company’s name.

parentCompany

Object; unites all information about the parent company.

partner

Object; unites all information about the partner.

taxIdentity

String; the company’s tax identity.

vatPayer

Boolean; defines if the company is a VAT payer.

Object Contact Group

Short Description

description

String; the contact group description.

id

Number; the contact group ID.

name

String; the contact group name.

Object Person Type

Short Description

description

String; the person type description.

id

Number; the ID of the person type.

name

String; the name of the person type.

sysid

String; the internal name of the person type.

Object Dispatch State

Short Description

id

Number; the dispatch state ID.

name

String; the name of the dispatch state.

order

Number; this number defines the order of this dispatch state.

sysid

String; the internal name of the dispatch state.

Object Delivery Detail

Short Description

accountCode

String; the account code used for the accounting software purposes.

carrierService

Object; unites all information about the delivery method.

classificationVat

String; used for accounting purposes. It is defined in the e-shop settings.

code

costDefinition

discounts

Array; list of all discounts applied on the delivery.

externalId

String; the delivery’s external ID.

grossPrice

Boolean; defines if the price is with or without VAT included.

id

Number; the unique ID of the delivery.

itemPriceTaxExclusive

Integer; the price without tax included.

itemPriceTaxInclusive

Integer; the price with tax included.

name

String; the name of the delivery.

productTaxCategory

Object; unites all information about the tax applied on the delivery.

quantity

Number; the quantity.

rateVat

String; rate VAT used for your software accounting purposes.

pickupPointInfo

Object; unites all information about the selected pick up point.

tax

Object; unites all information about the tax type.

taxAmount

Integer; the total tax amount.

taxBaseAmount

Integer; the tax base amount.

taxDiscountAmount

Integer; the tax discnout amount.

taxExclusiveAmount

Integer; the tax exclusive amount.

taxExclusiveBaseAmount

Integer; the tax exclusive base amount.

taxExclusiveBaseUnitPrice

Integer; the tax exclusive base unit price.

taxExclusiveDiscountAmount

Integer; the tax exclusive discount amount.

taxExclusiveUnitPrice

Integer; the tax exclusive unit price.

taxInclusiveAmount

Integer; the tax inclusive amount.

taxInclusiveBaseAmount

Integer; the tax inclusive base amount.

taxInclusiveBaseUnitPrice

Integer; the tax inclusive base unit price.

taxInclusiveDiscountAmount

Integer; the tax inclusive discount amount.

taxInclusiveUnitPrice

Integer; the tax inclusive unit price.

taxType

Object; unites all information about the tax type.

trackings

Array; list of tracking numbers conncted to this delivery.

type

String; the delivery detail type.

unit

Object; unites all information about the delivery unit.

Tracking (array)

Short Description

id

Number; the unique ID.

trackingNumber

String; the tracking number of the delivery.

shipment

Array; identifies the shipment connected to this tracking number.

url

String; the tracking URL address (provided by the delivery service, used to track and trace the package).

Pickup Point Info

Short Description

name

String; the name of the pickup point.

streetAddress

String; the street address (a part of the pickup point address).

city

String; the city (a part of the pickup point address).

postalCode

String; the postal code (a part of the pickup point address).

country

Object; unites all information about the country (a part of the pickup point address).

url

String; the URL address of the pickup point.

routingCode

String; the routing code of the pickup point.

Shipment (array)

Short Description

id

Number; the unique ID of the shipment.

shipmentNumber

String; the shipment number.

shipmentOrder

Number; the order of the shipment.

packageCount

Number; the number of packages.

createdDate

Date; the shipment creation date.

expeditionDate

Date; the expedition date.

consigned

Boolean; defines if the shipment has been consigned.

consignedDate

Date; the consignation date.

labelPrinted

Boolean; defines if the label has been printed.

labelPrintedDate

Date; the label printed date.

order

String; the order ID.

issue

Identifies the issue connected to this shipment.

state

Object; the current shipment state.

carrierService

Object; unites all info about the delivery method used for this shipment.

trackings

Array; unites all information about tracing numbers connected to this shipment.

Shipment State (object)

Short Description

id

Number; the unique ID of the shipment state.

name

String; the shipment state name.

order

Number; the order of the shipment state.

sysid

String; the internal name of the shipment state.

Object Advance Payments

Short Description

classificationVat

String; VAT classification used for the accounting purposes. It is defined in the e-shop settings.

label

String; label used for accounting purposes. It is defined in the e-shop settings.

name

String; name used for accounting purposes. It is defined in the e-shop settings.

number

Number; the advance payment number (proforma invoice number).

quantity

Number

rateVat

String

taxAmount

Integer; the tax amount.

taxExclusiveAmount

Integer; the tax exclusive amount.

taxInclusiveAmount

Integer; the tax inclusive amount.

taxRate

Integer; the applied tax rate.

Object Customer Address

Short Description

callingCode

String; the customer’s calling code.

city

String; the customer’s city.

company

String; the customer’s company name.

country

Object; unites all information about the customer’s country.

countryName

String; the name of the customer’s country.

county

String; the customer’s county.

customer

Object; unites all information about the customer.

email

String; the customer’s e-mail address.

firstName

String; the customer’s first name.

formattedPhone

String; the customer’s phone number (formatted calling code with phone).

honorific

String; the customer’s honorific.

id

Number; the unique address ID.

ipAddress

String; the customer’s IP address.

lastName

String; the customer’s last name.

phone

String; the customer’s phone number.

pickupPointId

Number; the ID of the selected pick up point.

pickupPointName

String; the name of the selected pick up point.

postalCode

String; the customer’s postal code.

region

String; the customer’s region.

streetAddress

String; the customer’s street address.

Object Customer

Short Description

callingCode

String; the customer’s calling code.

companyExtraTaxIdentity

String; the customer’s company extra tax identity.

companyIdentificationNumber

String; the customer’s company identification number.

companyName

String; the customer’s company name.

companyTaxIdentity

String; the customer’s company tax identity.

contact

String; the customer’s county.

email

String; the customer’s e-mail address.

firstName

String; the customer’s first name.

honorific

String; the customer’s honorific.

id

Number; the unique address ID.

ipAddress

String; the customer’s IP address.

lastName

String; the customer’s last name.

phone

String; the customer’s phone number.

Object Order State

Short Description

id

Number; the unique order source ID.

name

String; the order source name.

sysid

String; the internal name of the order source.

Object Order State

Short Description

id

Number; the unique order state ID.

name

String; the order state name.

order

Number; the state order.

sysid

String; the internal name of the order state.

Object Tax Summary

Short Description

amount

Integer; the tax summary amount.

id

Number; the unique tax summary ID.

order

Object; unites all information about the connected order.

taxExclusiveAmount

Integer; the tax exclusive amunt.

taxInclusiveAmount

Integer; the tax inclusive amount.

taxType

Object; unites all information about the tax type.

Object Tax Type

Short Description

abbreviation

String; the tax abbreviation.

id

Number; the unique tax type ID.

name

String; the tax name (defined in the Administration module in the Zone Taxes application.

rate

Integer; the tax rate.

value

Integer; manually defined tax value.

Object Partner

Partner (CRM parameter)

Short Description

addresses

Object; unites all addresses connected to the partner.

agreements

Object; unites all agreements to which has this partner agreed.

carrierServices

Object; unites all information about available carrier services.

companies

Array; unites all information about all companies connected to the partner.

company

Array; unites all information about the partner’s company.

creditLimit

Integer; partner’s credit limit.

currency

Object; unites all information about partner’s currency.

email

String; partner’s e-mail address.

firstName

String; partner’s first name.

invoicedAmount

Integer; partner’s invoiced amount (current value according to partner’s orders).

invoices

Object; list of all invoices available for the partner.

lastName

String; partner’s last name.

managers

Object; unites all partner’s managers.

orders

Object; unites all information about partner’s orders.

paymentMethods

Array; unites all information about available payment methods.

phone

String; partner’s phone number.

tier

Object; unites all information about the partner tier.

Object Address

Address

Short Description

id

String; the unique address ID.

callingCode

String; the address info - calling code.

city

String; the address info - city.

company

String; the address info - company.

county

String; the address info - county.

honorific

String; the address info - honorific.

firstName

String; the address info - first name.

lastName

String; the address info - last name.

phone

String; the address info - phone.

postalCode

String; the address info - postal code.

region

String; the address info - region.

streetAddress

String; the address info - street address.

country

Array; the address info - unites all information about the country.

Object Partner Agreement

Partner Agreement

Short Description

id

Integer; the unique ID of the agreement.

name

String; the name of the agreement.

label

String; the label of the agreement (it is a name that should be displayed to website visitors).

description

String; the description connected to the agreement.

default

Boolean; defines if the current agreement is set as the default in your account.

validFrom

Object; defines the date from which is this agreement valid (and can be used on the website).

file

Integer; identifies the file (particular agreement).

hasPartners

Boolean; defines if there is at least one partner who has agreed to this agreement.

approved

Date and time when has been this agreement approved.

approvedBy

url

Object; unites all information about aliases defined for current page.

Object Valid From

validFrom (partnerAgreement)

Short Description

date

Date and time which deretmines the start of the agreement validity.

timezone_type

Integer; defines used timezone.

timezone

String; used timezone.

Object Page

Attributes for a particular page or article.

Page (CMS parameter)

Short Description

aliases

Object; unites all information about aliases defined for current page.

archived

Boolean; defines if the page is currently marked as Archived.

articleCategories

Object; unites all information about available article categories. Used only for articles.

authors

Object; unites all information about the author (or authors) of this article.

cacheSchema

Information about the current cache schema.

canonicalUrl

String; the canonical URL of the page.

component

Object; unites all information about the current component (used for articles).

content

The content of the current page.

culture

Object; unites all information about the currently used culture.

cultures

Object; unites all information about the current page in various cultures in which it exists.

description

The SEO description of the current page.

descriptionSource

Object; unites all information about the SEO description source.

fullUrl

String; the full URL address of the current page.

id

The unique ID of the current page.

keywords

The SEO keywords connected to the current page.

language

Object; unites all information about the language of the current page.

layout

Information about the current layout (used for articles/components).

name

The name of the current page.

navCurrent

Boolean; used for navigation purposes. Defines if the current page is active.

navPath

Boolean; used for navigation purposes. Defines if the current page is in the active path.

navigationPlacement

Boolean; defines if the current page is a part of a dynamic navigation (can be changed in the page settings).

navigationTitle

String; the navigation title (taken from the current page settings).

navigationTrees

Object; unites all information about all navigation trees in which is this page used.

navigations

Object; unites all information about all navigation trees in which is this page used.

noarchive

Boolean; the SEO setting: no archive. You can change it in the page settins.

nofollow

Boolean; the SEO setting: no follow. You can change it in the page settins.

noindex

Boolean; the SEO setting: no index. You can change it in the page settins.

notUseTemplate

Boolean; defines if a website template will be used. You can change it in the page settings.

page.

Object; unites all information about the current page.

pageSysid

String; the internal name of the current page.

parent

Object; unites information about the parent page.

path

String; the URL path to the current page.

perex

String; the perex defined in the article settings (used only for articles).

permissions

Object; unites all information about the permissions connected to the current page.

photo

String; information about the photo inserted in the article settings (used for articles only).

previewUrl

String; the preview URL address of the current page.

priority

The priority defined for in the current article settings (used only for articles).

published

Date and time of the publishing of this article (used for articles only).

relatedProductCategories

Array; unites all related categories which are defined in the Article Products tab (used for articles only).

relations

Object; unites information about the related articles (used for articles only).

searchIndexing

Boolean; defines if the current page will be indexed for searching. You can change this value in the page settings.

sitemapPlacement

Boolean; defines if the current node (page) will be a part of the sitemap.

sitemapPriority

The particuar priority sitemap value in the range 0-1. This can be changed in the Sitemap settings.

source

String; the source provided in the article settings (used for articles only).

ssl

Boolean; defines if the current page will be displayed in the SLL mode.

startPublishing

The date and time of the start of publishing of this article (used for articles only).

storage

Object; unites all information about the storege info of the current page.

subtitle

String; the subtitle of the current article defined in the article settins (used for articles only).

tags

Object; unites all information about the tags connected to the current page.

teaserImage

Object; unites all information about the teaser image provided in the article settings (used for articles only).

template

Object; unites all information about the template connected to this template.

title

String; the title of this page provided in its SEO settings.

titleSource

The source of the SEO title. This is set in the SEO settings of the current page.

translated

Boolean; defines if the current page is translated.

url

String; the URL of the current page.

useKeywords

Boolean; defines the usage of keywords.

useRobots

Boolean; defines the usage of robots.txt file.

useRobotsCustom

Boolean; defines the usage of customized robot.txt file.

zone

Object; unites all information about the current zone.

Object Author

Author (CMS parameter)

Short Description

description

String; the description of the author (can be set in the author detail in the Author Tools module).

email

String; the e-mail address of the author.

firstName

String; the first name of the author.

fullName

String; the full name of the author.

honorific

String; the honorific of the author.

id

Integer; the unique ID of the author.

lastName

String; the last name of the author.

photo

Object; unites all information about the photo of the author.

user

Object; unites all information about the user (if the author is a BizBox user).

website

String; the website address defined in the author’s profile.

Object Data List

Data List (CMS parameter)

Short Description

allCultures

Boolean; defines if the content of the data list will be used in all cultures.

culture

Object; information about the default culture.

description

String; the data list’s description.

id

Integer; the data list’s unique ID.

items

Object; unites all items from the data list.

name

String; the name of the data list.

sysid

String; the internal name of the data list.

type

Object; the type of the data list.

Object Data List Item

Data List Item

Short Description

active

Boolean; defines the activity of the current item.

alternateFile

Object; the alternate file of the item.

alternateFileUseDefault

Boolean; defines if the value of the alternate file in default culture will be used (setting available only for translated items).

alternateLink

String; the alternate link connected to the item.

alternateLinkUseDefault

Boolean; defines if the valueof alternate link in default culture will be used (setting available only for translated items).

alternateText

String; the alternate text connected to the item.

alternateTextUseDefault

Boolean; defines if the value of alternate text in default culture will be used (setting available only for translated items).

alternateTitle

String; the alternate title connected to the item.

alternateTitleUseDefault

Boolean; defines if the value of alternate title in default culture will be used (setting available only for translated items).

culture

Object; unites all information about the culture of the item.

date

Date and time; the date connected to this item.

dateUseDefault

Boolean; defines if the value of date in default culture will be used (setting available only for translated items).

displayName

String;

file

Object, the file connected to this item.

fileUseDefault

Boolean; defines if the value of the file in default culture will be used (setting available only for translated items).

id

Integer; the unique ID of the current item.

link

String; the link defined for this item.

linkUseDefault

Boolean; defines if the value of the link in default culture will be used (setting available only for translated items).

listId

Integer; the unique list ID of this item.

listItem

Object; unites all information about the item.

order

Integer; the order (number) of the item.

sysid

String; the internal name of the item.

text

String; the text defined for this item.

title

String; the title of this item.

titleUseDefault

Boolean; defines if the value of the title in default culture will be used (setting available only for translated items).

Object List Item

Data List Item

Short Description

active

Boolean; defiens the current activity of the item.

finishPublishing

Date and time; defines when will be this item unpublished.

id

Integer; the unique ID of the item.

list

Object; unites all information about the list of the item.

order

Integer; the order (number) of this item.

startPublishing

Date and time; defines when will be this item published.

sysid

String; the internal name of the item (defined in its detail).

Object Data List Type

Data List Type

Short Description

allCultures

Boolean; defines if the content of the data list will be used in all cultures.

description

String; the description connected to the data list type.

id

Integer; the unique ID of the data list type.

name

String; the name of the data list type.

sysid

String; the internal name of the data list type.

CMS User

Short Description

active

Boolean; defines if the user’s account is currently active.

changePwdHash

String; the hash used to reset user’s password.

defaultBillingAddress

Object; unites all information about the default billing address.

defaultShippingAddress

Object; unites all inforamtion about the default shipping address.

email

String; the user’s e-mail address.

firstName

String; the user’s first name.

fullName

String; the user’s full name.

id

Number; the unique user ID.

lastBillingAddress

Object; unites all information about the last used billing address.

lastName

String; the user’s last name.

lastShippingAddress

Object; unites all information about the last used shipping address.

login

String; the user’s login.

permissions

Object; unites all information about the permissions connected to the user.

person

Object; unites all information about the user’s person.

registered

Date and time; the date and time when has been the user registration completed.

registrationSource

Object; unites all information about the user registration source.

supplier

Unites all information about the supplier.

Registration Source

Short Description

id

Number; the unique ID of the registration source.

name

String; the name of the registration source.

sysid

String; the internal name of the registration source.

Contact Address

Short Description

callingCode

String; the calling code.

city

String; the city.

company

String; the company name.

contact

Object; unites all inforamtion about the contact to which this address belongs.

country

Object; unites all information about the country.

county

String; the county.

deleteURL

String; the URL address used to detele this address (on the website).

editURL

String; the URL address used to edit this address (on the website).

firstName

String; the first name.

honorific

String; the honorific.

id

Number; the unique address ID.

lastName

String; the last name.

phone

String; the phone number.

postalCode

String; the postal code.

region

String; the region.

streetAddress

String; the street address.

type

Object; unites all information about the contact address type.

Contact Address Type

Short Description

id

Number; the ID the contact address type.

name

String; the name of the address type.

sysid

String; the unique system ID of the address type.

Object BizBox User

User

Short Description

accountName

String; the name of the BizBox account.

avatar

Object; unites all information about the user’s avatar.

department

String; the user’s department.

email

String; the user’s e-mail addresss.

firstName

String; the user’s first name.

fullName

String; the user’s full name.

id

Integer; the user’s unique ID.

lastName

String; the user’s last name.

permissions

Object; unites all information about the user’s permissions.

phone

String; the user’s phone number.

position

String; the user’s job position.

roles

Object; unites all information about the user’s permissions.

user

Object; the website address defined in the author’s profile.

Object User

User

Short Description

id

Integer; the user’s unique ID.

login

String; the user’s login.

Object Roles

Roles

Short Description

id

Integer; the unique ID of the role.

name

String; the user’s login.

sysid

String; the internal name of the role.

Object Navigation

cms.navigation.get(‘product-category-tree’).getTree - array of objects;

Navigation (CMS parameter)

Short Description

active

Boolean; defines the activity of this node (page).

activePage

activePath

Boolean; defines if the current node is a path of the active path.

aliases

Object; unites all information about the aliases of this node (page).

archived

Boolean; defines if the node (page) is currently archived.

articleCategories

Object; unites all information about the node (article) categories.

authors

Object; unites all inforamtion about the author of the node (article).

cacheSchema

information about the current cache schema.

canonicalUrl

String; the canonical URL of the page.

component

Object; unites all information about the current component (used for articles).

content

The content of the current node.

contentSource

Object; unites all information about the SEO description source.

culture

Object; unites all information about the used culture.

cultures

Array; contains information about the particular node in other cultures defined on the website.

depth

Integer; the depth of the current node in the navigation tree.

description

String; the page description connected to this node.

descriptionSource

String; defines from where should be the description

file

Integer; the unique identificator of the connected file (used for File page type).

finishPublishing

Date and time; defines when will be the node (article) unpublished.

fullUrl

String; the full URL address of the node (page).

id

Integer; the unique ID of this node (page).

index

keywords

String; all SEO keywords connected to this node (page).

language

Object; unites all information about the current language.

layout

information about the used layout (used for components).

link

String; the link defined for the Link External page type.

linkInternal

Object; available for the Link Internal page type. Unites all information about the linked page.

mimeType

name

String; the name of the current node (page).

navCurrent

Boolean; defines if the node is currently active.

navPath

Boolean; defines if the current node is a part of the active path.

navigationPlacement

Boolean;

navigationTitle

String; the navigation title of the current node (page).

navigationTrees

navigations

noarchive

Boolean; the SEO setting: no archive. You can change it in the page settins.

nofollow

Boolean; the SEO setting: no follow. You can change it in the page settins.

noindex

Boolean; the SEO setting: no index. You can change it in the page settins.

notUseTemplate

Boolean; defines if the default template shall be used.

page

Object; unites all information about the node (page).

pageSysid

String; the internal name of the node (page).

parent

Object; unites all information about the parent node.

path

String; the path to the current node (page).

perex

String; the perex defined for this node (used for articles).

permissions

Object; unites all information the permissions set for this node.

photo

String; the photo connected to this node (used for articles).

previewUrl

String; the preview URL of this node (page).

priority

Integer; the priority set for this node (used for articles).

private

published

relations

searchIndexing

Boolean; defines if the current node (page) will be indexed for searching. You can change this value in the page settings.

sitemapPlacement

Boolean; defines if the current node (page) will be a part of the sitemap.

sitemapPriority

Integer; defines the priority of this node (page) in the sitemap.

source

String; defines the source of the node (used for article).

ssl

Boolean; defines if the node (page) is secured (available only in the SSL access level.

startPublishing

Date and time; defines when will be this node (used for articles) being published.

storage

Object; unites all information about the storage.

subtitle

String; the subtitle connected to this node (used for articles).

syncEnabled

synchronized

sysid

String; the internal name of the navigation tree.

tags

Object; unites all information about the tags connected to this node (page).

teaserImage

Object; unites all information about the teaser image connected to this node (article).

template

Object; unites all information about the used template.

title

String; the title of the node (article).

titleSource

The source of the SEO title. This is set in the SEO settings of the current page.

translated

Boolean; defines if the current node (page) is translated.

tree

type

Object; unites all information about the type of the node (page).

url

String; the URL of the node (page).

useKeywords

Boolean; defines the usage of the keywords.

useRobots

Boolean; defines the usage of the robots.

useRobotsCustom

Boolean; defines the usage of custom robots file.

zone

Object; unites all information about the current zone.

childItems

Object; unites all child items of this node.

Object Aliases

Alias (Object Page)

Short Description

account

Object; unites all information about your BizBox account.

culture

Object; unites all information about the currently used culture.

default

Boolean; defines if the alias is marked as default (particular alias setting).

id

The ID of the current alias.

name

The name of the current alias.

page

Object; unites all information about the alias page.

redirect

Boolean; defines if the current alias will be redirected to the landing alias (alias setting).

redirectCode

Object; unites all information about the redirection.

urlName

String; the URL name of the current alias.

Object Culture

Culture (CMS parameter)

Short Description

account

Object; unites all information about your BizBox account.

code

String; the code of the current culture (example: ww-en).

displayName

String; the full name of the current culture - name and code (example: World | English (ww-en)).

genericLanguage

Boolean; defines if the currently used language (a part of the culture) is marked as generic.

id

Integer; an unique ID of the current culture.

language

Object; unites all information about the culture’s language.

locale

Object; unites all locale information.

name `

String; the name of the current culture (example: World | English).

zone

Object; unites all information about the current zone.

Component

Short Description

id

Integer; the unique ID of the component.

pageCulture

Array;

systemComponent

Object; unites all information about the system component.

System Component

Short Description

description

String; the description of the system component.

id

Integer; the unique ID of the system component.

name

String; the component name.

sysid

String; the internal name of the component.

Page Culture

Short Description

absoluteUrl

String; the absolute URL of the page.

activePage

Boolean; defines the activity of the page set in its settings.

archived

Boolean; defines if the page is currently marked as Archived*.

authors

Array; unites information about the authors connected to this page (used for articles).

canonicalUrl

String; the canonical URL of the page.

component

Object; unites all information about the current component (used for articles).

content

The content of the current page.

culture

Object; unites all information about the currently used culture.

description

The SEO description of the current page.

descriptionSource

Object; unites all information about the SEO description source.

file

fullUrl

String; the full URL address of the current page.

id

The unique ID of the current page.

keywords

The SEO keywords connected to the current page.

language

Object; unites all information about the language of the current page.

link

linkInternal

name

The name of the current page.

navigationPlacement

Boolean; defines if the current page is a part of a dynamic navigation (can be changed in the page settings).

navigationTitle

String; the navigation title (taken from the current page settings).

noarchive

Boolean; the SEO setting: no archive. You can change it in the page settins.

nofollow

Boolean; the SEO setting: no follow. You can change it in the page settins.

noindex

Boolean; the SEO setting: no index. You can change it in the page settins.

notUseTemplate

Boolean; defines if a website template will be used. You can change it in the page settings.

page.

Object; unites all information about the current page.

pageSysid

String; the internal name of the current page.

perex

String; the perex defined in the article settings (used only for articles).

permissions

Object; unites all information about the permissions connected to the current page.

photo

String; information about the photo inserted in the article settings (used for articles only).

previewUrl

String; the preview URL address of the current page.

published

Date and time of the publishing of this article (used for articles only).

relatedProducts

Array; list of products connected to this article (used for articles only).

relations

Object; unites information about the related articles (used for articles only).

source

String; the source provided in the article settings (used for articles only).

storage

Object; unites all information about the storege info of the current page.

subtitle

String; the subtitle of the current article defined in the article settins (used for articles only).

tags

Object; unites all information about the tags connected to the current page.

teaserImage

Object; unites all information about the teaser image provided in the article settings (used for articles only).

template

Object; unites all information about the template connected to this template.

title

String; the title of this page provided in its SEO settings.

titleSource

The source of the SEO title. This is set in the SEO settings of the current page.

translated

Boolean; defines if the current page is translated.

url

String; the URL of the current page.

useKeywords

Boolean; defines the usage of keywords.

useRobots

Boolean; defines the usage of robots.txt file.

useRobotsCustom

Boolean; defines the usage of customized robot.txt file.

zone

Object; unites all information about the current zone.

Object Description Source

Description Source (CMS parameter) )

Short Description

description

The page description.

id

Integer; the ID of the used description source.

name

String; the name of the used description source.

sysid

String; the internal name of the used description source.

Object Language

Langauge (CMS parameter)

Short Description

id

Integer; the ID of the used language.

iso

String; the ISO of the current language.

name

String; the name of the current language.

Object Navigation Trees

Navigation Trees (CMS parameter) )

Short Description

Object Permission

Permissions (CMS parameter) )

Short Description

description

String; the description of the particular permission.

id

Integer; the ID of the particular permission.

name

String; the name of the particular permission.

public

Boolean; Specifies whether the permission is set as public.

sysid

String; the internal name of the particular permission.

Object Relations

This object contains an array of particular connected related articles defined in the article settings. Every related article has the structure of the page object.

Object Storage

Storage alias.redirectCode

Short Description

filename

String; the name of the particular file used in the storage.

id

Integer; the ID of the particular file used in the storage.

key

Integer; the key of the particular file used in the storage.

mimeType

String; the mime type of the particular file used in the storage.

size

Integer; information about the size of the particular file in the storage.

storageColumn

Object; unites information about the used storage column.

uri

String; the URI of the particular file used in the storage.

Object Tags

An array of all tags connected to a particular page.

Tags

Short Description

displayname

String; the name of the particular file used in the storage.

id

Integer; the ID of the particular file used in the storage.

internal

Integer; the key of the particular file used in the storage.

label

String; the mime type of the particular file used in the storage.

name

Integer; information about the size of the particular file in the storage.

totalItems

Object; unites information about the used storage column.

Type

Short Description

displayname

String; the name of the particular file used in the storage.

id

Integer; the ID of the particular file used in the storage.

internal

Integer; the key of the particular file used in the storage.

label

String; the mime type of the particular file used in the storage.

name

Integer; information about the size of the particular file in the storage.

totalItems

Object; unites information about the used storage column.

Object File

File

Short Description

autoCompress

Boolean; defines if the current file is auto compressed.

dataUrl

String; file content coded as data URL.

description

String; the description connected to the file.

folder

Object; information about the folder of the file.

id

Integer; the ID of the file (can be used with <img src>).

link

String; the link to the file.

mimeType

Object; information about the mime type of the file.

name

String; the name of the file.

path

String; the path to the file (in the File Manager).

permissions

Object; information about the permissions connected to this file.

private

Boolean;

storage

Object; unites all information about the storage.

productDocument

Object; unites all information about the document.

thumbnail

String; the thumbnail of the file.

urlPath

String; the URL path to the file.

Object Product Document

Object Product Document

Short Description

description

String; description.

displayName

String; defined display name (label).

file

Object; unites all information about the file.

fileSourcePath

String; path to the file source.

fileSourceSysid

String; the internal name of the file source.

id

Number; the unique ID.

language

Object; unites all information about the defined language.

name

String; the name of the document.

order

Number; the order of the document.

paidContent

Boolean; defines if the documents is marked as paid content.

product

Object; unites all information about the product.

sentByMail

Boolean; defines if the document will be sent as an attachment of the purchase confirmation e-mail.

sysid

String; the internal name of the document.

type

Object; unites all information about the product document.

Object Product Document Type

Object Product Document Typ

Short Description

id

Number; the uniqur ID.

name

String; the name of the document type.

sysid

String; the internal name of the document type.

Object Folder

Folder

Short Description

autoPermissions

Array; unites all automatic permissions for the folder.

depth

Integer; defines the depth (location) of the current folder in the hierarchy of folders in the File Manager.

description

String; the description connected to the folder.

id

String; the unique ID of the folder.

index

Integer;

name

String; the name of the folder.

parent

Object; information about the parent folder.

path

String; the path to the folder.

permissions

Object; information about the name translations.

private

Boolean;

urlPath

String; the URL path to the folder.

Object Mime Type

Mime Type

Short Description

fileExtension

String; the file extension of the file.

groups

Array; unites all information about the group of mime types to which this one belongs.

id

Integer; the unique ID of the mime type.

mimeType

String; the mimetype.

name

String; the name of the mime type.

Object Zone

Zone

Short Description

country

Object; unites all information about the country.

currency

String; the used currency.

eshop

Array; unites information about all available e-shops.

id

Integer; the unique ID of the zone.

name

String; the name of the zone.

region

String; the name of the mime type.

sysid

String; the internal name of the zone.

E-commerce E-shop

Short Description

accessTokenValidity

Integer; numericaly defines the validity of the access token (in days).

accounting

Object; unites all information about the e-shop accounting settings.

automaticIssueVoucher

Object; unites all information about the vouchers connected to the e-shop settings.

branch

Object; unites all information about the branch.

checkout

Object; unites all information about the checkout connected to this e-shop settings.

createAccount

Boolean; defines if the automatic user account creation is enabled.

description

String; the description of the e-shop settings.

enableOrderAccessToken

Boolean; defines if the order token is enabled.

externalRatings

Object; unites all available external ratings; available parameters are heurekaCz and heurekaSk.

id

Integer; the unique ID of the e-shop settings.

isStockDispatchManual

Boolean; defines if the e-shop settings have manual (TRUE) of automatic (FALSE) dispatch.

maxAttachmentSize

Integer; defines the maximal size of an attachment file (MiB).

maxCartAttachmentsSize

Integer; defines the maximal size of all attachments in the cart (MiB).

name

String; the name of the e-shop settings.

onlineSale

Boolean; defines if this e-shop settings are intended form online sale.

prodCatWithoutPrice

Boolean; defines if the products without price defined will be dispalyed in the product catalog.

prodCatWithoutStock

Boolean; defines if the products that are currently out of stock will be dispalyed in the product catalog.

quantityLimit

Integer; the value of the quantity limit setting.

stockService

Object; unites all information about the connected stock service.

sysid

String; the internal name of the e-shop settings.

type

Object; unites all information about the type of the e-shop settings.

website

Object; unites all information about the website on which are the e-shop settings available.

zones

Array; unites information about all zones for which are the e-shop settings available.

External Ratings; single rating

Short Description

cons

String; part of the rating - cons.

created

Date and time; date of creation of the rating.

getRecommendsRate

Recommends rate defines how many customers recommend this online store (as a percentage). This value is available only if the Public Key field in the e-shop settings if filled properly.

getTotalCount

A total count of particular ratings. This value is available only if the Public Key field in the e-shop settings if filled properly.

pros

String; part of the rating - pros.

summary

String; part of the rating - summary.

totalRating

Number; numeric rating (10-100).

username

String; part of the rating - username of the reviewer.

External Product Rating

Short Description

username

String; the username of your customer who rated this product.

created

Date and time; date of creation of the rating.

recommends

Boolean; determines whether the customer recommends the product.

rating

Number; customer’s product rating (percent).

pros

String; part of the rating - pros (text).

cons

String; part of the rating - cons (text).

summary

String; part of the rating - summary (text).

product

Object; unites all information about the rated product.

Checkout

Short Description

description

String; the description of the checkout (defined in the checkout settings).

id

Integer; the unique ID of the checkout.

name

String; the name of the checkout (defined in the checkout settings).

type

Object; unites all information about the checkout type.

Checkout Type

Short Description

id

Integer; the unique ID of the checkout type.

name

String; the name of the checkout type.

sysid

String; the internal name of the checkout type.

E-shop Accounting

Short Description

accountActivity

String; the value defined in the Account Activity field.

accountAssignment

String; the value defined in the Account Assignment Default field.

crediteNoteAccountAssignment

String; the value defined in the Account Assignment Credit Note field.

crediteNotePreamble

String; the value defined in the E-shop Documents Texts Credit Note field.

delivery

String; the value defined in the Account Assignment Delivery field.

discountProductLabel

String; the value defined in the E-shop Documents Texts Discount Product Label field.

eshop

Object; the e-shop settings to which this accounting belongs.

id

Integer; the unique ID of the e-shop accounting settings.

orderPreamble

String; the value defined in the E-shop Documents Texts Order Introduction field.

orderRounding

Object; unites all information about order rounding settings.

orderRoundingMultiple

Integer; the value set in the Order Total Amount multiplicator field.

paymentDueDatePeriod

Integer; the value set in the Payment Due Date field (in days).

preamble

String; the value defined in the E-shop Documents Texts Invoice Introduction field.

profitCenter

String; the value defined in the Account Identification Profit Center field.

proformaInvoiceLabel

String; the value defined in the E-shop Documents Texts Proforma Invoice Label field.

projectAccounting

String; the value defined in the Account Identification Project Accounting field.

rounding

String; the value defined in the Account Rounding field.

taxPointDatePeriod

Integer; the value defined in the Tax Point Date field.

taxRounding

Object; unites all information about the tax rounding type.

taxRoundingItemType

Object; unites all information about the tax rounding item type.

taxRoundingMultiple

Integer; the value defined in the Order Total Tax multiplicator field.

Tax Rounding Item Type

Short Description

id

Integer; the unique ID of the tax rounding item type.

name

String; the name of the tax rounding item type.

sysid

String; the internal name of the tax rounding item type.

Tax Rounding Type

Short Description

id

Integer; the unique ID of the tax rounding type.

name

String; the name of the tax rounding type.

sysid

String; the internal name of the tax rounding type.

Order Rounding Type

Short Description

id

Integer; the unique ID of the order rounding type.

name

String; the name of the order rounding type.

sysid

String; the internal name of the order rounding type.

Voucher Template

Short Description

active

Boolean; defines the activity of the voucher settings.

amount

Integer; the discounted amount defined in the Discount Amount field (used for monetary discounts).

buyX

Integer; the number of products a customer has to buy in order to get Y products for free (voucher type).

comment

String; the comment added to the vooucher.

conditions

Array; unites information about all the conditions defined for the voucher.

conditionsAll

Boolean; defines the value of the Condition Conjunction setting.

currency

Object; unites all info about the currency.

customerTypes

Object; unites all information about the customer type for which is this voucher available.

defaultForNonPartner

Boolean; determines whether the setting is the default for a non parter customer.

defaultForPartner

Boolean; determines whether the setting is the default for the parter.

description

String; the description defined in the sale settings.

evaluateTogether

Boolean; determines whether the discount setting should be evaluated together.

excludedPriceCategories

Array; a list of product price categories that are excluded from the discount.

excludedProductCategories

Array; a list of product categories that are excluded from the discount.

excludedProducts

Array; a list of products that are excluded from the discount.

generateVoucherCodesAutomatically

Boolean; determines whether voucher codes are generated automatically by the system.

giftPriceCategories

Array; a list of product price categories for which the discount is valid.

giftProductCategories

Array; a list of categories for which the discount is valid.

giftProductConditions

Array; a list of product for which the discount is valid.

giftProducts

Array; a list of gifts.

grossPrice

Boolean; defines the gross price setting.

id

Integer; the unique ID of the voucher template.

label

String; the label defined for the voucher template.

maximalDiscount

Integer; the maximal discount a customer can achieve with this voucher.

multipleUse

Boolen; defines if the voucher can be used several times.

name

String; the name defined in the voucher settings.

onlyFirstPurchase

Boolean; determines whether the discount is applicable only to the customer’s first order.

orderMaximalAmount

Integer; the maximal amount a customer has to fulfil on order to use the voucher.

orderMinimalAmount

Integer; the minimal amount a customer has to fulfil on order to use the voucher.

payY

Integer; the value defined in the payY field (defined for the voucher type X for the price of Y).

priceCategories

Array;

priority

Integer; the priority of the voucher (defined in the voucher settings).

productCategories

Array; the product categories defined on the Discounted Products tab.

productConditions

Array;

productSelectionMinimalAmount

Integer; the amount defined in the Minimal Discounted Products Amount setting.

productSelectionQuantityLimit

Number; the number defined in the Discounted Product Quantity Limit setting.

products

Array; list of products (or gifts) selected on the Discounted Products tab.

public

Boolean; defines if the sale information is available on the website.

quantityLimit

Number; the quantity limit defined in the discounts settings.

rate

Number; the sale rate defined in its settings.

rounding

Object; unites information about the roundig settings.

setSingleGiftAutomatically

Boolean; determines whether the gift (if there is only one in the settings) is added to the cart automatically.

sysid

String; the internal name of the sale.

taxUsageType

Object; unites all information about the tax usage type.

templateCode

String; the template code defined in the voucher settings.

type

Object; unites information about the voucher type.

useLimit

Number; defines how many times can be a particular voucher code used.

useOnProductsWithoutDiscount

Boolean; determines whether the discount should be applied to products without a discount.

useProductSelection

Boolean; defines the usage of product selection setting.

validFrom

Date and tme; the sale validity date.

validUntil

Date and tme; the sale validity date.

zones

Array; unites all information about all zones for which is this sale available.

Voucher Type

Short Description

id

Integer; the unique ID of the voucher type.

name

String; the name of the voucher type.

sysid

String; the internal name of the voucher type.

Customer Type

Short Description

id

Integer; the unique ID of the customer type.

name

String; the name of the customer type.

sysid

String; the internal name of the customer type.

Condition

Short Description

condition

Object; unites all information about the condition.

conditionTwig

Object;

description

String; the description of the condition.

id

Integer; the unique ID of the condition.

name

String; the condition name.

sysid

String; the condition internal name.

Checkout

Short Description

additionalInfo

String; the additional info provided in the additionalInfo field during the checkout.

callingCode

String; the calling code provided in the callingCode field during the checkout.

city

String; the city name provided in the city field during the checkout.

companyExtraTaxIdentity

String; the company extra tax identity provided in the companyExtraTaxIdentity field during the checkout.

companyIdentificationNumber

String; the company identification number provided in the companyIdentificationNumber field during the checkout.

companyName

String; the company name provided in the companyName field during the checkout.

companyTaxIdentity

String; the company tax identity number provided in the companyTaxIdentity field during the checkout.

countries

Object; unites all information about the countries available in the checkout.

country

Object; unites information about the country selected in the country field during the checkout.

customerTaxCategory

deliveryMethod

Object; unites all information about the delivery method selected during the checkout process.

deliveryMethods

Object; unites all information about all available delivery methods.

differentShippingAddress

Boolean; defines if the customer has selected that the shipping address is different from the billing address.

differentFinalShippingAddress

Boolean; defines if the differentShippingAddress is set to TRUE or the selected delivery method is a system delivery method.

email

String; the e-mail address provided in the email field during the checkout.

jsonParams

JSON; use the jsonDecode filter. Contains data stored for the order in the checkout using the jsonParams field.

finalShippingCallingCode

String; the calling code used to create the order; shipping info.

finalShippingCity

String; the city used to create the order; shipping info.

finalShippingCompanyName

String; the company name used to create the order; shipping info.

finalShippingCountry

String; the country used to create the order; shipping info.

finalShippingFirstName

String; the first name used to create the order; shipping info.

finalShippingHonorific

String; the honorific used to create the order; shipping info.

finalShippingLastName

String; the last name used to create the order; shipping info.

finalShippingPickupPointId

String; the pick up point ID used to create the order; shipping info. Used only for delivery methods with system delivery address.

finalShippingPickupPointName

String; the pick up point name used to create the order; shipping info. Used only for delivery methods with system delivery address.

finalShippingPostalCode

String; the postal code used to create the order; shipping info.

finalShippingPhone

String; the phone number used to create the order; shipping info.

finalShippingRegion

String; the region used to create the order; shipping info.

finalShippingStreetAddress

String; the street address used to create the order; shipping info.

firstName

String; the first name provided in the firstName field during the checkout.

honorific

String; the honorific provided in the honorific field during the checkout.

lastName

String; the last name provided in the lastName field during the checkout.

orderTags

Contains the tags that were set for the order in the checkout.

paymentMethod

paymentMethods

Object; unites all information about available payment methods. Particular Payment Gateway Method object are ordered according to the order in the Checkout settings (second sorting level is according to its Label, if there is no label defined, the name is used intead).

phone

String; the phone number provided in the phone field during the checkout.

pickupPointId

Integer; the ID of a pick up point selected during the checkout (the value of the pickupPointId field).

poNumber

String; the PO number provided in the poNumber field during the checkout.

postalCode

String; the postal code provided in the postalCode field during the checkout.

region

String; the region provided in the region field during the checkout.

shippingCallingCode

String; the shipping calling code provided in the shippingCallingCode field during the checkout.

shippingCity

String; the shipping city name provided in the shippingCity field during the checkout.

shippingCompanyName

String; the shipping company name provided in the shippingCompanyName field during the checkout.

shippingCountry

Object; unites all information about the shipping country selected during the checkout.

shippingFirstName

String; the shipping first name provided in the shippingFirstName field during the checkout.

shippingHonorific

String; the shipping honorific provided in the shippingHonorific field during the checkout.

shippingLastName

String; the shipping last name provided in the shippingLastName field during the checkout.

shippingPhone

String; the shipping phone provided in the shippingPhone field during the checkout.

shippingPostalCode

String; the shipping postal code provided in the shippingPostalCode field during the checkout.

shippingRegion

String; the shipping region provided in the shippingRegion field during the checkout.

shippingStreetAddress

String; the shipping street address provided in the shippingStreetAddress field during the checkout.

streetAddress

String; the street address provided in the streetAddress field during the checkout.

systemPaymentAndDeliveryCombinations

Object; unites information about the allowed combinations of payment and delivery methods.

systemPaymentMethod

Object; the system payment method selected during the checkout process.

systemPaymentMethods

Object; unites all available system payment methods.

termsConfirmation

Boolean; defines if the customer aggrees with the terms and conditions.

voucher

String; the voucher code provided by the customer during the checkout.

Object Payment Gateway Method

Short Description

comment

String; the comment added to the payment gateway in its settings.

description

String; the description added to the payment gateway in its settings.

id

Number; the unique ID of the payment gateway.

label

String; the label defined in the payment gateway settings.

name

String; the name of the payment gateway.

paymentGateway

Object; unites information about the payment gateway.

sysid

String; the internal name of the payment gateway.

systemPaymentMethod

Object; unites all information about the system payment method.

Object Payment Gateway

Short Description

accountIdentification

String; the comment added to the payment gateway in its settings.

comment

String; the description added to the payment gateway in its settings.

constraintCurrencies

Number; the unique ID of the payment gateway.

currency

Number; the unique ID of the payment gateway.

description

String; the description defined in the payment gateway settings.

id

Number; the unique ID of the payment gateway.

importCreditOnly

Boolean; the value of the Import Credit Only setting in the payment gateway detail.

label

String; the label defined in the payment gateway settings.

name

String; the name of the payment gateway.

settings

Array; unites information about the payment gateway settings.

systemPaymentGateway

Object; unites all information about the system payment gateway.

waitingLimit

Number; the value of Cancel Days (after how many days the state of an unpaid order will be automatically changed to cancelled) defined in the gateway settings.

Array Payment Gateway Settings

Short Description

bankName

String; the bank name defined in the payment gateway settings.

accountNumber

String; the account number defined in the payment gateway settings.

bankCode

String; the bank code defined in the payment gateway settings.

specificSymbol

String; the specific symbol defined in the payment gateway settings.

constantSymbol

String; the constant symbol defined in the payment gateway settings.

bankStreetAddress

String; the bank street address defined in the payment gateway settings.

bankCustomerInfo

String; the bank customer info defined in the payment gateway settings.

bankCity

String; the bank city defined in the payment gateway settings.

swift

String; the SWIFT defined in the payment gateway settings.

iban

String; the IBAN defined in the payment gateway settings.

bankPostalCode

String; the bank postal code defined in the payment gateway settings.

bankCountry

String; the bank country defined in the payment gateway settings.

Object System Payment Gateway

Short Description

hasDirectRequest

Boolean; defines if it’s necessary to send the payment request to the payment gateway directly.

hasExternalPayment

Boolean; defines if the customer will be redirected to the payment gateway webpage in order to make the payment.

id

Number; the unique ID of the system payment gateway.

methods

Array; list of all available payment methods.

name

String; the name of the system payment gateway.

sysid

String; the internal name of the system payment gateway.

Object System Payment Method

Short Description

id

Number; the unique ID of the particular system payment method.

name

String; the name of the system payment method.

paymentGateway

price

sysid

String; the internal name of the system payment method.

Object Payment Processing Type

Short Description

id

Number; the unique ID of the particular payment processing type.

name

String; the name of the payment processing type.

sysid

String; the internal name of the payment processing type.

Object Allowed Checkout Combinations

Short Description

deliveries

Array; the value inserted in the Calling Code field on the Contact tab.

payments

Array; the value inserted in the Calling Code field on the Contact tab.

Object Delivery Method

Short Description

callingCode

String; the value inserted in the Calling Code field on the Contact tab.

carrier

Object; unites all information about the carrier.

city

String; the vaule inserted in the City field on the Contact tab.

comment

String; the value inserted in the Comment field on the Identification tab.

condition

String; the vaule insetred in the Condition field on the General Limits tab.

country

Object; unites information about the country selected on the Contact tab.

deleteFlag

Boolean; defines if the delivery methdo is currently marked as deleted.

description

String; the description field defined ont he Customer Labels tab.

email

String; the value of the e-mail field on the Contact tab.

id

Integer; the unique ID of the delivery method.

instructions

String; the value of the instructions field in the Delivery tab.

label

String; the value of the label field on the General tab.

mapUrl

String; the value inserted in the Map URL field on the Contact tab.

maxDepth

Integer; the value inserted in the depth (maximal) field on the General Limits tab.

maxHeight

Integer; the value inserted in the height (maximal) field on the General Limits tab.

maxLength

Integer; the value inserted in the length (maximal) field on the General Limits tab.

maxVolume

Integer; the value inserted in the volume (maximal) field on the General Limits tab.

maxWeight

Integer; the value inserted in the weight (maximal) field on the General Limits tab.

maxWidth

Integer; the value inserted in the width (maximal) field on the General Limits tab.

minDepth

Integer; the value inserted in the depth (minimal) field on the General Limits tab.

minHeight

Integer; the value inserted in the height (minimal) field on the General Limits tab.

minLength

Integer; the value inserted in the length (minimal) field on the General Limits tab.

minVolume

Integer; the value inserted in the volume (minimal) field on the General Limits tab.

minWeight

Integer; the value inserted in the weight (minimal) field on the General Limits tab.

minWidth

Integer; the value inserted in the width (minimal) field on the General Limits tab.

name

String; the name of the delivery method.

order

Integer; the order of the delivery method.

phone

String; the phone defined in the Contact tab of the delivery method.

postalCode

String; the postal code defined on the Contact tab of the delivery method.

price

streetAddress

String; the street address defined on the Contact tab of the delivery method.

sysid

String; the unique internal name of this delivery method.

systemCarrierService

Object; unites all information about the system carrier service.

systemShippingAddress

Boolean; defines if the customer’s shipping address will be automatically changed by the system.

timeToDelivery

Integer; the value of the Time field on the Delivery tab (defines the time to delivery in days).

timeToDeliveryLabel

String; the value of the Label field on the Delivery tab.

Stock Service

Short Description

deleteFlag

Boolean; defines if the stock service is currently marked as deleted.

description

String; the description of the stock service.

id

Integer; the unique ID of the stock service.

name

String; the name of the stock service.

removeReservationAfterDispatch

Boolean; defines the vaule set in the Remove Reservation After Dispatch setting (stock service setting).

settings

Array; unites information about all stock service settings.

stocks

Array;

systemStockService

Object; unites all information about the system stock service.

Stock Service Setting

Short Description

attribute

Object; unites all information about the stock service attribute.

displayName

String; the name of the stock service setting.

id

Integer; the unique ID of the stock service settong.

stockService

Object; unites all information about the connected stock service.

value

String; the value (URL address) of the stock service setting.

Stock Service Setting Attribute

Short Description

id

Integer; the unique ID of the stock service setting attribute.

name

String; the name of the system stock service attribute.

sysid

String; the internal name of the system stock service atribute.

attribute

Object; unites all information about the stock service.

E-shop Settings Type

Short Description

id

Integer; the unique ID of the e-shop type.

name

String; the name of the e-shop type.

sysid

String; the internal name of the e-shop type.

Comparator

Short Description

comparison

Array; unites all custom property information you can dispay in the comparator.

products

Array; unites all products from the comparator (the key is a particular product’s code).

Country

Country

Short Description

callingCode

Integer; the calling code of the country.

currency

Object; unites all information about the connected currency.

id

Integer; the unique ID of the zone.

iso2

String; the ISO 2 of the country.

iso3

String; the ISO 3 of the country.

languages

Array; unites all information about the connected languages.

name

String; the name of the country.

Currency

Currency

Short Description

exponent

Integer; exponent of the currency.

id

Integer; the unique ID of the currency.

iso

String; the ISO of the currency.

name

String; the name of the currency.

numericIso

Integer; the numeric ISO of the currency.

symbol

String; the symbol of the currency.

Object Aliases - Redirect Code

alias.redirectCode

Short Description

code

String; the code of redirection (particuar alias setting).

id

The redirection ID.

name

String; the redirection name (system defined, you cannot set your own name).

nameTrans

Object; information about the name translations.

Object Type

Title Source

Short Description

description

String; internal description.

id

Integer; unique ID.

name

String; name of the type.

sysid

String; internal name of the type.

Object Product Category

Product Category

Short Description

active

Boolean; defines the actitity of the category. Only active categories are available on the website.

activePath

Boolean; used in navigation. Defines if the category belongs to an active path.

bigImage

Object; unites all information about the big image connected to the category.

bigImageSourcePath

String; the path to the big image source.

bigImageSourceSysid

String; the big image source internal name.

customProperties

Array; the custom properties defined for the brand.

depth

Integer; the tree depth of the category.

disabled

Boolean; defines if the category is currently disabled (particular category setting).

hasItems

Boolean; defines if the category contains at least one product.

hasItemsWithSubcategories

Boolean; defines if the category itself or its subcategories contain at least one product.

id

Integer; the unique ID of the category.

includeInNavigation

Boolean; defines if the category will be automatically included in the navigation tree.

longDescription

Object; unites all information about the long description of the category.

mapping

Array; unites all defined category mappings. mapping[ ‘mappingInternalName’ ].category.externalName

name

String; the name of the category.

nameUrl

String; the name of the category that will be displayed in the URL address.

navCurrent

Boolean; used for the purposes of the navigation (menu). Defines if the category is currently displayed.

navPath

Boolean; used for the purposes of the navigation (menu). Defines if the category belongs to a currently active path.

navigationActive

parent

Object; unites all information about the parent category (according to the Category Tree).

productBrands

Array; unites information about all brands of products from this category.

productCustomProperties

Array; unites information about all custom properties of products from this category.

productList

Array; unites information about products from this category.

productTags

Array; unites information about all products’ tags from this category.

products

Array; unites information about products from this category.

seoDescription

String; the SEO description defined for the category in its settings.

seoDescriptionSource

Object; unites all information about the SEO description source.

seoKeywords

String; the SEO keywords defined for the category in its settings.

seoTitle

String; the SEO title defined for the category in its settings.

seoTitleSource

Object; unites all information about the SEO description source.

shortDescription

String; the short description of the category.

smallImage

Object; unites all information about the small image of the category.

smallImageSourcePath

String; the small image source path.

smallImageSourceSysid

String; the small image source internal name.

subcategories

Array; unites information about all subcategories of this category (according to the Category Tree).

syncEnabled

Boolean; defines if the synchronization is enabled.

syncTimestamp

Date; the date of the last synchronization.

synchronized

sysid

String; the internal name of the category.

totalItems

Number; the count of total items (products) that are inserted in the category.

totalItemsWithSubcategories

Number; the count of total items (products) that are inserted in the category and its subcategories.

tree

Object; contains all information about the product category tree to which the category belongs.

Product Category Tree

Short Description

id

Integer; the unique ID of the category tree.

sysid

String; the internal name of the category tree.

Object Product (E-commerce)

Product

Short Description

accessoryProducts

Array; contains all accessory products connected to this product (Relations tab).

accessoryProductsGrouped

Array; contains all groups created for this type of relation (Relations tab).

active

Boolean; defines the activity of this product (particular product setting).

aggregateRating

Object; unites all information about the aggregated product rating.

alternateProducts

Array; contains all alternate products connected to this product (Relations tab).

allImages

Array; contains all images connected to the product (images are sorted in order: big images, gallery images, small images).

alternateProductsGrouped

Array; contains all groups created for this type of relation (Relations tab).

archived

Boolean; defines if the product is marked as archived.

availability

Object; unties all information about the Default Availability State defined for the product.

availableKeys

Boolean;

basePrice

Object; unites all information about the base product price (without any discounts or special pricelists applied).

brand

Object; unites all information about the brand to which is this product connected. Only active brands are available.

bundleContent

Array;

businessType

Object; unites all information about the business type of this product.

categories

Array; unites all categories to which this product belongs. Only active categories are available; default category is ordered first.

code

String; the product code (defined on the General tab).

comment

String; the comment (defined on the General tab).

couponCardTemplate

Object; unites all information about the coupon card template connected to this product.

crossSellProducts

Array; contains all cross sell products connected to this product (Relations tab).

crossSellProductsGrouped

Array; contains all groups created for this type of relation (Relations tab).

currentAvailability

Object; unites information about the product availability. For more info see the product availability section.

currentCategoryAssignment

Object; unites information about the product category assignment type. Available only in the Product List View (Product Catalog).

currentEShopSetting

Object; unites information about the product e-shop settings.

customProperties

Array; unites all custom properties defined for this product (taken from the product group).

defaultVariant

Object; unites all information about the default variant. In default variant is set, the first variant will be used as a default. This parameter is available only for master products and variants.

deliveryService

Object; unites all information about the delivery service selected in the product settings.

deliveryType

Object; unites all information about the delivery type selected in the product settings.

deliveryMethods

Object; unites all available delivery methods.

deliveryService

Object; unites all information about the delivery service (defined on the General tab.

description

Object; unites all information about the description connected to the description.

disabledInCatalog

Boolean; defines if the product is disabled in the catalog.

discussions

Object; unites all information about discussions connected to this product.

documents (particular document object)

Array; unites all information about documents connected to the product (on the Documents tab). Available values: certificate, technicalSpecification, userManual, genericDocument1, genericDocument2, genericDocument3.

ean

String; the EAN code defined on the product.

eshops

Array; the list of all e-shop settings for which is this product available.

externalId

String; the external ID defined on the product (used only for specialized purposes).

fullUrl

String; the product’s full URL address.

getProductVariantsByCustomProperty()

This method is used to get particular variants of this product according to defined custom properties values. Example: getProductVariantsByCustomProperty( { ‘color’: [ ‘black’, ‘red’ ], ‘size’: [‘large’] } ) This example will filter all variants in black or red color in the ‘large’ size.

id

Integer; the unique ID of the product.

images

Array; unites information about all connected images.

inCategory

Array; unites information about all categories in which this product belongs.

instructions

String; the instruction defined on the product.

inventory

Object; unites all information about the product inventory (available amount, scheduled deliveries and stocks).

isBuyable

Boolean; defines if the product can be bought (according to its marketability, stock condition, price and more).

isMaster

Boolean; defines if particular product is a master product.

isNew()

Boolean; defines if the product is new. For more information see the Product Offerings help site. An optional parameter is the number of days during which the product is considered as new in stock.

isVariant

Boolean; defines if particular product is a variant of a master product.

keyManagement

loyaltyPoints

Number; defines how many loyalty points a customer earns when buying this product.

manufacturer

Object; unites all information about the manufacturer of the product. Only active manufacturers are available.

manufacturerCode

String; the manufacturer code provided in the product inventory settings.

marketabilityType

Object; unties all information about the product marketability type.

masterPackEan

String; the master pack EAN defined in the product inventory settings.

masterPackQuantity

Integer; the master pack quantity defined in the product inventory settings.

masterProduct

Object; unites all information about the master product.

material

Object; unites all information about the packing box material defined in the product inventory settings.

name

String; product name.

nameUrl

String; product URL address.

outOfStockAvailability

Object; unties all information about the Out of Stock Availability State defined for the product.

price

Object; unites all information about the product price (discounts are included).

priceCategory

Object; unites all information about the price category to which is this product added.

productAlternativesInCurrentCategory

Array; list of all products alternatives (category assign type) in the current category. Available only in the Product List View (Product Catalog).

productGroup

Object; unites all information about the product group to which this product belongs.

productType

Object; unites all information about the product type.

productUrls

Array; unites all information about the URL addresses connected to this product.

productVariants

Array; unites all product variants of this product; for variants without defined master properties a numbered index is available.

quantityLimit

Integer; the quantity limit set in the product settings.

relations

Array; unites all information about the relations set in the product settings.

relevance

Integer; the relevance number set in the product settings.

seoDescription

String; the SEO description defined in the product settings.

seoDescriptionSource

Object; unites all information about the SEO description source.

seoKeywords

String; the SEO keywords defined in the product settings.

seoTitle

String; the title defined in the product settings.

seoTitleSource

Object; unites all information about the SEO title source.

shortDescription

String; the short description defined for the product.

sizes

Array; unites all information about the product size defined in the product settings.

snAgenda

Boolean; defines if the serial number agenda will be for the product used.

supplier

Object; unites information about the supplier connected to this product.

tags

Array; unites information about all tags connected to the product.

unit

Object; unites all information about the product unit.

upSellProducts

Array; contains all upsell products connected to this product (Relations tab).

upSellProductsGrouped

Array; contains all groups created for this type of relation (Relations tab).

validFrom

Date and time; defines when the product activity starts.

validUntil

Date and time; defines when the product activity ends.

variants

Array; list of all custom properties values used for a variant products (master properties). This parameter is empty for variants without defined master properties.

variantsForAlternativesInCurrentCategory

Array; list of product variants according to the currently displayed category. Available only in the Product List View (Product Catalog).

volumePrices

Array; list of volume prices information.

voucherTemplate

Object; unites all information about voucher templates (sale promotions) that affect this product.

warranty

Number; the warranty value defined for the product (tab Advanced).

Product E-shop

Short Description

allowedDeliveryMethods

Array; unites all delivery methods which can be used for this product. When no restriction occurs, this array is empty.

available

Boolean; defines if the product is available for selling (for the current e-shop settings).

displayName

String; the e-shop settings name.

freeShipping

Boolean; defines if the product’s shipping is free of charge.

id

Number; the e-shop settings ID.

Object Aggregate Product Rating

Short Description

id

Number; the unique ID of the aggregated rating.

range1

Number; the count of the 1 rating.

range2

Number; the count of the 2 rating.

range3

Number; the count of the 3 rating.

range4

Number; the count of the 4 rating.

range5

Number; the count of the 5 rating.

rating

Integer; the aggregated rating.

ratingCount

Number; the rating count of the product.

Object Product Rating

Short Description

comment

String; the discussion content.

commentId

Number; an unique comment ID.

commentTree

Object; unites all information about the comment tree (unites all comments).

id

Number; an unique discussion ID.

loyaltyPointsEarned

Number; an unique discussion ID.

pros

String; the proc of the product.

public

Boolean; defines if the commentary is public.

rating

Number; the rating of the product.

recommends

Boolean; defines if the customer recommends this product.

reviewed

Date and time; date and time when has been this review reviewed by a BizBox administrator.

reviewedBy

Object; unites all information about BizBox administrator who reviewed this review.

title

String; the title of the discussion.

user

Object; unites all information about the customer who reviewed this product.

voteCount

Object; unites all votes bounded to this discussion.

Object Contact Loyalty Earned Points

Short Description

bonus

Object; unites all information about the loyalty program bonus.

contactLoyaltyProgram

Object; unites all information about the contact loyalty program.

id

Number; an unique contact loyalty earned points ID.

order

Object; unites all information about the order to which are there loyalty points bounded.

points

Number; the number of earned points.

productRating

Object; unites all information about the product rating to which these points belong.

remainPoints

Number; the number of remaining points.

validity

Date and time; the validity of the points.

Volume Prices Array

Short Description

minQuantity

Number; defines the minimal quantity which is required to use the volume price.

price

Object; unites all information about the volume price.

basePrice

Object; unites all information about the product base price.

Volume Product Price

Short Description

currency

Object; unites all information about the used currency.

minQuantity

Number; the minimal product quantity for which will be the volume price applied.

taxAmount

Integer; the tax amount.

taxExclusiveAmount

Integer; the tax exclusive price.

taxInclusiveAmount

Integer; the tax inclusive price.

Object Loyalty Program Bonus

Short Description

id

Number; an unique loyalty program bonus ID.

name

String; the name of the loyalty program bonus.

sysid

String; the internal name of the loyalty program bonus.

Object Discussions

Short Description

comment

String; the discussion content.

commentId

Number; an unique comment ID.

commentTree

Object; unites all information about the comment tree (unites all comments).

id

Number; an unique discussion ID.

title

String; the title of the discussion.

voteCount

Object; unites all votes bounded to this discussion.

Object Comment Tree

Short Description

allComments

Object; unites all information about the comments.

id

Number; an unique ID of the comment tree.

title

String; the title of the comment tree.

Object All Comments

Short Description

accountUser

Object; unites all information about the user who posted the comment.

authorEmail

String; author’s e-mail address.

authorName

String; author’s name.

comment

String; the content of the comment.

depth

Number; the depth of the comment in the comment tree.

discussion

id

Number; an unique commend ID.

parent

Object; unites all information about the parent comment.

product

Object; unites all information about the commented product.

productUrl

String; the URL address of the commented product.

public

Boolean; defines if the comment is currently set as public.

user

Object; unites all information about the user who posted this comment.

voteCount

Object; unites all votes bounded to this comment.

childItems

Array; unites all information about the child items of the comment.

Object Vote Count

Short Description

id

Number; an unique ID of the vote count.

negative

Number; the number of negative votes for this comment.

positive

Number; the number of positive votes for this comment.

Object Discussions

Short Description

id

Number; the unique ID of the assign type.

name

String; the name of the assign type.

sysid

String; the internal name of the assign type.

Unit

Short Description

abbreviation

String; the unit abbreviation.

description

String; the description of the unit.

id

Integer; the unique ID of the unit.

name

String; the name of the unit.

sysid

String; the internal name of the unit.

Tag

Short Description

displayName

Integer; the name that should be displayed on the website.

id

Integer; the unique ID of the tag.

internal

Boolean; defines if the current tag is marked as internal.

label

String; the label of the tag.

name

String; the name of the tag.

totalItems

Integer; total number of items which have assigned this tag.

Product Size

Short Description

depth

Integer; the depth defined in the product settings.

displayName

String; the name of the product size.

height

Integer; the height defined in the product settings.

id

Integer; the unique ID of the product size.

length

Integer; the length defined in the product settings.

product

Object; unites all information about the product.

type

Object; unites all information about the type of the size.

volume

Integer; the volume defined in the product settings.

weight

Integer; the weight defined in the product settings.

width

Integer; the width defined in the product settings.

Size Type

Short Description

id

Integer; the unique ID of the size type.

name

String; the name of the size type.

sysid

String; the internal name of the size type.

E-commerce SEO Source

Short Description

description

String; the description of the e-commerce SEO source.

id

Integer; the unique ID of the e-commerce SEO source.

name

String; the name of the e-commerce SEO source.

sysid

String; the internal name of the e-commerce SEO source.

Product URLs

Short Description

demoDownload

Object; unites all information about the Demo Download URL defined on the product.

fullVersionDownload

Object; unites all information about the Full Version Download URL defined on the product.

video

Object; unites all information about the Video URL defined on the product.

review

Object; unites all information about the Review URL defined on the product.

manufacturerWebsite

Object; unites all information about the Manufacturer Website URL defined on the product.

other

Object; unites all information about the Other URL defined on the product.

Product URL

Short Description

description

String; the description of the URL address.

id

Integer; the unique ID of the URL address.

language

Object; unites all information about the language of the URL address.

name

String; the name of this URL address.

order

Integer; the order of this URL address.

product

String; the product to which this URL address belongs.

sysid

String; the internal name of the URL address.

type

Object; unites all information about the URL type.

url

String; the URL address.

Product URL Type

Short Description

id

Integer; the unique ID of the URL type.

name

String; the name of the URL type.

sysid

String; the internal name of the URL type.

Product Group

Short Description

customProperties

Array; unites all custom properties added to this product group.

description

String; the product group description.

id

Integer; the unique ID of the product group.

name

String; the name of the product group.

quantityLimit

Integer; the quantity limit defined in the product group settings.

sysid

String; the internal name of the product group.

Custom Property

Short Description

defaultValueBool

Boolean; the default value set for the boolean property.

defaultValueDate

Date; the default value set for the date property.

defaultValueEnum

String; the default value set for the enumeration property.

defaultValueNumber

Integer; the default value set for the number property.

defaultValueString

String; the default value set for the text property.

enumeration

Object; unites all information about the enumeration (product variant).

generated

id

Integer; the unique ID of the custom property.

name

String; the name of the custom property.

order

Integer; the order number of the custom property.

productGroup

Object; unites all information about the product group to which this custom property belongs.

sysid

String; the internal name of the custom property.

translated

Boolean; defines if the custom property can be translated.

type

Object; unites all information about the custom property type.

Custom Property Type

Short Description

id

Integer; the unique ID of the custom property type.

name

String; the name of the custom property type.

sysid

String; the internal name of the custom property type.

Product Variant

Short Description

description

String; the product variant description.

id

Integer; the unique ID of the product variant.

name

String; the name of the product variant.

sysid

String; the internal name of the product variant.

values

Array; unites all possible variants of this product variant.

Product Variant Value

Short Description

color

String; the hex color code of a color selected in the detail of the product variant.

id

Integer; the unique ID of the product variant value.

order

Integer; the order of the product variant value.

productVariant

Object; unties all information about the product variant to which this value belongs.

sysid

String; the internal name of the product variant value.

variantValue

String; the particular value of the product variant.

Price Category

Short Description

description

String; the price category description.

id

Integer; the unique ID of the price category.

name

String; the name of the price category.

Packing Box Material

Short Description

default

Boolean; defines if the packing box material has been set as a default in its settings.

id

Integer; the unique ID of the packing box material.

name

String; the name of the packing box material.

order

Integer; the order number of the packing box material.

sysid

String; the internal name of the packing box material.

Marketability Type

Short Description

id

String; the unique ID of the marketability type.

name

String; the name of the marketability type.

sysid

String; the internal name of the marketability type.

Manufacturer

Short Description

active

Boolean; defines the manufacturer activity. Only active manufacturers are available on the website.

availability

String; the value inserted in the field availability in the manufacturer detail.

bigImage

Object; the big image defined in the manufacturer detail.

bigImageSourcePath

String; the big image source path.

bigImageSourceSysid

String; the big image source internal name.

customProperties

Array; the custom properties defined for the manufacturer.

id

Integer; unique manufacturer ID.

includeInNavigation

Boolean; defines if the manufacturer will be included in a navigation (manufacturer setting).

logo

Object; unites all information about the logo defined in the manufacturer detail.

longDescription

Object; the long description of the manufacturer.

name

String; the name of the manufacturer.

nameUrl

String; the name in URL of the manufacturer.

seoDescription

String; the SEO description of this manufacturer.

seoDescriptionSource

Object; unites all information about the description SEO source.

seoKeywords

String; the SEO keywords of this manufacturer.

seoTitle

String; the SEO title of this manufacturer.

seoTitleSource

Object; unites all information about the title SEO source.

shortDescription

String; the short description of the manufacturer.

smallImage

Object; unites all information about the small image conncted to this manufacturer.

smallImageSourcePath

String; the small image source path.

smallImageSourceSysid

String; the small image source internal name.

sysid

String; the internal name of the manufacturer.

web

Extra Entity

Short Description

active

Boolean; defines the extra entity activity. Only active extra entites are available on the website.

bigImage

Object; the big image defined in the extra entity detail.

bigImageSourcePath

String; the big image source path.

bigImageSourceSysid

String; the big image source internal name.

customProperties

Array; the custom properties defined for the extra entity.

id

Integer; unique extra entity ID.

includeInNavigation

Boolean; defines if the extra entity will be included in a navigation (extra entity setting).

longDescription

Object; the long description of the extra entity.

name

String; the name of the extra entity.

nameUrl

String; the name in URL of the extra entity.

seoDescription

String; the SEO description of this extra entity.

seoDescriptionSource

Object; unites all information about the description SEO source.

seoKeywords

String; the SEO keywords of this extra entity.

seoTitle

String; the SEO title of this extra entity.

seoTitleSource

Object; unites all information about the title SEO source.

shortDescription

String; the short description of the extra entity.

smallImage

Object; unites all information about the small image connected to this extra entity.

smallImageSourcePath

String; the small image source path.

smallImageSourceSysid

String; the small image source internal name.

sysid

String; the internal name of the extra entity.

Inventory

Short Description

availableAmount

Integer; currently available amount (stock condition).

earliestExpirationDate

Date and time; the earliest date of expiry of the product.

isNewInStock()

Boolean; defines if the product is marked as new in stock. An optional parameter is the number of days during which the product is considered as new in stock.

hasScheduledDelivery

Boolean; defines if a confirmed scheduled delivery exists for the product.

scheduledDeliveries

Array; list of all scheduled deliveries set for the product (sorted by date).

stocks

Array; list of all stocks in which is this product stored.

Scheduled Delivery

Short Description

date

Date and time; the date of the scheduled delivery.

id

Number; the unique ID of the scheduled delivery.

product

Object; unites all information about the product.

quantity

Number; the total quantity of the scheduled delivery.

stock

Object; unites all information about the stock.

Product in Category

Short Description

assignType

Object; unites information about the product assignment type.

displayName

String; the name of the category that will be displayed to website visitors.

id

Integer; the unique ID of the assignment type.

product

Object; unites all information about the assigned product.

productCategory

Object; unites all information about the products category.

Product Images

Short Description

smallImage

Array; unites information about all small images connected to the product.

bigImage

Array; unites information about all big images connected to the product.

galleryImage

Array; unites information about all gallery images connected to the product.

System Delivery Service

Short Description

id

Integer; the ID of the system delivery service.

name

String; the name of the system delivery service.

sysid

String; the internal name of the system delivery service.

Business Type

Short Description

id

Integer; the ID of the business type.

name

String; the name of the business type.

sysid

String; the internal name of the business type.

Availability State

Short Description

id

Integer; the ID of the selected availability state.

name

String; the name of the selected availability state.

sysid

String; the internal name of the selected availability state.

Object Price Cached

Short Description

branch

Object; unites all information about the connected branch which is responsible for the sale.

campaign

Object; unites all information about the connected campaign.

currency

Object; unites all information about the currency.

customerTaxCategory

Object; unites all information about the applied customer tax category.

grossPrice

Boolean; defines if the price is with (TRUE) of without (FALSE) tax included.

id

Integer; the unique ID of the price.

partnerPrice

Boolean; defines if the price is generated from a partner pricelist.

priceWithoutSale

Integer; the price without campaign sale applied (pricelist price).

product

Object; unites all information about the product to which this price belongs.

productTaxCategory

Object; unites all information about the applied product tax category (set in the pricelist).

saleRate

sourceDailyDeal

Object; defines the daily deal (price source).

sourcePartnerTierPriceRule

Object; defines the partner rule (defined in a partner tier) which defines the sale in %.

sourcePricelist

Object; defines the source pricelist.

taxAmount

Integer; the total tax amount.

taxAmountRounded

Integer; the rounded total tax amount.

taxExclusivePrice

Integer; the price without tax included.

taxExclusivePriceRounded

Integer; the rounded price without tax included.

taxInclusiveBasePrice

Integer; the base price with tax included (taken from the applied pricelist - standard, partner).

taxInclusiveDiscountAmount

Integer; the discount amount with tax included.

taxInclusivePrice

Integer; the price with tax included.

taxInclusivePriceRounded

Integer; the rounded price with tax included.

taxRate

Integer; the tax rate applied on the price.

tier

validFrom

Date; the date of the pricelist activity start.

validUntil

Date; the date of the pricelist activity end.

zone

Object; unites all information about the zone in which is this pricelist active.

Object Product Tax Category

Short Description

description

String; contains the Product Tax Category description.

id

Integer; the unique ID of the Product Tax Category.

name

String; the name of the Product Tax Category.

sysid

String; the internal name of the Product Tax Category.

Object Customer Tax Category

Short Description

VATPayer

Boolean; defines if the customer is a VAT payer (customer tax category setting).

default

Boolean; defines if tax category is in current zone default (customer tax category setting).

description

String; the description of this customer tax category.

id

Integer; an unique ID of this customer tax category.

label

String; the label of this customer tax category.

name

String; the name of this customer tax category.

sysid

String; the internal name of this customer tax category.

zone

String; the account number defined in the branch detail.

Object Branch

Short Description

accountNumber

String; the account number defined in the branch detail.

bankAccountIdentification

String; the bank account identification defined in the branch detail.

bankCode

String; the bank code defined in the branch detail.

bankName

String; the bank name defined in the branch detail.

city

String; the city (part of the branch address) defined in the branch detail.

country

Object; the country (part of the branch address) defined in the branch detail.

countryName

String; the country name (part of the branch address) defined in the branch detail.

extraTaxIdentity

String; the extra tax identity defined in the branch detail.

homeCurrency

Object; unites all information about the home currency selected in the branch detail.

iban

String; the IBAN defined in the branch detail.

id

Integer; the ID of the branch.

identificationNumber

String; the identification number defined in the branch detail.

legalNotice

String; the legal notice defined in the branch detail.

logo

Object; unites all information about the logo file selected in the branch detail.

name

String; the name defined in the branch detail.

postalCode

String; the postal code defined in the branch detail.

street

String; the street address defined in the branch detail.

supportEmail

String; the e-mail defined in the branch detail.

supportPhone

String; the phone number defined in the branch detail.

swift

String; the SWIFT defined in the branch detail.

sysid

String; the internal name defined in the branch detail.

taxIdentity

String; the tax identity defined in the branch detail.

vatPayer

Boolean; defines if the branch is a vat payer.

www

String; the WWW defined in the branch detail.

Object Campaign

Short Description

actions

active

conditions

conditionsAll

description

id

name

periods

priority

variant

Object; unites all information about the website variant (campaign setting).

website

Object; unites all information about the website.

Object Website Variant

Short Description

description

id

name

rules

Array; unites all rules connected to this website variant.

sysid

String; the internal name of the website variant.

website

Object; unites all information about the website.

Object Website Variant Content Rule

Short Description

block

id

Integer; the unique ID of the particular content variant rule.

name

pageSource

pageTarget

template

Object; unites all information about the used website template.

type

Object; unites all information about the rule type.

variant

Object; unites all information about the website variant (campaign setting).

Object Template (Account)

Short Description

baseTemplate

defaultCulture

Object; unites all information about the culture of the template.

defaultLanguage

description

String; the description connected to the template.

id

Integer; the unique ID of the template.

layout

name

String; the name of the template.

parent

Object; unites all information about the partent template connected to this template.

storage

type

String; unites all information about the base template type.

userChange

Object Template Type

Short Description

description

String; the description of the template type.

id

Integer; the unique ID of the template type.

name

String; the name of the template type.

sysid

String; the internal name of the template type.

module

Object; unites all information about the template module.

Object Template Module

Short Description

cultureTranslation

id

Intger; the unique base template module ID.

name

String; the name of the template module.

sysid

String; the internal name of the template module.

Object Website Variant Content Rule

Short Description

description

String; the description of the content rule.

id

Integer; the unique ID of the content rule.

name

String; the name of the content rule.

sysid

String; the internal name of the content rule.

Object Website

Short Description

accessLevel

Object; unites all information about the access level set for this website (General Website Settings - Access Level).

adminEmail

allCultures

Array; unites all cultures connected to the website.

cacheSchema

cacheStyle

Object; unites all information about the cache style selected in the website settings.

cacheTtl

checkXml

Boolean; defines if the XML validity will be checked (Check XML setting).

contentReplacement

Boolean; the Content Replacement setting (Localizaton settings).

contentReplacementRedirect

Boolean; the Redirect to source Culture setting (Localizaton settings).

culture

Object; the website culture (used only for monolingual websites).

cultureDetectionSchema

Object; unites all information about the Culture Detection Schema used on the website.

cultureReplacement

Boolean; the Culture Replacement setting (Localizaton settings).

cultureTree

Object; unites all information about the culture tree connected to the website.

defaultCulture

Object; unites all information about the default culture in which is this website created.

deleteFlag

Boolean; defines if the website has been deleted.

description

String; the description of the website.

disableCultureDetection

Boolean; the Disable Detection setting (Localizaton settings).

displayLinkType

Object; unites all information about the display link type setting.

domain

domainUrl

endpoint

endpointDnsName

favicon

Object; unites all information about the favicon file connected to the website (General Website Settings).

firstPage

Object; unites all information about the first page of this website.

hasIndexPage

Boolean; defines if the website has set the index special page.

hostnames

Array; unites all information about hostnames connected to this website.

id

Integer; the unique website ID.

indexPage

Object; unites all information about the index page (Home Page Special Page).

inlineLinksMaxFilesize

loginExpiration

Object; unites all information about the login expiration set on the website.

loginExpirationDuration

Integer; the login expiration time (in minutes). The user has to be inactive for this time period.

logo

Object; unites all information about the logo defined in the General Website Settings.

name

String; the name of the website.

navigationTrees

Array; unites all information about the navigation trees created on this website.

outputMinimization

Boolean; defines if the output will me minimized (website setting).

pageTrees

passwordStrength

Array; unites all information about the password strength set in the website settings.

previewUrl

String; the preview URL address of the website.

primary

Boolean; defines if the website is set as a primary in the account.

published

Boolean; defines if the website has been already published.

redirectToIndexPage

Boolean; defines the value of the Redirect to Index Page setting.

registrationApproval

Boolean; defines the value of the Registration Approval setting.

registrationPermissions

Object; unites all permissions that will be automatically assigned to a registered user.

replaceInlineLinks

Boolean;

resourceMinimization

Boolean;

robots

String; the additional code provided in the Robots settings.

robotsSitemap

String; the info provuded in the Sitemap Path field in the Robots settings.

robotsSitemapDefault

Boolean; defines the value of the Default Sitemap setting in the Robots settings.

subdomain

String; the instant domain defined in the DNS Domains settings.

subdomainHostname

String; the subdomain host name.

subdomainUrl

String; the subdomain URL.

template

Object; unites all information about the template defines for the website.

titlePrefix

String; prefix defined in the website settings (SEO Configuration).

titleSuffix

String; suffix defined in the website settings (SEO Configuration).

translationPackage

Object; unites all information about the used Translation Strings.

url

String; the website URL address.

urlSchema

Object; unites all information about the URL schema.

useCustomStyles

Boolean; defines the value of the Use Custom Styles setting.

useTracking

Boolean; defines the value of the Use Tracking setting.

Object Access Level

Short Description

description

String; description of the access level of the website.

id

Integer; the unique ID of the access level of the website.

name

String; the name of the access level of the website.

sysid

String; the internal name of the website.

Object Culture Detection Schema

Short Description

description

String; the description of the culture detection schema.

id

Integer; the unique ID of the culture detection schema.

methods

Array; unites all information about methods connected to the culture detection schema.

name

String; the name of the culture detection schema.

Object Culture Detection Schema

Short Description

description

String; the description of the culture detection method.

id

Integer; the unique ID of the culture detection method.

sysid

String; the internal name of the culture detection method.

name

String; the name of the culture detection method.

Object Culture Tree

Short Description

description

String; the description of the culture tree.

id

Integer; the unique ID of the culture tree.

name

String; the name of the culture tree.

sysid

String; the internal name of the culture tree.

websites

Array; unites all websites on which is this culture tree used.

Object Hostname

Short Description

accessLevel

Object; unites all information about the access level set for the hostname.

hostname

String; the hostname address.

id

Integer; the unique ID of the hostname.

reserved

Boolean;

websites

Object; unites all info about the website on which is this hostname used.

Object Navigation Tree

Short Description

breadcrumbs

Array;

displayRoot

Boolean; defines if the root of the navigation tree will be displayed.

id

Integer; the unique ID of the Navigation Tree.

Name

String; the name of the Tree (set in the Navigation Trees application).

page

Object;

pageDepth

Integer; page depth set for this tree.

productCategory

Object; unites all information about the partiuclar product category (used for Product Category Navigation.

sysid

String; the internal name of the particular Navigation Tree.

tree

Array; unites all information about the tree nodes (pages or product categories).

type

Object; unites all information about the type of the navigation tree.

websites

Object; unites all info about the website on which is this navigation tree used/created.

Object Navigation Tree Type

Short Description

description

String; the description of the navigation tree type.

id

Integer; the unique ID of the navigation tree type.

name

String; the name of the navigation tree type.

sysid

String; the internal name of the navigation tree type.

Object Website Password Strength

Short Description

capitalLetter

Boolean; defines if the password has to contain a capital letter (website setting).

id

Integer; the unique ID of the website password strength.

length

Integer; the minimal length of the password defined in the website settings.

nonAlphanumericChar

Boolean; defines if the password has to contain a nonalphanumeric character (website setting).

number

Boolean; defines if the password has to contain a number (website setting).

websites

Object; unites all info about the website on which is this password stength applied.

Object Translation Package

Short Description

default

Boolean; defines if the translation package is set as default for the account.

description

String; the translation package settings description.

id

Integer; the unique ID of the translation string package.

name

String; the name of the translation string package.

Object URL Schema

Short Description

description

String; the description of the URL schema.

id

Integer; the unique ID of the URL schema.

name

String; the name of the URL schema.

sysid

String; the internal name of the URL schema.

Object Request

Request

Short Description

browser

Object; unites all information about the visitor’s browser.

currency

Object; unites all information about the current currency.

language

Object; unites all information about the current language.

page

Object; unites all information about the current page.

params

Array; list of all params connected to the current request.

secured

Boolean; defines the access level (HTTPS = true; HTTP = false).

seo

Object; unites all information about the page SEO.

url

Object; unites all information about the current URL address.

website

Object; unites all information about the current website.

zone

Object; unites all information about the current zone.

Browser (object request)

Short Description

browser

String; the used browser.

isMobile

Boolean; determines whether it is a mobile device or not.

platform

String; the used platform.

Particular values are taken from the used source (page SEO settings). As a default source the requested page is used. For a component pages can be returned other source object; if so, it will be automatically used. For the Products Catalog component a product, product category, brand or manufacturer objects can be returned (see the seoSource parameter in the product catalog component parameters.). For the Article component a current article object can be returned.

SEO (object request)

Short Description

description

String; the SEO description of the page.

keywords

String; the SEO keywords of the page.

title

String; the SEO title of the page.

URL

Short Description

full

String; the full URL address of the current page.

path

String; the path to the current page.

User

Short Description

allowsTracking

Boolean; specifies whether the user has enabled tracking (/__api/user/tracking?allow).

claims

Object; unites all information about user’s claims.

enquiries

Object; unites all information about user’s enquiries.

  • claims - array; list of all user’s claims. Contains claim number which can be used to create a link to the claim detail.

  • creditNotes - array; list of all user’s credit notes. Contains credit notes numbers which can be used in combination with the get credit note API.

  • invoices - array; list of all user’s invoices. Contains invoices numbers which can be used in combination with the get invoice API.

  • items - array; list of all user’s orders. Particular recored contains complete info about the order.

  • proformaInvoices - array; list of all user’s proforma invoices. Contains proforma invoices numbers which can be used in combination with the get proforma invoice API.

hasPermission( <permissionInternalName> )

Boolean; Checking whether the logged-in user has a permission defined by its internal name.

identity

Array; unites all information about user’s identity.

invoices

Object; list of all invoices available for the user.

logged

Boolean; defines if the used is currently logged in.

loyaltyProgram

Object; unites all information about user’s loyalty program.

offers

Object; unites all information about user’s offers.

  • claims - array; list of all user’s claims. Contains claim number which can be used to create a link to the claim detail.

  • creditNotes - array; list of all user’s credit notes. Contains credit notes numbers which can be used in combination with the get credit note API.

  • invoices - array; list of all user’s invoices. Contains invoices numbers which can be used in combination with the get invoice API.

  • items - array; list of all user’s orders. Particular recored contains complete info about the order.

  • proformaInvoices - array; list of all user’s proforma invoices. Contains proforma invoices numbers which can be used in combination with the get proforma invoice API.

orders

Object; unites all information about user’s orders.

  • claims - array; list of all user’s claims. Contains claim number which can be used to create a link to the claim detail.

  • creditNotes - array; list of all user’s credit notes. Contains credit notes numbers which can be used in combination with the get credit note API.

  • invoices - array; list of all user’s invoices. Contains invoices numbers which can be used in combination with the get invoice API.

  • items - array; list of all user’s orders. Particular recored contains complete info about the order.

  • proformaInvoices - array; list of all user’s proforma invoices. Contains proforma invoices numbers which can be used in combination with the get proforma invoice API.

productRating

Object; unites all information about the product rating.

  • productsForRating - array; list of all products which are available for rating.

  • ratings - array; list of all products that have been rated by the user.

profile

Object; unites all information about user’s profile.

shoppingLists

Object; unites all information about user’s shopping lists. Lists are sorted by name.

subscriptionOrders

Object; unites all information about user’s subscription orders.

Shoping List (Object)

Short Description

comment

String; the shopping list commentary.

id

String; the shopping list ID.

name

String; the shopping list name.

productCount

Number; the count of products in the shopping list.

Profile

Short Description

addresses

Object; list of addresses.

avatar

Object; unites all information about the user’s avatar.

callingCode

String; the user’s calling code.

company

Object; unites all information about the user’s company.

consents

Object; unites all user’s consents.

contactGroup

Object; unites all information about the contact group to which this user belongs.

customProperties

Array; the custom properties defined for the user.

defaultBillingAddress

Object; unites all information about the default billing address.

defaultShippingAddress

Object; unites all information about the default shipping address.

email

String; the user’s e-mail address.

firstName

String; the user’s first name.

lastBillingAddress

Object; unites all information about the last billing address.

lastName

String; the user’s last name.

lastShippingAddress

Object; unites all information about the user’s last shipping address.

newsletters

Array; list of all newsletters to which this user belongs.

partnerTier

Object; unites all information about the partner tier.

phone

String; the user’s phone number.

priceLevel

Object; unites all information about the price level do which this user belongs.

Contact Group

Short Description

allCountries

Boolean; defines if the contact group is set as default for all countries.

comment

String; the contact group comment.

countries

Array; list of countries for which is this contact group set as default.

id

Number; the unique ID of the contact group.

name

String; the name of the contact group.

sysid

String; the internal name of the contact group.

User Address

Short Description

id

Number; the unique address ID.

honorific

String; the honorific (part of the address).

firstName

String; the first name (part of the address).

lastName

String; the last name (part of the address).

streetAddress

String; the street and house number (part of the address).

city

String; the city (part of the address).

county

String; the county (part of the address).

region

String; the region (part of the address).

postalCode

String; the postal code (part of the address).

callingCode

String; the calling code.

phone

String; the phone number.

company

String; the company (part of the address).

contact

Number; the unique contact identification.

country

Array; unites all information about the county (part of the address).

type

Object; unites all information about the address type.

editURL

String; an URL address used to change the address.

deleteURL

String; an URL address used to delete the address.

User Identity

Short Description

login

String; the user’s login.

loggedSince

Date and time; the time then the user has logged in.

id

Number; the unique user’s ID.

fullName

String; the user’s full name.

firstName

String; the user’s first name.

lastName

String; the user’s last name.

email

String; the user’s e-mail address.

tierId

Number; the ID of a partner tier to which this user belongs.

permissions

Array; list of all user permissions granted to this user.

logged

Boolean; defines if the user is currently logged in.

websiteId

Number; the unique ID of a website.

accountId

Number; the unique ID of the account.

partnerId

Number; the unique ID of a partner (used in case the user is a partner).

partner

String; the partner name (used in case the user is a partner).

partnerTier

String; the parter tier name (used in case the user belongs to a partner tier).

partnerActive

Boolean; defines if the partner is currently marked as active (a partner settings). This value is available only for partners.

companyId

Number; the unique ID of a company (used in case the user is connected to a company).

supplierId

Number; the unique ID of a supplier (used in case the user is a supplier).

Example of usage:

{% for item in user.subscriptionOrders.items %}
{% set order = item.order %}
        {% for product in item.products %}
                {{product.name}} - {{product.subscriptionPeriod.name}}</br>
        {% endfor %}
{% endfor %}

Order is an array which contains order info. Products is an array of objects with the order product structure.

User Loyalty Program

Short Description

activePointList

Array; list of active loyalty points.

  • remainPoints - number of remaining loyalty points

  • validity - array, unites information about the loyalty points validity

  • validity.date - the date of points exspiration

  • validity.timezone_type - the timezone type connected to the validity

  • validity.timezone - the timezone connected to the validity

  • order - array; unites information about the connected order

  • order.id - the unique ID of the connected order

  • order.orderNumber - the number of the connected order

  • bonus - list of information about the loyalty points bonus

  • bonus.id - the unique ID of the bonus

  • bonus.name - the name of the bonus

availablePoints

Number; total available points.

program

Object; unites all information about the loyalty program to which the user belongs.

Loyalty Program

Short Description

active

Boolean; defines the activity of the loyalty program.

comment

String; the commentary provided in the loyalty program detail.

currency

Object; unites information about the loyalty program currency.

customerTypes

Array; a list of customer types for which is this loyalty program available.

earnedPoints

Number; the count of loyalty points that is earned for every (defined) amount spent.

earnedPointsAmount

Number; defines how many amount a customer has to spent in order to get the revard (earned points).

eshops

Array; defines the e-shop settings for which is this loyalty program available.

grossPrice

Boolean; defines if the configuration is defined with the tax included.

id

Number; the unique ID of the loyalty program.

label

String; the label defined in the loyalty program settings.

maxDiscount

Integer; the maximum discount defined in the loyalty program settings.

maxDiscountRate

Integer; the maximum discount rate defined in the loyalty program settings.

minOrderAmount

Integer; the minimal order amount defined in the loyalty program settings.

name

Integer; the minimal order amount defined in the loyalty program settings.

rounding

Object; unites information about the loyalty program rounding settings.

sysid

String; the internal name of the loyalty program.

usedPoints

Number; defines the value how many points has to be used to get the sale.

usedPointsAmount

Integer; defines the sale for the used points.

validFrom

Date and time; defines the validity of the loyalty program.

validUntil

Date and time; defines the validity of the loyalty program.

usedPointsAmount

Number; points validity (in days).

Object enums

Short Description

addressTypes

Object; unites information about particular address types.

cartAttachmentTypes

Object; unites all order attachment types (used in :ref:Cart Attachments form`<lab-cart-attachments>`.

claimReasonTypes

Object; unites all reason types defined in the Reason Types application in the Administration module.

dispatchStates

Object; unites information about particular dispatch states.

Order Attachment Type

Short Description

id

Integer; the unique ID of the attachment type.

name

String; the attachment type name.

sysid

String; the attachment type internal name.

Contact Address Type

Short Description

id

Integer; the unique ID of the address type.

name

String; the address type name.

sysid

String; the address type internal name.

Claim Reason Types

Short Description

id

Integer; the unique ID of the reason type.

name

Integer; the name of the reason type.

See the list of available enumerations states.

Dispatch States

Short Description

id

Integer; the unique ID of the dispatch state.

name

Integer; the mame of the dispatch state.

order

Integer; the order of the dispatch state.

sysid

Integer; the internal name of the dispatch state.

E-mail Template Parameters

The following list contains all the parameters you can use in the code of e-mail templates which are created on a Website in the Templates application. These Templates are used as a pattern for personalized e-mail communication with your customers and registered website users.

Parameter

Short Parameter Description

cms

A group of information connected with websites and its content. Mostly used for Author Tools module and navigations. More info >.

crm

A group of information connected with sales and partners. More info >.

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more). More info >.

enums

Contains all enumerations you can use on your website. More info >.

Registration and Reset Password E-mail Parameters

Registration and Reset E-mail Parameters

Short Description

user

Array; list of information about a particular user.

partner

website

Array; list of information about the website

  • name - the name of the website on which has the user registered

  • url - the website’s URL

  • registrationApproval - boolean; defines if the registration approval is required on the website

  • specialPages - array; list of BizBox special pages with their URL addresses

cms

A group of information connected with websites and its content. Mostly used for Author Tools module and navigations. More info >.

crm

A group of information connected with sales and partners. More info >.

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more). More info >.

enums

Contains all enumerations you can use on your website. More info >.

User (array)

Short Parameter Description

id

Number; user’s ID.

login

String; user’s login.

fullName

String; user’s full name (first and last name).

firstName

String; user’s first name.

lastName

String; user’s last name.

email

String; user’s e-mail address.

permissions

Array; list of user’s permissions.

changePwdHashCreated

String; date of password change hash creation .

changePwdHash

String; hash used for pasword change (link).

logged

Boolean; defines if the user is logged in.

tierId

Number; the ID of a user’s partner tier.

Account Info E-mail Parameters

Account Info E-mail Parameters

Short Description

user

Array; list of information about a particular user.

website

Array; list of information about the website

  • id - the unique website ID

  • name - the name of the website on which has the user registered

  • url - the website’s URL

  • registrationApproval - boolean; defines if the registration approval is required on the website

  • specialPages - array; list of BizBox special pages with their URL addresses

cms

A group of information connected with websites and its content. Mostly used for Author Tools module and navigations. More info >.

crm

A group of information connected with sales and partners. More info >.

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more). More info >.

enums

Contains all enumerations you can use on your website. More info >.

Claim E-mail Template Parameters

Claim E-mail Template Parameters

Short Description

claim

Object; unites all information about the claim.

cms

A group of information connected with websites and its content. Mostly used for Author Tools module and navigations. More info >.

crm

A group of information connected with sales and partners. More info >.

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more). More info >.

enums

Contains all enumerations you can use on your website. More info >.

Invoice Template Parameters

Invoice Template Parameters

Short Description

order

Object; unites all information about the order for which has been this invoice created.

invoice

Array; list of information about the invoice:

  • invoiceNumber - the document number generated according to the document sequence.

  • number - the document number generated according to the document sequence.

  • issueDate - date; the invoice issue date.

  • paymentDueDate - date; the payment due date.

  • taxPointDate - date; the tax point date.

proformaInvoice

Array; list of information about the proforma invoice:

  • number - the document number generated according to the document sequence.

  • issueDate - date; the invoice issue date.

  • paymentDueDate - date; the payment due date.

  • taxPointDate - date; the tax point date.

payment

Array; list of information about the payment used for the order:

  • paymentMethod - object; unites all information about the used system payment method.

  • address - array, list of information about the city and street provided to this payment.

  • accountHolder - string; account holder.

  • accountNumber - string; account number.

  • bankName - string; bank name.

  • bankCode - string; bank code.

  • bankConstantSymbol - string; constant symbol.

  • bankCustomerInfo - string; customer info.

  • bankSpecificSymbol - string; specific symbol.

  • iban - string; IBAN.

  • swift - string; SWIFT.

advancePayments

Array; list of all advance payments connected to this order. Here is the structure of each one of them:

  • classificationVat - string; an accounting setting.

  • label - string; label defined in the E-shop Settings.

  • name - string; name defined in the E-shop Settings.

  • number - string; the proforma invoice number generated according to the document sequence.

  • quantity - number; the quantity of payments.

  • rateVat - string; an accounting setting.

  • taxAmount - integer; the tax amount of the advance payment.

  • taxExclusiveAmount - integer; the tax exclusive amount of the advance payment.

  • taxInclusiveAmount - integer; the tax exclusive amount of the advance payment.

  • taxRate - integer; the tax rate applied on the advance payment.

originator

Object; unites information about the origin of the order:

  • domain - string; the used domain.

  • name - string; the name of the origin.

cms

A group of information connected with websites and its content. Mostly used for Author Tools module and navigations. More info >.

crm

A group of information connected with sales and partners. More info >.

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more). More info >.

enums

Contains all enumerations you can use on your website. More info >.

Proforma Invoice Template Parameters

Proforma Invoice Template Parameters

Short Description

order

Object; unites all information about the order for which has been this invoice created.

invoice

Array; list of information about the invoice:

  • invoiceNumber - the document number generated according to the document sequence.

  • number - the document number generated according to the document sequence.

  • issueDate - date; the invoice issue date.

  • paymentDueDate - date; the payment due date.

  • taxPointDate - date; the tax point date.

payment

Array; list of information about the payment used for the order:

  • paymentMethod - object; unites all information about the used system payment method.

  • address - array, list of information about the city and street provided to this payment.

  • accountHolder - string; account holder.

  • accountNumber - string; account number.

  • bankName - string; bank name.

  • bankCode - string; bank code.

  • bankConstantSymbol - string; constant symbol.

  • bankCustomerInfo - string; customer info.

  • bankSpecificSymbol - string; specific symbol.

  • iban - string; IBAN.

  • swift - string; SWIFT.

cms

A group of information connected with websites and its content. Mostly used for Author Tools module and navigations. More info >.

crm

A group of information connected with sales and partners. More info >.

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more). More info >.

enums

Contains all enumerations you can use on your website. More info >.

Order Confirmation E-mail Template Parameters

Order Confirmation E-mail Template Parameters

Short Description

orderItemDetails

Array; list of all order items. The structure of a single item follows:

  • product - object; unites all information about the product.

  • name - string; the product name.

  • code - string, the product code.

  • key - string; the product key.

  • licenseKey - string; the product license key.

  • link - string; the link connected with this product.

  • downloadLink - string; the product download link.

  • customerInfo - string; the customer info (instructions).

  • urls - array; list of URL addresses defined in the product detail.

  • images - array; list of all product images.

  • documents - array; list of all product documents.

order

Object; unites all information about the order for which has been this invoice created.

payment

Array; list of information about the payment used for the order:

  • paymentMethod - object; unites all information about the used system payment method.

  • address - array, list of information about the city and street provided to this payment.

  • accountHolder - string; account holder.

  • accountNumber - string; account number.

  • bankName - string; bank name.

  • bankCode - string; bank code.

  • bankConstantSymbol - string; constant symbol.

  • bankCustomerInfo - string; customer info.

  • bankSpecificSymbol - string; specific symbol.

  • iban - string; IBAN.

  • swift - string; SWIFT.

originator

Object; unites information about the origin of the order:

  • domain - string; the used domain.

  • name - string; the name of the origin.

Object Claim

Short Description

attachments

Object; unites all information about the attachments connected to this claim.

claimCompleted

Date and time; defines when has been this claim completed.

claimDispatch

Array; list of claim dispatch objects.

claimReceived

Date and time; defines when has been this claim received.

completedOrder

Object; unites all information about the replacement order defined for the claim.

conclusion

String; the conclusion of the claim.

id

Number; the claim ID.

items

Array; list of all claim items.

name

String; the name (number) of the claim.

notes

Object; unites all information about the notes connected to this claim.

order

Object; unites all information about the order from which has this claim arised.

reason

String; the claim reason provided in the claim detail.

reasonType

Object; unites all information about the particular product.

resolution

Object; unites all information about the claim resolution.

state

Object; unites all information about the current claim state.

taxAmount

Integer; the tax amount of the claimed products.

taxExclusiveAmount

Integer; the tax exclusive amount of the claimed products.

taxInclusiveAmount

Integer; the tax inclusive amount of the claimed products.

Object Claim Attachment

Short Description

attachment

Object; unites all information about the attachment storage item.

dispatch

Object; unites all information about the claim dispatch.

id

Number; the ID of the claim item.

quantity

Number; defines the claimed quantity of this item.

Object Claim Dispatch

Short Description

claim

Object; unites all information about the claim to which this item belongs.

dispatch

Object; unites all information about the claim dispatch.

id

Number; the ID of the claim item.

quantity

Number; defines the claimed quantity of this item.

Object Order Product Dispatch

Short Description

bundleId

Number; the ID used in case this product is a bundle.

id

Number; the ID of the order product dispatch.

licenseNumber

String; contains the license number (or voucher code) connected to this product.

orderProduct

Object; unites all information about the product (order).

product

Object; unites all information about this CRM product.

quantity

Number; defines the quantity of this item.

refundProduct

refunded

Boolean; defines if the product has been refunded.

refundedQuantity

Number; defines the refunded quantity of this item.

serialNumber

String; the serial number.

state

Object; unites all information about the dispatch state.

terminated

Boolean; defines if the license has terminated.

terminatedDate

Date and time; the date of a license termination.

Object Dispatch State

Short Description

id

Number; the ID of the dispatch state.

name

String; the name of the dispatch state.

order

Number; the order number.

sysid

String; the internal name of the dispatch state.

Object Claim comment

Short Description

claim

Object; unites all information about the claim to which this note belongs.

id

Number; the ID of the claim note.

note

String; the content of a particular note.

visible

Boolean; defines if the note is visible to the customer.

Object Reason Type

Short Description

id

Number; the ID of the claim reason type.

name

String; the name of the claim reason type.

Object Resolved with

Short Description

id

Number; the ID of the claim resolution.

name

String; the name of the claim resolution.

sysid

String; the internal name of the claim resolution.

Object Claim State

Short Description

id

Number; the ID of the claim state.

isClosed

Boolean; defines if the claim is currently in a closed state.

name

String; the name of the claim state.

sysid

String; the internal name of the claim state.

Order Item Detail

Short Description

product

Object; unites all information about the particular product.

name

String; the product name.

code

String; the product code.

key

String; the key connected to the product.

licenseKey

String; the license key connected to the product.

link

String; the key connected to the product.

downloadLink

String; the link for this product download.

customerInfo

String; content of the Instructions field from the product detail.

urls

Array; list of URL addresses connected to the product.

images

Array; list of images connected to the product.

documents

Array; list of documents connected to the product.

E-commerce Template Parameters

Parameter

Type of a Parameter

Short Parameter Description

order.taxInclusiveAmount

Integer

A total purchase price with tax included.

order.taxExclusiveAmount

Integer

A total purchase price without tax included.

order.taxInclusivePaidAmount

Integer

A total paid purchase price with tax included.

order.taxExclusivePaidAmount

Integer

A total paid purchase price without tax included.

order.taxAmount

Integer

A total tax amount for purchase.

order.currencySymbol

String

A currency symbol connected with particular order.

order.id

Integer

A system generated identification order number.

order.date

NetteDateTime

Date connected with order.

order.billingAddress

Object

An object used to unite all customer’s billing address parameters listed below.

order.billingAddress.honorific

String

A honorific listed in customer’s billing address.

order.billingAddress.firstName

String

A first name listed in customer’s billing address.

order.billingAddress.lastName

String

A last name listed in customer’s billing address.

order.billingAddress.company

String

A company name listed in customer’s billing address.

order.billingAddress.street

String

A street listed in customer’s billing address.

order.billingAddress.country.name

String

A country name listed in customer’s billing address.

order.billingAddress.city

String

A city listed in customer’s billing address.

order.billingAddress.region

String

A region listed in customer’s billing address.

order.billingAddress.email

String

An e-mail address listed in customer’s billing address.

order.billingAddress.postalCode

String

A postal code listed in customer’s billing address.

order.billingAddress.county

String

A county listed in customer’s billing address.

order.billingAddress.ipAddress

String

An IP address connected with customer’s billing address.

order.shippingAddress

Object

An object used to unite all customer’s shipping address parameters listed below.

order.shippingAddress.honorific

String

A honorific listed in customer’s shipping address.

order.shippingAddress.firstName

String

A first name listed in customer’s shipping address.

order.shippingAddress.lastName

String

A last name listed in customer’s shipping address.

order.shippingAddress.company

String

A company name listed in customer’s shipping address.

order.shippingAddress.street

String

A street listed in customer’s shipping address.

order.shippingAddress.country.name

String

A country name listed in customer’s shipping address.

order.shippingAddress.city

String

A city listed in customer’s shipping address.

order.shippingAddress.region

String

A region listed in customer’s shipping address.

order.shippingAddress.email

String

An e-mail address listed in customer’s shipping address.

order.shippingAddress.postalCode

String

A postal code listed in customer’s shipping address.

order.shippingAddress.county

String

A county listed in customer’s shipping address.

order.shippingAddress.ipAddress

String

An IP address connected with customer’s shipping address.

order.branch

Object

An object used to unite all Branch parameters listed below.

order.branch.name

String

A name of a Branch used for order.

order.branch.street

String

A street of a Branch used for order.

order.branch.city

String

A city of a Branch used for order.

order.branch.postalCode

String

A postal code of a Branch used for order.

order.branch.countryName

String

A country name of a Branch used for order.

order.branch.www

String

A website of a Branch used for the order.

order.branch.taxIdentity

String

A tax identity of a Branch used for the order.

order.branch.vatPayer

Boolean

Defines if a particular Branch is a VAT Payer.

order.branch.identificationNumber

String

An identification number of a Branch used for order.

order.branch.supportPhone

String

A support phone number of a Branch used for order.

order.branch.supportEmail

String

A support e-mail address of a Branch used for order.

order.branch.accountNumber

String

An account number of a Branch used for order.

order.branch.bankCode

String

A bank code of a Branch used for order.

order.branch.iban

String

An IBAN of a Branch used for order.

order.branch.swift

String

A SWIFT of a Branch used for order.

order.items

Object

An object used to unite all order items parameters listed below.

item

Object; used locally in the template

A particular item (such as Product, Delivery or Payment Method) on order.

order.items.quantity

Integer

A quantity of particular order item.

order.items.name

String

A name of a particular order item.

order.items.downloadLink

String

A download link connected with order item.

order.items.licenseKey

String

A licence key connected with order item.

order.items.customerInfo

String

A customer info connected with order item.

payment.gateway

String

A Payment Gateway used for order.

order.deliveryDetail.name

String

A name of Delivery Service used for order.

order.deliveryDetail.carrierService.name

String

A name of Delivery Method used for order.

order.deliveryDetail.carrierService.description

String

A description of Delivery Method used for order.

order.paymentDetail.paymentMethod.name

String

A name of Payment Method used for order.

payment.bankName

String

For Payment Gateway Bank Transfer: A bank name.

payment.accountNumber

Integer

For Payment Gateway Bank Transfer: An account number.

payment.bankCode

Integer

For Payment Gateway Bank Transfer: A bank code.

payment.bankConstantSymbol

Integer

For Payment Gateway Bank Transfer: A constant symbol.

order.discounts

Object

An object used to unite all Discounts parameters listed below.

order.discounts.taxAmount

Integer

A tax amount applied on a discount.

order.discounts.taxExclusiveAmount

Integer

A total discount tax-exclusive price.

order.discounts.taxInclusiveAmount

Integer

A total discount tax-inclusive price.

order.discounts.name

String

A particular Discount’s name.

order.discounts.voucherCode

String

A particular Discount’s Voucher code.

Photoalbum Component Parameters

Parameter

Type of a Parameter

Short Parameter Description

component.album

Object

Unites all parameters about the album.

component.album.active

Boolean

Defines the album activity.

component.album.bigImage

Object

A big image connected to this album (in the album settings).

component.album.smallImage

Object

A small image connected to this album (in the album settings).

component.album.description

String

A descripton of this album (defined in the album settings).

component.album.firstImage

String

A first image of this album.

component.album.images

Array

Unites all parameters of images from this album.

component.album.label

String

A label of this album (defined in the album settings).

component.album.name

String

A name of this album.

component.album.nameURL

String

An URL address of this album.

component.album.products

Array

Unites all parameters of products from this album.

component.album.sourceAccessible

Array

Defines if the source images are accessible (according to the Source Accessible setting in the album settings).

component.album.childItems

Array

A child items of this album.

component.albumPath

Array

Contains a list of all albums to the root one. It is used for the breadcrumb navigation.

component.albumTree

Array

A list of all albums (in a hierarchical organization).

component.subalbums

Array

Unites information about the current album tree.

component.imageList

Object

List of all images from a current album.

component.imageList.filter

Array

Filtering. For more info see the related help-site.

component.imageList.paginator

Array

Unites all paginator parameters.

component.imageList.sorters

Array

Currently used sorters (sorters are defined by the sorting form - see below).

component.imageList.images

Object

List of all images from a current album.

component.imageList.images[0]

Object

Unites all information connected to the first image.

component.imageList.images[0].albumId

Object

The ID of the album to which this image belongs.

component.imageList.images[0].name

Object

The name of the image.

component.imageList.images[0].nameURL

Object

The URL address of the image.

component.imageList.images[0].source.url

String

The source URL address. This parameter is available only if the setting Source Accessible is available in the album settings.

component.imageList.images[0].thumbnails

Object

Unites all thumbnails generated for the album.

component.imageList.images[0].thumbnails.internalName

Array

Unites all thumbnails generated for the album. Instead of internalName has to be used the real name of thumbnails defined in the album settings.

component.imageList.images[0].thumbnails.internalName.url

String

The particular thumbnail for this image.

component.imageList.images[0].isPurchasable

Boolean

Defines if the image is purchasable.

component.imageList.images[0].products

Object

Unites all information about connected products.

component.imageList.images[0].products[0]

Array

Unites all information about the first connected product. Use the dump for more parameters info.

component.imageList.images[0].products[0].price

Array

Unites all information about the product’s price.

component.imageList.images[0].products[0].name

String

The product’s name.

component.imageList.images[0].products[0].code

String

The product’s code.

Stock Services Parameters

Object Stock Receipt

Short Description

date

Date and time; the date when has been the receipt created.

id

Number; ID of the receipt.

items

Object; unites all items (products) from the receipt.

note

String; the note connected to the receipt.

number

String; the receipt number (according to the connected document sequence).

state

Object; unites information about the current state of the receipt.

stock

Object; unites information about the stock to which is this receipt received.

supplier

Object; unites information about the supplier.

supplierAddress

Object; unites information about the supplier’s address.

transfer

Object; unites information about the connected transfer.

type

Object; unites information about the receipt type.

Object Stock Receipt State

Short Description

id

Number; the number of the current receipt state.

name

String; the name of the current receipt state.

sysid

String; the internal name of the current receipt state.

Object Stock Receipt Type

Short Description

id

Number; the number of the current receipt type.

name

String; the name of the current receipt type.

sysid

String; the internal name of the current receipt type.

Object Stock

Short Description

active

Boolean; defines if the stock is currently active.

carrierServices

Array; list of the stock’s carrier services.

description

String; the stock description.

earliestExpirationDate

Date and time; the earliest date of expiry of the product.

externalId

String; external ID of the stock.

id

Number; the stock ID.

isInhouse

Boolean; defines if the stock is BizBox Stock Management type

label

String; the stock label.

name

String; the stock name.

priority

Number; the stock priority.

stockService

Object; unites information about the stock service.

sysid

String; the stock internal name.

useLocations

Boolean; defines the usage of stock locations.

Object Stock Issue

Short Description

contact

Object; unites all information about the particular product.

date

Date and time; the date when has been the issue created.

id

Number; ID of the issue.

issueItems

Array; list of all items (products) from the issue.

items

Object; unites all items (products) from the issue.

language

note

String; the note connected to the issue.

number

String; the issue number (according to the connected document sequence).

order

Object; the origin order.

state

Object; unites information about the current state of the issue.

stock

Object; unites information about the stock from which is this issue issued.

transfer

Object; unites information about the connected transfer.

type

Object; unites information about the issue type.

Object Stock Issue Item

Short Description

accountCode

String; the account code of the item (product).

code

String; the code of the item (product).

externalId

String; the external ID of the item (product).

id

Number; unique ID of the item.

issue

Object; unites all items (products) from the issue.

locations

Array of objects; unites all information about the locations from which has been the item issued.

name

String; the issued item (product) name.

product

Object; unites all information about the product (e-commerce).

quantity

Number; the issued quantity.

unit

Object; unites all information about the item unit.

Object Stock Issue Item Location

Short Description

currency

Object; unites all information about the item.

grossPrice

Boolean; defines if the price is defined with or without VAT.

id

Number; the ID of the item (product).

item

Object; unites all information about the issue item.

location

Object; unites all information about the location.

price

Number; the price defined for the item (product).

quantity

Number; the count of issued items.

receiptItemLocation

Object; unites all information about location on the receipt.

taxRate

Number; the tax applied on the price of the item.

Object Stock Location

Short Description

id

Number; unique ID of the stock location.

name

String; the name of the stock location.

stock

Object; unites all information about the stock.

sysid

String; the internal name of the stock location.

Object Stock Receipt Item Location

Short Description

id

Number; unique ID of the stock receipt item location.

item

Object; unites all information about the receipt item.

location

Object; unites all information about the used location.

quantity

Number; the quantity of the item.

Object Stock Receipt Item

Short Description

id

Number; unique ID of the stock receipt item location.

locations

Array of objects; unites all information about the item locations.

product

Object; unites all information about the item (product).

productBatch

Object; unites all information about the product batch.

purchasePrice

Number; the quantity of the item.

purchasePriceCurrency

Object; unites all information about the purchase price currency.

purchasePriceGrossPrice

Boolean; defines if the purchase price is with or without VAT.

purchasePriceTaxRate

Number; the purchase price tax rate.

quantity

Number; the quantity of the item.

receipt

Object; unites all information about the receipt.

remainQuantity

Number; the quantity which remains on the stock.

Object Product Batch

Short Description

expirationDate

Date and time; the expiration date of the batch.

id

Number; the unique batch ID.

number

String; the batch number.

product

Object; unites all information about the product.

Parameter

Type of a Parameter

Short Parameter Description

issue.number

String

The number of a particular issue (generated according to the connected Document Sequence).

issue.stock.name

String

The name of a particular stock used with this issue.

issue.supplier.name

String

The name of a supplier connected with this issue.

issue.date

Date

The date of issue of the issue.

issue.note

String

The note connected to the issue.

issue ({% for item in issue.items %})

Object Used locally in the template

One item (product) in the issue.

item.product.name

String

The name of a product.

item.quantity

String

The number of issued items of a product.

issue.createdBy.fullName

String

The full name of a person who created the issue.

Object Stock Transfer

Short Description

id

Number; the ID of the transfer.

issue

Object; unites all information about the connected issue.

issueDate

Date and time; defines when has been the trans.

items

Array of object; list of all items; unites all information about the transfer items.

note

String; the transfer note.

number

String; the number of the transfer.

receipt

Object; unites information about the conncted receipt.

receiptDate

Date and time; the date of the receival.

sourceStock

Object; unites information about the source stock.

state

Object; unites information about the current transfer state.

targetStock

Object; unites information about the target stock.

Object Stock Transfer Item

Short Description

id

Number; unique ID of the stock receipt item location.

item

Object; unites all information about the receipt item.

location

Object; unites all information about the used location.

quantity

Number; the quantity of the item.

Picking List

Parameter

Type of a Parameter

Short Parameter Description

issue.number

String

The number of a particular issue (generated according to the connected Document Sequence).

issue.stock.name

String

The name of a particular stock used with the issue.

issue.contact.displayName

String

The name of a contact connected with the issue.

issue.date

Date

The date of issue of the issue.

issue.note

String

The note conected to the issue.

{% for item in issue.items %}

Object Used locally in the template

One item (product) in the issue.

{% for location in issue.locations %}

Object Used locally in the template

All information connected to a location of an item (product) on the issue. Particular products can be received to a particular location.

item.product.name

String

The name of a product.

location.quantity

String

The number of issued items of a product.

location.purchasePrice

String

The number of issued items of a product.

location.location.name

String

The name of a particular location.

issue.createdBy.fullName

String

The full name of a person who created the issue connected with this list.

Coupon Card

Coupon Card

Short Description

productDispatch

Object; unites all information about the product dispatch.

cms

A group of information connected with e-commerce (products, cart, checkout and more).

ecommerce

A group of information connected with e-commerce (products, cart, checkout and more).

enums

Contains all enumerations you can use on your website.

Notification Templates

For more information about notifications please visit the page about the Notifications application. For information on how to create a notification template, see the template information.

New Product Discussion

Available objects are: product, :ref:`website<doc-object-website>`, :ref:`commentary<doc-object-comment>`.

New Product Rating

Available objects are: rating, :ref:`website<doc-object-website>`, productPageSysid (optional - taken from the widget).

New Product Discussion Commentary

Available objects are: :ref:`commentary<doc-object-comment>`, replyTo, :ref:`website<doc-object-website>`, productPageSysid (optional - taken from the widget).

New Product Rating Commentary

Available objects are: :ref:`commentary<doc-object-comment>`, replyTo, :ref:`website<doc-object-website>`, productPageSysid (optional - taken from the widget).

New Product Discussion Vote

Available objects are: vote, :ref:`website<doc-object-website>`, productPageSysid (optional - taken from the widget).

New Product Rating Vote

Available objects are: vote, :ref:`website<doc-object-website>`, productPageSysid (optional - taken from the widget).

Object Order Parameters

In your templates and page codes can be available the object order which carries complete information about the placed order.

Parameter

Type of the Parameter

Short Parameter Description

order.allItems

Object

Unites all information about a particular order.

item {% for item in order.allItems %}

Object Used locally in the template

Unites all information about a single order. {% for item in order.allItems %}

item.type

String

Type of the particular item: product, productDiscount, orderDiscount, packing, packingDiscount, handling, handlingDiscount, payment, paymentDiscount, delivery, deliveryDiscount.

item.name

String

The name of the particular item.

item.quantity

String

The quantity of the particular item.

item.unit

String

The unit in which is this item counted.

item.rateVat

String

The identification of vat rate used for the accounting.

item.homeCurrency

Boolean

Indicates if the price of the item is in the home currency (home currency is defined in the branch settings).

item.classificationVat

String

The clasification of tax group (used for the purposes of accounting).

item.accountCode

String

The identification of the item according to its code or external ID (for products) or service identification (for services).

item.code

String

The code of the item.

item.externalId

String

The external ID of the item.

item.taxInclusiveUnitPrice

Float

The price of the item - tax inclusive unit price.

item.taxExclusiveUnitPrice

Float

The price of the item - tax exclusive unit price.

item.taxInclusiveBaseUnitPrice

Float

The price of the item - tax inclusive base unit price.

item.taxExclusiveBaseUnitPrice

Float

The price of the item - tax exclusive base unit price.

item.taxBaseAmount

Float

The price of the item - tax base amount.

item.taxAmount

Float

The price of the item - tax amount.

item.taxInclusiveBaseAmount

Float

The price of the item - tax inclusive base amount.

item.taxExclusiveBaseAmount

Float

The price of the item - tax exclusive base amount.

item.grossPrice

Boolean

Indicates if the price is with or without tax defined.

item.tax

Object

The object unites all information about the applied tax.

item.discount

Boolean

Indicates if there is a discount applied on the order.

Object Issue Parameters

In your export templates can be used two main parameters: branch and issueSlips.

You can use:

  • issueSlips.items

  • issueSlips.groupBy(‘price’)

Parameter

Type of the Parameter

Short Parameter Description

issueSlips.items

Object

Unites all information about a particular items from the issue slip.

item {% for item in order.issueSlips.items %}

Object Used locally in the template

Unites all information about a single issue. {% for item in order.issueSlips.items %}

item.name

String

The name of a particular item.

item.unit

String

The unit of a particular item.

item.quantity

Integer

The quantity of a particular item.

item.code

String

The code of a particular item.

item.accountCode

String

The code (item.code or item.externalId) used according to the export/accounting settings.

item.externalId

String

The external ID of the particular item.

item.locations

Object

Unites all locations connected to a particular item.

item.product

Object

Unites all information about the particular item (the product itself).

Partner Extension

Following parameters are available in the Registration and Registration Partner Manager e-mails in case you are using the Partner addon.

Parameter

Type of a Parameter

Short Parameter Description

partner

Object

An object used to unite all partner parameters listed below.

partner.name

String

The name of a particular partner.

partner.id

Integer

The ID of a particular partner.

partner.comment

String

The comment connected to a particular partner.

partner.active

Boolean

Defines the activity of a particular partner.

Product Catalog Component Data

Product Catalog Parameters

Parameter

Short Parameter Description

View

allTags

Array; the list of all tags sorted by its name.

Catalog, Product Detail, Product List, Search

brand

Object; unites all information about the current brand.

Product List

brandsInRootCategories

Array of objects; list of product brands (brands of the displayed products).

Product List, Search

category

Object; unites all information about the current category.

Product Detail, Product List

categoryPath

Array; all subcategories for selected category (recursively). Used for creating of a breadcrumb navigation. If a default category exists, it will be reflected in the created navigation.

Product Detail, Product List

categoryTree

Array of objects; used to create category menu.

Catalog, Product Detail, Product List, Search

currentEntity

Object; defines the currently displayed entity (product category, brand or manufacturer.

Product List

currentView

String; defines the current product catalog component view.

Catalog, Product Detail, Product List, Search

extraEntity

Object; unites all information about the extra entity.

Product Detail, Product List, Search

foundCategory

Object; unites all information about the category.

Product Detail, Product List, Search

itemsPerPageValues

Array; contains the number of products per page; values are defined in the product component settings.

Product List, Search

manufacturer

Object; unites all information about the current manufacturer.

Product List

nextProduct

Object; unites all information about the next product. If the parameters for the product list are not listed, the category defined in the URL address or the first product category will be used instead.

Catalog, Product Detail, Product List, Search

previousProduct

Object; unites all information about the previous product. If the parameters for the product list are not listed, the category defined in the URL address or the first product category will be used instead.

Catalog, Product Detail, Product List, Search

product

Object; unites all information about particular product.

Product Detail

productList

Object; list of information about displayed products limited by filters.

Product List, Search

seoSource

Object; unites all information about the current object which is used as the source for SEO.

Catalog, Product Detail, Product List, Search

subcategories

Array of object; subcategories of particular category.

Product Detail, Product List, Search

Product List

Short Description

brands

Array; list of all brands connected to available products.

brandsForFiler

Array; list of all brands connected to available products for currently applied filters.

categories

Array; list of all categories (main view/filter).

categoriesForFiler

Array; list of all categories for currently applied filters.

extraEntities

Array; unites information about custom properties of available products.

extraEntitiesForFilter

Array; list of all extra entities connected to available products for currently applied filters.

customProperties

Array; list of all extra entities (main view/filter).

filter

Object; list of all filters applied on the current product list.

filteredBrands

Array; list of available brands (and total items count) for currently applied filters.

filteredCategories

Array; list of available categories (and total items count) for currently applied filters.

filteredCustomProperties

Array; list of available custom properties (and total items count) for currently applied filters.

filteredExtraEntities

Array; list of available extra entities (and total items count) for currently applied filters.

filteredManufacturers

Array; list of available manufacturers (and total items count) for currently applied filters.

filteredTags

Array; list of available tags (and total items count) for currently applied filters.

filters

Array; list of all filters applied on the current product list.

highestPrice

Integer; the highest price among prices of available products.

getCustomPropertyForFilter()

Method; its parameter is the internal name of a custom property for which the filter is created.

lowestPrice

Integer; the lowest price among prices of available products.

manufacturers

Array; list of all brands connected to available products.

manufacturersForFilters

Array; list of all brands connected to available products for currently applied filters.

paginator

Object; unites all information about pages (according to the component settings).

products

Array; list of all available products.

sorters

Array; list of all available sorters.

tags

Array; list of all available tags.

tagsForFilters

Array; list of all available tags for currently applied filters.

total

Number; count of available products.

Paginator

Short Description

perPage

Number; defines how many items will be displayed per one page (component setting)

totalItems

Number; defines the total count of particular products.

totalPages

Number; defines the total count of particular pages.

currentPage

Number; the number of currently displayed page.

items

Array; unites all available pages. Single record contains the URL address of a curricular page (items[0].url).

fromPage

Number; the value determines the page from which the products will be returned.

firstPage

Array; contains the URL address of the first page (firstPage.url).

lastPage

Array; contains the URL address of the last page (lastPage.url).

nextPage

Array; contains the URL address of the next page (nextPage.url).

Product Detail View Parameters

Product Detail displays one particular Product - this View is typically displayed after a customer selects one of the products from the Product List (list of Products from particular Product Category).

Product Detail displays all the information about one Product. Thanks to the parameters you are able to display all info you have added to the Product in the Products module - name, code, EAN, manufacturer, brand, descriptions, inventory info, custom properties, images, documents, relations and so on. The Name in URL field (defined along with the product in the Products module) is displayed in the URL address in the Product Detail View.

Note

You can test if a particular product has been added to cart. The product itself has a parameter “isInCart” which tests whether the product is in the customer’s cart. You can also test if a particular variant (in case of a variant Product) has been already added to the cart. Use the parameter “isVariantInCart”, such as a condition {% if component.product.isVariantInCart %}.

Product List View Parameters

Product List displays all the products from one selected product category, brand or manufacturer. Products categories, brands and manufacturers are created in the Products module. You customers will typically select one category/brand/manufacturer from the menu (see Navigation Trees for more info) and the selected category/brand/manufacturer will be automatically displayed in the Product List view.

Appart from globally available parameters, the component object is available.

Parameters starts with “component.productList.product” - it is an array. Every single (the first in this case) product can be accessible as follows: “component.productList.product[0]”. The structure is designed for iteration which allows you to display all products from the particular category.

Use these parameters to customize the Product Detail View. The basic use can be seen in the default template. You can feel free to change is according to your needs.

Default View, Blocks and Layout Names

Name

Internal Name

Type

Catalog

catalog

View

Product List

product-list

View

Product Detail

product-detail

View

Search

Search

View

Category Tree

category-tree

Block

Product List Item

product-list-item

Block

Search

search

Block

Breadcrumb Navigation

breadcrumb-navigation

Block

Default Layout

default-layout

Layout

Component Parameters Examples:

Total items (category.totalItems) and total items with subcategories (category.totalItemsWithSubcategories)

The total count of Products from one Category and all its subcategories. You are able to work with the number of products added to a particular Category and also with the products added into the subcategories of this Category. Use the parameters totalItems or totalItemsWithSubcategories to find the number of products that have been added to a Category and its subcategories.

These parameters can be used within the Category Tree object – it can be found in the Product Catalog Component or in the Navigation Trees.

Article Component Parameters and Forms

Articles Component Parameters

Parameter

Type of a Parameter

Short Parameter Description

component.articleList

Array of objects

List of articles from one category.

component.articleList.articles

Array of objects

Particular article from one category.

component.productList.sorters

Array of objects

Sorters used in the category.

component.productList.filter

Array of objects

See the related help-site.

component.articleList.paginator

Array

Paginator’s items.

component.articleList.paginator.perPage

Integer

Defines the number of articles displayed per one page.

component.articleList.paginator.totalPages

Integer

Defines the total number of pages.

component.articleList.paginator.currentPage

Integer

The current paginator page.

component.articleList.paginator.prevPage

Array

information about previous Page.

component.articleList.paginator.nextPage

Array

information about next Page.

component.articleList.paginator.firstPage

Array

Link to the first page.

component.articleList.paginator.lastPage

Array

Link to the last page.

component.articleList.paginator.items

Array

Particular paginator items (links to another pages).

component.foundCategories

Object

List of found categories (searching).

component.category

Object

A current article.

component.tags

Object

A list of all tags used on particular pages.

component.foundCategories

Object

All errors from the Component.

component.messages

Object

All messages from the Component.

Default View, Blocks and Layout Names

Name

Internal Name

Type

Article

article

View

Articles Overview

articles-overview

View

Category Articles

category-articles

View

Search

Search

View

Author

author

Block

Search

search

Block

Default Layout

default-layout

Layout