Customers

Get the customer list
Scroll upRead more...

Request

Response

An array of the first 10 customers; each object has the following properties:

  • id - the id of the customer (integer)
  • siteId - the id of the site (integer)
  • customerTypeId - the id of the customer type assigned (integer)
  • leadSourceTypeId - the id of the lead source type assigned (integer)
  • industryTypeId - the id of the lead industry type assigned (integer)
  • ratingTypeId - the id of the rating type assigned (integer)
  • titleTypeId - the id of the title type assigned (integer)
  • externalId (string)
  • firstName (string)
  • middleName (string)
  • lastName (string)
  • company (string)
  • dateOfBirth e.g. 1982-12-06T23:00:00 (dateTime)
  • username (string)
  • createDate - customer's creation date (dateTime)
  • lastUpdateDate - customer's last update date (dateTime)
  • wholesaler (boolean)
Get a customer's details
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the customer (integer)
  • siteId - the id of the site (integer)
  • customerTypeId - the id of the customer type assigned (integer)
  • leadSourceTypeId - the id of the lead source type assigned (integer)
  • industryTypeId - the id of the lead industry type assigned (integer)
  • ratingTypeId - the id of the rating type assigned (integer)
  • titleTypeId - the id of the title type assigned (integer)
  • externalId (string)
  • firstName (string)
  • middleName (string)
  • lastName (string)
  • company (string)
  • dateOfBirth e.g. 1982-12-06T23:00:00 (dateTime)
  • username (string)
  • createDate - customer's creation date (dateTime)
  • lastUpdateDate - customer's last update date (dateTime)
  • wholesaler (boolean)
Create a customer
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/customers/

