FAQs

Support

CrescoData CML

Cresco Mapping Language

Welcome to our CML integration page.

Use the CrescoData Commerce Connect Platform to integrate to over 100 commerce channels.

The available CML mapping features are on the left. Code examples are shown on the right. If you can’t find what you are looking for please email support@crescodata.com

goslash_categories

Description

Set SystemCategoryId given Backend Name and Product ID

Attributes

name

text, currency, country, url, multiline_text, richtext

Required

None

product_id

text, currency, country, url, multiline_text, richtext

Required

None

Sample

 
goslash_categories
  name "value"
  product_id "value"
                

currency

Description

Convert a value's currency

Attributes

source_currency

currency

Required

The currency to convert from (the input/source value currency)

destination_currency

currency

Required

The currency to convert into

value

price, number

Required

The value to convert

Sample

xxxxxxxxxx
 
currency
  source_currency "value"
  destination_currency "value"
  value "value"
                

optional

Description

Removes and clears this attribute if the given value is null, false or empty

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The value to check

Sample

xxxxxxxxxx
 
optional
  value "value"
                

replace_empty

Description

Replaces null, empty, false and empty lists, with the given new value

Attributes

new

text, currency, country, url, multiline_text, richtext

Required

The new value to replace with

value

text, currency, country, url, multiline_text, richtext

Required

The value to check

Sample

xxxxxxxxxx
 
replace_empty
  new "value"
  value "value"
                

replace_not_empty

Description

Replaces values which are not null, empty, false, or an empty list with the given new value

Attributes

new

text, currency, country, url, multiline_text, richtext

Required

The new value to replace with

value

text, currency, country, url, multiline_text, richtext

Required

The value to check

Sample

xxxxxxxxxx
 
replace_not_empty
  new "value"
  value "value"
                

settings

Description

Retrieve a specific setting

Attributes

source

text, currency, country, url, multiline_text, richtext

The key or name of the setting

default

text, currency, country, url, multiline_text, richtext

The value to set if the setting was not found.

Sample

xxxxxxxxxx
 
settings
  source "value"
  default "value"
                

earliest

Description

Chooses the earliest date, give a list of dates

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
earliest
  sources "value"
                

relative_timestamp

Description

Create and add or subtract from a date.

Attributes

years

price, number

The number of years to add. Supports a negative number to subtract

months

price, number

The number of months to add. Supports a negative number to subtract

weeks

price, number

The number of weeks to add. Supports a negative number to subtract

days

price, number

The number of days to add. Supports a negative number to subtract

hours

price, number

The number of hours to add. Supports a negative number to subtract

minutes

price, number

The number of minutes to add. Supports a negative number to subtract

seconds

price, number

The number of seconds to add. Supports a negative number to subtract

microseconds

price, number

The number of micro seconds to add. Supports a negative number to subtract

timezone

The timezone to convert the date into

date

text, currency, country, url, multiline_text, richtext

The date. If not given, will default to the current processing time.

Sample

xxxxxxxxxx
 
relative_timestamp
  years "value"
  months "value"
  weeks "value"
  days "value"
  hours "value"
  minutes "value"
  seconds "value"
  microseconds "value"
  timezone "value"
  date "value"
                

is_future

Description

Whether the given date is in the future

Attributes

value

date, datetime

Required

The date to check

relative_to

date, datetime

Whether its in the future, relative to this date. If not provided, assumes the current date of processing

Sample

xxxxxxxxxx
 
is_future
  value "value"
  relative_to "value"
                

raise_exception

Description

Raises an exception when an error occurs

Attributes

message

text, currency, country, url, multiline_text, richtext

Required

None

system_identifier

text, currency, country, url, multiline_text, richtext

None

Sample

xxxxxxxxxx
 
raise_exception
  message "value"
  system_identifier "value"
                

html

Description

Wraps your text with an HTML tag.

Attributes

tag

text, currency, country, url, multiline_text, richtext

The tag to wrap around your text

value

text, currency, country, url, multiline_text, richtext

Required

The text to wrap the tag around.

Sample

xxxxxxxxxx
 
html
  tag "value"
  value "value"
                

html2text

Description

Extracts text from your HTML.

Attributes

separator

text, currency, country, url, multiline_text, richtext

The separator to use between the text detected between HTML tags.

value

text, currency, country, url, multiline_text, richtext

The HTML value

Sample

xxxxxxxxxx
 
html2text
  separator "value"
  value "value"
                

markup

Description