Parameters

  • id - the id of the customer (integer)
  • siteId - the id of the site (integer)
  • customerTypeId - the id of the customer type assigned (integer)
  • leadSourceTypeId - the id of the lead source type assigned (integer)
  • industryTypeId - the id of the lead industry type assigned (integer)
  • ratingTypeId - the id of the rating type assigned (integer)
  • titleTypeId - the id of the title type assigned (integer)
  • externalId (string)
  • firstName (string)
  • middleName (string)
  • lastName (string)
  • company (string)
  • dateOfBirth e.g. 1982-12-06T23:00:00 (dateTime)
  • username (string)
  • createDate - customer's creation date (dateTime)
  • lastUpdateDate - customer's last update date (dateTime)
  • wholesaler (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit a customer's details
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/customers/[customer_ID]

Parameters

  • id - the id of the customer (integer)
  • siteId - the id of the site (integer)
  • customerTypeId - the id of the customer type assigned (integer)
  • leadSourceTypeId - the id of the lead source type assigned (integer)
  • industryTypeId - the id of the lead industry type assigned (integer)
  • ratingTypeId - the id of the rating type assigned (integer)
  • titleTypeId - the id of the title type assigned (integer)
  • externalId (string)
  • firstName (string)
  • middleName (string)
  • lastName (string)
  • company (string)
  • dateOfBirth e.g. 1982-12-06T23:00:00 (dateTime)
  • username (string)
  • createDate - customer's creation date (dateTime)
  • lastUpdateDate - customer's last update date (dateTime)
  • wholesaler (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete a customer record
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/customers/[customer_ID]

Response

Returns an empty body if successful or a detailed error message.


Get a customer's list of orders
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • assignedUserId - (integer)
  • categoryId - (integer)
  • countryCode - (string)
  • createDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • cycleTypeId - (integer)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • destinationAddressIsResidential - (boolean)
  • directDebitDays - (integer)
  • directDebitProcessed - (boolean)
  • directDebitTypeId - (integer)
    • 1 - Credit card
    • 2 - Direct debit
  • discountCodeId - (integer)
  • discountRate - (integer)
  • endRecurDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • entityId - (integer)
  • giftVoucherAmount - (integer)
  • giftVoucherId - (integer)
  • id - (integer)
  • integrationId - (integer)
  • invoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • invoiceNumber - (string)
  • invoiced - (boolean)
  • isIntermediate - (boolean)
  • lastUpdateDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • name - (string)
  • nextInvoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • parentId - (integer)
  • paymentMethodTypeId - (integer)
    • 1 - Credit card
    • 2 - Check
    • 3 - Cash
    • 4 - EFT
  • quote - (boolean)
  • recur - (boolean)
  • shippingAttention - (string)
  • shippingDescription - (string)
  • shippingInstructions - (string)
  • shippingOptionId - (integer)
  • shippingPrice - (integer)
  • shippingRateKey - (string)
  • shippingTaxRate - (integer)
  • siteId - (integer)
  • statusTypeId - (integer)
  • taxCodeId - (integer)
  • totalPrice - (integer)

Get a customer's secure zone subscriptions
Scroll upRead more...

Request

Response

The list of secure zones in JSON format.

  • customerid - the id of the customer(integer)
  • zoneId - the id of the secure zone (integer)
  • siteId - the id of the site (integer)
  • secureZone - the secure zone's properties (JSON)
Subscribe a customer to a secure zone
Scroll upRead more...

Request

Parameters

  • zoneId (integer)

Response

Returns an empty body if successful or a detailed error message.

Unsubscribe a customer from a secure zone
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.


Get a customer's address list
Scroll upRead more...

Request

Response

The list of addresses in JSON format.

  • addressId - the id of the address (integer)
  • siteId - the id of the site (integer)
  • customerId - the id of the CRM record (integer)
  • addressTypeId -the ID of the address type (integer)
    • 1 - Home address
    • 2 - Work address
    • 3 - PO box
    • 8 - Billing address
  • default - whether this is the record's default address (boolean)
  • address1 (string)
  • address2 (string)
  • zipCode (string)
  • suburb (string)
  • countryCode (string)
  • state (string)

e-Commerce

List the products of a site
Scroll upRead more...

Get all the products of your site.

Request

  • Method: GET
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path:
    /webresources/api/v3/sites/current/products

Response

An array of the first 10 items; each object has the following properties:

  • id - product ID (number)
  • siteId - site ID (number)
  • name - product's name (string)
  • roleId - the roleID of the user to be notified if the product is about to expire (-1 for none) (number)
  • weight - product's weight (number)
  • productCode - product's code (string)
  • keywords - product's keywords (string)
  • unitType - unitType (string)
  • smallImage - product's small image (string)
  • largeImage - product's large image (string)
  • description - product's description (string)
  • inventoryControl - whether this product has inventoryControl on or off (boolean)
  • canPreorder - whether this product can be pre ordered or not (boolean)
  • minUnits - minimum number of units that can be added to the cart (number)
  • maxUnits - maximum number of units that can be added to the cart (number)
  • inStock - number of items in stock (number)
  • onOrder - onOrder (number)
  • reOrder - reOrder (number)
  • reOrderNotified - reOrderNotified (boolean)
  • cycleTypeId - can be one of the following integers (number)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • variablePerCycle - variablePerCycle (boolean)
  • groupingID - the product's groupID (number)
  • GroupingDefault - GroupingDefault (boolean)
  • electronicProduct - whether or not this product is an e-Product (boolean)
  • displayFileName - product's display name (string)
  • size - size (number)
  • downloadLimitCount - download limit (only applies to e-Products) (number)
  • downloadLimitIp - download limit per IP (only applies to e-Products) (number)
  • productWeight - product weight (number)
  • productVolume - product volume (number)
  • productHeight - product height (number)
  • productDepth - product depth (number)
  • supplierEntityId - the supplier's entity ID (number)
  • supplierCommission - the supplier's commission (number)
  • isGiftVoucher - whether this product is to be used as a gift voucher (boolean)
  • poplets - the product's poplets(string)
  • attributes - deprecated, this is null by default, please use Product Attributes endpoint
  • custom1 - custom field 1 (string)
  • custom2 - custom field 2 (string)
  • custom3 - custom field 3 (string)
  • custom4 - custom field 4 (string)
  • releaseDate - product's release date (dateTime)
  • expiryDate - product's expiry date (dateTime)
  • createDate - product's creation date (dateTime)
  • lastUpdateDate - product's last update date (dateTime)
  • captureDetails - captureDetails (boolean)
  • isOnSale - whether this product is marked as "on sale" (boolean)
  • hideIfNoStock - hide product if stock is 0 (boolean)
  • enableDropShipping - enable drop shipping (boolean)
  • excludeFromSearch - exclude this product from search results(boolean)
  • enabled - enabled (boolean)
  • deleted - deleted (boolean)
  • title - product's title (string)
  • reIndex - reIndex (boolean)
  • hasAttributes - hasAttributes (boolean)
  • cycleTypeCount - cycleTypeCount (number)
  • hasVariations - whether the product has variations enabled(boolean)
  • slug - product's slug (string)
  • metaProductDescription - meta description (string)
  • canonicalUrl - product's url (if the product is placed in multiple catalogs the url of the default one will be used) (string)
  • absoluteCanonicalUrl - product's absolute url (string)
  • popletImage1 - product's poplet image 1 url (string)
  • popletImage2 - product's poplet image 2 url (string)
  • popletImage3 - product's poplet image 3 url (string)
  • popletImage4 - product's poplet image 4 url (string)
  • popletImage5 - product's poplet image 5 url (string)
  • popletImage6 - product's poplet image 6 url (string)
  • popletImage7 - product's poplet image 7 url (string)
  • popletImage8 - product's poplet image 8 url (string)
  • popletImage9 - product's poplet image 9 url (string)
  • popletImage10 - product's poplet image 10 url (string)
Get a product's details
Scroll upRead more...

Get one product and it's details.

Request

Response

Displays the details for the product as a JSON object

  • id - product ID (number)
  • siteId - site ID (number)
  • name - product's name (string)
  • roleId - the roleID of the user to be notified if the product is about to expire (-1 for none) (number)
  • weight - product's weight (number)
  • productCode - product's code (string)
  • keywords - product's keywords (string)
  • unitType - unitType (string)
  • smallImage - product's small image (string)
  • largeImage - product's large image (string)
  • description - product's description (string)
  • inventoryControl - whether this product has inventoryControl on or off (boolean)
  • canPreorder - whether this product can be pre ordered or not (boolean)
  • minUnits - minimum number of units that can be added to the cart (number)
  • maxUnits - maximum number of units that can be added to the cart (number)
  • inStock - number of items in stock (number)
  • onOrder - onOrder (number)
  • reOrder - reOrder (number)
  • reOrderNotified - reOrderNotified (boolean)
  • cycleTypeId - can be one of the following integers (number)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • variablePerCycle - variablePerCycle (boolean)
  • groupingID - the product's groupID (number)
  • GroupingDefault - GroupingDefault (boolean)
  • electronicProduct - whether or not this product is an e-Product (boolean)
  • displayFileName - product's display name (string)
  • size - size (number)
  • downloadLimitCount - download limit (only applies to e-Products) (number)
  • downloadLimitIp - download limit per IP (only applies to e-Products) (number)
  • productWeight - product weight (number)
  • productVolume - product volume (number)
  • productHeight - product height (number)
  • productDepth - product depth (number)
  • supplierEntityId - the supplier's entity ID (number)
  • supplierCommission - the supplier's commission (number)
  • isGiftVoucher - whether this product is to be used as a gift voucher (boolean)
  • poplets - the product's poplets(string)
  • attributes - deprecated, this is null by default, please use Product Attributes endpoint
  • custom1 - custom field 1 (string)
  • custom2 - custom field 2 (string)
  • custom3 - custom field 3 (string)
  • custom4 - custom field 4 (string)
  • releaseDate - product's release date (dateTime)
  • expiryDate - product's expiry date (dateTime)
  • createDate - product's creation date (dateTime)
  • lastUpdateDate - product's last update date (dateTime)
  • captureDetails - captureDetails (boolean)
  • isOnSale - whether this product is marked as "on sale" (boolean)
  • hideIfNoStock - hide product if stock is 0 (boolean)
  • enableDropShipping - enable drop shipping (boolean)
  • excludeFromSearch - exclude this product from search results(boolean)
  • enabled - enabled (boolean)
  • deleted - deleted (boolean)
  • title - product's title (string)
  • reIndex - reIndex (boolean)
  • hasAttributes - hasAttributes (boolean)
  • cycleTypeCount - cycleTypeCount (number)
  • hasVariations - whether the product has variations enabled(boolean)
  • slug - product's slug (string)
  • metaProductDescription - meta description (string)
  • canonicalUrl - product's url (if the product is placed in multiple catalogs the url of the default one will be used) (string)
  • absoluteCanonicalUrl - product's absolute url (string)
  • popletImage1 - product's poplet image 1 url (string)
  • popletImage2 - product's poplet image 2 url (string)
  • popletImage3 - product's poplet image 3 url (string)
  • popletImage4 - product's poplet image 4 url (string)
  • popletImage5 - product's poplet image 5 url (string)
  • popletImage6 - product's poplet image 6 url (string)
  • popletImage7 - product's poplet image 7 url (string)
  • popletImage8 - product's poplet image 8 url (string)
  • popletImage9 - product's poplet image 9 url (string)
  • popletImage10 - product's poplet image 10 url (string)
Create a product
Scroll upRead more...

Create a new product.

Request

Parameters

  • name - product's name (string)
  • roleId - the roleID of the user to be notified if the product is about to expire (-1 for none) (number)
  • weight - product's weight (number)
  • productCode - product's code (string)
  • keywords - product's keywords (string)
  • unitType - unitType (string)
  • smallImage - product's small image (string)
  • largeImage - product's large image (string)
  • description - product's description (string)
  • inventoryControl - whether this product has inventoryControl on or off (boolean)
  • canPreorder - whether this product can be pre ordered or not (boolean)
  • minUnits - minimum number of units that can be added to the cart (number)
  • maxUnits - maximum number of units that can be added to the cart (number)
  • inStock - number of items in stock (number)
  • onOrder - onOrder (number)
  • reOrder - reOrder (number)
  • reOrderNotified - reOrderNotified (boolean)
  • cycleTypeId - can be one of the following integers (number)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • variablePerCycle - variablePerCycle (boolean)
  • groupingID - the product's groupID (number)
  • GroupingDefault - GroupingDefault (boolean)
  • electronicProduct - whether or not this product is an e-Product (boolean)
  • displayFileName - product's display name (string)
  • size - size (number)
  • downloadLimitCount - download limit (only applies to e-Products) (number)
  • downloadLimitIp - download limit per IP (only applies to e-Products) (number)
  • productWeight - product weight (number)
  • productVolume - product volume (number)
  • productHeight - product height (number)
  • productDepth - product depth (number)
  • supplierEntityId - the supplier's entity ID (number)
  • supplierCommission - the supplier's commission (number)
  • isGiftVoucher - whether this product is to be used as a gift voucher (boolean)
  • poplets - the product's poplets(string)
  • attributes - deprecated, this is null by default, please use Product Attributes endpoint
  • custom1 - custom field 1 (string)
  • custom2 - custom field 2 (string)
  • custom3 - custom field 3 (string)
  • custom4 - custom field 4 (string)
  • releaseDate - product's release date (dateTime)
  • expiryDate - product's expiry date (dateTime)
  • createDate - product's creation date (dateTime)
  • lastUpdateDate - product's last update date (dateTime)
  • captureDetails - captureDetails (boolean)
  • isOnSale - whether this product is marked as "on sale" (boolean)
  • hideIfNoStock - hide product if stock is 0 (boolean)
  • enableDropShipping - enable drop shipping (boolean)
  • excludeFromSearch - exclude this product from search results(boolean)
  • enabled - enabled (boolean)
  • title - product's title (string)
  • reIndex - reIndex (boolean)
  • hasAttributes - hasAttributes (boolean)
  • cycleTypeCount - cycleTypeCount (number)
  • hasVariations - whether the product has variations enabled(boolean)
  • slug - product's slug (string)
  • metaProductDescription - meta description (string)
  • canonicalUrl - product's url (if the product is placed in multiple catalogs the url of the default one will be used) (string)
  • absoluteCanonicalUrl - product's absolute url (string)
  • popletImage1 - product's poplet image 1 url (string)
  • popletImage2 - product's poplet image 2 url (string)
  • popletImage3 - product's poplet image 3 url (string)
  • popletImage4 - product's poplet image 4 url (string)
  • popletImage5 - product's poplet image 5 url (string)
  • popletImage6 - product's poplet image 6 url (string)
  • popletImage7 - product's poplet image 7 url (string)
  • popletImage8 - product's poplet image 8 url (string)
  • popletImage9 - product's poplet image 9 url (string)
  • popletImage10 - product's poplet image 10 url (string)

Response

Returns an empty body if successful or a detailed error message.

Accepts JSON as Content-Type.

Important! This call creates the product, but doesn't actually upload any images. To do this, you'll need to generate a second request. Please see Upload product image.

Edit a product
Scroll upRead more...

Update an existing product.

Request

Parameters

  • name - product's name (string)
  • roleId - the roleID of the user to be notified if the product is about to expire (-1 for none) (number)
  • weight - product's weight (number)
  • productCode - product's code (string)
  • keywords - product's keywords (string)
  • unitType - unitType (string)
  • smallImage - product's small image (string)
  • largeImage - product's large image (string)
  • description - product's description (string)
  • inventoryControl - whether this product has inventoryControl on or off (boolean)
  • canPreorder - whether this product can be pre ordered or not (boolean)
  • minUnits - minimum number of units that can be added to the cart (number)
  • maxUnits - maximum number of units that can be added to the cart (number)
  • inStock - number of items in stock (number)
  • onOrder - onOrder (number)
  • reOrder - reOrder (number)
  • reOrderNotified - reOrderNotified (boolean)
  • cycleTypeId - can be one of the following integers (number)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • variablePerCycle - variablePerCycle (boolean)
  • groupingID - the product's groupID (number)
  • GroupingDefault - GroupingDefault (boolean)
  • electronicProduct - whether or not this product is an e-Product (boolean)
  • displayFileName - product's display name (string)
  • size - size (number)
  • downloadLimitCount - download limit (only applies to e-Products) (number)
  • downloadLimitIp - download limit per IP (only applies to e-Products) (number)
  • productWeight - product weight (number)
  • productVolume - product volume (number)
  • productHeight - product height (number)
  • productDepth - product depth (number)
  • supplierEntityId - the supplier's entity ID (number)
  • supplierCommission - the supplier's commission (number)
  • isGiftVoucher - whether this product is to be used as a gift voucher (boolean)
  • poplets - the product's poplets(string)
  • attributes - deprecated, this is null by default, please use Product Attributes endpoint
  • custom1 - custom field 1 (string)
  • custom2 - custom field 2 (string)
  • custom3 - custom field 3 (string)
  • custom4 - custom field 4 (string)
  • releaseDate - product's release date (dateTime)
  • expiryDate - product's expiry date (dateTime)
  • createDate - product's creation date (dateTime)
  • lastUpdateDate - product's last update date (dateTime)
  • captureDetails - captureDetails (boolean)
  • isOnSale - whether this product is marked as "on sale" (boolean)
  • hideIfNoStock - hide product if stock is 0 (boolean)
  • enableDropShipping - enable drop shipping (boolean)
  • excludeFromSearch - exclude this product from search results(boolean)
  • enabled - enabled (boolean)
  • deleted - deleted (boolean)
  • title - product's title (string)
  • reIndex - reIndex (boolean)
  • hasAttributes - hasAttributes (boolean)
  • cycleTypeCount - cycleTypeCount (number)
  • hasVariations - whether the product has variations enabled(boolean)
  • slug - product's slug (string)
  • metaProductDescription - meta description (string)
  • canonicalUrl - product's url (if the product is placed in multiple catalogs the url of the default one will be used) (string)
  • absoluteCanonicalUrl - product's absolute url (string)
  • popletImage1 - product's poplet image 1 url (string)
  • popletImage2 - product's poplet image 2 url (string)
  • popletImage3 - product's poplet image 3 url (string)
  • popletImage4 - product's poplet image 4 url (string)
  • popletImage5 - product's poplet image 5 url (string)
  • popletImage6 - product's poplet image 6 url (string)
  • popletImage7 - product's poplet image 7 url (string)
  • popletImage8 - product's poplet image 8 url (string)
  • popletImage9 - product's poplet image 9 url (string)
  • popletImage10 - product's poplet image 10 url (string)

 

Response

Returns an empty body if successful or a detailed error message.

Accepts JSON as Content-Type.

Delete a product
Scroll upRead more...

Delete an existing product.

Request

Response

Returns an empty body if successful or a detailed error message.

Upload image or electronic product
Scroll upRead more...

Upload images or e-product to an existing product.

Request

  • Method: PUT
  • Path:
    • /webresources/api/v3/sites/current/products/[product-id]?image=smallimage
    • /webresources/api/v3/sites/current/products/[product-id]?image=largeimage
    • /webresources/api/v3/sites/current/products/[product-id]?image=popletimage1
    • /webresources/api/v3/sites/current/products/[product-id]? ...
    • /webresources/api/v3/sites/current/products/[product-id]?image=popletimage10
    • /webresources/api/v3/sites/current/products/[product-id]?image=eproduct
  • Headers:
    • Authorization: This should contain the authorization token. Here is how to obtain the token.
    • Content-Type: application/octet-stream

Note: In order to be uploaded, the file path must be previously set in smallImage, largeImage, popletImage[N], displayFileName field. There are ten poplet images, from popletImage1 to popletImage10. Exception "Image path not found." will be thrown for negative case.

The electronic product can be of any extension but with a size limit of 250MB.

WARNING: The request will overwrite any file found at the image path.

Response

Returns an empty body if successful or a detailed error message.


Get prices
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • productId - the id of the price (numeric)
  • siteId - the id of the site (numeric)
  • countryCode (string)
  • taxCodeId - the ID of the tax code applied (numeric)
  • wTaxCodeId - the ID of the tax code applied for wholesalers (numeric)
  • retailPrice - the retail price (numeric)
  • salePrice - the sale price (numeric)
  • salePrice2 (numeric)
  • salePrice3 (numeric)
  • quantity2 - the 2-nd quantity threshold (if the volume discounts is enabled) (numeric)
  • quantity3 - the 3-rd quantity threshold (if the volume discounts is enabled)(numeric)
  • wSalePrice2 - the wholesaler sale price for the 2-nd threshold(numeric)
  • wSalePrice3 - the wholesaler sale price for the 3-rd threshold(numeric)
  • wQuantity2 - the 2-nd quantity threshold for wholesalers (if the volume discounts is enabled) (numeric)(numeric)
  • wQuantity3 - the 3-nd quantity threshold for wholesalers (if the volume discounts is enabled) (numeric)(numeric)

Get a product's prices
Scroll upRead more...

Request

Response

An array of the first 10 prices; each object has the following properties:

  • productId - product's ID (numeric)
  • siteId - current siteID (numeric)
  • countryCode - country code the priduct applies for (string)
  • taxCodeId - tax code ID associated (numeric)
  • wTaxCodeId - wholesaler tax code(numeric)
  • retailPrice - retail price (numeric)
  • salePrice - sale price (numeric)
  • wholesalerPrice - wholesaler price (numeric)
  • salePrice2 - sale price2 (numeric)
  • salePrice3 - sale price3 (numeric)
  • quantity2 - quantity threshold 2 (numeric)
  • quantity3 - quantity threshold 3(numeric)
  • wSalePrice - wholesaler sale price (numeric)
  • wSalePrice2 - wholesaler sale price 2 (numeric)
  • wSalePrice3 - wholesaler sale price 3 (numeric)
  • wQuantity2 - wholesaler quantity threshold 2 (numeric)
  • wQuantity3 - wholesaler quantity threshold 3 (numeric)

Get the orders that contain a particular product
Scroll upRead more...

Request

Response

An array of the first 10 prices; each object has the following properties:

  • id - (integer)
  • siteId - (integer)
  • entityId - (integer)
  • categoryId - (integer)
  • statusTypeId - (integer)
  • discountCodeId - (integer)
  • name - (string)
  • userIdAssignedTo - (integer)
  • countryCode - (string)
  • paymentMethodTypeId - (integer)
    • 1 - Credit card
    • 2 - Check
    • 3 - Cash
    • 4 - EFT
  • shippingPrice - (integer)
  • shippingTaxRate - (integer)
  • discountRate - (integer)
  • taxCodeId - (integer)
  • giftVoucherId - (integer)
  • giftVoucherAmount - (integer)
  • totalPrice - (integer)
  • shippingDescription - (string)
  • shippingOption - (integer)
  • shippingAttention - (string)
  • shippingInstructions - (string)
  • quote - (boolean)
  • invoiced - (boolean)
  • invoiceNumber - (string)
  • invoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • recur - (boolean)
  • nextInvoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • endRecurDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • cycleTypeID - (integer)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • directDebitTypeId - (integer)
    • 1 - Credit card
    • 2 - Direct debit
  • directDebitDays - (integer)
  • directDebitProcessed - (boolean)
  • ownBy - (integer)
  • ownByDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • deleted - (boolean)
  • integrationId - (integer)
  • parentId - (integer)
  • destinationAddressIsResidential - (boolean)
  • isIntermediate - (boolean)
  • shippingRateKey - (string)

Get variations
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the variation (integer)
  • siteId - the id of the site (integer)
  • label - the name of the customer Type (string)
  • default (boolean)
Create a new variation resource
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/variations

Parameters

  • label - the name of the variation resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit an variation resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/variations/[variation_ID]

Parameters

  • label - the name of the variation resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete an variation entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/variations/[variation_ID]

Response

Returns an empty body if successful or a detailed error message.


List all the variations on a site
Scroll upRead more...

Request

Response

An array of the first 10 variations; each object has the following properties:

  • id - product ID (number)
  • siteId - site ID (number)
  • productId - corresponding product's id (string)
  • sku - variations' SKU (string)
  • inStock - items in stock (number)
  • onOrder - items on order (number)
  • enabled - variation is enabled(string)
Get a product's variations
Scroll upRead more...

Request

Response

Displays the details for the variation as a JSON object

  • id - product ID (number)
  • siteId - site ID (number)
  • productId - corresponding product's id (string)
  • sku - variations' SKU (string)
  • inStock - items in stock (number)
  • onOrder - items on order (number)
  • enabled - variation is enabled(string)

List the catalogs of a site
Scroll upRead more...

Request

Response

An array of the first 10 catalogs; each object has the following properties:

  • id - catalog's id (numeric)
  • siteId - site's id (numeric)
  • parentId - the ID of this catalog's parent (-1 if this is a root level catalog) (numeric)
  • templateId - templateId (numeric)
  • roleId - the roleID of the user to be notified if the catalog is about to expire (-1 for none) (number)
  • displayTypeId - show prices to everybody or only to existing customers. Possible values are:
    • 1: everyone
    • 2: only existing customers
  • weight - catalog's weight (numeric)
  • name - catalog's name (string)
  • title - catalog's title (string)
  • description - catalog's description (string)
  • imageUrl - the path to the catalog's thumbnail (string)
  • releaseDate - catalog's release date (dateTime)
  • expiryDate - catalog's expiry date (dateTime)
  • notify - user to notify (numeric)
  • createDate - catalog's creation date (dateTime)
  • lastUpdateDate - catalog's last update date (dateTime)
  • useFriendlyUrl - catalog URL (string)
  • excludeFromFeed - whether the products in this catalog are included in the XML feed (boolean)
  • enabled - whether the catalog is enabled or not (boolean)
  • deleted - whether the catalog is deleted or not (boolean)
  • minPrice - browsepanel minimum price (numeric)
  • maxPrice - browsepanel maximum price (numeric)
  • priceSlots - the total number of slots in the browsepanel (numeric)
  • productsStatsXml - productsStatsXml (string)
  • url - catalog's url (string)
Get a catalog's attributes
Scroll upRead more...

Request

Response

Displays the details for the catalog as a JSON object

  • id - catalog's id (numeric)
  • siteId - site's id (numeric)
  • parentId - the ID of this catalog's parent (-1 if this is a root level catalog) (numeric)
  • templateId - templateId (numeric)
  • roleId - the roleID of the user to be notified if the catalog is about to expire (-1 for none) (number)
  • displayTypeId - show prices to everybody or only to existing customers. Possible values are:
    • 1: everyone
    • 2: only existing customers
  • weight - catalog's weight (numeric)
  • name - catalog's name (string)
  • title - catalog's title (string)
  • description - catalog's description (string)
  • imageUrl - the path to the catalog's thumbnail (string)
  • releaseDate - catalog's release date (dateTime)
  • expiryDate - catalog's expiry date (dateTime)
  • notify - user to notify (numeric)
  • createDate - catalog's creation date (dateTime)
  • lastUpdateDate - catalog's last update date (dateTime)
  • useFriendlyUrl - catalog URL (string)
  • excludeFromFeed - whether the products in this catalog are included in the XML feed (boolean)
  • enabled - whether the catalog is enabled or not (boolean)
  • deleted - whether the catalog is deleted or not (boolean)
  • minPrice - browsepanel minimum price (numeric)
  • maxPrice - browsepanel maximum price (numeric)
  • priceSlots - the total number of slots in the browsepanel (numeric)
  • productsStatsXml - productsStatsXml (string)
  • url - catalog's url (string)

List the products in a catalog
Scroll upRead more...

Request

Response

An array of the first 10 items; each object has the following properties:

  • id - product ID (number)
  • siteId - site ID (number)
  • name - product's name (string)
  • roleId - the roleID of the user to be notified if the product is about to expire (-1 for none) (number)
  • weight - product's weight (number)
  • productCode - product's code (string)
  • tags - product's tags (string)
  • unitType - unitType (string)
  • smallImage - product's smallImage (string)
  • largeImage - product's largeImage (string)
  • description - product's description (string)
  • inventoryControl - whether this product has inventoryControl on or off(boolean)
  • canPreorder - canPreorder (boolean)
  • minUnits - min number units that can be added to the cart (number)
  • maxUnits - max number units that can be added to the cart (number)
  • inStock - number of items in stock(number)
  • onOrder - onOrder (number)
  • reOrder - reOrder (number)
  • reOrderNotified - reOrderNotified (boolean)
  • variablePerCycle - variablePerCycle (boolean)
  • groupingID - the product's groupID (number)
  • GroupingDefault - GroupingDefault (boolean)
  • electronicProduct - whether or not this product is an e-Product (boolean)
  • displayFileName - product's display name (string)
  • size - size (number)
  • downloadLimitCount - download limit (only applies to e-Products) (number)
  • downloadLimitIp - download limit per IP (only applies to e-Products) (number)
  • productWeight - product weight (number)
  • productVolume - product volume (number)
  • productHeight - product height (number)
  • productDepth - product depth (number)
  • supplierEntityId - the supplier's entity ID (number)
  • supplierCommission - the supplier's commission (number)
  • isGiftVoucher - whether this product is to be used as a gift voucher (boolean)
  • poplets - the product's poplets(string)
  • attributes - product's attributes (string)
  • custom1 - custom field 1 (string)
  • custom2 - custom field 2 (string)
  • custom3 - custom field 3 (string)
  • custom4 - custom field 4 (string)
  • releaseDate - product's release date (dateTime)
  • expiryDate - product's expiry date (dateTime)
  • captureDetails - captureDetails (boolean)
  • isOnSale - whether this product is marked as "on sale" (boolean)
  • hideIfNoStock - hide product if stock is 0 (boolean)
  • enableDropShipping - enable drop shipping (boolean)
  • excludeFromSearch - exclude this product from search results(boolean)
  • enabled - enabled (boolean)
  • deleted - deleted (boolean)
  • title - product's title (string)
  • reIndex - reIndex (boolean)
  • hasAttributes - hasAttributes (boolean)
  • cycleTypeCount - cycleTypeCount (number)
  • hasVariations - whether the product has variations enabled(boolean)
  • url - product's url (if the product is placed in multiple catalogs the url of the default one will be used) (string)
  • metaProductDescription - metaProductDescription (string)

List the discount codes applied to a catalog
Scroll upRead more...

Request

Response

An array of the first 10 discount codes; each object has the following properties:

  • id - the id of the discount code (integer)
  • siteId - the id of the site (integer)
  • discountType - the type of the discount code (integer)
    • 1 - Percentage of Order
    • 2 - Fixed Dollar Amount
    • 3 - Free Shipping
  • code - the discount code's code(string)
  • description - the discount code's description (string)
  • discountPercentageOrFixedAmount - if the discount type is "1" this represents the percentage to be discounted. If the discount type is 1 or 2 this value is -1 (numeric)
  • discountThreshold - only apply this discount if the order's value is over this threshold (integer)
  • expireAfterXUses - the number of uses the discount code expires after (string)
  • releaseDate - the release date (dateTime)
  • expiryDate - the expiry date (dateTime)
  • enabled - whether the discount code is enabled or not (boolean)
Remove the discount code from a catalog
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/catalogs/
    [catalog_ID]discountCodeID_1catalogueId_2

Response

The response should be "204 no content" if the catalogues were successfully removed from list of catalogues discounted with this particular discount code.


List the shipping options marked to exclude catalog
Scroll upRead more...

Request

Response

An array of the first 10 discount codes; each object has the following properties:

  • id - the id of the shipping option (integer)
  • siteId - the id of the site (integer)
  • "description" - the shipping option's description (string)
  • "price" - (integer)
  • "type" - the type of shipping option (integer)
    • 1 - User defined
    • 2 - Australia Post
    • 3 - FedEx
    • 4 - USPS
    • 5 - Free shipping
    • 6 - DHL
    • 7 - UPS
  • "packageType" - (integer)
  • "taxCodeId" - (integer)
  • "countryCode" - (string)
  • "state" - (string)
  • "postcode" - (string)
  • "productMinWeight" - (integer)
  • "productMinVolume" - (integer)
  • "productMinHeight" - (integer)
  • "productMinDepth" - (integer)
  • "productMaxWeight" - (integer)
  • "productMaxVolume" - (integer)
  • "productMaxHeight" - (integer)
  • "productMaxDepth" - (integer)
  • "totalOrderPriceMin" - (integer)
  • "totalOrderPriceMax" - (integer)
  • "handlingBaseCharge" - (integer)
  • "handlingPerItemCharge" - (integer)
  • "freeThreshold" - (integer)
  • "limitDeliveryTo" - (string)
  • "userAccountNumber" - (string)
  • "userAccountId" - (string)
  • "userAccountKey" - (string)
  • "userAccountPassword" - (string)
  • "upsAccountType" - (integer)
  • "upsPackageType" - (integer)
  • "upsConfirmationType" - (integer)

List the shipping options in a site
Scroll upRead more...

Request

Response

An array of the first 10 shipping options; each object has the following properties:

  • id - the id of the shipping option (integer)
  • siteId - the id of the site (integer)
  • "description" - the shipping option's description (string)
  • "price" - (integer)
  • "type" - the type of shipping option (integer)
    • 1 - User defined
    • 2 - Australia Post
    • 3 - FedEx
    • 4 - USPS
    • 5 - Free shipping
    • 6 - DHL
    • 7 - UPS
  • "packageType" - (integer)
  • "taxCodeId" - (integer)
  • "countryCode" - (string)
  • "state" - (string)
  • "postcode" - (string)
  • "productMinWeight" - (integer)
  • "productMinVolume" - (integer)
  • "productMinHeight" - (integer)
  • "productMinDepth" - (integer)
  • "productMaxWeight" - (integer)
  • "productMaxVolume" - (integer)
  • "productMaxHeight" - (integer)
  • "productMaxDepth" - (integer)
  • "totalOrderPriceMin" - (integer)
  • "totalOrderPriceMax" - (integer)
  • "handlingBaseCharge" - (integer)
  • "handlingPerItemCharge" - (integer)
  • "freeThreshold" - (integer)
  • "limitDeliveryTo" - (string)
  • "userAccountNumber" - (string)
  • "userAccountId" - (string)
  • "userAccountKey" - (string)
  • "userAccountPassword" - (string)
  • "upsAccountType" - (integer)
  • "upsPackageType" - (integer)
  • "upsConfirmationType" - (integer)
Get a shipping option's attributes
Scroll upRead more...

Request

Response

Displays the details for the shipping option as a JSON object

  • id - the id of the shipping option (integer)
  • siteId - the id of the site (integer)
  • "description" - the shipping option's description (string)
  • "price" - (integer)
  • "type" - the type of shipping option (integer)
    • 1 - User defined
    • 2 - Australia Post
    • 3 - FedEx
    • 4 - USPS
    • 5 - Free shipping
    • 6 - DHL
    • 7 - UPS
  • "packageType" - (integer)
  • "taxCodeId" - (integer)
  • "countryCode" - (string)
  • "state" - (string)
  • "postcode" - (string)
  • "productMinWeight" - (integer)
  • "productMinVolume" - (integer)
  • "productMinHeight" - (integer)
  • "productMinDepth" - (integer)
  • "productMaxWeight" - (integer)
  • "productMaxVolume" - (integer)
  • "productMaxHeight" - (integer)
  • "productMaxDepth" - (integer)
  • "totalOrderPriceMin" - (integer)
  • "totalOrderPriceMax" - (integer)
  • "handlingBaseCharge" - (integer)
  • "handlingPerItemCharge" - (integer)
  • "freeThreshold" - (integer)
  • "limitDeliveryTo" - (string)
  • "userAccountNumber" - (string)
  • "userAccountId" - (string)
  • "userAccountKey" - (string)
  • "userAccountPassword" - (string)
  • "upsAccountType" - (integer)
  • "upsPackageType" - (integer)
  • "upsConfirmationType" - (integer)
Create a shipping option
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/shippingoptions

Note: Only "user-defined" type shipping ("type": 1) options can be added using this API endpoint.

Response

The response should be "201 created" if the shipping option was successfully created.

Here are the parameters you can use when creating a shipping option:

  • "description" - the shipping option's description (string)
  • "price" - (integer)
  • "type" - the type of shipping option (integer)
    • 1 - User defined
  • "taxCodeId" - (integer)
  • "countryCode" - (string)
  • "postcode" - (string)
Update an existing shipping option
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/shippingoptions/[shipping_option_ID]

Note: Only "user-defined" type shipping ("type": 1) options can be added using this API endpoint.

Response

The response should be "204 no content" if the shipping option was successfully modified.

Here are the parameters you can use when updating a shipping option:

  • "description" - the shipping option's description (string)
  • "price" - (integer)
  • "type" - the type of shipping option (integer)
    • 1 - User defined
  • "taxCodeId" - (integer)
  • "countryCode" - (string)
  • "postcode" - (string)
Delete a shipping option
Scroll upRead more...

This section details the endpoints you can use to delete a shipping option.

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/shippingoptions/[shipping_options_ID]

Response

The response should be "204 no content" if the shipping option was successfully deleted.


List the catalogs a shipping option is excluded from
Scroll upRead more...

Request

Response

An array of the first 10 catalogs the shipping option is applied to.

Exclude a catalog from a shipping option
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/shippingoptionscatalogues

Note: If the shipping option type is 3 (Free shipping) it cannot be applied to a catalog.

Response

The response should be "204 no content" if the shipping option was successfully applied to the catalog.

Remove an 'excluded catalog' entry from a shipping option
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/shippingoptions/[shippingOptionId]/excludedCatalogs?items=[{'optionId':
    option_Id_1catalogue_Id_1

Response

The response should be "204 no content" if the catalogues were successfully removed from list of catalogues discounted with this particular shipping option.


List the tax codes in a site
Scroll upRead more...

Request

Response

An array of the first 10 tax codes; each object has the following properties:

  • id - the id of the tax code (integer)
  • siteId - the id of the site (integer)
  • countryCode - the country code the tax is defined for(string)
  • code - the tax code's display name (string)
  • rate - the tax percentage (numeric)
Get a tax code's attributes
Scroll upRead more...

Request

Response

An array of the first 10 tax codes; each object has the following properties:

  • id - the id of the tax code (integer)
  • siteId - the id of the site (integer)
  • countryCode - the country code the tax is defined for(string)
  • code - the tax code's display name (string)
  • rate - the tax percentage (numeric)
Create a tax code
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/taxcodes

Response

The response should be "201 created" if the tax code was successfully created.

Here are the parameters you can use when creating a tax code:

  • countryCode - the country code the tax is defined for(string)
  • code - the tax code's display name (string)
  • rate - the tax percentage (numeric)
Update an existing tax code
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/taxcodes/[tax_code_ID]

Response

The response should be "204 no content" if the tax code was successfully modified.

Here are the parameters you can use when updating a tax code:

  • countryCode - the country code the tax is defined for(string)
  • code - the tax code's display name (string)
  • rate - the tax percentage (numeric)
Delete a tax code
Scroll upRead more...

This section details the endpoints you can use to delete a tax code.

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/taxcodes/[tax_code_ID]

Response

The response should be "204 no content" if the tax code was successfully deleted.


Orders

Get the order list
Scroll upRead more...

Request

Response

An array of the first 10 orders; each object has the following properties:

  • assignedUserId - (integer)
  • categoryId - (integer)
  • countryCode - (string)
  • createDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • cycleTypeId - (integer)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • destinationAddressIsResidential - (boolean)
  • directDebitDays - (integer)
  • directDebitProcessed - (boolean)
  • directDebitTypeId - (integer)
    • 1 - Credit card
    • 2 - Direct debit
  • discountCodeId - (integer)
  • discountRate - (integer)
  • endRecurDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • entityId - (integer)
  • giftVoucherAmount - (integer)
  • giftVoucherId - (integer)
  • id - (integer)
  • integrationId - (integer)
  • invoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • invoiceNumber - (string)
  • invoiced - (boolean)
  • isIntermediate - (boolean)
  • lastUpdateDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • name - (string)
  • nextInvoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • parentId - (integer)
  • paymentMethodTypeId - (integer)
    • 1 - Credit card
    • 2 - Check
    • 3 - Cash
    • 4 - EFT
  • quote - (boolean)
  • recur - (boolean)
  • shippingAttention - (string)
  • shippingDescription - (string)
  • shippingInstructions - (string)
  • shippingOptionId - (integer)
  • shippingPrice - (integer)
  • shippingRateKey - (string)
  • shippingTaxRate - (integer)
  • siteId - (integer)
  • statusTypeId - (integer)
  • taxCodeId - (integer)
  • totalPrice - (integer)
Get an order's details
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - (integer)
  • siteId - (integer)
  • entityId - (integer)
  • categoryId - (integer)
  • statusTypeId - (integer)
  • discountCodeId - (integer)
  • name - (string)
  • userIdAssignedTo - (integer)
  • countryCode - (string)
  • paymentMethodTypeId - (integer)
    • 1 - Credit card
    • 2 - Check
    • 3 - Cash
    • 4 - EFT
  • shippingPrice - (integer)
  • shippingTaxRate - (integer)
  • discountRate - (integer)
  • taxCodeId - (integer)
  • giftVoucherId - (integer)
  • giftVoucherAmount - (integer)
  • totalPrice - (integer)
  • shippingDescription - (string)
  • shippingOption - (integer)
  • shippingAttention - (string)
  • shippingInstructions - (string)
  • quote - (boolean)
  • invoiced - (boolean)
  • invoiceNumber - (string)
  • invoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • recur - (boolean)
  • nextInvoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • endRecurDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • cycleTypeID - (integer)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • directDebitTypeId - (integer)
    • 1 - Credit card
    • 2 - Direct debit
  • directDebitDays - (integer)
  • directDebitProcessed - (boolean)
  • ownBy - (integer)
  • ownByDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • deleted - (boolean)
  • integrationId - (integer)
  • parentId - (integer)
  • destinationAddressIsResidential - (boolean)
  • isIntermediate - (boolean)
  • shippingRateKey - (string)
Create a order
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orders

Parameters

  • name - (string)
  • entityId - (integer)
  • categoryId - (integer)
  • userIdAssignedTo - (integer)
  • statusTypeId - (integer)
  • countryCode - (string)
  • paymentMethodTypeId - (integer)
    • 1 - Credit card
    • 2 - Check
    • 3 - Cash
    • 4 - EFT
  • shippingPrice - (integer)
  • shippingTaxRate - (integer)
  • discountCodeId - (integer)
  • discountRate - (integer)
  • taxCodeId - (integer)
  • giftVoucherId - (integer)
  • giftVoucherAmount - (integer)
  • shippingDescription - (string)
  • shippingOption - (integer)
  • shippingAttention - (string)
  • shippingInstructions - (string)
  • invoiced - (boolean)
  • cycleTypeID - (integer)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • directDebitTypeId - (integer)
    • 1 - Credit card
    • 2 - Direct debit
  • directDebitDays - (integer)
  • integrationId - (integer)
  • destinationAddressIsResidential - (boolean)
  • isIntermediate - (boolean)
  • shippingRateKey - (string)

Response

Returns an empty body if successful or a detailed error message.

Edit an order's details
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orders/[order_ID]

Parameters

  • id - (integer)
  • siteId - (integer)
  • entityId - (integer)
  • categoryId - (integer)
  • statusTypeId - (integer)
  • discountCodeId - (integer)
  • name - (string)
  • userIdAssignedTo - (integer)
  • countryCode - (string)
  • paymentMethodTypeId - (integer)
    • 1 - Credit card
    • 2 - Check
    • 3 - Cash
    • 4 - EFT
  • shippingPrice - (integer)
  • shippingTaxRate - (integer)
  • discountRate - (integer)
  • taxCodeId - (integer)
  • giftVoucherId - (integer)
  • giftVoucherAmount - (integer)
  • totalPrice - (integer)
  • shippingDescription - (string)
  • shippingOption - (integer)
  • shippingAttention - (string)
  • shippingInstructions - (string)
  • quote - (boolean)
  • invoiced - (boolean)
  • invoiceNumber - (string)
  • invoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • recur - (boolean)
  • nextInvoiceDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • endRecurDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • cycleTypeID - (integer)
    • 1 - Once
    • 2 - Daily
    • 3 - Weekly
    • 4 - Fortnightly
    • 5 - Monthly
    • 6 - Quarterly
    • 7 - Half Yearly
    • 8 - Yearly
  • directDebitTypeId - (integer)
    • 1 - Credit card
    • 2 - Direct debit
  • directDebitDays - (integer)
  • directDebitProcessed - (boolean)
  • ownBy - (integer)
  • ownByDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • deleted - (boolean)
  • integrationId - (integer)
  • parentId - (integer)
  • destinationAddressIsResidential - (boolean)
  • isIntermediate - (boolean)
  • shippingRateKey - (string)

Response

Returns an empty body if successful or a detailed error message.

Delete an order
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orders/[order_ID]

Response

Returns an empty body if successful or a detailed error message.

Order print support
Scroll upRead more...

Get an order's products
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • itemId - the address ID (integer)
  • orderId - the order's ID (integer)
  • productId - the address ID (integer)
  • siteId - the site's ID (integer)
  • catalogueId - the product's catalog ID(integer)
  • units - the number of units added to the order (integer)
  • unitPrice - price per unit (integer)
  • unitTaxRate - the tax per unit (integer)
  • discountRate - (integer)
  • totalPrice - (integer)
  • description - (string)
  • supplierCommission- (integer)
  • deleted - (boolean)
  • attributeExtras - (integer)
  • variationId - (integer)
  • product - (JSON)
    • id - (integer)
    • siteId - (integer)
    • name - (string)
    • roleId - (integer)
    • weight - (integer)
    • productCode - (string)
    • tags - (string)
    • unitType - (string)
    • smallImage - (string)
    • largeImage - (string)
    • description - (string)
    • inventoryControl - (boolean)
    • canPreorder - (boolean)
    • minUnits - (integer)
    • maxUnits - (integer)
    • inStock - (integer)
    • onOrder - (integer)
    • reOrder - (integer)
    • reOrderNotified - (boolean)
    • variablePerCycle - (boolean)
    • groupingID - (integer)
    • GroupingDefault - (boolean)
    • electronicProduct - (boolean)
    • displayFileName - (string)
    • size - (integer)
    • downloadLimitCount - (integer)
    • downloadLimitIp - (integer)
    • productWeight - (integer)
    • productVolume - (integer)
    • productHeight - (integer)
    • productDepth - (integer)
    • supplierEntityId - (integer)
    • supplierCommission - (integer)
    • isGiftVoucher - (boolean)
    • poplets - ()
    • attributes - ()
    • custom1 - (string)
    • custom2 - (string)
    • custom3 - (string)
    • custom4 - (string)
    • releaseDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
    • expiryDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
    • captureDetails - (boolean)
    • isOnSale - (boolean)
    • hideIfNoStock - (boolean)
    • enableDropShipping - (boolean)
    • excludeFromSearch - (boolean)
    • enabled - (boolean)
    • deleted - (boolean)
    • title - (string)
    • reIndex - (boolean)
    • hasAttributes - (boolean)
    • cycleTypeCount - (integer)
    • hasVariations - (boolean)
    • slug - (string)
    • metaProductDescription - (string)
Add products to an order
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orders/[ORDER_ID]/products

Parameters

  • itemId - the item's ID, this is used to identify this particular order item. For example if you need to delete an element from an order you would reffer it using this ID(integer)
  • orderId - the order's ID (integer)
  • productId - the address ID (integer)
  • siteId - the site's ID (integer)
  • catalogueId - the product's catalog ID (integer)
  • units - the number of units added to the order (integer)
  • unitPrice - price per unit (integer)
  • unitTaxRate - the tax per unit (integer)
  • discountRate - (integer)
  • totalPrice - (integer)
  • description - (string)
  • supplierCommission- (integer)
  • deleted - (boolean)
  • attributeExtras - (integer)
  • variationId - (integer)

Response

Returns an empty body if successful or a detailed error message.

Remove products from an order
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orders/[ORDER_ID]/products?items=[ITEM_ID]

Response

Returns an empty body if successful or a detailed error message.


Get orderStatuses
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the order status (integer)
  • siteId - the id of the site (integer)
  • label - the name of the orderstatus (string)
  • default (boolean)
Create a new orderStatus item
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orderstatuses

Parameters

  • label - the name of the orderStatus resource (string)
  • default (boolean)
  • notifyCustomer - whether to notify the customer as the order status is changed (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit an orderStatus resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orderstatuses/[customerType_ID]

Parameters

  • label - the name of the orderStatus resource (string)
  • default (boolean)
  • notifyCustomer - whether to notify the customer as the order status is changed (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete an orderStatus entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/orderstatuses/[customerType_ID]

Response

Returns an empty body if successful or a detailed error message.


Get an order's addresses
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the address ID (integer)
  • siteId - the site's ID (integer)
  • addresstype - the type of address (integer)
    • 5 - Shipping address
    • 6 - Pickup address
    • 8 - Billing address
  • objectId - the order's object id (integer)
  • default - whether this address is marked as default (boolean)
  • address1 - (string)
  • address2 - (string)
  • zipCode - (string)
  • suburb - (string)
  • countryCode- (string)
  • state - (string)

Events, Media downloads, News, FAQs, RSS and Tags

Get events
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the event (integer)
  • siteId - the id of the site (integer)
  • name - the name of the customer Type (string)
  • body (string)
  • date (dateTime)
  • capacity (numeric)
  • hideWhenFull (boolean)
  • disabled (boolean)
  • deleted (boolean)
  • requiresPayment (boolean)
  • CreateDate (dateTime)
  • lastUpdateDate (dateTime)
Create a new event resource
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/bookings

Parameters

  • id - the id of the event (integer)
  • siteId - the id of the site (integer)
  • name - the name of the customer Type (string)
  • body (string)
  • date (dateTime)
  • capacity (numeric)
  • hideWhenFull (boolean)
  • disabled (boolean)
  • deleted (boolean)
  • requiresPayment (boolean)
  • CreateDate (dateTime)
  • lastUpdateDate (dateTime)

Response

Returns an empty body if successful or a detailed error message.

Edit an event resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/bookings/[event_ID]

Parameters

  • id - the id of the event (integer)
  • siteId - the id of the site (integer)
  • name - the name of the customer Type (string)
  • body (string)
  • date (dateTime)
  • capacity (numeric)
  • hideWhenFull (boolean)
  • disabled (boolean)
  • deleted (boolean)
  • requiresPayment (boolean)
  • CreateDate (dateTime)
  • lastUpdateDate (dateTime)

Response

Returns an empty body if successful or a detailed error message.

Delete an event entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/bookings/[event_ID]

Response

Returns an empty body if successful or a detailed error message.


Get Media downloads
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the media download item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • name - name of the media download(string)
  • literatureTypeId - type of item - mp3, pdf, etc.(integer)
    • 1 - Adobe Acrobat
    • 2 - Microsoft Word
    • 4 - Microsoft Excel
    • 5 - Microsoft Access
    • 6 - Archive File
    • 7 - Help File
    • 8 - Microsoft PowerPoint
    • 9 - Microsoft Project
    • 10 - Microsoft Visio
    • 11 - Text File
    • 12 - Word Perfect
    • 13 - Executable File
    • 14 - MP3
    • 16 - Windows Media
    • 17 - Real Audio
    • 18 - Adobe Flash
    • 19 - Other
    • 20 - MP3 (Streaming)
    • 21 - MP4 (Streaming)
    • 22 - M4A (Streaming)
    • 23 - MOV (Streaming)
    • 24 - M4V (Streaming)
  • description - item description(string)
  • displayFileName - file name to be displayed(string)
  • size - physical size on disk(integer)
  • weight - priority(integer)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • createBy - admin user that created the item(integer)
  • createDate - date of news item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • displayable - display state, true or false(boolean)
  • reindex - reindex content, true/false(boolean)
  • excludeFromSearch - exclude from search(boolean)
  • uploadedContentType - effective content type(string)
  • downloadUrl - download url(string)
  • literatureType - literature type name(literaturetypes)
  • role - role set as responsible for item(userroles)
Create a new Media Download
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/mediadownloads

Parameters

  • id - the id of the media download item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • name - name of the media download(string)
  • literatureTypeId - type of item - mp3, pdf, etc.(integer)
    • 1 - Adobe Acrobat
    • 2 - Microsoft Word
    • 4 - Microsoft Excel
    • 5 - Microsoft Access
    • 6 - Archive File
    • 7 - Help File
    • 8 - Microsoft PowerPoint
    • 9 - Microsoft Project
    • 10 - Microsoft Visio
    • 11 - Text File
    • 12 - Word Perfect
    • 13 - Executable File
    • 14 - MP3
    • 16 - Windows Media
    • 17 - Real Audio
    • 18 - Adobe Flash
    • 19 - Other
    • 20 - MP3 (Streaming)
    • 21 - MP4 (Streaming)
    • 22 - M4A (Streaming)
    • 23 - MOV (Streaming)
    • 24 - M4V (Streaming)
  • description - item description(string)
  • displayFileName - file name to be displayed(string)
  • size - physical size on disk(integer)
  • weight - priority(integer)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • createBy - admin user that created the item(integer)
  • createDate - date of news item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • displayable - display state, true or false(boolean)
  • reindex - reindex content, true/false(boolean)
  • excludeFromSearch - exclude from search(boolean)
  • uploadedContentType - effective content type(string)
  • downloadUrl - download url(string)
  • literatureType - literature type name(literaturetypes)
  • role - role set as responsible for item(userroles)

Response

Returns an empty body if successful or a detailed error message.

Edit a media download
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/mediadownloads/[mediadownloadsId]

Parameters

  • id - the id of the media download item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • name - name of the media download(string)
  • literatureTypeId - type of item - mp3, pdf, etc.(integer)
  • description - item description(string)
  • displayFileName - file name to be displayed(string)
  • size - physical size on disk(integer)
  • weight - priority(integer)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • createBy - admin user that created the item(integer)
  • createDate - date of news item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • displayable - display state, true or false(boolean)
  • reindex - reindex content, true/false(boolean)
  • excludeFromSearch - exclude from search(boolean)
  • uploadedContentType - effective content type(string)
  • downloadUrl - download url(string)
  • literatureType - literature type name(literaturetypes)
  • role - role set as responsible for item(userroles)

Response

Returns an empty body if successful or a detailed error message.

Delete an FAQ item
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/mediadownloads/[mediadownloadsId]

Response

Returns an empty body if successful or a detailed error message.


Get News
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the news item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • subject - question body(string)
  • body - answer body(string)
  • templateId - template assigned to news(integer)
  • weight - weight value(integer)
  • createBy - admin user id(integer)
  • createDate - date of news item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • eventFromDate - associated start date(datetime)
  • eventToDate - associated end date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • displayable display state, true or false(boolean)
  • parentId id of parent node(integer)
  • urlPrefix URL prefix(string)
  • slug item slug(string)
  • url full item url(string)
Create a new News item
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/faqs

Parameters

  • id - the id of the news item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • subject - question body(string)
  • body - answer body(string)
  • templateId - template assigned to news(integer)
  • weight - weight value(integer)
  • createBy - admin user id(integer)
  • createDate - date of news item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • eventFromDate - associated start date(datetime)
  • eventToDate - associated end date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • displayable display state, true or false(boolean)
  • parentId id of parent node(integer)
  • urlPrefix URL prefix(string)
  • slug item slug(string)
  • url full item url(string)

Response

Returns an empty body if successful or a detailed error message.

Edit a news resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/news/[newsId]

Parameters

  • id - the id of the news item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • subject - question body(string)
  • body - answer body(string)
  • templateId - template assigned to news(integer)
  • weight - weight value(integer)
  • createBy - admin user id(integer)
  • createDate - date of news item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • eventFromDate - associated start date(datetime)
  • eventToDate - associated end date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • displayable display state, true or false(boolean)
  • parentId id of parent node(integer)
  • urlPrefix URL prefix(string)
  • slug item slug(string)
  • url full item url(string)

Response

Returns an empty body if successful or a detailed error message.

Delete an FAQ item
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/news/[faqId]

Response

Returns an empty body if successful or a detailed error message.


List the secure zones a news item is added into
Scroll upRead more...

Request

Response

An array of the first 10 securezones assigned to the news item; each object has the following properties:

  • id - the id of the secure zone (integer)
  • siteId - the id of the site (integer)
  • landingPageId - the ID of the secure zone's landing page (string)
  • name - the name of the secure zone (string)
  • sellAccess - whether you charge the customers who get access to the secure zone or not (boolean)
  • costPerPeriod - the membership cost amount (integer)
  • orderCountryCode - the currency to use when charging the customers for access(string)
  • cycleType - the frequency of membership renewal (integer)
    • "1" Once
    • "2" Daily
    • "3" Weekly
    • "4" Fortnightly
    • "5" Monthly
    • "6" Quarterly
    • "7" Half Yearly
    • "8" Yearly
  • createDate - the date the secure zone was created (string)
  • lastUpdateDate - the date the secure zone was last updated (string)
Add a news item to a secure zone
Scroll upRead more...

Request

  • Method: POST
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

  • Path:
    /webresources/api/v3/sites/current/news/[news_ID]/securezones
  • Data: This should contain a stringified, valid json object containing an array of objects with key "zoneId" and value of a valid secure zone id

Response

Returns an empty body if successful or a detailed error message.

Remove a news item from a secure zone
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.


Get FAQs
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the faq item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • question - question body(string)
  • answer - answer body(string)
  • internalNotes admin-only visible notes(string)
  • templateId - template assigned to faq(integer)
  • weight - weight value(integer)
  • createBy - admin user id(integer)
  • createDate - date of faq item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • displayable display state, true or false(boolean)
  • reIndex trigger reindex, true or false(boolean)
Create a new FAQ item
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/faqs

Parameters

  • id - the id of the faq item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • question - question body(string)
  • answer - answer body(string)
  • internalNotes admin-only visible notes(string)
  • templateId - template assigned to faq(integer)
  • weight - weight value(integer)
  • createBy - admin user id(integer)
  • createDate - date of faq item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • displayable display state, true or false(boolean)
  • reIndex trigger reindex, true or false(boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit an anniversary resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/faqs/[faqId]

Parameters

  • id - the id of the faq item(integer)
  • siteId - the id of the site(integer)
  • roleId - id of the role responsible(integer)
  • question - question body(string)
  • answer - answer body(string)
  • internalNotes admin-only visible notes(string)
  • templateId - template assigned to faq(integer)
  • weight - weight value(integer)
  • createBy - admin user id(integer)
  • createDate - date of faq item creation(datetime)
  • latUpdateBy - admin user that performed latest update(integer)
  • lastUpdateDate - most recent update date(datetime)
  • releaseDate release date(datetime)
  • expiryDate - date of item expiry(datetime)
  • enabled - active state, true or false(boolean)
  • deleted deleted state, true or false(boolean)
  • displayable display state, true or false(boolean)
  • reIndex trigger reindex, true or false(boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete an FAQ item
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/faqs/[faqId]

Response

Returns an empty body if successful or a detailed error message.


List all RSS channels
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • Id - the id of the RSS channel(integer)
  • siteId - the id of the site (integer)
  • title - the RSS channel's name(integer)
  • description - the RSS channel's description (integer)
  • maxFeedEntries - the update frequency of the channel (integer)
    • 15 - Several times a week
    • 30 - Once a day
    • 50 - Many times a day
    • 100 - Wildfire!
  • createBy - the id of the entity that created the channel (number)
  • createDate - the name of the customer Type (dateTime)
  • lastUpdateBy - the id of the entity that did the last modification (number)
  • lastUpdateDate - the name of the customer Type (dateTime)
  • enabled - enabled (boolean)
Get a RSS channel
Scroll upRead more...

Request

  • Method: GET
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/
    rsschannels[rsschannel_ID]

Parameters

  • Id - the id of the RSS channel(integer)
  • siteId - the id of the site (integer)
  • title - the RSS channel's name(integer)
  • description - the RSS channel's description (integer)
  • maxFeedEntries - the update frequency of the channel (integer)
    • 15 - Several times a week
    • 30 - Once a day
    • 50 - Many times a day
    • 100 - Wildfire!
  • createBy - the id of the entity that created the channel (number)
  • createDate - the name of the customer Type (dateTime)
  • lastUpdateBy - the id of the entity that did the last modification (number)
  • lastUpdateDate - the name of the customer Type (dateTime)
  • enabled - enabled (boolean)

Response

Returns an empty body if successful or a detailed error message.


List all the tags of a site
Scroll upRead more...

Request

Response

An array of the first 10 tags; each object has the following properties:

  • id - the tag's ID (numeric)
  • siteId - the site's ID (numeric)
  • tagName -the tag's name (string)
Create a tag
Scroll upRead more...

Request

Parameters

  • siteId - the site's ID (numeric)
  • tagName -the tag's name (string)
Edit a tag
Scroll upRead more...

Request

Parameters

  • tagName -the tag's name (string)

Response

Returns an empty body if successful or a detailed error message.

Delete tags
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.


types

Get titleTypes
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the ratingType (integer)
  • siteId - the id of the site (integer)
  • label - the name of the customer Type (string)
  • default (boolean)
Create a new ratingType resource
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/titleTypes

Parameters

  • label - the name of the ratingType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit a ratingType resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/titleTypes/[customerType_ID]

Parameters

  • label - the name of the ratingType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete a ratingType entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/titleTypes/[customerType_ID]

Response

Returns an empty body if successful or a detailed error message.


Get ratingTypes
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the ratingType (integer)
  • siteId - the id of the site (integer)
  • label - the name of the customer Type (string)
  • default (boolean)
Create a new ratingType resource
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/ratingTypes

Parameters

  • label - the name of the ratingType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit a ratingType resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/ratingTypes/[customerType_ID]

Parameters

  • label - the name of the ratingType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete a ratingType entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/ratingTypes/[customerType_ID]

Response

Returns an empty body if successful or a detailed error message.


Get leadsourcetypes
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the leadsourceType (integer)
  • siteId - the id of the site (integer)
  • label - the name of the customer Type (string)
  • default (boolean)
Create a new leadsourceType resource
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/leadsourcetypes

Parameters

  • label - the name of the leadsourceType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit a leadsourceType resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/leadsourcetypes/[customerType_ID]

Parameters

  • label - the name of the leadsourceType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete a leadsourceType entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/leadsourcetypes/[customerType_ID]

Response

Returns an empty body if successful or a detailed error message.


Get industry Types
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the industryType (integer)
  • siteId - the id of the site (integer)
  • label - the name of the customer Type (string)
  • default (boolean)
Create a new industryType resource
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/industrytypes

Parameters

  • label - the name of the industryType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit an industryType resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/industrytypes/[industryType_ID]

Parameters

  • label - the name of the industryType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete an industryType entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/industrytypes/[industryType_ID]

Response

Returns an empty body if successful or a detailed error message.


Get customer Types
Scroll upRead more...

Request

Response

The details for the specified customer ID in JSON format.

  • id - the id of the customer Type (integer)
  • siteId - the id of the site (integer)
  • label - the name of the customer Type (string)
  • default (boolean)
Create a new customer Type resource
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/customertypes

Parameters

  • label - the name of the customerType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Edit a customer Type resource
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/customertypes/[customerType_ID]

Parameters

  • label - the name of the customerType resource (string)
  • default (boolean)

Response

Returns an empty body if successful or a detailed error message.

Delete a customer Type entity
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/customertypes/[customerType_ID]

Response

Returns an empty body if successful or a detailed error message.


Pages and templates

List available webpages and get their attributes
Scroll upRead more...

Request

Response

An array of the first 10 web pages; each object has the following properties:

  • id - the page's ID (number)
  • siteId - the ID of the site the page is on (number)
  • workflowId - the ID of the workflow assigned (-1 of the page does not have a workflow assigned) (number)
  • roleId - the ID of the role responsible (-1 if not applicable) (number)
  • templateId - the ID of the template (-1 if no template is applied or 0 to use the default template) (number)
  • parentId - the ID of the parent page (-1 if no page is applied or 0 to use the default template) (number)
  • livePageId - only applicable if the "displayable" parameter is "true" (meaning this is a draft page). The "livePageId" is the ID of the live page. (number)
  • pageUrl - the page's url (string)
  • name - the page's name (string)
  • displayFileName - the page's display name (string)
  • size - the page's size (number)
  • enabled - whether the page is enabled or not (boolean)
  • startPage - whether the page is set as start page(boolean)
  • createDate - the creation date of the page (dateTime)
  • lastUpdateDate - the last update date of the page (dateTime)
  • releaseDate - the release date of the page (dateTime)
  • expiryDate - the expiry date of the page (dateTime)
  • displayable - whether the page is live or it is a draft page (boolean)
  • excludeFromSearch - whether to exclude the page from the site search (boolean)
  • content - the content of the page HTML encoded (string)
  • redirect301 - the URL this page should 301 redirect to (string)
  • title - the page's title (string)
  • seoMetadataDescription - the page's SEO meta description (string)
Get a webpage's attributes
Scroll upRead more...

Request

Response

Returns the properties below for a single page:

  • id - the page's ID (number)
  • siteId - the ID of the site the page is on (number)
  • workflowId - the ID of the workflow assigned (-1 of the page does not have a workflow assigned) (number)
  • roleId - the ID of the role responsible (-1 if not applicable) (number)
  • templateId - the ID of the template (-1 if no template is applied or 0 to use the default template) (number)
  • parentId - the ID of the parent page (-1 if no page is applied or 0 to use the default template) (number)
  • livePageId - only applicable if the "displayable" parameter is "true" (meaning this is a draft page). The "livePageId" is the ID of the live page. (number)
  • pageUrl - the page's url (string)
  • name - the page's name (string)
  • displayFileName - the page's display name (string)
  • size - the page's size (number)
  • enabled - whether the page is enabled or not (boolean)
  • startPage - whether the page is set as start page(boolean)
  • createDate - the creation date of the page (dateTime)
  • lastUpdateDate - the last update date of the page (dateTime)
  • releaseDate - the release date of the page (dateTime)
  • expiryDate - the expiry date of the page (dateTime)
  • displayable - whether the page is live or it is a draft page (boolean)
  • excludeFromSearch - whether to exclude the page from the site search (boolean)
  • content - the content of the page HTML encoded (string)
  • redirect301 - the URL this page should 301 redirect to (string)
  • title - the page's title (string)
  • seoMetadataDescription - the page's SEO meta description (string)
Create new live and draft pages
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/pages

Response

The response should be "201 created" if the page was successfully created.

Here are the parameters you can use when creating a page:

  • siteId - the ID of the site the page is on (number)
  • workflowId - the ID of the workflow assigned (-1 of the page does not have a workflow assigned) (number)
  • roleId - the ID of the role responsible (-1 if not applicable) (number)
  • templateId - the ID of the template (-1 if no template is applied or 0 to use the default template) (number)
  • parentId - the ID of the parent page (-1 if no page is applied or 0 to use the default template) (number)
  • livePageId - only applicable if the "displayable" parameter is "true" (meaning this is a draft page). The "livePageId" is the ID of the live page. (number)
  • pageUrl - the page's url (string)
  • name - the page's name (string)
  • displayFileName - the page's display name (string)
  • size - the page's size (number)
  • enabled - whether the page is enabled or not (boolean)
  • startPage - whether the page is set as start page(boolean)
  • createDate - the creation date of the page (dateTime)
  • lastUpdateDate - the last update date of the page (dateTime)
  • releaseDate - the release date of the page (dateTime)
  • expiryDate - the expiry date of the page (dateTime)
  • displayable - whether the page is live or it is a draft page (boolean)
  • excludeFromSearch - whether to exclude the page from the site search (boolean)
  • content - the content of the page HTML encoded (string)
  • redirect301 - the URL this page should 301 redirect to (string)
  • title - the page's title (string)
  • seoMetadataDescription - the page's SEO meta description (string)
Edit an existing page
Scroll upRead more...

Request

  • Method: GET
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/templates

Response

The response should be "204 no content" if the secure zone was successfully modified.

Here are the parameters you can use when updating a page:

  • siteId - the ID of the site the page is on
  • url - the page's URL
  • name - the page's NAME
  • deleted - whether the page is deleted or not
  • categoryId - the ID of the workflow assigned (-1 of the page does not have a workflow assigned)
  • roleId - the ID of the role responsible (-1 if not applicable)
  • templateId - the ID of the template (-1 if no template is applied or 0 to use the default template)
  • displayFileName - the page's display name
  • size - the page's size
  • enabled - whether the page is enabled or not
  • startPage - whether the page is set as start page
  • releaseDate - the release date of the page
  • expiryDate - the expiry date of the page
  • displayable - whether the page is live or it is a draft page
  • excludeFromSearch - whether to exclude the page from the site search
  • livePageId - only applicable if the "displayable" parameter is "true" (meaning this is a draft page). The "livePageId" is the ID of the live page.
  • content - the content of the page HTML encoded
  • redirect301 - the URL this page should 301 redirect to
  • title - the page's title
  • seoMetadataDescription - the page's SEO meta description
Delete a webpage
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/pages/[page_ID]

Response

The response should be "204 no content" if the page was successfully deleted.


Get the list of templates
Scroll upRead more...

Request

Response

An array of templates, each object has the following properties:

  • id - the id of the template in the current site (integer)
  • siteId- the id of the site (integer)
  • categoryId - the ID of the workflow assigned (integer)
  • name - the name of the template (string)
  • displayFileName - the name of the file on the filesystem (string)
  • printerView - whether this is marked as "Printer View" (boolean)
  • displayable - whether the template is live or draft (boolean)
  • enabled - whether the template is enabled or not (boolean)
  • liveTemplateId - if the template is in draft mode this is the ID of the live template it corresponds to (integer).
  • noHeaders - whether this template has the "No HEAD elements" option checked or not(boolean)
Get a template's details
Scroll upRead more...

Request

Response

An array of templates, each object has the following properties:

  • id - the id of the template in the current site (integer)
  • siteId- the id of the site (integer)
  • categoryId - the ID of the workflow assigned (integer)
  • name - the name of the template (string)
  • displayFileName - the name of the file on the filesystem (string)
  • printerView - whether this is marked as "Printer View" (boolean)
  • displayable - whether the template is live or draft (boolean)
  • enabled - whether the template is enabled or not (boolean)
  • liveTemplateId - if the template is in draft mode this is the ID of the live template it corresponds to (integer).
  • noHeaders - whether this template has the "No HEAD elements" option checked or not(boolean)
Create a template
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/templates/

Parameters

  • categoryId - the ID of the workflow assigned (integer)
  • name - the name of the template (string)
  • displayFileName - the name of the file on the filesystem (string)
  • printerView - whether this is marked as "Printer View" (boolean)
  • displayable - whether the template is live or draft (boolean)
  • enabled - whether the template is enabled or not (boolean)
  • liveTemplateId - if the template is in draft mode this is the ID of the live template it corresponds to (integer).

    In the Admin Console the live and draft versions of a template appear to be one entity. The system however, saves two different templates. One represents the draft version and a completely different template that represents the live version. This parameter is used to "connect" the two templates that basically represent the two states - live and draft.

  • noHeaders - whether this template has the "No HEAD elements" option checked or not(boolean)
  • desktopContent -the template's content (string)

Response

Returns an empty body if successful or a detailed error message.

Edit a template
Scroll upRead more...

Request

  • Method: PUT
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/templates/[template_ID]

Parameters

  • id - the id of the template in the current site (integer)
  • siteId- the id of the site (integer)
  • categoryId - the ID of the workflow assigned (integer)
  • name - the name of the template (string)
  • displayFileName - the name of the file on the filesystem (string)
  • printerView - whether this is marked as "Printer View" (boolean)
  • displayable - whether the template is live or draft (boolean)
  • enabled - whether the template is enabled or not (boolean)
  • liveTemplateId - if the template is in draft mode this is the ID of the live template it corresponds to (integer).

    In the Admin Console the live and draft versions of a template appear to be one entity. The system however, saves two different templates. One represents the draft version and a completely different template that represents the live version. This parameter is used to "connect" the two templates that basically represent the two states - live and draft.

  • noHeaders - whether this template has the "No HEAD elements" option checked or not(boolean)
  • desktopContent -the template's content (string)

Response

Returns an empty body if successful or a detailed error message.

Delete a template
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/templates/[template_ID]

Response

Returns an empty body if successful or a detailed error message.


Get the list of pages a template is assigned to
Scroll upRead more...

Request

  • Method: GET
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

  • Path:
    /webresources/api/v3/sites/current/templates/[template_ID]/pages
  • Required Permissions: View Template

Response

An array of templates, each object has the following properties:

  • id - the id of the template in the current site (integer)
  • siteId- the id of the site (integer)
  • url- the id of the site (string)
  • name- the id of the site (string)
  • categoryId - the ID of the workflow assigned (integer)
  • roleId -the ID of the role assigned to the page(integer)
  • templateId - the ID of the template(integer)
  • parentId - the ID of the parent element (integer)
  • displayFileName - the name of the file on the filesystem (string)
  • size - (integer)
  • enabled - (boolean)
  • startPage - (boolean)
  • releaseDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • expiryDate - (dateTime) - the date must be in this format - 2014-09-03T07:00:00
  • excludeFromSearch - (boolean)
  • livePageId- if the page is in draft mode this is the ID of the live page it corresponds to (integer).
  • content - (string)
  • redirect301- (string)
  • title - (string)
  • seoMetadataDescription - (string)
Add a template to a page
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/templates/[templateID]/pages

Response

Returns an empty body if successful or a detailed error message.

Important! To remove a template from a page you can make a PUT through the Pages api and modify the template Assigned value to either -1 (no template) or 0(default template).


Blogs

List the blogs of a site
Scroll upRead more...

Request

Response

An array of the first 10 blogs; each object has the following properties:

  • id - the blog's ID (numeric)
  • siteId - the site's ID (numeric)
  • roleId - the ID of the user role assigned to the blog (numeric)
  • templateId - the ID of the template assigned to this blog (numeric)
  • blogName - the blog's name (string)
  • blogDescription - the blog's description (string)
  • title - the blog's title (string)
  • allowRSS - whether this blog is syndicated via a RSS feed or not (boolean)
  • rssChannelId - the RSS feed's ID (numeric)
  • lastPostDate - the date of the newest post (dateTime)
  • postCount - the total number of posts (numeric)
  • weight - the blog's weight (numeric)
  • releaseDate - the blog's release date (dateTime)
  • expiryDate - the blog's expiry date (dateTime)
  • createDate - the blog's create date (dateTime)
  • lastUpdateDate - the blog's last update date (dateTime)
  • enabled - whether the blog is enabled or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the blog's slug (string)
  • blogUrl - the blog's friendly URL (string)
Get a blog's details
Scroll upRead more...

Request

Response

Displays the details for the blog as a JSON object

  • id - the blog's ID (numeric)
  • siteId - the site's ID (numeric)
  • roleId - the ID of the user role assigned to the blog (numeric)
  • templateId - the ID of the template assigned to this blog (numeric)
  • blogName - the blog's name (string)
  • blogDescription - the blog's description (string)
  • title - the blog's title (string)
  • allowRSS - whether this blog is syndicated via a RSS feed or not (boolean)
  • rssChannelId - the RSS feed's ID (numeric)
  • lastPostDate - the date of the newest post (dateTime)
  • postCount - the total number of posts (numeric)
  • weight - the blog's weight (numeric)
  • releaseDate - the blog's release date (dateTime)
  • expiryDate - the blog's expiry date (dateTime)
  • createDate - the blog's create date (dateTime)
  • lastUpdateDate - the blog's last update date (dateTime)
  • enabled - whether the blog is enabled or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the blog's slug (string)
  • blogUrl - the blog's friendly URL (string)
Create a blog
Scroll upRead more...

Request

Parameters

  • roleId - the ID of the user role assigned to the blog (numeric)
  • templateId - the ID of the template assigned to this blog (numeric)
  • blogName - the blog's name (string)
  • blogDescription - the blog's description (string)
  • title - the blog's title (string)
  • allowRSS - whether this blog is syndicated via a RSS feed or not (boolean)
  • rssChannelId - the RSS feed's ID (numeric)
  • lastPostDate - the date of the newest post (dateTime)
  • postCount - the total number of posts (numeric)
  • weight - the blog's weight (numeric)
  • releaseDate - the blog's release date (dateTime)
  • expiryDate - the blog's expiry date (dateTime)
  • createDate - the blog's create date (dateTime)
  • lastUpdateDate - the blog's last update date (dateTime)
  • enabled - whether the blog is enabled or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the blog's slug (string)
  • blogUrl - the blog's friendly URL (string)

Response

Returns an empty body if successful or a detailed error message.

Edit a blog
Scroll upRead more...

Request

Parameters

  • roleId - the ID of the user role assigned to the blog (numeric)
  • templateId - the ID of the template assigned to this blog (numeric)
  • blogName - the blog's name (string)
  • blogDescription - the blog's description (string)
  • title - the blog's title (string)
  • allowRSS - whether this blog is syndicated via a RSS feed or not (boolean)
  • rssChannelId - the RSS feed's ID (numeric)
  • lastPostDate - the date of the newest post (dateTime)
  • postCount - the total number of posts (numeric)
  • weight - the blog's weight (numeric)
  • releaseDate - the blog's release date (dateTime)
  • expiryDate - the blog's expiry date (dateTime)
  • createDate - the blog's create date (dateTime)
  • lastUpdateDate - the blog's last update date (dateTime)
  • enabled - whether the blog is enabled or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the blog's slug (string)
  • blogUrl - the blog's friendly URL (string)

Response

Returns an empty body if successful or a detailed error message.

Delete blogs
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.


List a blog's posts
Scroll upRead more...

Request

Response

An array of the first 10 blog posts; each object has the following properties:

  • id - the blogpost's ID (numeric)
  • siteId - the site's ID (numeric)
  • blogId - the blog's ID (numeric)
  • postTitle - the post's title (string)
  • postFeaturedImage - the post's featured image URL (string)
  • postBody - the post's content (string)
  • createBy - the ID of the user who created the post (numeric)
  • releaseDate - the post's release date (dateTime)
  • createDate - the post's create date (dateTime)
  • lastUpdateDate - the date of the latest update (dateTime)
  • enabled - whether the post is enabled or not (boolean)
  • deleted - whether the post was deleted or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the post's slug (string)
  • postUrl - the post's friendly URL (string)
  • metaBlogPostTitle - the post's meta title (string)
  • metaBlogPostDescription - the post's meta description (string)

List a blog's categories
Scroll upRead more...

Request

Response

An array of the first 10 categories assigned to the blog; each object has the following properties:

  • id - the category's ID (numeric)
  • siteId - the site's ID (numeric)
  • parentId - the ID of the parent (numeric)
  • category - the category's name (string)
  • publicAccess - whether this category is visible in the site's front-end or not (boolean)
  • Default - whether this category is to be marked as default or not (boolean)
  • deleted - whether this category is enabled or not (boolean)
Add a category to a blog
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.

Remove a category from a blog

List the secure zones a blog is added into
Scroll upRead more...

Request

Response

An array of the first 10 securezones assigned to the blog; each object has the following properties:

  • id - the id of the secure zone (integer)
  • siteId - the id of the site (integer)
  • landingPageId - the ID of the secure zone's landing page (string)
  • name - the name of the secure zone (string)
  • sellAccess - whether you charge the customers who get access to the secure zone or not (boolean)
  • costPerPeriod - the membership cost amount (integer)
  • orderCountryCode - the currency to use when charging the customers for access(string)
  • cycleType - the frequency of membership renewal (integer)
    • "1" Once
    • "2" Daily
    • "3" Weekly
    • "4" Fortnightly
    • "5" Monthly
    • "6" Quarterly
    • "7" Half Yearly
    • "8" Yearly
  • deleted - whether the secure zone is deleted or active (boolean)
Add a blog to a secure zone
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.

Remove a blog from a secure zone
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.


List the blog posts of a site (across all blogs)
Scroll upRead more...

Request

Response

An array of the first 10 blog posts; each object has the following properties:

  • id - the blogpost's ID (numeric)
  • siteId - the site's ID (numeric)
  • blogId - the blog's ID (numeric)
  • postTitle - the post's title (string)
  • postFeaturedImage - the post's featured image URL (string)
  • postBody - the post's content (string)
  • createBy - the ID of the user who created the post (numeric)
  • releaseDate - the post's release date (dateTime)
  • createDate - the post's create date (dateTime)
  • lastUpdateDate - the date of the latest update (dateTime)
  • enabled - whether the post is enabled or not (boolean)
  • deleted - whether the post was deleted or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the post's slug (string)
  • postUrl - the post's friendly URL (string)
  • metaBlogPostTitle - the post's meta title (string)
  • metaBlogPostDescription - the post's meta description (string)
Get a blog post's details
Scroll upRead more...

Request

Response

Displays the details for the blog post as a JSON object

  • id - the blogpost's ID (numeric)
  • siteId - the site's ID (numeric)
  • blogId - the blog's ID (numeric)
  • postTitle - the post's title (string)
  • postFeaturedImage - the post's featured image URL (string)
  • postBody - the post's content (string)
  • createBy - the ID of the user who created the post (numeric)
  • releaseDate - the post's release date (dateTime)
  • createDate - the post's create date (dateTime)
  • lastUpdateDate - the date of the latest update (dateTime)
  • enabled - whether the post is enabled or not (boolean)
  • deleted - whether the post was deleted or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the post's slug (string)
  • postUrl - the post's friendly URL (string)
  • metaBlogPostTitle - the post's meta title (string)
  • metaBlogPostDescription - the post's meta description (string)
Create a blog post
Scroll upRead more...

Request

Parameters

  • blogId - the blog's ID (numeric)
  • postTitle - the post's title (string)
  • postFeaturedImage - the post's featured image URL (string)
  • postBody - the post's content (string)
  • createBy - the ID of the user who created the post (numeric)
  • releaseDate - the post's release date (dateTime)
  • createDate - the post's create date (dateTime)
  • lastUpdateDate - the date of the latest update (dateTime)
  • enabled - whether the post is enabled or not (boolean)
  • deleted - whether the post was deleted or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the post's slug (string)
  • postUrl - the post's friendly URL (string)
  • metaBlogPostTitle - the post's meta title (string)
  • metaBlogPostDescription - the post's meta description (string)
Edit a blog post
Scroll upRead more...

Request

Parameters

  • blogId - the blog's ID (numeric)
  • postTitle - the post's title (string)
  • postFeaturedImage - the post's featured image URL (string)
  • postBody - the post's content (string)
  • createBy - the ID of the user who created the post (numeric)
  • releaseDate - the post's release date (dateTime)
  • createDate - the post's create date (dateTime)
  • lastUpdateDate - the date of the latest update (dateTime)
  • enabled - whether the post is enabled or not (boolean)
  • deleted - whether the post was deleted or not (boolean)
  • disableComments - whether site visitor comments are allowed or not (boolean)
  • slug - the post's slug (string)
  • postUrl - the post's friendly URL (string)
  • metaBlogPostTitle - the post's meta title (string)
  • metaBlogPostDescription - the post's meta description (string)

Response

Returns an empty body if successful or a detailed error message.

Delete a blog post
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.


List the tags assigned to a blog post
Scroll upRead more...

Request

Response

An array of the first 10 blogs; each object has the following properties:

  • objectId - the blog post's ID (numeric)
  • tagId - the tag's ID (numeric)
  • objectType - the current item's object type - for blogposts this is 56 (numeric)
  • siteId -the site's ID (numeric)
  • tag - an object containing the tag's properties (object)
    • id - the tag's ID (numeric)
    • siteId -the site's ID (numeric)
    • tagname - the tag's name (string)
Tag a blog post
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.

Remove a tag from a blog post
Scroll upRead more...

Request

Response

Returns an empty body if successful or a detailed error message.


List all categories associated to a blog post
Scroll upRead more...

Request

Parameters

  • objectId - the ID of the blog (integer)
  • categoryId the Id of the category (integer)
  • objectType - category object type is 56 (integer)
  • displayable should be 1 (integer)
  • siteId the ID of the site (integer)
  • category json object, listing default category fields (object)

Response

Returns an empty body if successful or a detailed error message.

Add a category to a blogpost
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/blogposts/[blogID]/categories

Response

Returns an empty body if successful or a detailed error message.

Remove a category from a blogpost
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/blogposts/[blogpostID]/categories

Response

Returns an empty body if successful or a detailed error message.


Secure zones

List the pages in a particular secure zone
Scroll upRead more...

Request

Response

An array of the first 10 web pages contained by the secure zone.

Add pages to a secure zone
Scroll upRead more...

Request

  • Method: POST
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/[secure_zone_ID]/pages

Response

The response should be "204 no content" if the page was successfully added to the secure zone.

Remove pages from a secure zone
Scroll upRead more...

Request

  • Method: DELETE
  • Version: v3
  • Path:
    /webresources/api/v3/sites/current/securezones/[secure_zone_ID]/pages?items=[page1_ID,page2_ID,page3_ID]

Response

The response should be "204 no content" if the pages were successfully removed from the the secure zone.


Ad Rotators, Ad Rotator Items

List all ad rotators
Scroll upRead more...

Get all the ad rotators of a site.

Request

  • Method: GET
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path:
    /webresources/api/v3/sites/current/adrotators

Response body

An array of the first 10 items; each object has the following properties:

  • id - ad rotator ID (number)
  • siteId - site ID (number)
  • name - ad rotator's name (string)
  • createDate - ad rotator's creation date (dateTime)
  • lastUpdateDate - ad rotator's last update date (dateTime)
  • enabled - enabled (boolean)
Get an ad rotator's details
Scroll upRead more...

Get an ad rotator and it's details.

Request

Response

Displays the details for the ad rotator as a JSON object

  • id - ad rotator ID (number)
  • siteId - site ID (number)
  • name - ad rotator's name (string)
  • createDate - product's creation date (dateTime)
  • lastUpdateDate - product's last update date (dateTime)
  • enabled - enabled (boolean)

List all items of an ad rotator
Scroll upRead more...

Get all the items of an ad rotator.

Request

  • Method: GET
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path:
    /webresources/api/v3/sites/current/adrotators/[adrotator_ID]/items

Response body

An array of the first 10 items; each object has the following properties:

  • id - ad rotator item ID (number)
  • adRotatorId - ad rotator ID (number)
  • siteId - site ID (number)
  • itemTypeId - item type ID (number)
    • 1 - Image
    • 2 - Flash
    • 3 - HTML
  • itemName - item's name/label (string)
  • itemUrl - item's click-through URL (string)
  • itemSource - item's source URL or HTML depending on the item's type (string)
  • itemTargetFrame - item's target frame (string)
  • itemWidth - item width (string)
  • itemHeight - item height (string)
  • itemUrl - item's source URL (string)
  • releaseDate - item's release date (dateTime)
  • expiryDate - item's expiry date (dateTime)
  • enabled - enabled (boolean)

Photo Galleries, Photo Gallery Items

List all photo galleries
Scroll upRead more...

Get all the photo galleries of a site.

Request

  • Method: GET
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path:
    /webresources/api/v3/sites/current/photogalleries

Response body

An array of the first 10 items; each object has the following properties:

  • id - photo gallery ID (number)
  • siteId - site ID (number)
  • photoGallery - photo gallery's name (string)
  • folderId - the photo gallery's folder ID (number)
  • createDate - photo gallery's creation date (dateTime)
  • lastUpdateDate - photo gallery's last update date (dateTime)
Get a photo gallery's details
Scroll upRead more...

Get a photo gallery and it's details.

Request

Response

Displays the details for the photo gallery as a JSON object

  • id - photo gallery ID (number)
  • siteId - site ID (number)
  • photoGallery - photo gallery's name (string)
  • folderId - the photo gallery's folder ID (number)
  • createDate - photo gallery's creation date (dateTime)
  • lastUpdateDate - photo gallery's last update date (dateTime)

List all items of a photo gallery
Scroll upRead more...

Get all the items of a photo gallery.

Request

  • Method: GET
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path:
    /webresources/api/v3/sites/current/photogalleries/[photogallery_ID]/items

Response body

An array of the first 10 items; each object has the following properties:

  • id - photo gallery's item ID (number)
  • folderId - photo gallery's folder ID (number)
  • siteId - site ID (number)
  • name - path to filename (string)
  • size - size in kilobits (number)
  • description - item's description / caption (string)
Resource relationships
Scroll upRead more...

List items with resources asociated with the photogallery by requesting these objects in the fields parameter:

  • folder
  • descriptionMetadata

Request

  • Method: GET
  • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

    Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path:
    /webresources/api/v3/sites/current/photogalleries/[photogallery_ID]/items?fields=id,folderId,siteId,name,size,
    folderdescriptionMetadata

Response body

An array of the first 10 items; each object has the following properties in addition to the default fields:

  • folder - item's folder object resource
    • id - folder's ID (number)
    • siteId - site ID (number)
    • parentId - folder's parent ID (number)
    • folderName - folder's name (string)
    • folderPath - folder's path (string)
  • descriptionMetadata - item's metadata object resource (null if item has not description)
    • fileName - item's filename (string)
    • siteId - site ID (number)
    • photoGalleryId - photo gallery ID (number)
    • description - item's description/caption (string)
    • createDate - item's metadata creation date (dateTime)
    • lastUpdateDate - item's metadata update date (dateTime)

Liquid globals
Scroll upRead more...

Description

The Liquid globals object is available on every page and it contains useful information about the site, the current page, the logged in user, browser related information and much more.

Here is what the globals object contains

{{globals.get}} The current relative path and the query parameters passed in the URL. For example, for the URL http://mtica1.businesscatalyst.com/_s1/s2?a=1&b=2 the output of the module is:
{
  "ID": "/_s1/s2",
  "a": "1",
  "b": "2"
}
{{globals.site}} Site related information:
 "site": {
    "id": 12345,
    "name": "mtica1",
    "host": "mtica1.businesscatalyst.com",
    "countryCode": "RO",
    "language": "GB",
    "dateNow": "2015-01-09T15:11:33.0878202"
  }
{{globals.user}} User related information (assuming somebody is logged in):

  {
  "entityId": 9532870,
  "firstname": "John",
  "middleName": "Doe",
  "lastname": "John",
  "fullname": "John John Doe",
  "username": "jdoe",
  "email": "jdoe@mailinator.com",
  "email2": "jdoe2@mailinator.com",
  "email3": "jdoe3@mailinator.com",
  "customerType": {
    "id": 420538,
    "name": "Other"
  },
  "leadSourceType": {
    "id": 465473,
    "name": "Other"
  },
  "industryType": {
    "id": 1090438,
    "name": "Other"
  },
  "ratingType": {
    "id": 126400,
    "name": "Warm"
  },
  "isWholesaler": true,
  "isLoggedIn": true
}
  
{{globals.visitor}} Visitor related information:
"visitor": {
    "deviceClass": "desktop",
    "ip": "123.123.123.123",
    "country": "RO",
    "city": "BUCHAREST",
    "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/38.0.2125.104 Safari/537.36"
  }
{{globals.cart}} The shopping cart URL
"cart": {
    "cartUrl": "/OrderRetrievev2.aspx?CatalogueID=0"
  }
{{globals.cookie}} The cookies stored on the current domain (including cookies you might create using javascript). For a site visitor that is not logged in the Admin Console the cookie object looks something like this:
"cookie": {
    "visitorDeviceClass": "desktop",
    "ASP.NET_SessionId": "x54fgiweu1zwhoisjetfsv5r",
    "ANONID_FS1576341": "24.09.2014 12:21:51.298",
    "ANONID1576341": "e626ac8b-45ff-4801-9808-ec9ad51d847a",
    "VISID1576341": "877790b5-3feb-499d-8227-a12cb6a5f388#mtica4.businesscatalyst.com#24.09.2014 12:21:51.298"
  }

Liquid logic tags

IF
Scroll upRead more...

Simple if decision block.

  {% if item.Color == 'red' %}    <p>Red is the color</p>
  {% endif -%}
IF else
Scroll upRead more...

Just like a regular IF condition, the only difference is this adds another possible choice.

{% if item.Color == 'red' %}<p>Red is the color</p>
{% elsif item.Color == 'blue' %}  <p>Blue is the color</p>
{% else %}  <p>Neither red nor blue.</p>
{% endif %}
UNLESS
Scroll upRead more...

Unless the condition is true the code is executed

{% unless item.Color == 'red' %} <p>The color is not red.</p>
{% endunless -%}

or

{% unless item.Color == 'red' or item.Color == 'blue'%}	<p>The color is not red nor blue.</p>
{% endunless %}
CASE
Scroll upRead more...

Do something based on the possible values of a variable. If none of the "known" values are encountered the last "else" branch will be executed.

{% case item.country %}  {% when 'DE' %}    Willkommen
  {% when 'ES' %}    Bienvenido
  {% when 'EN' %}    Welcome
  {% else %}    Bine ai venit
{% endcase %}
FOR
Scroll upRead more...

FOR is used to loop over a collection of items.

{% for item in webapp1.items %}<p>
    This item's name is: {{item.name}} 
</p>
{% endfor -%}

In FOR loops you can also access the key/value pairs, for example:

<ul>
{% for getParam in this.globals.visitor -%} 
  <li>{{getParam[0]}} = '{{getParam[1]}}'</li>
{% endfor %}</ul>

will render the this.globals.visitor object like so:

<ul>
  <li>deviceClass = 'desktop'</li>
  <li>ip = '10.10.10.10'</li>
  <li>country = 'US'</li>
  <li>userAgent = 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.103 Safari/537.36'</li>
</ul>

Break

Causes the for loop to stop iterating when it encounters the break tag.

{% for i in (1..5) -%}
{% if i == 4 -%}
{% break %} {% else -%}
{{ i }} {% endif -%}
{% endfor -%}

Will output: 1 2 3

Continue

Causes the for loop to skip the current iteration when it encounters the continue tag.

{% for i in (1..5) -%}
{% if i == 4 -%}
{% continue %} {% else -%}
{{ i }} {% endif -%}
{% endfor -%}

Will output: 1 2 3 5

Limit and Offset

Liquid for loops support the ability to limit and offset the results. You can limit the number of results by a value and offset the results by a value also.
More can be read about these loop filters in the filters reference.

In a loop you can access these variables:

  • {{forloop.length}} - length of the entire for loop (integer)
  • {{forloop.index}} - index of the current iteration (integer)
  • {{forloop.index0}} - index of the current iteration (zero based) (integer)
  • {{forloop.rindex}} - how many items are still left? (integer)
  • {{forloop.rindex0}} # => how many items are still left? (zero based) (integer)
  • {{forloop.first}} - is this the first iteration? (boolean)
  • {{forloop.last}} - is this the last iteration? (boolean)

You can only iterate over a part of a collection, for example if you have a large list of customers you can only iterate over 20 at a time using the limit and offset variables.

The loop can also iterate in reverse using the reversed parameter.

CYCLE
Scroll upRead more...

Render one of a few possible items. For example:

{% cycle 'red', 'green', 'blue' -%}
{% cycle 'red', 'green', 'blue' -%}
{% cycle 'red', 'green', 'blue' -%}
{% cycle 'red', 'green', 'blue' -%}
INCLUDE
Scroll upRead more...

Include is used to pull data from another page.

For example, paste this code in a page, name it to-be-included.html:

<html>
<head><head>
<body>
{module_data resource="customers" subresource="orders" resourceId="{{globals.user.entityid}}" version="v3" template="" collection="customerOrders"} 
//this gets the list of orders for the logged in customer
</body>
</html>

On another page (the main page) paste this code:

{%include "/to-be-included.html"%}<pre>{{customerOrders | json}}</pre>
//even though the collection customerOrders is not defined in the main page you will still see its contents
ASSIGN
Scroll upRead more...

This is used to create a new variable.

{% assign new_variable = "my new value" -%}

Or update a variable's value:

{% assign new_variable = "the new value" -%}
CAPTURE
Scroll upRead more...

Assign a block of text, HTML code to a variable.

{% capture item_date -%}<span style="color:blue">{{item.releaseDate}}</span>{% endcapture -%}

You can then use {{item_date}} to output the release date of the item in blue. The HTML code or text between the capture tags does not render on the page.

COMMENT
Scroll upRead more...

Comments out a block of text. The text between the comment tags does not render in the front-end.

{%comment%}	Do not forget to remove comments
{%endcomment-%}

The comment will only be visible in the Admin Console.

RAW
Scroll upRead more...

Raw renders liquid markup in plain text.

{%raw%}	{{this | json}}
{% endraw %}

This will render the Liquid code in plain text.

TABLEROW
Scroll upRead more...

This will draw a table. You can specify how many columns the table will contain using the "cols:" value.


<table>
{% tablerow item in webapp1.items cols:2 %}    {{item.name}}{{item.counter}}
{% endtablerow %}</table>

Liquid filters

Mathematical filters
Scroll upRead more...
ceil rounded up - {{ 4.3 | ceil }} is 5
divided_by

division - {{ 500 | divided_by: 20 }} is 25
Note: when you divide a number by another number which has one decimal the result will also have an output:
{{399 | divided_by: 2.0}} will output: 199.5

floor rounded down - {{ 4.6 |floor }} is 4
minus substraction - {{ 500 | minus: 20 }} is 480
modulo Divides the number by the modulo parameter and returns the remainder - {{ 3 | modulo: 2 }} is 1, {{ 6 | modulo: 2 }} is 0
plus addition - {{ 500 | plus: 20 }} is 520
round typical rounding - {{ 4.5 | round }} is 5 &{{ 4.4 |round }} is 4
round:x rounding by number of decimals - {{ 4.5612 | round: 2 }} is 4.56
times multiplication - {{ 500 | times: 2 }} is 1000
String manipulation filters
Scroll upRead more...
append {{ 'This is the first part' | append: ' appending the second part' }} outputs "This is the first part appending the second part"
capitalize {{ 'Sample text' | capitalize }} outputs "Sample Text"
downcase {{ 'Sample text' | downcase }} outputs "sample text"
escape {{ "<h1>Escaped heading</h1>" | escape }} outputs HTML encoded "&lt;h1&gt;Escaped heading&lt;/h1&gt;"
newline_to_br {% capture var %} One Two Three <br>heloo echo ecko lorem ipsum dolor sin amet {% endcapture %} {{ var | newline_to_br }} creates a line break for each new line encountered
pluralize {{ item.quantity | pluralize: 'item', 'items' }} outputs "item" if item.quantity is 1, or "items" if item.quantity is bigger then 1
prepend {{' this is the second part' | prepend: 'This is the first part' }} outputs "This is the first part this is thesecond part"
remove {{'Sample text. All occurences of "text" will be removed.' | remove: 'text' }} outputs 'Sample . All occurences of "" will be removed.'
replace {{'Sample text. All occurences of "text" will be replaced.' | replace: 'text', 'string' }} outputs 'Sample string. All occurences of "string" will be replaced.'
replace_first {{'Sample text text.' | replace_first: 'text', 'string' }} outputs "Sample string text"
slice {{ 'hello' | slice: -4, 2 }} keeps only the first two letters starting from position -4 in a string, where -1 is the last letter: 'el'.
split {{ '1,2,3,4,5 ' | split: ',' }} splits the text and creates an array ["1","2","3","4","5"]
strip {{ '      too many spaces      ' | strip }} Strips tabs, spaces, and newlines (all whitespace) from the left and right side of a string. Output: 'too many spaces'
lstrip {{ '      too many spaces      ' | lstrip }} Strips tabs, spaces, and newlines (all whitespace) from the left side of a string. Output: 'too many spaces      '
rstrip {{ '      too many spaces      ' | rstrip }} stripsStrips tabs, spaces, and newlines (all whitespace) from the right side of a string. Output: '      too many spaces'
strip_html {{ '<p>My paragraph</p>' | strip_html }} strips the HTML code from the string, this outputs "My paragraph"
strip_newlines {% capture var %} One Two Three <br>heloo echo ecko lorem ipsum dolor sin amet {% endcapture %} {{ var | strip_newlines: '///'}} in this example the strip_newlines: "///" filter removes the line breaks and replaces them with "///"
truncate {{ 'Sample text ' | truncate: 9, '...' }} outputs 'Sample... '
truncatewords {{ '<p>Lorem ipsum dolor sin amet</p>' | truncatewords: 2, '...' }} strips the paragraph to a specified number of words. Example output: "Lorem ipsum..."
unescape {{ "<div style='color:red'><h1>header</h1><p>this is a paragraph</p></div>" | unescape }} Opposite of escape, basically HTML decode.
upcase {{ 'Sample text' | upcase }} outputs "SAMPLE TEXT"
Array manipulation filters
Scroll upRead more...
limit array = [1,2,3,4,5,6]
{% for item in array limit:2 %}
This will limit the number of items returned from the array. In this case 1 and 2 will be returned
offset array = [1,2,3,4,5,6]
{% for item in array offset:2 %}
This will offset the items from the array. In this case items 3 and 4 will be returned.
You can combine both offset and limit.
join {{ myArray | join: "///" }} assuming myArray is an array joins the elements and puts the separator between each element
sort {{ myArray | sort }} assuming myArray is an array ["5","4","3"] ]the sort filter outputs ["3","4","5"]
first {{ myArray | first }} Will output the first item in an array
last {{ myArray | last }} Will output the last item in an array
map

array = [{ "id": 9683555, "name": "Childhood Dreams T-Shirt" }, { "id": 9683556, "name": "Kung-Fu Panda T-Shirt" }]

{{array | map: "name"}}

Accepts an array element's attribute as a parameter and creates a string from it's values: Childhood Dreams T-ShirtKung-Fu Panda T-Shirt

   
Date filters
Scroll upRead more...
site_date {{ globals.site.dateNow | date }} outputs "09-Jan-2015"
site_datetime {{ globals.site.dateNow | datetime }} outputs "09-Jan-2015 02:46 PM"
date_utc {{ globals.site.dateNow | date_utc }} converts a date to UTC (assuming that the date is always given in the site’s timezone)
date_add

{{ myDate | date_add: amount, datePart }}

myDate - filter input should be a date time object or a string convertible to a date time object

amount - an integer number or a string convertible to an integer number representing the amount of date or time units to add (if positive) or to subtract (if negative) from the input date time object

datePart - a string representing the date or time parts to be added or subtracted. The allowed values are:

  • "year"
  • "month"
  • "day"
  • "hour"
  • "minute"
  • "second"
  • "millisecond"

E.g. using either one of the two line below:

{% assign myDate = "2016-06-15T12:30:30.400" -%}
{% assign myDate = "2016-06-15T12:30:30.400" | convert: "date" -%}

and

{{ myDate | date_add: 1000, "year" }} will output 3016-06-15T12:30:30

{{ myDate | date_add: 3, "month" }} will output 2016-09-15T12:30:30

{{ myDate | date_add: 15, "day" }} will output 2016-06-30T12:30:30

{{ myDate | date_add: "20", "hour" }} will output 2016-06-16T08:30:30

{{ myDate | date_add: "-40", "minute" }} will output 2016-06-15T11:50:30

{{ myDate | date_add: 1800, "second" }} will output 2016-06-15T13:00:30

{{ myDate | date_add: -500, "millisecond" | date_add: 20, "hour" | date_add: -12, "month" | date: "yyyy-MM-ddThh:mm:ss.fff" }} will output 2015-06-16T08:30:29.900

If one of the parameters is of an incompatible type or value, the filter will not alter the input.

 

Date switches
Scroll upRead more...

Assuming the value of the dateTime field is 2014-12-09T23:00:00 here are the available switches you can use to format the date:

%d Outputs the day of the month - 18
dd The day of the month. Single-digit days will have a leading zero - 03
ddd The abbreviated name of the day of the week. - Tue
dddd The full name of the day of the week. - Tuesday
%h The hour in a 12-hour clock. Single-digit hours will not have a leading zero - 12
hh The hour in a 12-hour clock. Single-digit hours will have a leading zero - 12
%H The hour in a 24-hour clock. Single-digit hours will not have a leading zero - 0
HH The hour in a 24-hour clock. Single-digit hours will have a leading zero - 0
%m The minute. Single-digit minutes will not have a leading zero - 0
mm The minute. Single-digit minutes will have a leading zero - 00
%M The numeric month. Single-digit months will not have a leading zero - 9
MM The numeric month. Single-digit months will have a leading zero - 09
MMM The abbreviated name of the month, as defined in AbbreviatedMonthNames - sep.
MMMM The full name of the month, as defined in MonthNames - september
%s The second. Single-digit seconds will not have a leading zeroThe second. Single-digit seconds will not have a leading zero - 0
ss The second. Single-digit seconds will have a leading zero - 00
%t The first character in the AM/PM designator, if any - a
tt The AM/PM designator, if any - a.m.
%y The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero - 14
yy The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero - 14
yyyy The year in four or five digits (depending on the calendar used), including the century. Will pad with leading zeroes to get four digits. Thai Buddhist and Korean calendars both have five digit years; users selecting the "yyyy" pattern will see all five digits without leading zeros for calendars that have five digits. Exception: the Japanese and Taiwan calendars always behave as if "yy" was selected - 1914
\c Where c is any character. Displays the character literally. Useful for escaping characters that are usually rendered as switches (m, h, s, etc.) To display the backslash character, use "\\" - 14
timeSpan switches
Scroll upRead more...
%d Outputs the number of whole days in the time interval - 5
dd The number of whole days in the time interval, padded with leading zeros as needed - 05
%h The number of whole hours in the time interval that are not counted as part of days. Single-digit hours do not have a leading zero - 2
hh The number of whole hours in the time interval that are not counted as part of days. Single-digit hours have a leading zero - 02
%m The number of whole minutes in the time interval that are not included as part of hours or days. Single-digit minutes do not have a leading zero - 39
mm The number of whole minutes in the time interval that are not included as part of hours or days. Single-digit minutes have a leading zero - 39
%s The number of whole seconds in the time interval that are not included as part of hours, days, or minutes. Single-digit seconds do not have a leading zero - 20
ss The number of whole seconds in the time interval that are not included as part of hours, days, or minutes. Single-digit seconds have a leading zero - 20
%f The tenths of a second in a time interval - 2
ff The /hundredths of a second in a time interval - 25
fff The milliseconds in a time interval - 250
ffff The ten-thousandths of a second in a time interval - 2500
fffff The hundred-thousandths of a second in a time interval - 25002
ffffff The millionths of a second in a time interval - 250025
fffffff The ten-millionths of a second (or the fractional ticks) in a time interval - 2500250
%F The tenths of a second in a time interval. Nothing is displayed if the digit is zero -2
FF The hundredths of a second in a time interval. Any fractional trailing zeros or two zero digits are not included - 25
FFF The milliseconds in a time interval. Any fractional trailing zeros are not included - 25
FFFF The ten-thousandths of a second in a time interval. Any fractional trailing zeros are not included - 25
FFFFF The hundred-thousandths of a second in a time interval. Any fractional trailing zeros are not included - 25002
FFFFFF The millionths of a second in a time interval. Any fractional trailing zeros are not displayed - 250025
FFFFFFF The ten-millions of a second in a time interval. Any fractional trailing zeros or seven zeros are not displayed - 250025
string Literal string delimiter - date:"'Result : 'dd'"'' will output - Result : 05
\ The escape character. If you want to display a cahracter that would be normally interpreted as a switch, for example /ddd will output - d05
Other Filters
Scroll upRead more...
convert Converts variables into different formats. Possible dataTypes are:
  • string - {{ 3 | convert: "string" | json }} outputs "3"
  • number - {{ "3" | convert: "number" | json }} outputs 3 (this can now be used with the mathematical filters)
  • boolean - {{ "false" | convert: "boolean" | json }} outputs "false" (it is treated as a boolean variable)
  • date - {{ "2015-01-07" | convert: "date" }} outputs 2015-01-07T00:00:00 in dateTime format
json Displays the data passed in JSON format. For example rendering a single webapp item using - {{ webapp1.items[0] | json }} looks like:
{
 "itemid":"4646524",
 "name":"ABA",
 "urlWithHost":"http://abcd.com/car/ABA",
 "url":"/car/ABA",
 "releaseDate":"2014-06-18",
 "expiryDate":"9999-01-01",
 "lastUpdateDate":"2014-06-18",
 "counter":"1",
 "weight":"",
 "Make":"AC model",
 "Color":"red",
 "Country":"",
 "Review":"no review just yet"
}
size Can be used to return the number of elements in an array or the number of characters in a string.
url_param_escape/ url_param_unescape

Encodes/decodes a parameter than can be appended to an URL.

{{ "<div> & <span>" | url_param_escape }} / {{ "&lt;hello&gt; &amp; &lt;shopify&gt;" | url_param_unescape }}

number

We use the format strings from .Net, which are available here and here.

By default, if no format string is specified, we use the "N2" format which displays numbers using two decimals and which also includes the group separator if necessary. 

Cultures that use dot '.' as the decimal separator ($ is used as a sample currency):            

  • {{ invoiceTotal | number }}: 1,050.00
  • {{ invoiceTotal | number: "N2" }}: 1,050.00
  • {{ invoiceTotal | number: "N4" }}: 1,050.0000
  • {{ invoiceTotal | number: "F2" }}: 1050.00
  • {{ invoiceTotal | number: "F2" }}: $1050.00

Cultures that use comma ',' as the decimal separator (EUR is used as a sample currency):            

  • {{ invoiceTotal | number }}: 1.050,00
  • {{ invoiceTotal | number: "N2" }}: 1.050,00
  • {{ invoiceTotal | number: "N4" }}: 1.050,0000
  • {{ invoiceTotal | number: "F2" }}: 1050,00
  • {{ invoiceTotal | number: "F2" }}: EUR1050,00
money {{ 145.9 | money }} Formats the price based on the associated currency. (USD145.9)
default Dear {{ customer.name | default: "customer" }} Sets a default value for any variable with no assigned value. Can be used with strings, arrays, and hashes
Mathematical operators
Scroll upRead more...
== equals
!= does not equal
> greater than
< less than
>= greater than or equal to
<= less than or equal to
Other operators
Scroll upRead more...
or this or that
and this and that
contains You can use "contains" to check whether a string contains another string, for example:
{% if webapp1.items[0].name contains 'Jaguar' %}  This car is a Jaguar.
{% endif %}
or to check whether an array contains a value. Assuming {{cars_available_now}} is an array containing car makes:
{% if cars_available_now contains 'Jaguar' %}  A Jaguar is available now.
{% endif %}

Tip: What's the difference between %} and -%}? Here's how to handle Liquid generated whitespace.

module_data filtering

Resource ordering
Scroll upRead more...

Each collection can be sorted (ascending and descending) using the order query parameter. Below is an example where we will get the list of orders sorted in a descending order:

{module_data version="v3" resource="orders" order="-totalPrice" collection="myOrders" template=""}
Filtering
Scroll upRead more...

You can now get the data filtered by various parameters using the where parameter. In the examples below we will use the Orders resource:

{module_data version="v3" where="\{'creationDate':'2014-06-10'\}" resource="orders" skip="100" limit="50" collection="myOrders" template=""}
Equals operation applied to the specified property.

Get all orders created on 10th of June 2014.

{
"creationDate": "2014-06-10"
}

sample where parameter:

where="\{'creationDate':'2014-06-10'\}"
Less than operation applied to the specified property.

Return all orders created before 10th of June 2014.

{ "creationDate": { "$lt": "2014-06-10" } }

sample where parameter:

where="\{'creationDate':\{'$lt':'2014-06-10'\}\}"
Less than or equal operation applied to the specified property.

Return all orders created until 11th of June 2014.

{
"creationDate": {
"$lte": "2014-06-10"
}
}

sample where parameter:

where="\{'creationDate':\{'$lte':'2014-06-10'\}\}"
Greater than operation applied to the specified property.

Get all orders with a total price greater than 99.9.

{
"totalPrice": {
"$gt": 99.9
}
}

sample where parameter:

where="\{'totalPrice':\{'$gt':99.9\}\}"
Greater than or equal operation applied to the specified property.

Get all orders with a total price greater than or equal with 99.9.

{
"totalPrice": {
"$gte": 99.9
}
}

sample where parameter:

where="\{'totalPrice':\{'$gte':99.9\}\}"
Not equal operation applied to the specified property.

Get all orders where total price is different than 99.9.

{
"totalPrice": {
"$ne": 99.9
}
}

sample where parameter:

where=\{"totalPrice":\{"$ne":99.9\}\}"
In (contain) operation applied to the specified property.

Get all orders where total price is 99.9 or 22.5 or 0.99.

{
"totalPrice": {
"$in": [
99.9,
22.5,
0.99
]
}
}

sample where parameter:

where="\{'totalPrice':\{'$in':\[99.9,22.5,0.99\]\}\}"
Not in (not contained) operation applied to the specified property.

Get all orders where total price is different than 99.9 and 22.5 and 0.99.

{ "totalPrice": { "$nin": [ 99.9, 22.5, 0.99 ] } }

sample where parameter:

 where="\{'totalPrice':\{'$nin':\[99.9,22.5,0.99\]\}\}"
Or operation applied to a list of conditions. It is the equivalent of or statement from SQL.

Get all orders where total price is 99.9 or was created on 10th of June or 11th of June 2014.

{
"$or": [
{
"totalPrice": 99.9
},
{
"creationDate": {
"$in": [
"2014-06-10",
"2014-06-11"
]
}
}
]
}

sample where parameter:

where="\{'$or':\[\{'totalPrice':99.9\},\{'creationDate':\{'$in':\['2014-06-10','2014-06-11'\]\}\}\]\}"
And operation applied to a list of conditions. It is equivelent of AND statement from SQL.

Get all orders where total price is between 99.99 and 199.99.

{
"$and": [
{"totalPrice": {"$gt": 99.99}},
{"totalPrice": {"$lt": 199.99}}
]
}

sample where parameter:

where="\{'$and': \[\{'totalPrice': \{'$gt': 99.99\}\},\{'totalPrice': \{'$lt': 199.99\}\}\]\}"
Contains operation applicable only for string fields. It detects if serializedName field contains requested string value.

Get all orders where order description contains sample order string.

{
"description": {
"$contains": "sample order"
}
}

sample where parameter:

where="\{'description':\{'$contains':'sampleorder'\}\}"
Begins with operation applicable only for string fields. It detects if serializedName starts with requested string value.

Get all orders where order description starts with sample.

{
"description": {
"$beginsWith": "sample"
}
}

sample where parameter:

where="\{'description':\{'$beginsWith':'sample'\}\}"
Operation applied to the specified property of subresource. The current version of web resources supports only one level of nesting

Lists all the products that have a price with a rate greater than 5. Prices is a subresource for orders resource.

{
"prices.rate" : {
"$gt" : 5
}
}

sample where parameter:

where="\{'prices.rate':\{'$gt':5\}\}"

or

Lists all customers which have email1 and it's value contains '@gmail.com'. Email1 is a subfield for customers resource.

{
"email1.value" : {
"$contains" : "@gmail.com"
}
}

sample where parameter:

where="\{'email1.value':\{'$contains':'@gmail.com'\}\}"
Resource pagination
Scroll upRead more...

Each resource can be paginated using the skip and limit query parameters. These parameters are optional, if you do not specify them their default values are skip=0 and limit=10.

Do note the limit parameter cannot be larger than 500 module_data output is limited to a maximum of 500 items per request.

In the example below we get a batch 50 orders and skip the first 100:

 {module_data version="v3" resource="orders" skip="100" limit="50" collection="myOrders" template=""} 

eCommerce

Online shop overall layout
Scroll upRead more...

Renders these tags

{{description}} Catalogue description
{{name}} Catalogue name
{{pagination}} Enhanced pagination e.g. 1 .. 2 3 4 5 .. 10 to provide fast access to adjacentpages
Individual catalogue layout
Scroll upRead more...

Is used by these modules

Renders these tags

{{id}} Catalogue's ID
{{description}} Catalogue description
{{expiryDate}} Expiry date of catalogue
{{imageUrl}} Image for catalogue
{{name}} Catalogue name
{{releaseDate}} Release date of catalogue
{{url}} The catalog's relative URL
{{urlWithHost}} The catalog's complete URL
Individual product (small) layout
Scroll upRead more...

Is used by these modules

Renders these tags

{{title}} The product's title
{{attributes}}

Renders attribute dropdowns for a given product

The Liquid tag renders an object, use json filter to see it's properties like so: null

{{countryCode}} Display the country code; for example, AU
{{countryCurrencyFormat}} Display the country currency code; for example, AUD
{{currencyFormat}} Display the currency format; for example, $
{{custom1}} Custom field #1. Use to display any information about a product
{{custom2}} Custom field #2. Use to display any information about a product
{{custom3}} Custom field #3. Use to display any information about a product
{{custom4}} Custom field #4. Use to display any information about a product
{{description}} Description of the product (Editor content)
{{discountPrice}} The price if a discount applies to the current customer otherwise the normal sale price.
{{expiryDate}} Expiration date of product
{{groupingList}} List of product attributes used to switch between products
{{inStock}} Number of units in stock.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{url}} URL to the item referred, without host
{{urlWithHost}} URL to the item referred, with host
{{largeImageUrl}} Outputs the file path of the image; for example /images/imagename.jpg
{{maxUnits}} Maximum units
{{minUnits}} Minimum units
{{name}} Name of product
{{onOrder}} Number of units on order.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{isOnSale}}

Renders 1 if product on sale, otherwise 0. If page elements need to be altered for products on sale, then embed tag in relevant javascript.

For the Liquid tag it renders true instead of 1 and false instead of 0.

{{productCode}} Product code. With variations enabled, tg product will render the variation code instead of the product codes in all layouts where this is used.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{releaseDate}} Release date of item
{{reorder}} Number of units to reorder threshold
{{retailPrice}} Retail price of the product
{{salePrice}} Sale price of the product (the amount customers are charged)
{{wholesalerPrice}} Wholesaler price of the product (the amount "wholesale" type customers are charged)
{{smallImage}}
{{smallImageUrl}}
Outputs the file path of the image; for example /images/imagename.jpg
{{tags}} Product tags (you can use field for anything)
{{tax}} Tax amount for the product
{{taxCode}} Tax code name used for item
{{taxRate}} Tax rate used for item (%)
{{totalDiscountPrice}} Total discounted price of the product: Discount Price + Tax.
{{totalPrice}} Total price of the productT: Sale Price + Tax
{{totalRetailPrice}} Total retail price of the product: Retail Price + Tax
{{unitType}} Product unit type: Single, by the dozen
{{id}} Displays product system id
{{catalogId}} Displays catalog system id the product is currently displayed in
{{inventoryByAttributes}} Renders a JSON object that containsthe following parameters:
  • id
  • sku
  • inStock
  • onOrder
  • enabled
  • attributeString
  • attributes
Receipt (buy) layout
Scroll upRead more...

Renders these tags

{{orderId}} Internal ID associated with the purchase
{{amount}} The amount paid
{{authorizationCode}} Authorization code returned by the payment gateway
{{errorMessage}} Error message returned by the payment dateway
{{invoiceNumber}} Invoice number
{{paymentStatus}} The status of the order, possible values Success, Failed or Pending
{{amountExceptShipping}} The total amount excluding shipping cost
Receipt (quote) layout
Scroll upRead more...

Renders these tags

{{orderId}} Internal ID associated with the purchase
Shopping cart layout
Scroll upRead more...

Renders these tags

{{buyUrl}}

The URL for the Buy button

To ensure server side validation of shipping options please add &VS=True
<a href="{{burUrl}}&VS=True">Checkout</a>

{{buyButtonOnClick}} The javascript event to be assigned to the Buy button
{{clearCartOnClick}} The javascript event to be assigned to the clear cart button
{{items.custom1}} Custom field #1. Use to display any information about a product
{{items.custom2}} Custom field #2. Use to display any information about a product
{{items.custom3}} Custom field #3. Use to display any information about a product
{{items.custom4}} Custom field #4. Use to display any information about a product
{{quoteUrl}} Link to checkout and request a quote.
{{giftVoucher}} An input box for customer to enter gift voucher code in
{{giftVoucherAmount}} Total amount of credit applied to this order as a result of a gift voucher
{{giftVoucherOnChange}} The javascript event applied to the gift voucher controls
{{invoiceDiscountAmount}} Total discount amount based on the discount code entered (shipping price isnotdiscounted)
{{invoiceTotal}} Total cost of the current cart (factoring in all cost and discounts)
{{invoiceTotalExceptTaxAmount}} Invoice total amount excluding tax (e.g. products ex tax + shipping ex tax)
{{productTaxPercentage}} To use this tag, you should enter in the prices of all your products inclusive of tax. To show how much of the product price will be paid as a sales tax, use {tag_producttaxpercentage, 12.5} tag where 12.5 is the percentage of tax to be paid.
{{totalTaxPercentage}} To use this tag, you should enter in the prices of all your products inclusive of tax. To show how much of the total price will be paid as a sales tax , use {tag_producttaxpercentage, 12.5} tag where 12.5 is the percentage of tax to be paid.
{{orderId}} Order ID normally assigned to quotes. You can also use this value to search for the order in the Admin console's CRM > Search panel
{{code}} Product code. With variations enabled, tg product will render the variation code instead of the product codes in all layouts where this is used.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{body}} Product description as it appears in the WYSIWYG editor
{{productGrandTotal}} Total price of all products including tax in the cart
{{imagePath}} The path of the product's image
{{productAmountIncludingTax}} Price of each product including tax in the cart
{{name}} List of product names in the cart
{{quantity}} Number of units of each product in the cart
{{removeOnClick}} The event to be associated with the remove product button
{{productSubTotal}} Total price of all products excluding tax in the cart
{{productTaxAmount}} Amount of tax for each product in the cart
{{productTaxRate}} Tax rate associated with each product in the cart
{{productTaxTotal}} Total tax amount for all products in the cart
{{productTotal}} Total price of each product in the cart (e.g. units x unit price inc tax)
{{productTotalExceptTax}} Total amount for product excluding tax (Product x Quantity)
{{shippingTaxAmount}} Amount of tax associated with the shipping option chosen
{{shippingTaxRate}} Tax rate associated with the shipping option chosen
{{shippingTotal}} Total cost of the shipping option chosen (e.g. shipping ex tax + shipping tax)
{{totalUnits}} Total product units in the cart
Registration (buy) layout
Scroll upRead more...

Is used by these modules

  • This layout HTML code used for the Check Out form. Users get to this form as the final step of the shopping experience after clicking the checkout button outputted by the {tag_buybutton} tag found on the shopping cart layout.
Individual product (large) layout
Scroll upRead more...

This layout is not used by any module per se.

Site visitors get to it only after clicking the links outputted by any of these tags {tag_button,Your Text}, {tag_name} or {tag_itemurl_withhost}.

Renders these tags


{{title}} The product's title
{{attributes}} Renders attribute dropdowns for a given product.

Parameters:

  • horizontal – kept existing behavior
  • hideDisabledVariations – true or false
  • autoSelectFirstVariation – true or false

The Liquid tag renders an object, use json filter to see it's properties like so: null

{{countryCode}} Display the country code; for example, AU
{{countryCurrencyFormat}} Display the country currency code; for example, AUD
{{currencyFormat}} Display the currency format; for example, $
{{custom1}} Custom field #1. Use to display any information about a product
{{custom2}} Custom field #2. Use to display any information about a product
{{custom3}} Custom field #3. Use to display any information about a product
{{custom4}} Custom field #4. Use to display any information about a product
{{description}} Description of the product (Editor content)
{{discountPrice}} The price if a discount applies to the current customer otherwise the normal sale price.
{{expiryDate}} Expiration date of product
{{groupingList}}

List of product attributes used to switch between products.

The Liquid tag renders an object, use json filter to see it's properties like so: null

{{inStock}} Number of units in stock.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{url}} URL to the item referred, without host
{{urlWithHost}} URL to the item referred, with host
{{largeImageUrl}} Outputs the file path of the image; for example /images/imagename.jpg
{{maxUnits}} Maximum units
{{minUnits}} Minimum units
{{name}} Name of product
{{onOrder}} Number of units on order.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{isOnSale}} Renders 1 if product on sale, otherwise 0. If page elements need to be altered for products on sale, then embed tag in relevant javascript.
{{poplets}} Displays thumbnail version of poplet images. If you add ,noscript to this tag it will render the poplets with no default javascript lightbox feature. e.g. {tag_poplets,4,100,100,noscript}
{{productCode}} Product code. With variations enabled, tg product will render the variation code instead of the product codes in all layouts where this is used.

Parameters:

  • syncWithAttributes – true or false
  • noSelectionMessage – specify the message displayed when site customer has not selected a variation
  • disabledSelectionMessage – specify the message displayed when site customer has selected a variation that is disabled
{{metaDescription}} Meta description information added in the SEO Metadata section of product details page.
{{metaTitle}} Meta title information added in the SEO Metadata section of product details page.
{{releaseDate}} Release date of item
{{reorder}} Number of units to reorder threshold
{{retailPrice}} Retail price of the product
{{salePrice}} Sale price of the product (the amount that customers are charged)
{{wholesalerPrice}} Wholesaler price of the product (the amount "wholesale" type customers are charged)
{{smallImage}} Outputs the path of the small image
{{smallImageUrl}} Outputs the file path of the image; for example /images/imagename.jpg
{{tags}} Product tags (you can use field for anything)
{{tax}} Tax amount for the product
{{taxCode}} Tax code name used for item
{{taxRate}} Tax rate used for item (%)
{{totalDiscountPrice}} Total discounted price of the product: Discount Price + Tax.
{{totalPrice}} Total price of the product: Sale Price + Tax
{{totalRetailPrice}} Total retail price of the product: Retail Price + Tax
{{unitType}} Product unit type: single, by the dozen
{{id}} Displays product system id.
{{catalogId}} Displays catalog system id the product is currently displayed in
{{inventoryByAttributes}} Renders a JSON object that containsthe following parameters:
  • id
  • sku
  • inStock
  • onOrder
  • enabled
  • attributeString
  • attributes

Web apps

Webapp edit layout
Scroll upRead more...

Is used by these modules

Site visitors get to it only after clicking the links outputted by the tag {tag_edit} which can be found on the list layout.

Renders these tags

Warning: if you need to access a liquid tag that has a space in its name, for example tag_large image_value use this syntax: {{this.items[0].["large image_value"]}} - Liquid does not allow for the name of its output tags to contain spaces. In this case the tag that contains a space needs to be wrapped in square brackets and quotes and preceded by "this.".

{{itemid}} Item's system ID
{{image}} For "Image" type fields only - renders the image's src, for example /images/dog.jpeg
{{datasource_id}} Renders the ID of the datasource field e.g. - if my datasource field is named country, the tag will be {tag_country_id}
{{datasource}} Renders a link to the datasource item e.g. - if my datasource field is named country, the tag will be {tag_country}

Webapp detail layout
Scroll upRead more...

Is used by these modules

Site visitors get to it only after clicking the links outputted by the tag {tag_name} or {tag_button} which can both be found on the list layout.

Renders these tags

Warning: if you need to access a liquid tag that has a space in its name, for example tag_large image_value use this syntax: {{this.items[0].["large image_value"]}} - Liquid does not allow for the name of its output tags to contain spaces. In this case the tag that contains a space needs to be wrapped in square brackets and quotes and preceded by "this.".

{{itemid}} Item's system ID
{{address1}} Address1
{{address2}} Address2
{{city}} City
{{country}} Country
{{country_id}} The ID of the country
{{country_url}} The URL of the country
{{latitude}} Latitutde of web app item address
{{longitude}} Longitude of web app item address
{{state}} State
{{zipcode}} ZIP code
{{classifications}} List of categories that this industry content is classified under
{{commentCount}} Number of comments on the current item
{{description}} Description of item (editor content)
{{expiryDate}} Expiry date of item in dateTime format
{{lastUpdateDate}} Last update date of item in dateTime format
{{name}} Name of the item
{{releaseDate}} Release date of item in dateTime format
{{weight}} Weighting of item
{{urlWithHost}} Full URL of the web app item including host for example http://mysamplesite.com/car-catalogue/ford-explorer
{{url}} Relative URL of the web app item for example /car-catalogue/ford-explorer
{{image}} For "Image" type fields only - renders the image's src, for example /images/dog.jpeg
{{datasource_id}} Renders the ID of the datasource field e.g. - if my datasource field is named country, the tag will be {tag_country_id}
{{datasource}} Renders a link to the datasource item e.g. - if my datasource field is named country, the tag will be {tag_country}

Note: When using a custom image field type for Web Apps, by default the image tag outputs the full HTML image source and a link. Example:

<a href="/web-app/detail-web-app"><img src="/folder/imagename.jpg" border="0" alt=""></a>

You can customize custom image tags, by appending the below parameters to the tags:

  • _value eg. {tag_my custom image_value} - Outputs the file path of the image. For example /folder/image.jpg
  • _nolink eg. {tag_my custom image_nolink} - Ensures that the image does not link to the detailed view of the web app item
Webapp list layout
Scroll upRead more...

Is used by these modules

Renders these tags

Warning: if you need to access a liquid tag that has a space in its name, for example tag_large image_value use this syntax: {{this.items[0].["large image_value"]}} - Liquid does not allow for the name of its output tags to contain spaces. In this case the tag that contains a space needs to be wrapped in square brackets and quotes and preceded by "this.".

{{itemid}} Item's system ID
{{address1}} Address1
{{address2}} Address2
{{city}} City
{{country}} Country
{{latitude}} Latitutde of web app item address
{{longitude}} Longitude of web app item address
{{state}} State
{{zipcode}} ZIP code
{{button}} will output a hyperlink with the text "Your Text" and when clicked will take the site visitor to the detail layout
{{commentCount}} Number of comments for current post
{{counter}} Incremental count of the item on the page
{{deleteUrl}} The URL that allows current customer to delete a web app item they have previously submitted (only available if customer logged in to a secure zone)
{{description}} Description of item (editor content). On the "List Layout (Backup)" you can use {tag_description,10} to display the first 10 characters of the webapp item's description.
{{editUrl}} Creates a link that allows current customer to edit a web app item they have previously submitted (only available if customer logged in to a secure zone). Clicking this link will open up the edit layout
{{expiryDate}} Expiry date of item in dateTime format
{{lastUpdateDate}} Last update date of item in dateTime format
{{name}} Name of item (without hyperlink)
{{releaseDate}} Release date of item in dateTime format
{{weight}} Weighting of item
{{urlWithHost}} Full URL of the web app item including host for example http://mysamplesite.com/car-catalogue/ford-explorer
{{url}} Relative URL of the web app item for example /car-catalogue/ford-explorer
{{rowcss}} Replate myclass with your own CSS class. Alternates between classes, such as "myclass" and "myclass_alternate"
{{image}} For "Image" type fields only - renders the image's src, for example /images/dog.jpeg
{{datasource_id}} Renders the ID of the datasource field e.g. - if my datasource field is named country, the tag will be {tag_country_id}
{{datasource}} Renders a link to the datasource item e.g. - if my datasource field is named country, the tag will be {tag_country}

Blog tags

Blog post list layout
Scroll upRead more...

Is used by these modules:

Renders these tags

{{type}} The Blog type ID (56)
{{author}} Author of the post
{{body}} Details of the post. When using the legacy tag you can specify the number of characters the body will be truncated after and the link to be added at the end, e.g. {tag_blogpostbody,50,[...]}
{{date}} Date of the post e.g. 24-Aug-2014. The Liquid tag uses the dateTime format
{{date | date: "dd"}} Day of the post. The Liquid tag uses the dateTime format
{{date | date: "MMMM"}} Month of the post. The Liquid tag uses the dateTime format
{{date | date: "MM"}} Month part of the date the blog post was posted as a numeric value, e.g. 11-Dec-14 will render 12. The Liquid tag uses the dateTime format
{{title}} The title of the post as an anchor linked to the permalink
{{postFeaturedImage}} The featured image's URL of the blog post (relative to site root). e.g. /img/featured-1.jpg
{{date | date: "yyyy"}} Year part of the date that the post was submitted, e.g. 11-Dec-14 will render as the year only, like this: 2014 . The Liquid tag uses the dateTime format
{{commentsCount}} Number of comments for current post
{{trackbacksCount}} Number of trackbacks for current post
{{trackbackUrl}} Link for trackback
{{id}} Displays the blog post's ID
{{authorPictureUrl}} Will render the picture url (relative to site root). e.g. /images/profile.jpg
{{url}} URL to the item being referred, without host
Blog comment list layout
Scroll upRead more...

Is used by these modules:

  • This is actually called through {tag_commentspaged}, which can be found in the Detail Layout
  • If you use Liquid, the properties below are nested under tag_commentspaged_(UNIQUE-ID-HERE).

Renders these tags

{{body}} Customer comment
{{fullName}} Full name of the person who submitted the comment (anonymous if not available)
{{rating}} Rating in stars, the Liquid tag represents the numeric value of the rating
{{date}} Date when comment was given
{{country}} The country of the site visitor who posted the comment.
{{flagUrl}} The URL of the flag associated with the site visitor's country
{{website}} The value of the "website" field.
{{postUrlWithHost}} The URL of the post this comment is associated with.

Blog post details layout
Scroll upRead more...

Is used by these modules:

Renders these tags

{{type}} The Blog type ID (56)
{{author}} Author of the post
{{date}} Date of the post
{{body}} Content of the post
{{commentsCount}} Number of comments for current post
{{trackbacksCount}} Number of trackbacks for current post
{{id}} Generates the blog post id
{{day}} Day of the post
{{month}} Month of the post
{{monthNumeric}} Month of the post in numeric format, e.g Mar = 3
{{metaDescription}} Renders the blog post meta description entered in the SEO Metadata Description field in the Blog post interface
{{metaTitle}} Renders the blog post meta title entered in the SEO Metadata Title field in the Blog post interface
{{title}} The title of the post as an anchor linked to the permalink
{{postFeaturedImage}} The featured image's URL of the blog post (relative to site root). e.g. /img/featured-1.jpg
{{year}} Year part of the date that the post was submitted. Example: 11-Dec-14 will render as the year only, like this: 2014
{{pendingComment}} Checks if status of the comment is set to "pending" from admin, in which case outputs the following message: Your comment is awaiting moderation!
For additional information on how to render the output of this tag using Liquid take a look at the Enable other Liquid tags article.
{{trackbackUrl}} Link for trackback
{{authorBiography}} Displays the author's biography
{{authorPictureUrl}} Will render the picture url (relative to site root). e.g. /images/profile.jpg
{{urlwithhost}} URL to the item referred, with host
{{rating}} Rating in stars, the Liquid tag represents the numeric value of the rating
Blog overall layout
Scroll upRead more...

Is used by these modules:

Renders these tags

{{id}} The Blog's ID
{{title}} Name of the blog
{{description}} Description of the blog
{{pagination}} Pagination controls:
  • currentPage
  • itemsPerPage
  • numberOfPages
  • totalItemsCount
  • previousPageUrl (null if empty)
  • nextPageUrl (null if empty)
{{pagination.previousPageUrl}} Link to the previous page of blog posts
{{pagination.nextPageUrl}} Link to the next page of blog posts
Blog list layout
Scroll upRead more...

Is used by these modules:

Renders these tags

{{title}} Name of the blog (with a link to the blog)
{{counter}} Incremental count of the item on the page
{{description}} Description of the blog
{{expiryDate}} Expiry date of blog in dateTime format
{{lastPostDate}} Last post date of blog
{{lastUpdateDate}} Last update date of blog
{{releaseDate}} Release date of blog in dateTime format
{{totalPosts}} Total number of the posts in blog
{{url_withhost}} URL to the item referred, with host

e-Commerce

{module_product}
Scroll upRead more...

Syntax

{module_product render="items" catalogId="14886" targetFrame="_blank" productid="954557" useLi="false" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - for this module this can only be item. For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • catalogId - system generated catalogue id (do not change)
  • productid - system generated product id (do not change)
  • targetFrame - possible values are _blank, _self and _top. This parameter is used to specify the frame you want the item to open in.
  • useLi - wrap the module output in a list rather than a table
  • usebackupLayout - use the backup layout instead of the default one. The value of this parameter is ignored if the template parameter is also present.
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the individual product layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Individual Product - Small reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_product catalogId="591" productid="166845" targetFrame="_blank" } - will display a single product according to the Individual Product - Small. If one clicks the product link the product detail window will open in a new tab.
  • {module_product catalogId="63882" productid="5450055" targetFrame="_top" template="/layouts/custom/productfeaturelist.tpl"} - this rendes an individual product a custom template.
  • {module_product catalogId="591" productid="166845" collection="collection1" template="/folder/template.tpl"} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_productfeaturelist}
Scroll upRead more...

Syntax

{module_productfeaturelist render="collection" tag="featured" rowCount="4" sortType="Weight" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - for this module the value of this parameter can only be collection (if no value is specified the default will be collection). For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • tag being the product tag
  • rowCount - will limit the number of items displayed
  • sortType can be alphabetical, price, date, expirydate or weight
  • targetFrame - possible values are _blank, _self and _top. This parameter is used to specify the frame you want the item to open in.
  • useBackupLayout can be true or false. The value of this parameter is ignored if the template parameter is also present.
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered:

  • the individual product layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Individual Product - Small reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_productfeaturelist tag="special offer"} - lists all the products that are tagged with the "special offer" tag
  • {module_productfeaturelist tag="special offer" sortType="price" targetFrame="_blank" useBackupLayout="true"} - lists the products that are tagged with the "special offer" tag using the backup template. The products are sorted by price (cheapest first) and when clicking the product's name the detail view opens in a new window
  • {module_productfeaturelist tag="special offer" rowCount="3" sortType="price" targetFrame="_blank" useBackupLayout="true" template="/layouts/custom/productfeaturelist.tpl"} - lists 3 products that are tagged with the "special offer" tag using a custom template (the "true" parameter that states the backup template should be used is ignored). The products are sorted by price (cheapest first) and when clicking the product's name the detail view opens in a new window
  • {module_productfeaturelist tag="special offer" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_productlistdump}