Converts HTML into text with a markup language

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The HTML value

Sample

xxxxxxxxxx
 
markup
  value "value"
                

html_exclude_tags

Description

Excludes a list of HTML tags.

Attributes

html_exclude_hidden

Description

Excludes HTML elements with display: none

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The HTML value

Sample

xxxxxxxxxx
 
html_exclude_hidden
  value "value"
                

all_equals

Description

Check whether all values in the list equals to your given value

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The value to check the equality against

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values

Sample

xxxxxxxxxx
 
all_equals
  value "value"
  sources "value"
                

all_true

Description

Whether all the values in the list is a non-empty, non-null, and non-false value

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values to check

Sample

xxxxxxxxxx
 
all_true
  sources "value"
                

any_true

Description

Whether any item in the list is a non-empty, non-null, or non-false value.

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values to check

Sample

xxxxxxxxxx
 
any_true
  sources "value"
                

exclude

Description

Excludes empty strings, nulls, false and empty list values

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values to check

excludes

array

Leave empty to exclude null, empty and false values

Sample

xxxxxxxxxx
 
exclude
  sources "value"
  excludes "value"
                

first_not_empty

Description

By default, picks the first non-empty, non-null, and non-false value from a list of values. Returns null if all values are excluded

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values to check

excludes

array

If the value of a list item matches one of these values, it will be skipped

Sample

xxxxxxxxxx
 
first_not_empty
  sources "value"
  excludes "value"
                

index

Description

Get an item from a list with the given index.

Attributes

index

text, currency, country, url, multiline_text, richtext

Required

The index to grab from the list. Note that 0 is the first item, 1 is the second item, etc. Use -1 to grab the last item, -2 for 2nd last, etc.

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values

Sample

xxxxxxxxxx
 
index
  index "value"
  sources "value"
                

join

Description

Join a list of values with a given text separator, such as a comma, full-stop, etc.

Attributes

separator

text, currency, country, url, multiline_text, richtext

The separator to join the list of items with

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values to be joined

Sample

xxxxxxxxxx
 
join
  separator "value"
  sources "value"
                

length

Description

Get the length of a list

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
length
  sources "value"
                

merge

Description

Merges multiple lists into a single bigger list

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

The list of lists to be merged into one single list

Sample

xxxxxxxxxx
 
merge
  sources "value"
                

remove_duplicates

Description

Removes duplicate values from a list

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

The list of values to remove duplicates from

Sample

xxxxxxxxxx
 
remove_duplicates
  sources "value"
                

length_greater_than

Description

Whether the length of the list or text is greater than a value

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

None

value

price, number

Required

None

Sample

xxxxxxxxxx
 
length_greater_than
  sources "value"
  value "value"
                

length_less_than

Description

Whether the length of the list or text is less than a value

Attributes

sources

text, currency, country, url, multiline_text, richtext

Required

None

value

price, number

Required

None

Sample

xxxxxxxxxx
 
length_less_than
  sources "value"
  value "value"
                

remove_items

Description

Values to filter from a list

Attributes

source

text, currency, country, url, multiline_text, richtext

Required

The list of values to check

case_sensitive

boolean

Whether the check is case sensitive.

partial_match

boolean

Whether to partially match.

filter_out

boolean

Whether to remove items matching this filter. Set to False to include items matching this filter

values

multiline_text

Required

The values to filter

Sample

xxxxxxxxxx
 
remove_items
  source "value"
  case_sensitive "value"
  partial_match "value"
  filter_out "value"
  values "value"
                

not

Description

Flips the boolean value

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The value to check

Sample

xxxxxxxxxx
 
not
  value "value"
                

equals

Description

Check equality

Attributes

comparison

text, currency, country, url, multiline_text, richtext

Required

The value to compare against

value

text, currency, country, url, multiline_text, richtext

Required

The value to compare

case_sensitive

boolean

Whether to check equality with case sensitivity.

Sample

xxxxxxxxxx
 
equals
  comparison "value"
  value "value"
  case_sensitive "value"
                

not_equals

Description

Check non-equality

Attributes

comparison

text, currency, country, url, multiline_text, richtext

Required

The value to compare against

value

text, currency, country, url, multiline_text, richtext

Required

The value to compare

case_sensitive

boolean

Whether to check non-equality with case sensitivity.

Sample

xxxxxxxxxx
 
not_equals
  comparison "value"
  value "value"
  case_sensitive "value"
                

is_not_null

Description

Whether the given value is not null

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_not_null
  value "value"
                