Scroll upRead more...

Syntax

{module_productlistdump catalogId="14886" rowCount="2" targetFrame="_blank" sortType="Weight" collection="my_custom_collection_name" template=""}

Parameters

  • catalogId - the catalogID, the productlistdump will list the products inside that catalog. This can also be "-1" - this will list all the products in the site.
  • rowCount - will limit the number of items per row when items are displayed as a list. Default is 1 item per row
  • targetFrame - possible values are _blank, _self and _top. This parameter is used to specify the frame you want the item to open in.
  • sortType - will sort the item in specified order
    • Alphabetical - sorts items alphabetically
    • Weight - sorts items by weight
  • collection - use this if you need to access the module's Liquid output tags
  • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

This module can be rendered using:

  • a generic unordered list:
    <ul class="catalogueitemdump">
    <li><a href="/catalog1/product1">This is my first product</a></li>
    <li><a href="/catalog1/product2">This is my secondproduct</a></li>
    </ul>
  • Liquid collections - the output is a Liquid collection containing the products:

"dump": {
    "moduleName": "productlistdump",
    "moduleDescriptor": {
      "templatePath": "",
      "parameters": "collection=\"dump\"",
      "apiEndpoint": "/api/v3/productlistdump",
      "objectType": "27",
      "objectId": "-1",
      "adminUrl": "/Admin/Products_Detail.aspx?ProductID=-1"
    },
    "items": [
      {
        "name": "Sample Product 1",
        "url": "/spicy-perfumes/sample-product-1"
      },
      {
        "name": "Sample Product 2",
        "url": "/designer-brands/sample-product-2"
      },
      {
        "name": "Sample Product 3",
        "url": "/designer-brands/sample-product-3"
      },
      {
        "name": "Sample Product 4",
        "url": "/woody-parfumes/sample-product-4"
      },
      {
        "name": "Sample Product 5",
        "url": "/classic-boutique/sample-product-5"
      },
      {
        "name": "Sample Product 6",
        "url": "/woody-parfumes/sample-product-6"
      },
      {
        "name": "Sample Product 7",
        "url": "/spicy-perfumes/sample-product-7"
      },
      {
        "name": "Sample Product 8",
        "url": "/classic-boutique/sample-product-8"
      }
    ]
  }