is_null

Description

Whether the given value is null

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_null
  value "value"
                

is_empty

Description

Check whether the given value is an empty string, null, false, or an empty list of items.

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_empty
  value "value"
                

is_not_empty

Description

Check whether the given value is not an empty string, null, false, or an empty list of items.

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_not_empty
  value "value"
                

is_false

Description

Check whether the given value is a false boolean value

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_false
  value "value"
                

is_true

Description

Check whether the given value is a true boolean value

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_true
  value "value"
                

bool

Description

Returns true if your value is true, y, or 1 (case and type insensitive), otherwise, returns false

Attributes

Sample

xxxxxxxxxx
 
bool

is_falsy

Description

Returns true if your value is false, n, or 0 (case and type insensitive), otherwise, returns false

Attributes

Sample

xxxxxxxxxx
 
is_falsy

equals_one_of

Description

Check equality against multiple values

Attributes

comparison

multiline_text

Required

The value to compare against

value

text, currency, country, url, multiline_text, richtext

Required

The value to compare

case_sensitive

boolean

Whether to check equality with case sensitivity.

Sample

xxxxxxxxxx
 
equals_one_of
  comparison "value"
  value "value"
  case_sensitive "value"
                

not_equals_one_of

Description

Check non-equality against multiple values

Attributes

comparison

multiline_text

Required

The value to compare against

value

text, currency, country, url, multiline_text, richtext

Required

The value to compare

case_sensitive

boolean

Whether to check in-equality with case sensitivity.

Sample

xxxxxxxxxx
 
not_equals_one_of
  comparison "value"
  value "value"
  case_sensitive "value"
                

is_numeric

Description

Whether the given value is a number

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_numeric
  value "value"
                

is_list

Description

Check whether the given value is an array.

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
is_list
  value "value"
                

add

Description

Sums together a list of values

Attributes

sources

price, array, number

Required

None

Sample

xxxxxxxxxx
 
add
  sources "value"
                

add_rate

Description

Increase a number or price by a percentage rate

Attributes

rate

price, number

Required

The percentage to increase by

value

price, number

Required

The value to be added to

Sample

xxxxxxxxxx
 
add_rate
  rate "value"
  value "value"
                

subtract

Description

Subtracts numbers from a list of numbers

Attributes

sources

price, array, number

Required

None

Sample

xxxxxxxxxx
 
subtract
  sources "value"
                

subtract_rate

Description

Subtracts by a percentage rate

Attributes

rate

price, number

Required

The percentage to subtract

value

price, number

Required

The value to be subtracted from

use_multiplier

boolean

Whether to use "value - (value * rate / 100)". Otherwise uses "value / (rate / 100 + 1)"

Sample

xxxxxxxxxx
 
subtract_rate
  rate "value"
  value "value"
  use_multiplier "value"
                

multiply

Description

Multiplies a list of values

Attributes

sources

price, array, number

Required

None

Sample

xxxxxxxxxx
 
multiply
  sources "value"
                

divide

Description

Divides a list of values

Attributes

sources

price, array, number

Required

None

Sample

xxxxxxxxxx
 
divide
  sources "value"
                

max

Description

Gets the maximum number out of a list of numbers

Attributes

sources

array

Required

The list of numbers

Sample

xxxxxxxxxx
 
max
  sources "value"
                

min

Description

Gets the minimum number out of a list of numbers

Attributes

sources

array

Required

The list of numbers

Sample

xxxxxxxxxx
 
min
  sources "value"
                

round

Description

Round the value to a given decimal point

Attributes

decimals

price, number

Required

The number of decimals to round to. Give 0 to turn into an integer.

value

price, text, currency, country, url, multiline_text, richtext, number

Required

The value to round

Sample

xxxxxxxxxx
 
round
  decimals "value"
  value "value"
                

greater_than

Description

Checks if the value is greater than the comparison value

Attributes

comparison

price, date, number, datetime

Required

None

value

price, date, number, datetime

Required

The value to check

Sample

xxxxxxxxxx
 
greater_than
  comparison "value"
  value "value"
                

greater_than_or_equals

Description

Checks if the value is greater than or equals to the comparison value

Attributes

comparison

price, date, number, datetime

Required

None

value

price, date, number, datetime

Required

The value to check

Sample

xxxxxxxxxx
 
greater_than_or_equals
  comparison "value"
  value "value"
                

less_than

Description

Checks if the value is less than the comparison value

Attributes

comparison

price, date, number, datetime

Required

None

value

price, date, number, datetime

Required

The value to check

Sample

xxxxxxxxxx
 
less_than
  comparison "value"
  value "value"
                

less_than_or_equals

Description

Checks if the value is less or equals to the comparison value

Attributes

comparison

price, date, number, datetime

Required

None

value

price, date, number, datetime

Required

The value to check

Sample

xxxxxxxxxx
 
less_than_or_equals
  comparison "value"
  value "value"
                

abs

Description

Take the absolute value of a give number - turns negatives to positives.

Attributes

source

text, currency, country, url, multiline_text, richtext

Required

The value to take the absolute value of

Sample

xxxxxxxxxx
 
abs
  source "value"
                

lower

Description

Convert the text to all lowercase

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The text to make lowercase

Sample

xxxxxxxxxx
 
lower
  value "value"
                

title

Description

Capitalizes the first letter of each word in your text

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The text to be capitalized

Sample

xxxxxxxxxx
 
title
  value "value"
                

upper

Description

Convert the text to all uppercase

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The text to make uppercase

Sample

xxxxxxxxxx
 
upper
  value "value"
                

split

Description

Splits your string into multiple components, given by a separator. Returns a list of text.

Attributes

separator

text, currency, country, url, multiline_text, richtext

The separator to split by

value

text, currency, country, url, multiline_text, richtext

Required

The text to split

max_split

price, number

The maximum number to split by. Will ignore the separator after this many occurrences are found

Sample

xxxxxxxxxx
 
split
  separator "value"
  value "value"
  max_split "value"
                

strip

Description

Removes any spaces from the begging or end of your text

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The text to trim

char

text, currency, country, url, multiline_text, richtext

The character to trim, leave empty to trim spaces or extra lines

Sample

xxxxxxxxxx
 
strip
  value "value"
  char "value"
                

append_text

Description

Append a text to the end of a given value

Attributes

text

price, text, currency, country, url, multiline_text, richtext, number

Required

None

value

text, currency, country, url, multiline_text, richtext

Required

The value to be appended to

Sample

xxxxxxxxxx
 
append_text
  text "value"
  value "value"
                

prepend_text

Description

Prepend a text to the beginning of a given value

Attributes

text

text, currency, country, url, multiline_text, richtext

Required

None

value

text, currency, country, url, multiline_text, richtext

Required

The value to be prepended to

Sample

xxxxxxxxxx
 
prepend_text
  text "value"
  value "value"
                

shorten

Description

Cut and shorten the text to the maximum length provided. Appends ... to the end of your text.

Attributes

max_length

price, number

Required

The maximum length. This will be subtracted by 3 and have ... added to the end of your text.

value

text, currency, country, url, multiline_text, richtext

Required

The text to be shortened

truncated_text

text, currency, country, url, multiline_text, richtext

The text to add to when truncating

Sample

xxxxxxxxxx
 
shorten
  max_length "value"
  value "value"
  truncated_text "value"
                

nice_cut

Description

Shortens and cuts your text without cutting off sentences.

Attributes

limit

price, number

Required

The maximum output length of the text. Your output may be less than this length, depending on the sentence structure.

value

text, currency, country, url, multiline_text, richtext

Required

The text to be shortened nicely.

Sample

xxxxxxxxxx
 
nice_cut
  limit "value"
  value "value"
                

ends_with

Description

Checks whether your text ends with a certain text. Returns either true or false.

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The text value to check against

comparison

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
ends_with
  value "value"
  comparison "value"
                

starts_with

Description

Checks whether your text starts with a certain text. Returns either true or false.

Attributes

comparison

text, currency, country, url, multiline_text, richtext

Required

The text to check for

value

text, currency, country, url, multiline_text, richtext

Required

The text value to check against

Sample

xxxxxxxxxx
 
starts_with
  comparison "value"
  value "value"
                

replace

Description

Replace the given value with a new one, if matches.

Attributes

old

text, currency, country, url, multiline_text, richtext

Required

The value to check against

new

text, currency, country, url, multiline_text, richtext

Required

The value to replace with, if equals

value

text, currency, country, url, multiline_text, richtext

Required

None

Sample

xxxxxxxxxx
 
replace
  old "value"
  new "value"
  value "value"
                

contains_text

Description

Check whether a text contains a given sub-text

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The text to check for

case_sensitive

boolean

Whether the check is case sensitive.

source

text, currency, country, url, multiline_text, richtext

Required

The source text

Sample