Examples

  • {module_productlistdump catalogId="63858" targetFrame="_blank" sortType="Alphabetical"} - displays all the products in the catalog with the ID 63858 ordered alphabetically. Clicking a product will open its detail view (rendered using the Individual Product - Large layout) in a new tab.
  • {module_productlistdump catalogId="-1" targetFrame="_self" sortType="weight"} - displays all the products regardless of the catalog they are in ordered by weight. Clicking a product will open its detail view (rendered using the Individual Product - Large layout) in the same tab.
  • {module_productlistdump catalogId="63858" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_catalogue}
Scroll upRead more...

Syntax

{module_catalogue render="item" catalogId="14886" rowCount="2" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - for this module this can only be item. For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • catalogId - system generated catalogue id (do not change)
  • rowCount - will limit the number of items per row
  • targetFrame - e.g. _blank. Specify the frame you want the item to open in
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the individual catalog layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Individual Catalog's reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:
{module_shoppingcartsummary}
Scroll upRead more...

Syntax

{module_shoppingcartsummary render="collection" direction=“vertical” collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - for this module the value of this parameter can only be collection (if no value is specified the default will be collection). For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • direction - values are vertical or horizontal. Default is that the output is displayed horizontally.
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • your custom layout - take a look at the Shopping cart summary layout article for the exact steps you need to take
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_shoppingcartsummary direction="vertical"} - this module will display the output vertically.
  • {module_shoppingcartsummary collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    
        "collection1": {
        "moduleName": "shoppingcartsummary",
        "moduleDescriptor": {
          "templatePath": "",
          "parameters": "",
          "apiEndpoint": "/api/v3/shoppingcartsummary",
          "objectType": "-1",
          "objectId": "-1",
          "adminUrl": ""
        },
        "editableFieldTypes": {
          "price": "Number",
          "quantity": "Number",
          "totalPrice": "Number"
        },
        "cartUrl": "/OrderRetrievev2.aspx?CatalogueID=0",
        "itemCount": "5",
        "totalAmount": "54.95",
        "currencyFormat": "$",
        "countryCode": "US",
        "items": [
          {
            "id": 281509,
            "productId": 9008560,
            "catalogId": 176691,
            "name": "Panda World T-Shirt",
            "code": "SHDA9ZVVWY",
            "description": "M",
            "price": "10.99",
            "quantity": 3,
            "totalPrice": "32.97",
            "smallImage": "/shop/tshirt2.jpg",
            "url": "/mens-t-shirts/panda-world-t-shirt"
          },
          {
            "id": 281511,
            "productId": 9008559,
            "catalogId": 176854,
            "name": "Doomsday T-Shirt",
            "code": "HOONI2M83X",
            "description": "S",
            "price": "10.99",
            "quantity": 2,
            "totalPrice": "21.98",
            "smallImage": "/shop/tshirt3.jpg",
            "url": "/womens-t-shirts/doomsday-t-shirt"
          }
        ]
      }
      

Web Apps

{module_webapps}
Scroll upRead more...

Syntax

{module_webapps render="item|collection" id="webappId|webappName" filter="item" itemId="123" targetFrame="" resultsPerPage="" hideEmptyMessage="false" rowCount="" sortType="ALPHABETICAL" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • id - the web app name or the web app's ID
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
    • latest - latest items
    • latestClassified - latest items in a category
    • random - random item
    • randomClassified - displays a random item in a particular category
    • classified - all the items in a category
  • itemId - the category ID or the category name
  • targetFrame - e.g. _blank. Specify the frame you want the item to open in
  • useBackupTemplate - specify true if you want to use the backup list template or leave empty. The value of this parameter is ignored if the template parameter is also present.
  • resultsPerPage - total number of items per page before pagination is used (limit of 500 items per page)
  • hideEmptyMessage - specify True if you don't want the No Items Found message to be displayed.
  • rowCount - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
  • sortType - will sort the web apps in specified order.
    • alphabetical (default) - items are sorted in alphabetical order form A-Z
    • date - will display the web app items newest to oldest
    • datereverse - will display the web app items oldest to newest
    • weightreverse - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.
    • comments - display the items with the largest number of Comments first (can be used for a 'highest votes' type display).
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the webapp list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the Webapp List Layout's reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_webapps id="56" filter="all" targetFrame="_blank" useBackupTemplate="true" resultsPerPage="12" hideEmptyMessage="true" rowCount="3"} - this module will display 12 web app items according in the list view in the new window in three items per row way and the web app will use the backup layout.
  • {module_webapps id="123" filter="all" rowCount="12" } - will only display 12 items per page
  • {module_webapps id="123" filter="latest" rowCount="5"} - will only display the latest 5 items (by date) on the page
  • {module_webapps id="56" filter="all" resultsPerPage="10" rowCount="1" template="/layouts/custom/walist.html"} - will only display 10 items using the walist.html custom template
  • {module_webapps id="123" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

The previous and next links can be customized using CSS. Each link has its own custom CSS class. To see the CSS class assigned to these links view the web page source where these links appear. The CSS class name format is: WebAppIDPrev and WebAppIDNext where ID is the internal ID assigned to your Web App. You can easily find the ID using Firebug once on the live page.

{module_webappsmap}
Scroll upRead more...

Syntax

{module_webappsmap id="webappId|webappName" filter="item" itemId="categoryId|categoryName)|itemId" googleKey="" width="400" height="400" collection="my_custom_collection_name" template=""}

Parameters

  • id - the webapp ID or the webapp name
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
    • latest - latest items
    • latestClassified - latest items in a category
    • random - random item
    • randomClassified - displays a random item in a particular category
    • classified - all the items in a category
  • itemid -the category ID or the category name
  • googleKey - enter the Google Maps key here. To get a key please follow the steps described in this article.
  • width - the width in pixels of the Google Maps canvas
  • height - the height in pixels of the Google Maps canvas
  • resultsPerPage - total number of items that will be rendered, enter "-1" to render all the items
  • collection - use this if you need to access the module's Liquid output tags
  • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

This module is rendered:

  • using a Google map - the webapp items are plotted as pins on a Google map, for example:
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_webappsmap id="56" filter="a" googleKey= "ABCD" width="400" height="400" resultsPerPage="-1"} - displays all the webapp items on a 400px x 400px Google map
  • {module_webappsmap id="56" googleKey= "ABCD" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_webappscustomer}
Scroll upRead more...

Syntax

{module_webappscustomer render="item|collection" id="webappID|webappName" filter="item" itemId="categoryId|categoryName|itemId" targetFrame="" useBackupTemplate="true" resultsPerPage="" hideEmptyMessage="true|" rowCount="" sortType="ALPHABETICAL" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • id - web app id or the web app's name
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
    • latest - latest items
    • latestClassified - latest items in a category
    • random - random item
    • randomClassified - displays a random item in a particular category
    • classified - all the items in a category
  • itemid - system generated individual item id (do not change)
  • targetFrame - e.g. _blank. Specify the frame you want the item to open in
  • useBackupTemplate - specify True if you want to use the backup list template or leave empty
  • resultsPerPage - total number of items per page before pagination is used (limit of 500 items per page)
  • hideEmptyMessage - specify true if you don't want the No Items Found message to be displayed.
  • rowCount - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
  • sortType
    • ALPHABETICAL (default) - items are sorted in alphabetical order form A-Z
    • DATE - items are sorted from newest to oldest. The most recent item is displayed first.
    • DATEREVERSE - will display the web app items oldest to newest
    • WEIGHTREVERSE - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the webapp list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the Webapp List Layout's reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_webappscustomer id="56" filter="all"} - will display all web app items that belong to the customer that's logged in for a web app with ID 56
  • {module_webappscustomer id="56" filter="classified" itemid="14609" targetFrame="_blank" resultsPerPage="13" template="/layouts/custom/walist.html"} - will display the webapp items in the category with the ID 14609 using the walist.html custom template, 13 items per page
  • {module_webappscustomer id="56" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_webappsresults}
Scroll upRead more...

Syntax

{module_webappsresults render="items|collection" targetFrame="_blank" resultsPerPage="4" hideEmptyMessage="true" rowCount="2" sortType="DATE" collection="my_custom_collection_name" template=""}

Parameters

  • render - optional parameter, indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • targetFrame - e.g. _blank. Specify the frame you want the item to open in
  • useBackupTemplate - specify true if you want to use the backup list template or leave empty. The value of this parameter is ignored if the template parameter is also present.
  • resultsPerPage - total number of items per page before pagination is used
  • hideEmptyMessage - specify true if you don't want the No Items Found message to be displayed.
  • rowCount - will limit the number of items per row when items are displayed as a list. Default is 1 item per row.
  • sortType
    • ALPHABETICAL (default) - items are sorted in alphabetical order form A-Z
    • DATE - items are sorted from newest to oldest. The most recent item is displayed first.
    • DATEREVERSE - will display the web app items oldest to newest
    • WEIGHTREVERSE - allows you to display the web apps by weight but in reverse, that is the item with the smallest weight is displayed first.
  • collection - use this if you need to access the module's Liquid output tags
  • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

This module can be rendered using:

  • the webapp list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the Webapp List Layout's reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_webappsresults targetFrame="_blank" useBackupTemplate="true" resultsPerPage="16" hideEmptyMessage="true" rowCount="3" sortType="REVERSEDATE"} - This module will display the web app search results
  • {module_webappsresults collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

Blogs

{module_blog}
Scroll upRead more...

Syntax

{module_blog render="item|collection" filter="item" itemId="1" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
    • latest - latest items
    • latestClassified - latest items in a category
    • random - random item
    • randomClassified - displays a random item in a particular category
    • classified - all the items in a category
  • itemId- system generated (do not change), this is the blog item's ID
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the blog list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Blog list's reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_blog filter="item" itemId="419"} - will display the individual blog with ID of 419
  • {module_blog filter="item" itemId="419" template="/layouts/template.tpl"} - will display the individual blog with ID of 419 using the template.tpl custom template
  • {module_blog itemId="419" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_blogpostlist}
Scroll upRead more...

Syntax

{module_blogpostlist render="item|collection" collection="my_custom_collection_name" template="/folder/template.tpl" blogId="24" rowCount="10" tag="tag"}

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • blogId - system generated, replace with -1 to render blog posts across all the blogs
  • rowCount - how many posts to display - the default is 10
  • tag - name of the tag you want ot display the posts for. If is empty all the posts will be listed.
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the blog list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Blog list's reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_blogpostlist blogId=" 419" rowCount="1" tag="business "} - will display latest post in the blog with ID 419 where the tag is the word business
  • {module_blogpostlist blogId="419" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_blogsitepost}
Scroll upRead more...

Syntax

{module_blogsitepost rowCount="4" collection="my_custom_collection_name" template="/"}

Parameters

This module can be rendered using:

  • the blog list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Blog list's reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_blogsitepost rowCount="2"} - will display the most recent 2 posts on the site.
  • {module_blogsitepost collection="blog-posts" template=""} - will not render anything. What will happen is the Liquid "blog-posts" collection will become available. Take a look at this article for more information on collections.
{module_blogsitesummary}
Scroll upRead more...

Syntax

{module_blogsitesummary render="item|collection" blogId="24" rowCount="6" collection="my_custom_collection_name" template=""}

Parameters

  • render - optional parameter, indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • blogId - if you use -1, you will display the summary across the whole site. For a single blog you need to use the blog ID.
  • rowCount - limits the number of posts the module can display. Default is 5 posts.
  • collection - use this if you need to access the module's Liquid output tags
  • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

This module can be rendered using:

  • the blog list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: Blog list's reference page
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_blogsitesummary blogId="9216"} will output:
    
    <ul>
        <li>Some Philosophical questions Richard Dawkins 01-Jan-2000</li>
        <li>Welcome to my Blog! Woody Mark 01-Jan-2000</li>
    </ul>
    
  • {module_blogsitesummary blogId="9216" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

As you can see above, the module displays the post titles followed by the name of the author and the date.

{module_blogtaglist}
Scroll upRead more...

Syntax

{module_blogtaglist render="item|collection" blogId="24" rowCount="2" collection="my_custom_collection_name" template=""}

Parameters

  • render - optional parameter, indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • blogId - ID of the targeted blog
  • rowCount - number of rows to be generated (each tag is listed on a separate row, so if the row count is limited to 2, only the first 2 tags will be generated)
  • collection - use this if you need to access the module's Liquid output tags
  • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

This module can be rendered using:

  • a generic list (this layout cannot be modified):
    module_blogtaglist_output
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_blogtaglist blogId="4168" rowCount="3"} will output:
    
    <ul>
    <li> Tag 1 (1)</li>
    <li> Tag 2 (2)</li>
    <li> Tag 3 (1)</li>
    </ul>
  • {module_blogtaglist collection="collection1" blogId="24" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.

Other modules

{module_announcement}
Scroll upRead more...

Syntax

{module_announcement render="item|collection" filter="item" itemid="newsId" noTemplate="true" effect="ajax" targetFrame="blank" sortType="alphabetical" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
    • latest - latest items
    • latestClassified - latest items in a category
    • random - random item
    • randomClassified - displays a random item in a particular category
    • classified - all the items in a category
  • itemid – the itemID or the categoryId, depending on the filter type can be hoe many items to display
  • noTemplate – if you want to force the item not to use a site-level template when displayed pass in true, otherwise leave empty or you can also pass false
  • effect – enter ajax (see the examples below) if you want to take advantage of the latest web technologies for a better customer experience
  • targetFrame – the frame in which to open the item in
  • rowLength - this parameter is only used when the filter is either "l" or "cl" and dictates how many items are rendered per row
  • resultsPerPage - number of items per page
  • hideEmptyMessages - hide the default text rendered when no announcements are found
  • sortType - if you leave this parameter blank, by default announcements will be sorted from the latest to the oldest where the latest is displayed first
    • alphabetical - will sort announcements alphabetically
    • datereverse - will sort announcements in the reverse order, that is from the oldest to the latest
  • collection - use this if you need to access the module's Liquid output tags
  • template - optional, for this module this can either represent the path of the custom template you want to use, or use a blank value (template="") if you need to suppress the original output and use Liquid output tags instead

Layouts

Examples

  • {module_announcement filter="all" targetFrame="_parent"} - will display all news items and open them in parent frame
  • {module_announcement filter="latest" itemid="5"} - will display the latest 5 news
  • {module_announcement filter="random" noTemplate="true" effect="ajax" targetFrame="_blank" sortType="datereverse"} - will open a random item in a new window and will not apply the template and will use the Ajax effect where the detail content opens right underneath the news name and all the news items will be displayed from the oldest to the latest
  • {module_announcement filter="latestClassified" itemid="34392" effect="ajax" resultsPerPage="5"} - will display the 5 latest news items in the category with the ID 34392
  • {module_announcement filter="all" effect="ajax" targetFrame="_blank" template="/Layouts/Custom/news.tpl"} - will display all the news items using the "ajax" effect using the news.tpl custom template
  • {module_announcement filter="all" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_adrotator}
Scroll upRead more...

Syntax

{module_adrotator render="item" collection="my_custom_collection_name" adrotatorid="123" template="/folder/template.tpl"}

Parameters

  • render - for this module this can only be item. For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • collection - use this if you need to access the module's Liquid output tags
  • ID - this parameter is assigned by the system and should nor be altered
  • template - render the module using a custom template.

This module can be rendered using:

  • a single image nested in a hyperlink - when the user clicks the image he is taken to the URL specified in the "Click-Thru URL" field.
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_adrotator adrotatorid="15264"} - This generates the ad rotator with the ID 15264
{module_menu}
Scroll upRead more...

Syntax

{module_menu menuID="ID" version="1" render="collection" collection="my_custom_collection_name" template="/folder/template.tpl"}
{module_menu menuID="ID" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • version - 1 (if not specified the default is 1)
  • render - for this module the value of this parameter can only be collection (if no value is specified the default will be collection). For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • menuId - system generated menu id (do not change)
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered:

  • fixed layout - by default the menu is rendered as a table nested in a div element
  • using a custom template - this module supports custom templates
  • using Liquid collections - this is the Liquid output tags you can use:

Examples

  • {module_menu menuId="128392"} - will generate the menu with the ID 128392
  • {module_menu menuId="128392" template="/layouts/custom/menu1.tpl"} - will render the menu according to the custom template
  • {module_menu menuId="128392" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_literature}
Scroll upRead more...

Syntax

{module_literature render="item|collection" filter="item" itemid="literature-item-Id or classificationId" targetFrame="blank" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
    • latest - latest items
    • latestClassified - latest items in a category
    • random - random item
    • randomClassified - displays a random item in a particular category
    • classified - all the items in a category
  • itemid - the ID of the literature item or the ID of the categorysystem generated (do not change)
  • targetFrame - the frame in which to open the item in
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the News layout reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:

Examples

  • {module_literature filter="item" itemid="823" targetFrame="_blank"} - This will display the link to individual literature item which when clicked will open in the new window
  • {module_literature filter="a" targetFrame="_blank"} - This module will display links to all literature items which when clicked will open in the new window
  • {module_literature filter="latest"} - This module will display the latest items (default is 10 items)
  • {module_literature filter="random"} - This module will display 1 random literature item
  • {module_literature filter="cr" itemid="14606"} - This module will display 1 random literature item, from the category called "Company", identified through id 14606
  • {module_literature filter="item" itemid="823" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
{module_photogallery}
Scroll upRead more...

Syntax

{module_photogallery render="item|collection" id="12345" rowCount="2" targetFrame="_blank" resultsPerPage="4" width="400" height="400" useStandardMethod="true|false" thumbnail="proportional|fill_proportional|fill" collection="my_custom_collection_name" template="/folder/template.tpl"}

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • id - System generated ID (Do not change this number.)
  • rowCount - Set the number of photos displayed per row
  • targetFrame - Set the destination frame where the photos will open (such as _blank)
  • resultsPerPage - Set the number of photos displayed per page
  • width/height - Set the width and height of the thumbnail images. The default value is 80 pixels wide by 80 pixels high.
  • useStandardMethod - Use the standard Thumbnail Generation. Set to false for better thumbnail quality (with increased file size).
  • thumbnail - To avoid squashed images and control image proportion size. Use the following paramaters: proportional, fill, fill_proportional.
  • collection - use this if you need to access the module's Liquid output tags
  • template - you can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

Note: If an image is 640 pixels wide x 400 pixels high and you set the thumbnail size to 120 x 120 pixels, the thumbnail image will have a maximum width of 120 and a smaller height. Proportions are respected when creating the thumbnail image.

Alternatively if the image dimensions are 400 pixels wide x 640 pixels high, then the height will be 120 pixels and the width smaller. The thumbnail size dictates the maximum width or the maximum height of the image.

This module can be rendered:

  • in plain text
  • using Liquid collections - these are the Liquid output tags you can use

Examples

  • {module_photogallery id="26800" rowCount="4" resultsPerPage="12" width="120" height="120" useStandardMethod="true"} - this displays 4 photos per line and a maximum of 12 photos per page. The thumbnail size has also been set to 120x120 pixels
  • {module_photogallery id="26800" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
  • {module_booking}
    Scroll upRead more...

    Syntax

    {module_booking render="item|collection" filter="item" itemid="neventId or classificationId" rowCount="10" collection="my_custom_collection_name" template="/folder/template.tpl"}

    Parameters

    • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
    • filter - filtering criteria for display and can be one of the following:
      • item - individual item
      • all - all items
      • latest - latest items
      • random - random item
      • randomClassified - displays a random item in a particular category
      • latestClassified - latest items in a category
      • classified - all the items in a category
    • itemid - depending on the filter chosen this can be either one of (see the Examples section for details):
      • the ID of the booking module
      • the ID of the category
      • the number of booking items to be displayed
    • rowCount - number of items per row
    • collection - use this if you need to access the module's Liquid output tags
    • template - optional, for this module this can either represent the path of the custom template you want to use, or use a blank value (template="") if you need to suppress the original output and use Liquid output tags instead

    This module can be rendered using:

    • the list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the Event layout reference page
    • your own custom layout - take a look at the custom templates article for more details
    • Liquid collections - here are the Liquid output tags you can use:

    Examples

    • {module_booking filter="all"} - displays all the bookings
    • {module_booking filter="item" itemid="24407"} - displays an individual event item with the ID 24407
    • {module_booking filter="l" itemid="5"} - displays 5 latest events
    • {module_booking filter="random"} - displays a single random item
    • {module_booking filter="classified" itemid="14075"} - displays all the items classified in the category with the ID 14075
    • {module_booking filter="randomClassified" itemid="14075"} - displays a random item classified in the category with the ID 14075
    • {module_booking filter="item" itemid="63522" template="/layouts/custom/bookings.tpl"} - displays an individual item using a custom template
    • {module_booking filter="all" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_calendar}
    Scroll upRead more...

    Syntax

    {module_calendar render="collection" collection="my_custom_collection_name" template="/folder/template.tpl" eventType="all/news/events" filter="all/classified" classificationId="classificationId" notemplate="false" targetFrame="_blank"}

    Parameters

    • render - for this module the value of this parameter can only be collection (if no value is specified the default will be collection). For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
    • eventType - the type of item to display. This parameter has 3 possible values:
      • all - display both News and Events
      • news - display only News
      • events - display only Events
    • filter - filtering criteria for display and can be one of the following:
      • all - all items
      • classified - displays an item in a particular category
    • classificationId -if you choose to display the classified calendar items specify the classification ID here
    • noTemplate – if you want to force the item not to use a site-level template when displayed pass in true, otherwise leave empty
    • targetFrame - specify the way the item opens when it is clicked. the possible values are:
      • _blank - open the new item in a new window
      • _self - open the new item in the same window
    • collection - use this if you need to access the module's Liquid output tags
    • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

    This module can be rendered:

    • in its generic shape, as by default this module does not use a layout. Here is how the output looks like:
    • using Liquid collections - the output is a Liquid collection containing the days :

      "my_custom_collection_name": {
            "moduleName": "calendar",
            "moduleDescriptor": {
       	      "templatePath": "",
      	      "parameters": "0,a,,collection=\"my_custom_collection_name\"",
      	      "apiEndpoint": "/api/v3/calendar",
      	      "objectType": "-1",
      	      "objectId": "-1",
      	      "adminUrl": ""
            },
            "days": [
            {
              "day": "2014-09-01T00:00:00",
              "items": []
            },
            {
            	"day": "2014-09-12T00:00:00",
      	      "items": [
          	  {
      	    	  "startDate": "2014-09-12T00:00:00",
          		  "endDate": "0001-01-01T00:00:00",
      	    	  "objectId": 20460,
      		      "objectType": 48,
      		      "name": "First Appearance",
      	    	  "url": "/BookingRetrieve.aspx?ID=20460"
          	  }
            ]
      }

    Examples

    • {module_calendar eventType="all" filter="all" notemplate="false" targetFrame="_blank"}
      - displays all the news and announcement items on the calendar view and opens the detail view in a new window when clicked
    • {module_calendar eventType="news" filter="classified" classificationId="12345" notemplate="false" targetFrame="_blank"}
      - displays the news item classified in the category with the ID 12345 and opens the detail view in the same window when clicked
    {module_faq}
    Scroll upRead more...

    Syntax

    {module_faq render="item|collection" filter="item" itemid="faqId" noTemplate="false" effect="ajax" targetFrame="blank" collection="my_custom_collection_name" template="/folder/template.tpl"}

    Parameters

    • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
    • filter - filtering criteria for display and can be one of the following:
      • item - individual item
      • all - all items
      • latest - latest items
      • latestClassified - latest items in a category
      • random - random item
      • randomClassified - displays a random item in a particular category
      • classified - all the items in a category
    • itemid – system generated (do not change)
    • noTemplate – if you want to force the item not to use a site-level template when displayed pass in true, otherwise leave empty
    • effect – enter ajax if you want to take advantage of the latest web technologies for a better customer experience
    • targetFrame – the frame in which to open the item in
    • collection - use this if you need to access the module's Liquid output tags
    • template - optional, for this module this can either represent the path of the custom template you want to use, or use a blank value (template="") if you need to suppress the original output and use Liquid output tags instead

    This module can be rendered using:

    • the list layout. On this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use: FAQ layout's reference page
    • your own custom layout - take a look at the custom templates article for more details
    • Liquid collections - here are the Liquid output tags you can use:

    Examples

    • {module_faq filter="all" targetFrame="_parent"} - will display all FAQs and open them in parent frame.
    • {module_faq filter="all", template="/layouts/custom/faq.tpl"} - will display all FAQs using the faq.tpl custom template.
    • {module_faq filter="latest" itemid="5"} - will display the latest 5 FAQs.
    • {module_faq filter="random" noTemplate="true" effect="ajax" targetFrame="_blank"} - will open a random item in a new window and will not apply the template and will use the Ajax effect where the detailed content opens right underneath the FAQ name.
    • {module_faq filter="all" collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_faqresults}
    Scroll upRead more...

    Syntax

    {module_faqresults collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered using:

    • A static layout - this module is not rendered by any layouts. See the example below for the format of the output.
    • Liquid collections - here are the Liquid output tags you can use:

    Examples

    • {module_faqresults} - This outputs a list similar to this one:  

    CRM related

    {module_isloggedin}
    Scroll upRead more...

    Syntax

    {module_isloggedin collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.isLoggedIn

    Examples

    • {module_isloggedin} - if somebody is logged in this displays "1". If nobody is logged in it displays "0"
    • {module_isloggedin collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection
    • the information whether the current site visitor is logged in or not contained in a Liquid global object. {{globals.user}} will output:
      {
        "firstname": "Michael",
        "lastname": "Smith",
        "fullname": "Michael Smith",
        "email": "Michael.Boston@gmail.com",
        "isLoggedIn": true
      }
    {module_whosloggedin}
    Scroll upRead more...

    Syntax

    {module_whosloggedin loginUrl="/module_render/module_case" logoutRedirUrl="/home" collection="my_custom_collection_name" template=""}

    Parameters

    • loginUrl - is the page you want to send the customer to when they click on [Log in] link.
    • logoutRedirUrl - is the page you want to send the customer to when they click on [Log in] link.
    • collection - use this if you need to access the module's Liquid output tags
    • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title

    Examples

    • {module_whosloggedin loginUrl="/loginpage.htm"}
      • when customer logged in - "John Smith logged in. <a href="/LogOutProcess.aspx">Log out</a>"
      • when customer not logged in - "No one logged in. <a href="/loginpage.html">Log in</a>"
      {module_whosloggedin}
      • when customer logged in - "John Smith logged in. <a href="/LogOutProcess.aspx">Log out</a>"
      • when customer not logged in - "No one logged in."
    • {module_whosloggedin loginUrl="/cases" logoutRedirUrl="/home" collection="my_custom_collection_name" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_logout}
    Scroll upRead more...

    Description

    If an user is logged in this module renders the name of the currently logged in user and a log out link. If nobody is logged in it outputs "No one logged in."

    Syntax

    {module_logout collection="my_custom_collection_name" template=""}

    Parameters

    Examples

    • {module_logout} - this outputs FIRSTNAME SURNAME logged in. Log out. if somebody is logged in or No one logged in. if nobody is logged in.
    {module_ratingrank}
    Scroll upRead more...

    Syntax

    {module_ratingrank render="item" collection="my_custom_collection_name" imageFolder="/ratingImages/" template="/folder/template.tpl"}

    Parameters

    • render - for this module this can only be item. For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
    • collection - use this if you need to access the module's Liquid output tags
    • imageFolder - the path to your directory of custom star images to be used. For instance,{module_ratingrank, /images/stars} would use images located inside the directory /images/stars instead of the default image files. When using this parameter, ensure that your custom images use these exact names:
      • 1stars.gif
      • 15stars.gif
      • 2stars.gif
      • 25stars.gif
      • 3stars.gif
      • 35stars.gif
      • 4stars.gif
      • 45stars.gif
      • 5stars.gif
    • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

    This module can be rendered using:

    • using the 5-star rating image:
    • Liquid collections - here are the Liquid output tags you can use:

    Examples

    • {module_ratingrank imageFolder="/images/stars"} - displays the rating for the current item using the custom images from the /images
    {module_facebooklike}
    Scroll upRead more...

    Syntax

    {module_facebooklike moduleTemplateGroup="" language="en_US" url="" layout="" showFaces="true" width="450" verb="like" font="" colorScheme="" collection="my_custom_collection_name" template=""}

    Parameters

    • moduleTemplateGroup - This will specify a module template group, which is a folder located in FTP under /ModuleTemplates/SocialMedia/FacebookLike/
    • language – Can be any Facebook locales ISO language and country codes combined by an underscore (e.g en_US). If the parameter is not present, this will default to en_US
    • url – If the parameter is not present, this will default to the current page URL. This must be a valid URL otherwise the Facebook plugin returns error when the button is pressed
    • layout – standard, button_count, box_count. If the parameter is not present, the default value will be standard.
    • show facestrue, false. If the parameter is not present, the default value will be true
    • width – Any positive integers. If the parameter is not present, the default value will be 450
    • verb – like, recommend. If the parameter is not present, the default value will be like
    • fontarial, lucida grande, segoe ui, tahoma, trebuchet ms, verdana
    • color scheme – light, dark. If the parameter is not present, the default value will be light
    • collection - use this if you need to access the module's Liquid output tags
    • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

    This module is rendered with these layouts

    • Module templates > SocialMedia > FacebookLike > Default > container.html
    • See this article for activation steps: Facebook Integration

    Examples

    • {module_facebooklike, url="{tag_itemurl_withhost}"} - this generates the Facebook Like button, using the full URL of the module item, for example http://mysite.com/module-url.
    {module_facebookcomments}
    Scroll upRead more...

    Syntax

    {module_facebookcomments render="items|collection" moduleTemplateGroup="" language="en_US" url="" posts="" width="450" colorScheme="" collection="my_custom_collection_name" template=""}

    Parameters

    • render - optional parameter, indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
    • moduleTemplateGroup - This will specify a module template group, which is a folder located in FTP under /ModuleTemplates/SocialMedia/FacebookComments/
    • language – Can be any Facebook locales ISO language and country codes combined by an underscore (e.g en_US). If the parameter is not present, this will default to en_US
    • url – If the parameter is not present, this will default to the current page URL. This must be a valid URL otherwise the Facebook plugin returns error when the button is pressed
    • posts – Any positive integers. This is used to set the maximum number of posts to display. If the parameter is not present, this will default to 10
    • width – Any positive integers. If the parameter is not present, the default value will be 450
    • color scheme – light, dark. If the parameter is not present, the default value will be light
    • collection - use this if you need to access the module's Liquid output tags
    • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

    This module is rendered with these layouts:

    • Module templates > SocialMedia > FacebookComments > Default > container.html
      See this article for activation steps: Facebook Comments

    Examples

    • {module_facebookcomments, url="{tag_itemurl_withhost}"} - This enables Facebook comments and use the full URL of the module item, for example http://mysite.com/module-url.
    {module_facebooklogin}
    Scroll upRead more...

    Syntax

    {{module_facebooklogin buttonImage="/buttons/fb.png" buttonText="FB Login" zoneId="51" autoSubscribeNewUsers="true" redirectToPage="true" pageId="13543359" collection="my_custom_collection_name" template=""}

    Parameters

    • buttonImage - Image used to display the Facebook login button
    • buttonText - Text used in the Facebook login button
    • zoneId - The ID of the secure zone to log user into (Default value -1)
    • autoSubscribeNewUsers - automatically subscribe this user to the secure zone
    • redirectToPage - can be either true or false - indicates whether to redirect the user to a particular page after logging in
    • pageId - the pageID to redirect the user after logging in
    • collection - use this if you need to access the module's Liquid output tags
    • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

    Examples

    • Please refer to this article for a complete reference
    {module_facebookaccountlink}
    Scroll upRead more...

    Syntax

    {module_facebookaccountlink FbAccountLinkImg="/buttons/fb.png" FbAccountLinkText="Link your account" FbAccountUnlinkImg="/buttons/fb-unlink.png" FbAccountUnlinkText="Unlink your account" collection="my_custom_collection_name" template=""
    }

    Parameters

    • FbAccountLinkImg - Image used to display the Facebook account link button
    • FbAccountLinkText - Text used in the Facebook account link button
    • FbAccountUnlinkImg - Image used to display the Facebook account un-link button
    • FbAccountUnlinkText - Text used in the Facebook account un-link button
    • collection - use this if you need to access the module's Liquid output tags
    • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

    Examples

    • See this article for a full reference
    {module_twittertweet}
    Scroll upRead more...

    Syntax

    {module_twittertweet moduleTemplateGroup="" language="en" url="" count="horizontal" text="" via="" related="" countUrl="" collection="my_custom_collection_name" template=""}

    Parameters

    • moduleTemplateGroup - This will specify a module template group, which is a folder located in FTP under /ModuleTemplates/SocialMedia/TwitterTweet/
    • languageen, fr, de, it, es, ko, ja
    • url – if the parameter is not present, this will default to the current page URL. This must be a valid
    • counthorizontal, vertical, none. If the parameter is not present, the default value will be horizontal
    • text – this can have any text value. If the parameter is not present, this will default to the title of the page the button is on
    • via – this should be a valid Twitter username
    • related – this should be a valid Twitter username
    • counturl – must be a valid URL
    • collection - use this if you need to access the module's Liquid output tags
    • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

    Layouts

    • Module templates > SocialMedia > TweeterTweet > Default > container.html
    • See this article for activation steps: Tweeter Integration

    Examples

    • {module_twittertweet, url="{tag_itemurl_withhost}"} - This will generate the Tweeter Tweet button, using the full URL of the module item, for example http://mysite.com/module-url.

    CRM

    {module_anniversary1}
    Scroll upRead more...

    Syntax

    {module_anniversary1 collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary1

    Examples

    • {module_anniversary1} - displays the anniversary date
    • {module_anniversary1 collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary1title}
    Scroll upRead more...

    Syntax

    {module_anniversary1title collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary1title

    Examples

    • {module_anniversary1title} - displays the first name in plain text.
    • {module_anniversary1title collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary2}
    Scroll upRead more...

    Syntax

    {module_anniversary2 collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary2

    Examples

    • {module_anniversary2} - displays the anniversary date
    • {module_anniversary2 collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary2title}
    Scroll upRead more...

    Syntax

    {module_anniversary2title collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary2title

    Examples

    • {module_anniversary2title} - displays the first name in plain text.
    • {module_anniversary2title collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary3}
    Scroll upRead more...

    Syntax

    {module_anniversary3 collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary3

    Examples

    • {module_anniversary3} - displays the anniversary date
    • {module_anniversary3 collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary3title}
    Scroll upRead more...

    Syntax

    {module_anniversary3title collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary3title

    Examples

    • {module_anniversary3title} - displays the first name in plain text.
    • {module_anniversary3title collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary4}
    Scroll upRead more...

    Syntax

    {module_anniversary4 collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary4

    Examples

    • {module_anniversary4} - displays the anniversary date
    • {module_anniversary4 collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary4title}
    Scroll upRead more...

    Syntax

    {module_anniversary4title collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary4title

    Examples

    • {module_anniversary4title} - displays the first name in plain text.
    • {module_anniversary4title collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary5}
    Scroll upRead more...

    Syntax

    {module_anniversary5 collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary5

    Examples

    • {module_anniversary5} - displays the anniversary date
    • {module_anniversary5 collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_anniversary5title}
    Scroll upRead more...

    Syntax

    {module_anniversary5title collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.anniversary5Title

    Examples

    • {module_anniversary5title} - displays the first name in plain text.
    • {module_anniversary5title collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_billingaddress}
    Scroll upRead more...

    Syntax

    {module_billingaddress collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_billingcity}
    Scroll upRead more...

    Syntax

    {module_billingcity collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_billingcountry}
    Scroll upRead more...

    Syntax

    {module_billingcountry collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.countryCode

    Examples

    • {module_billingcountry} - this displays "AU" for Australia.
    • {module_billingcountry collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_billingstate}
    Scroll upRead more...

    Syntax

    {module_billingstate collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_billingzip}
    Scroll upRead more...

    Syntax

    {module_billingzip collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_captchav2}
    Scroll upRead more...

    Syntax

    {module_captchav2 backgroundColor="DimGray" foregroundColor="White" width="160" height="36" collection="my_custom_collection_name" template=""}

    Examples

    • {module_captchav2 backgroundColor="LightBlue" foregroundColor="#FF3300" width="100" height="36" }

    Parameters

    {module_cellphone}
    Scroll upRead more...

    Description

    Displays the customer's cell phone (must be logged in to secure zone).

    Syntax

    {module_cellphone collection="my_custom_collection_name" template=""}

    Parameters

    {module_company}
    Scroll upRead more...

    Syntax

    {module_company collection="my_custom_collection_name" template=""}

    Parameters

    Examples

    • {module_company} - displays the company name in plain text
    • {module_company collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_customerfield}
    Scroll upRead more...

    Description

    This module renders the information stored in a custom field (also known as an extended database field) attached to the CRM record that is currently logged into your site's front-end.

    Syntax

    {module_customerfield,extended database id,custom field id collection="my_custom_collection_name" template=""}

    Parameters

    • extended database id - this is the ID of the extended database field collection
    • custom field id - this is the ID of the individual field you wish to render
    • collection - use this if you need to access the module's Liquid output tags
    • template - this module does not support custom templates. You can use the template parameter however to supress the module's output

    How to get the IDs for this module

    There are basically two ways you can get the IDs for that particular module:

    Use the Update User Details form

    • create a test page
    • from the Toolbox insert the Site Modules > Secure zones > Update User Details form
    • from the Insert module dialog make sure you select All CRM forms
    • after you insert the form look for the custom fields you want to get the module for, the module_customerfield module will be used to pre-fill the information in the form's fields

    Manually getting the IDs

    • To get the extended database id go to CRM > Extended CRM Database and hover the extended database form's name:
    • To get the custom field id go to the particular Extended database form and inspect the list of fields:
    {module_dob}
    Scroll upRead more...

    Description

    Displays the customer's date of birth in this format: 22-Apr-2014 (must be logged in to secure zone).

    Syntax

    {module_dob collection="my_custom_collection_name" template=""}

    Parameters

    {module_emailaddress}
    Scroll upRead more...

    Syntax

    {module_emailaddress collection="my_custom_collection_name" template=""}

    Parameters

    Examples

    • {module_emailaddress} - displays the email address in plain text
    • {module_emailaddress collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection
    • the logged in user's email address is also contained in a Liquid global object. {{globals.user}} will output:
      {
        "firstname": "Michael",
        "lastname": "Smith",
        "fullname": "Michael Smith",
        "email": "Michael.Boston@gmail.com",
        "isLoggedIn": true
      }
    {module_entityid}
    Scroll upRead more...

    Syntax

    {module_entityid collection="my_custom_collection_name" template=""}

    Parameters

    {module_favorites}
    Scroll upRead more...

    Syntax

    {module_favorites render="item|collection" collection="my_custom_collection_name" template="/folder/template.tpl" filter="item(individual)|all" itemType="7" itemId=""}

    Parameters

    • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
    • filter - filtering criteria for display and can be one of the following:
      • item - individual item
      • all - all items
    • itemType -
      • 7 - news items
      • 48 - event items
      • 9 - FAQ items
      • 6 - media downloads
      • 27 - products
      • 35 - webapps
    • itemID - if you choose itemType 35 (a webapp) you can specify the webapp's ID. In this case only the favorite webapp items in that particular webapp will be displayed.
    • collection - use this if you need to access the module's Liquid output tags
    • template - optional, for this module this can either represent the path of the custom template you want to use, or use a blank value (template="") if you need to suppress the original output and use Liquid output tags instead

    Examples

    • {module_favorites< itemType="35" itemID="24325"} - displays the webapp items contained by the webapp with the ID 24325 that have been added as "favorites" by the currently logged in user. The items are displayed using their "List" layout.
    • {module_favorites filter="all"} - displays all the items (regardless of the item type) added marked as favorite by the logged in user. The items are displayed using their "List" layout.
    {module_firstname}
    Scroll upRead more...

    Syntax

    {module_firstname collection="my_custom_collection_name" template=""}

    Parameters

    Examples

    • {module_firstname} - displays the first name in plain text
    • {module_firstname collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection
    • the logged in user's first name is also contained in a Liquid global object. {{globals.user}} will output:
      {
        "firstname": "Michael",
        "lastname": "Smith",
        "fullname": "Michael Smith",
        "email": "Michael.Boston@gmail.com",
        "isLoggedIn": true
      }
    {module_fullname}
    Scroll upRead more...

    Syntax

    {module_fullname collection="my_custom_collection_name" template=""}

    Parameters

    Examples

    • {module_fullname} - Displays the first and last name together as the full name.
    • {module_fullname collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection
    • the logged in user's full name is also contained in a Liquid global object. {{globals.user}} will output:
      {
        "firstname": "Michael",
        "lastname": "Smith",
        "fullname": "Michael Smith",
        "email": "Michael.Boston@gmail.com",
        "isLoggedIn": true
      }

    See this article for information on how to make standard forms display just a full name field instead of separate first and last name fields

    {module_homeaddress}
    Scroll upRead more...

    Syntax

    {module_homeaddress collection="my_custom_collection_name" template=""}

    Parameters

    {module_homecity}
    Scroll upRead more...

    Syntax

    {module_homecity collection="my_custom_collection_name" template=""}

    Parameters

    {module_homecountry}
    Scroll upRead more...

    Syntax

    {module_homecountry collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.countryCode

    Examples

    • {module_homecountry} - this displays "AU" for Australia
    • {module_homecountry collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_homefax}
    Scroll upRead more...

    Description

    Displays the customer's home fax (must be logged in to secure zone)

    Syntax

    {module_homefax collection="my_custom_collection_name" template=""}

    Parameters

    {module_homephone}
    Scroll upRead more...

    Description

    Displays the customer's home phone (must be logged in to secure zone).

    Syntax

    {module_homephone collection="my_custom_collection_name" template=""}

    Parameters

    {module_homestate}
    Scroll upRead more...

    Syntax

    {module_homestate collection="my_custom_collection_name" template=""}

    Parameters

    {module_homezip}
    Scroll upRead more...

    Syntax

    {module_homezip collection="my_custom_collection_name" template=""}

    Parameters

    {module_lastname}
    Scroll upRead more...

    Syntax

    {module_lastname collection="my_custom_collection_name" template=""}

    Parameters

    Examples

    • {module_lastname} - displays the last name in plain text
    • {module_lastname collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection
    • the logged in user's last name is also contained in a Liquid global object. {{globals.user}} will output:
      {
        "firstname": "Michael",
        "lastname": "Smith",
        "fullname": "Michael Smith",
        "email": "Michael.Boston@gmail.com",
        "isLoggedIn": true
      }
    {module_pager}
    Scroll upRead more...

    Description

    Displays customer's pager (must be logged in to secure zone).

    Syntax

    {module_pager collection="my_custom_collection_name" template=""}

    Parameters

    {module_password}
    Scroll upRead more...

    Syntax

    {module_password collection="my_custom_collection_name" template=""}

    Parameters

    Examples

    • {module_password} - displays "******".
    • {module_password collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_recaptcha}
    Scroll upRead more...

    Syntax

    {module_recaptcha theme="white" version="1" size="normal" type="image"}

    Parameters

    • theme - the theme used, default is "white" for v1 and "light" for v2
    • version - version of reCaptcha used
      • 1 - for v1 (default)
      • 2 - for v2
    • size - the size of the widget (only for v2)
      • normal (default)
      • compact
    • type - the type of recaptcha to serve (only for v2)
      • image (default)
      • audio

    Note: For themes and more information please check Google reCAPTCHA Documentation: Version 1.0 - Customizing the Look and Feel, Version 2.0 - Displaying the widget

    Examples

    • {module_recaptcha version="2"} - will display a default v2 reCaptcha.
    • {module_recaptcha theme="red" size="compact" type="audio"} - will display a v1 reCaptcha with the red theme, the size and type parameters are only for v2, they will be ignored

    Known Issues

    Back button issue: In IE or Edge when visiting a page containing a ReCaptcha V2 control by using the back button after the form submission, one of the following problems might happen:

    • the reCaptcha control displays the "ERROR: Stoken expired" message
    • the reCaptcha control loads ok but the spinner enters an infinite loop when clicking the checkbox

    End users can still use the page if refreshing it from the browser. Alternatively, partners can provide a links or buttons like below for refreshing all ReCaptcha controls from the page:

    <a href="#" onclick="reCaptchaV2Manager.reloadControls(); return false;">Reload captcha</a>

    Both reCaptcha versions on the same page: V2 controls will not work on back button if V1 controls are present as well.

     

    {module_shippingaddress}
    Scroll upRead more...

    Syntax

    {module_shippingaddress collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_shippingcity}
    Scroll upRead more...

    Syntax

    {module_shippingcity collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_shippingcountry}
    Scroll upRead more...

    Syntax

    {module_shippingcountry collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.countryCode

    Examples

    • {module_shippingcountry} - this displays "AU" for Australia
    • {module_shippingcountry collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_shippingstate}
    Scroll upRead more...

    Syntax

    {module_shippingstate collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_shippingzip}
    Scroll upRead more...

    Syntax

    {module_shippingzip collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_subscriptions}
    Scroll upRead more...

    Syntax

    {module_subscriptions render="item|collection" collection="my_custom_collection_name" template="/folder/template.tpl" showExpiry="true|false" showPrice="true|false" allowCancel="false|true" renderAsJson="false|true"}

    Parameters

    • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
    • showExpiry - shows or hides the expiry date of the secure zone (true/false; default:true)
    • showPrice - shows or hides the cost of the subscription to that secure zone (true/false; default:true)
    • allowCancel - will show the cancel subscription link. This works only when not setting the renderAsJson to true
    • renderAsJson - Will render the secure zone information in Json format which can be manually parsed. Possible values are true or false.
    • collection - use this if you need to access the module's Liquid output tags
    • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

    This module can be rendered using:

    • an unordered list - see the examples below for details
    • Liquid collections - here are the Liquid output tags you can use:

    Examples

    • {module_subscriptions} - renders
      <ul class="zoneSubscriptions">
          <li>
              <ul>
                  <li class="zoneName">
                      <a href="/Default.aspx?PageID=54321">Member Only Area</a>
                  </li>
                  <li>Never</li>
              </ul>
          </li>
          <li>
              <ul>
                  <li class="zoneName">
                      <a href="/Default.aspx?PageID=54321">Secure Zone 1</a>
                  </li>
                  <li>Never</li>
              </ul>
          </li>
          <li>
              <ul>
                  <li class="zoneName">
                      <a href="/Default.aspx?PageID=54321">Secure Zone 2</a>
                  </li>
                  <li>Never</li>
              </ul>
          </li>
      </ul>
      
      
    • {module_subscriptions showExpiry="true" showPrice="true" renderAsJson="true"} - renders
      
      "{  
         "SecureZoneSubscriptionList":{  
            "EntityId":9532870,
            "Subscriptions":[  
               {  
                  "ZoneName":"Member Only Area",
                  "ZoneId":"51",
                  "ExpiryDate":"01/01/9999 00:00:00",
                  "SellAccess":false,
                  "CostPerPeriod":"0",
                  "CycleType":""
               },
               {  
                  "ZoneName":"photo download monthly plan",
                  "ZoneId":"2722",
                  "ExpiryDate":"01/01/9999 00:00:00",
                  "SellAccess":true,
                  "CostPerPeriod":"20",
                  "CycleType":"Monthly"
               },
               {  
                  "ZoneName":"photo download weekly plan",
                  "ZoneId":"2723",
                  "ExpiryDate":"01/01/9999 00:00:00",
                  "SellAccess":true,
                  "CostPerPeriod":"6",
                  "CycleType":"Monthly"
               },
               {  
                  "ZoneName":"sz1",
                  "ZoneId":"2762",
                  "ExpiryDate":"01/01/9999 00:00:00",
                  "SellAccess":false,
                  "CostPerPeriod":"0",
                  "CycleType":""
               },
               {  
                  "ZoneName":"sz2",
                  "ZoneId":"2763",
                  "ExpiryDate":"01/01/9999 00:00:00",
                  "SellAccess":false,
                  "CostPerPeriod":"0",
                  "CycleType":""
               }
      
            ]
         }
      }
      
      
    • {module_subscriptions showExpiry="true" showPrice="true" allowCancel="true"} - renders
      
      <ul class="zoneSubscriptions">
          <li>
              <ul>
                  <li class="zoneName"><a href="/Default.aspx?PageID=5387991">Member Only Area</a>
                  </li>
                  <li>Never</li>
                  <li><a href="/ZoneProcess.aspx?A=Cancel&amp;ZoneId=51">Cancel</a>
                  </li>
              </ul>
          </li>
          <li>
              <ul>
                  <li class="zoneName"><a href="/Default.aspx?PageID=5059413">photo download premium</a>
                  </li>
                  <li>Never</li>
                  <li>£20.00 Monthly</li>
                  <li><a href="/ZoneProcess.aspx?A=Cancel&amp;ZoneId=2722">Cancel</a>
                  </li>
              </ul>
          </li>
          <li>
              <ul>
                  <li class="zoneName"><a href="/Default.aspx?PageID=5059413">photo download standard</a>
                  </li>
                  <li>Never</li>
                  <li>£6.00 Monthly</li>
                  <li><a href="/ZoneProcess.aspx?A=Cancel&amp;ZoneId=2723">Cancel</a>
                  </li>
              </ul>
          </li>
      </ul>
      
      
    {module_title}
    Scroll upRead more...

    Syntax

    {module_title type="id" collection="my_custom_collection" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title

    Examples

    • {module_title} - this displays the ID that corresponds to the logged in customer's title for example a number like "317688" which corresponds to "MR". To find out the title IDs for your site go to an existing contact and inspect the "Title" drop down:
    • {module_title collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_username}
    Scroll upRead more...

    Syntax

    {module_username collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_webaddress}
    Scroll upRead more...

    Description

    Displays the customer's web address (must be logged in to secure zone).

    Syntax

    {module_webaddress collection="my_custom_collection_name" template=""}

    Parameters

    {module_workaddress}
    Scroll upRead more...

    Syntax

    {module_workaddress collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_workcity}
    Scroll upRead more...

    Syntax

    {module_workcity collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_workcountry}
    Scroll upRead more...

    Syntax

    {module_workcountry collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.countryCode

    Examples

    • {module_workcountry} - AU for Australia
    • {module_workcountry collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.
    {module_workfax}
    Scroll upRead more...

    Description

    Displays customer's work fax (must be logged in to secure zone).

    Syntax

    {module_workfax collection="my_custom_collection_name" template=""}

    Parameters

    {module_workphone}
    Scroll upRead more...

    Description

    Displays customer's work phone (must be logged in to secure zone).

    Syntax

    {module_workphone collection="my_custom_collection_name" template=""}

    Parameters

    {module_workstate}
    Scroll upRead more...

    Syntax

    {module_workstate collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.title
    {module_workzip}
    Scroll upRead more...

    Syntax

    {module_workzip collection="my_custom_collection_name" template=""}

    Parameters

    This module can be rendered:

    • in plain text
    • using Liquid collections - this is the Liquid output tag you can use - my_custom_collection_name.zipCode

    Examples

    • {module_workzip} - displays the ZIP code in plain text
    • {module_workzip collection="collection1" template=""} - in this case nothing will be displayed, however the module's Liquid tags will become available in the collection1 collection.