xxxxxxxxxx
 
contains_text
  value "value"
  case_sensitive "value"
  source "value"
                

not_contains_text

Description

Check whether a text does not contains a given sub-text

Attributes

value

text, currency, country, url, multiline_text, richtext

Required

The text to check for

case_sensitive

boolean

Whether the check is case sensitive.

source

text, currency, country, url, multiline_text, richtext

Required

The source text

Sample

xxxxxxxxxx
 
not_contains_text
  value "value"
  case_sensitive "value"
  source "value"
                

map

Description

Provide a mapping of the current value into a different value.

Attributes

mappings

text, currency, country, url, multiline_text, richtext

Required

Use -> to indicate a mapping. For example: this -> that

default

text, currency, country, url, multiline_text, richtext

The default value if your value did not match any mappings

Sample

xxxxxxxxxx
 
map
  mappings "value"
  default "value"
                

partial_remove

Description

Removes parts of your specified text.

Attributes

text

text, currency, country, url, multiline_text, richtext

Required

The text to replace

count

price, number

The maximum number of removals to do. Leave empty to replace all occurrences

case_sensitive

boolean

Whether the removals are case sensitive. Setting to false will also use Regular Expression

use_regex

boolean

Whether the removal should check using regular expression

value

text, currency, country, url, multiline_text, richtext

Required

The full text to be checked for removal

Sample

xxxxxxxxxx
 
partial_remove
  text "value"
  count "value"
  case_sensitive "value"
  use_regex "value"
  value "value"
                

partial_replace

Description

Replaces parts of your value with a new text.

Attributes

old_text

text, currency, country, url, multiline_text, richtext

Required

The text to replace

new_text

text, currency, country, url, multiline_text, richtext

Required

Replace the text with

count

price, number

The maximum number of removals to do. Leave empty to replace all occurrences

case_sensitive

boolean

Whether the removals are case sensitive. Setting to false will also use Regular Expression

use_regex

boolean

Whether the removal should check using regular expression

value

text, currency, country, url, multiline_text, richtext

Required

The full text to be checked for removal

Sample

xxxxxxxxxx
 
partial_replace
  old_text "value"
  new_text "value"
  count "value"
  case_sensitive "value"
  use_regex "value"
  value "value"
                

contains_one_of_text

Description

Check whether a text contains given sub-texts

Attributes

values

multiline_text

Required

The values to check for

case_sensitive

boolean

Whether the check is case sensitive.

source

text, currency, country, url, multiline_text, richtext

Required

The source text

Sample

xxxxxxxxxx
 
contains_one_of_text
  values "value"
  case_sensitive "value"
  source "value"
                

not_contains_one_of_text

Description

Check whether a text does not contains given sub-texts

Attributes

values

multiline_text

Required

The text to check for

case_sensitive

boolean

Whether the check is case sensitive.

source

text, currency, country, url, multiline_text, richtext

Required

The source text

Sample

xxxxxxxxxx
 
not_contains_one_of_text
  values "value"
  case_sensitive "value"
  source "value"
                

price

Description

Convert the input into a price.

Attributes

Sample

xxxxxxxxxx
 
price

timestamp

Description

Convert into a date format from a timestamp

Attributes

timezone

The timezone to convert to

Sample

xxxxxxxxxx
 
timestamp
  timezone "value"
                

date

Description

Re-format a date into your specified format

Attributes

source

text, currency, country, url, multiline_text, richtext

Required

None

from_format

text, currency, country, url, multiline_text, richtext

None

from_format_2

text, currency, country, url, multiline_text, richtext

None

to_format

text, currency, country, url, multiline_text, richtext

Use formats such as %Y %m %d %m %s

timezone

text, currency, country, url, multiline_text, richtext

None

to_timezone

timezone

The timezone to convert the date into

Sample

xxxxxxxxxx
 
date
  source "value"
  from_format "value"
  from_format_2 "value"
  to_format "value"
  timezone "value"
  to_timezone "value"
                

country

Description

Converts country names (case-insensitive) into the appropriate 2 letter country code. Returns the country name that was given if no match is found.

Attributes

country

text, currency, country, url, multiline_text, richtext

Required

The country name to be converted into the country code

use_smart_matching

boolean

Whether to use partial-text matching to find the most appropriate country code.

Sample

xxxxxxxxxx
 
country
  country "value"
  use_smart_matching "value"
                

integer

Description

Convert the input into an integer.

Attributes

Sample

xxxxxxxxxx
 
integer