Discount Predicate Field Identifiers

Certain resources have a predicate or cartPredicate field. In particular, Product Discounts, Cart Discounts, and Shipping Method have predicate fields. This field expects a conditional statement known as a predicate. When a predicate evaluates as true, the API applies the discount or selects a shipping method. Predicates consist of field identifiers and operators. For more information on creating predicates, see Discount Predicate Operators.

You cannot use field identifiers listed here to construct API queries using the where field. General purpose queries use a different syntax. For more information, see Query Predicates.

MoneyString

A string representation of the money value in cent precision followed by the currency code compliant to ISO 4217, for example, 42000.00 USD.

Only the dot separator is allowed to divide the base monetary unit and the cents. Other separators, like for grouping thousands and millions, are not supported.

ProductDiscount predicates

ProductDiscount predicates reference a field on a Product for specifying Product Discounts.

Product field identifiers

The following identifiers reference fields on a Product.

product.id - String
product.key - String
productType.id - String
productType.key - String
variant.id - Number
variant.key - String
sku - String
attributes.<name>
Matches a Product Attribute by its name. For more information, see Product Attribute Field Identifiers.

Price field identifiers

The following identifiers reference price fields from both Embedded Prices and StandalonePrices of a product, regardless of the Product's priceMode value.

price - MoneyString
amount - Number - The amount in the specified currency.
centAmount - Number - The amount in cents (the subunit) of the specified currency.
currency- CurrencyCode
country - CountryCode
customerGroup.id - String
customerGroup.key - String
channel.id - String
channel.key - String

Category field identifiers

The following identifiers identify products that have a specific Category or group of categories.

categories.id - Array of Strings
Identifies all Products that have a category.
categories.key - Array of Strings
Identifies all Products that have a category with a given key.
categoriesWithAncestors.id - Array of Strings
Identifies all Products that have a category as well as products in child categories.
categoriesWithAncestors.key - Array of Strings
Identifies all Products that have a category as well as products in child categories that have a given key.

Product Attribute field identifiers

The following identifiers reference user-defined product attribute fields on a Product.

attribute.name - Attribute
Matches a product attribute by its name.
If a field name contains a dash (-) or starts with a digit, escape it using backticks (`): attributes.\`2019Season\`

Supported Attribute Types

The following attribute types are supported as individual values or as Sets:

boolean
text
number
datetime
date
time
enum
lenum
money

For enum and lenum attributes, you can only reference a value in the collection using the value's key field.

Product Predicate examples


// matches a specific variant in the specific product
product.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7" and variant.id = 1

// matches a specific variant based on variant key in the specific product
(product.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7" and variant.id = 1) or variant.key = "blue_shirt"

// matches a product that is only in the given category
categories.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7"

//matches a product that is in the given category
categories.id contains "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7"

//matches a product that is in all of the given categories
categories.id contains all ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7", "abcd9a23-14e3-40d0-aee2-3e612fcbefgh")

//matches a product that is in one of the given categories
categories.id contains any ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7", "abcd9a23-14e3-40d0-aee2-3e612fcbefgh")

//matches a product that is not in one of the given categories
not(categories.id contains any ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7","abcd9a23-14e3-40d0-aee2-3e612fcbefgh"))

//matches a product that is in the two given categories and in no others
categories.id = ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7", "abcd9a23-14e3-40d0-aee2-3e612fcbefgh")

//matches a product that is not in a given category
categories.id != ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7")

//matches the prices above 12€ for any countries except France that do not have a customer group set
centAmount > 1200 and currency = "EUR" and country != "FR" and customerGroup.id is not defined

//matches all product variants that have size "L" and have the color white and black
//size is an EnumType attribute for which the key is specified in the predicate,
//color is a SetType of Enums for which the keys are listed in the predicate.
attributes.size = "L" and attributes.colors contains all ("black", "white")

//matches all product variants with the given sku, the boolean attribute available set to true and the number attribute weight less than 100
sku = "AB-12" and attributes.available = true and attributes.weight < 100

//matches all products that are in the given category or in a category that is a descendant of the given category
categoriesWithAncestors.id contains "abcd9a23-14e3-40d0-aee2-3e612fcbefgh"

Cart Predicates

Cart Predicate field identifiers reference fields on a Cart. You can also use Cart Predicate Functions to construct conditional statements based on the state of the cart and its line items.

You can use Cart Predicates for the following:

Cart Discounts
Cart Discounts can have multiple predicates: a cartPredicate and one or more CartDiscountTarget predicates.
Shipping Methods

Cart field identifiers

The following identifiers reference fields on a Cart.

currency - CurrencyCode
country - CountryCode
origin - CartOrigin
store.key - key of a Store
Can only be used for Shipping Predicates.
totalPrice - MoneyString
totalPrice.centAmount - Number
totalPrice.currencyCode - CurrencyCode
taxedPrice.net - MoneyString
taxedPrice.net.centAmount - Number
taxedPrice.net.currencyCode - CurrencyCode
taxedPrice.gross - MoneyString
taxedPrice.gross.centAmount - Number
taxedPrice.gross.currencyCode - CurrencyCode
createdAt - DateTime
lastModifiedAt - DateTime
shippingAddress - Address field identifier
billingAddress - Address field identifier
custom.<name> - CustomField
Matches a custom field by its name. For more information, see CustomField Predicate Field Identifiers.
custom.type.id - id of a Type
custom.type.key - key of a Type

Customer field identifiers

The following identifiers reference fields on a Cart's Customer.

For Customer fields to apply as predicates, customerId must exist on the Cart. customerEmail must be set explicitly on the Cart.

customer.id - String
customer.key - String
customer.email - String
customer.customerNumber - String
customer.customerGroup.id - String
customer.customerGroup.key - String
customer.firstName - String
customer.lastName - String
customer.middleName - String
customer.title - String
customer.isEmailVerified - Boolean
customer.externalId - String
customer.createdAt - DateTime
customer.lastModifiedAt - DateTime

ShippingInfo field identifiers

The following identifiers reference fields on a Cart's ShippingInfo.

To match against Carts with multiple Shipping Methods, you must construct your predicate using the Cart Predicate functions shippingInfoExists or forAllShippingInfos.

shippingInfo.shippingMethod.id - String
shippingInfo.shippingMethod.key - String
shippingInfo.shippingMethodName - String
shippingInfo.price - MoneyString
shippingInfo.price.centAmount - Number
shippingInfo.price.currencyCode - CurrencyCode
shippingInfo.shippingRate.price - MoneyString
shippingInfo.shippingRate.price.centAmount - Number
shippingInfo.shippingRate.price.currencyCode - CurrencyCode
shippingInfo.shippingRate.freeAbove - MoneyString
shippingInfo.shippingRate.freeAbove.centAmount - Number
shippingInfo.shippingRate.freeAbove.currencyCode - CurrencyCode
shippingInfo.taxCategory.id - String
shippingInfo.taxCategory.key - String
shippingInfo.taxRate - TaxRate field identifiers

Address field identifiers

The following identifiers reference fields on a Cart's shippingAddress or billingAddress Address fields.

Depending on the address you want to construct a predicate with, replace <address-field> with shippingAddress or billingAddress.

<address-field>.id - String
<address-field>.key - String
<address-field>.title - String
<address-field>.salutation - String
<address-field>.firstName - String
<address-field>.lastName - String
<address-field>.streetName - String
<address-field>.streetNumber - String
<address-field>.additionalStreetInfo - String
<address-field>.postalCode - String
<address-field>.city - String
<address-field>.region - String
<address-field>.state - String
<address-field>.country - CountryCode
<address-field>.company - String
<address-field>.department - String
<address-field>.building - String
<address-field>.apartment - String
<address-field>.pOBox - String
<address-field>.phone - String
<address-field>.mobile - String
<address-field>.email - String
<address-field>.additionalAddressInfo - String

TaxRate field identifiers

The following identifiers reference fields on a Cart's TaxRate field.

taxRate.id - String
taxRate.name - String
taxRate.amount - Number
taxRate.includedInPrice - Boolean
taxRate.country - CountryCode
taxRate.state - String

LineItem field identifiers

The following identifiers reference fields on a Cart's LineItems.

You can only use LineItem predicate field identifiers for the following:

Cart Discounts with a lineItem CartDiscountTarget
As a part of a Cart Predicate Function.

You cannot use LineItem predicates by themselves in a CartDiscount.

product.id - String
product.key - String
productType.id - String
productType.key - String
variant.id - Number
variant.key - String
sku - String
categories.id - Array of Strings
categories.key - Array of Strings
categoriesWithAncestors.id - Array of Strings
Identifies categories of a product and all the ancestors of those categories. It is used to match all categories that are in a subtree of a specific category.
categoriesWithAncestors.key - Array of Strings
Identifies categories of a product and all the ancestors of those categories. It is used to match all categories that are in a subtree of a specific category by key.
attributes.<name>
Matches a product attribute by its name. For more information, see Product Attribute Field Identifiers.
custom.<name> - CustomField
Matches a custom field on the line item by its name. For more information, see CustomField Field Identifiers
custom.type.id - id of a Type
custom.type.key - key of a Type
taxRate - TaxRate field identifiers
supplyChannel.id - String
supplyChannel.key - String
quantity - Number
This field cannot be used in predicates for MultiBuyLineItemsTarget or CartDiscountPatternTarget predicates.
price - MoneyString
The product price without any cart discounts applied.
price.centAmount - Number
price.currencyCode - CurrencyCode
price.discount.id - String
price.country - CountryCode
price.customerGroup.id - String
price.customerGroup.key - String
price.channel.id - String
price.channel.key - String

LineItem predicate examples


// matches all line items
true

// matches line item with SKU "SKU-123" only if the price is a net price
sku = "SKU-123" and taxRate.includedInPrice = false

// matches a line item by product type, a specific product and at least 3 'rating' attributes
productType.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7" and attributes.rating > 3 and (product.id = "abcd9a23-14e3-40d0-aee2-3e612fcbefgh" or product.id = "ba3e4ee7-30fa-400b-8155-46ebf423d793")

// matches a line item that has the custom field "gender" to be "alien"
custom.gender = "alien"

// matches a line item that is only in the given category
categories.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7"

//matches a line item that is in the given category
categories.id contains "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7"

//matches a line item that is in all of the given categories
categories.id contains all ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7", "abcd9a23-14e3-40d0-aee2-3e612fcbefgh")

//matches a line item that is in one of the given categories
categories.id contains any ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7", "abcd9a23-14e3-40d0-aee2-3e612fcbefgh")

//matches a line item that is not in one of the given categories
not(categories.id contains any ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7","abcd9a23-14e3-40d0-aee2-3e612fcbefgh"))

//matches a line item that is in the two given categories and in no others
categories.id = ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7", "abcd9a23-14e3-40d0-aee2-3e612fcbefgh")

//matches a line item that is not in a given category
categories.id != ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7")

CustomLineItem field identifiers

The following identifiers reference fields on a Cart's CustomLineItems.

You can only use CustomLineItem predicate field identifiers for the following:

Cart Discounts with a customLineItem CartDiscountTarget
As a part of a Cart Predicate Function.

You cannot use CustomLineItem predicates by themselves in a CartDiscount.

money - MoneyString
money.centAmount - Number
money.currencyCode - CurrencyCode
slug - String
quantity - Number
This field cannot be used in predicates for MultiBuyCustomLineItemsTarget or CartDiscountPatternTarget predicates.
price - MoneyString
taxCategory.id - String
taxCategory.key - String
taxRate - TaxRate field identifiers
custom.<name> - CustomField
Matches a custom field on the custom line item by its name given a certain predicate.
custom.type.id - id of a Type
custom.type.key - key of a Type

CustomLineItem predicate examples


// matches all custom line items
true

// matches custom line items with price of individual items greater than 10.50 EUR only if the price is a net price
money > "10.50 EUR" and taxRate.includedInPrice = false

// matches a custom line item by slug
slug = "adidas-superstar-2"

// matches a custom line item that has the custom field "gender" to be "alien"
custom.gender = "alien"

CustomField field identifiers

The following identifiers reference custom fields on a Cart, or a line item in a cart.

You can use CustomField field identifiers for the following:

A Cart's cartPredicate field, to identify custom fields on a Cart.
A CartDiscount with a lineItem CartDiscountTarget, to identify custom fields on a LineItem.
A CartDiscount with a customLineItem CartDiscountTarget, to identify custom fields on a CustomLineItem.
custom.<name> - CustomField
Matches a custom field by its name.
If a field name contains a dash (-) or starts with a digit, escape it using backticks (`): custom.\`1stYear\`

Supported custom field types

The following field types are supported as individual values or as Sets:

Boolean
String
Number
DateTime
Date
Time
Enum
LocalizedEnum
Reference

Custom Fields using the Money type are also supported, but Sets with the Money type are not supported.

CustomField predicate examples

Predicates on a reference match on the ID.
Examples:

//identifies a custom field by ID (where the field is a Reference type)
custom.<name> = "<id>"

//checks if a custom field is contained in a collection, where the field is a reference type
custom.<name> contains any ("<id1>", "<id2>")

//checks if a custom field has a value equal to 18.00 EUR, if the field is a Money type
custom.<name> = "18.00 EUR"

//checks if
custom.<name>.centAmount = 18

//checks if
custom.<name>.currencyCode = "EUR"

Cart Predicate functions

In addition to accessing specific field information, you can use the following predicate functions when constructing Cart Predicates.

All functions accept a LineItemPredicate, CustomLineItemPredicate, or ShippingInfoPredicate as an argument, which allows you to limit function to a subset of matching (custom) line items or shipping infos. You can also provide a simple predicate, like true, as an argument if you want to sum or count all (custom) line items or shipping infos.

lineItemCount(predicate: LineItemPredicate) – Number
Counts matching line items.
customLineItemCount(predicate: CustomLineItemPredicate) – Number
Counts matching custom line items.
lineItemTotal(predicate: LineItemPredicate) – MoneyString
Sums the total of matching line items.
The total of a line item depends on the Line Item price mode and the discounts that might apply.
customLineItemTotal(predicate: CustomLineItemPredicate) – MoneyString
Sums the quantity * money of matching custom line items.
lineItemNetTotal(predicate: LineItemPredicate) – MoneyString
Sums the total of matching line items only if the price is a net price (only valid for tax-exclusive taxRate).
customLineItemNetTotal(predicate: CustomLineItemPredicate) – MoneyString
Sums the quantity * money of matching custom line items only if the price is a net price (only valid for tax-exclusive taxRate).
lineItemGrossTotal(predicate: LineItemPredicate) – MoneyString
Sums the total of matching line items only if the price is a gross price (only valid for tax-inclusive taxRate).
customLineItemGrossTotal(predicate: CustomLineItemPredicate) – MoneyString
Sums the quantity * money of matching custom line items only if the price is a gross price (only valid for tax-inclusive taxRate).
lineItemExists(predicate: LineItemPredicate) – Boolean
Returns true if at least one line item matches the predicate, otherwise false.
forAllLineItems(predicate: LineItemPredicate) – Boolean
Returns true if all line items match the predicate or a cart is empty, otherwise false.
To return false for an empty cart, use the function in combination with lineItemExists.
shippingInfoExists(predicate: ShippingInfoPredicate) – Boolean
Returns true if at least one shipping info matches the predicate, otherwise false.
forAllShippingInfos(predicate: ShippingInfoPredicate) – Boolean
Returns true if all shipping infos match the predicate, otherwise false.

Cart Predicate examples


// matches a cart with total line item cost greater than or equal to 10 USD (which excludes other costs, like shipping)
lineItemTotal(true) >=  "10.00 USD"

// matches a cart only when it has exactly 2 line items that have product with size "xxl" or "xl"
lineItemCount(attributes.size in ("xxl", "xl")) = 2

// matches a cart by customer information
customer.email = "john@example.com" and customer.customerGroup.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7"

// matches a cart with a minimum total price and at least one lineItem that satisfies a price, a productType, a size attribute or a specific product
totalPrice > "800.00 EUR" and lineItemCount(price > "10.50 EUR" and productType.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7" and attributes.size in ("xl", "xxl") or product.id = "abcd9a23-14e3-40d0-aee2-3e612fcbefgh") > 0

// matches a cart with custom.bookingStart = 2016-11-24 and custom.bookingEnd = 2016-12-04
custom.bookingStart = "2016-11-24" and custom.bookingEnd = "2016-12-04"

// matches a cart for a family (at least 2 adults and at least one youth)
lineItemCount(custom.age = "adult") >=2 and lineItemCount(custom.age = "youth") >=1

// matches a cart with total line item cost lesser than or equal to 55 USD if the line items are not in one of the given categories and does not have 1234 as SKU
lineItemTotal(not(categories.id contains any ("SALE","NEW")) and sku != "1234") <= "55.00 USD"

// matches a cart if all line items match the predicate, otherwise false (for empty carts too)
forAllLineItems(<predicate>) and lineItemExists(<predicate>)

Order Predicates

Order Predicate field identifiers reference fields on an Order. You can also use Order Predicate Functions to construct conditional statements based on the state of the cart and its line items.

You can use Order Predicates for the following:

Approval Rules

Order field identifiers

The following identifiers reference fields on a Order.

currency - CurrencyCode
country - CountryCode
totalPrice - MoneyString
totalPrice.centAmount - Number
totalPrice.currencyCode - CurrencyCode
taxedPrice.net - MoneyString
taxedPrice.net.centAmount - Number
taxedPrice.net.currencyCode - CurrencyCode
taxedPrice.gross - String - MoneyString
taxedPrice.gross.centAmount - Number
taxedPrice.gross.currencyCode - CurrencyCode
createdAt - DateTime
lastModifiedAt - DateTime
shippingAddress - Address field identifiers
billingAddress - Address field identifiers
custom.<name> - CustomField
Matches a custom field by its name. For more information, see CustomField Predicate Field Identifiers.
custom.type.id - id of a Type
custom.type.key - key of a Type

Customer field identifiers

The following identifiers reference fields on a Order's Customer.

customer.id - String
customer.key - String
customer.email - String
customer.customerNumber - String
customer.customerGroup.id - String
customer.customerGroup.key - String
customer.firstName - String
customer.lastName - String
customer.middleName - String
customer.title - String
customer.isEmailVerified - Boolean
customer.externalId - String
customer.createdAt - DateTime
customer.lastModifiedAt - DateTime

ShippingInfo field identifiers

The following identifiers reference fields on a Order's ShippingInfo.

shippingInfo.shippingMethod.id - String
shippingInfo.shippingMethod.key - String
shippingInfo.shippingMethodName - String
shippingInfo.price - MoneyString
shippingInfo.price.centAmount - Number
shippingInfo.price.currencyCode - CurrencyCode
shippingInfo.shippingRate.price - MoneyString
shippingInfo.shippingRate.price.centAmount - Number
shippingInfo.shippingRate.price.currencyCode - CurrencyCode
shippingInfo.shippingRate.freeAbove - MoneyString
shippingInfo.shippingRate.freeAbove.centAmount - Number
shippingInfo.shippingRate.freeAbove.currencyCode - CurrencyCode
shippingInfo.taxCategory.id - String
shippingInfo.taxCategory.key - String
shippingInfo.taxRate - TaxRate field identifiers

Address field identifiers

The following identifiers reference fields on a Order's shippingAddress or billingAddress Address fields.

Depending on the address you want to construct a predicate with, replace <address-field> with shippingAddress or billingAddress.

<address-field>.id - String
<address-field>.key - String
<address-field>.title - String
<address-field>.salutation - String
<address-field>.firstName - String
<address-field>.lastName - String
<address-field>.streetName - String
<address-field>.streetNumber - String
<address-field>.additionalStreetInfo - String
<address-field>.postalCode - String
<address-field>.city - String
<address-field>.region - String
<address-field>.state - String
<address-field>.country - CountryCode
<address-field>.company - String
<address-field>.department - String
<address-field>.building - String
<address-field>.apartment - String
<address-field>.pOBox - String
<address-field>.phone - String
<address-field>.mobile - String
<address-field>.email - String
<address-field>.additionalAddressInfo - String

TaxRate field identifiers

The following identifiers reference fields on a Order's TaxRate field.

taxRate.id - String
taxRate.name - String
taxRate.amount - Number
taxRate.includedInPrice - Boolean
taxRate.country - CountryCode
taxRate.state - String

LineItem field identifiers

The following identifiers reference fields on a Order's LineItems.

You can only use LineItem predicate field identifiers for the following:

As a part of a Order Predicate Function.
product.id - String
product.key - String
productType.id - String
productType.key - String
variant.id - Number
variant.key - String
sku - String
categories.id - Array of Strings
categories.key - Array of Strings
categoriesWithAncestors.id - Array of Strings
Identifies categories of a product and all the ancestors of those categories. It is used to match all categories that are in a subtree of a specific category.
categoriesWithAncestors.key - Array of Strings
Identifies categories of a product and all the ancestors of those categories. It is used to match all categories that are in a subtree of a specific category by key.
attributes.<name>
Matches a product attribute by its name. For more information, see Product Attribute Field Identifiers.
custom.<name> - CustomField
Matches a custom field on the line item by its name. For more information, see CustomField Field Identifiers
custom.type.id - id of a Type
custom.type.key - key of a Type
taxRate - TaxRate field identifiers
supplyChannel.id - String
supplyChannel.key - String
quantity - Number
This field cannot be used in predicates for MultiBuyLineItemsTarget or CartDiscountPatternTarget predicates.
price - MoneyString
The product price without any cart discounts applied.
price.centAmount - Number
price.currencyCode - CurrencyCode
price.discount.id - String
price.country - CountryCode
price.customerGroup.id - String
price.customerGroup.key - String
price.channel.id - String
price.channel.key - String

LineItem predicate examples


// matches all line items
true

// matches line item with SKU "SKU-123" only if the price is a net price
sku = "SKU-123" and taxRate.includedInPrice = false

// matches a line item by product type, a specific product and at least 3 'rating' attributes
productType.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7" and attributes.rating > 3 and (product.id = "abcd9a23-14e3-40d0-aee2-3e612fcbefgh" or product.id = "ba3e4ee7-30fa-400b-8155-46ebf423d793")

// matches a line item that has the custom field "gender" to be "alien"
custom.gender = "alien"

//matches a line item that is not in a given category
categories.id != ("f6a19a23-14e3-40d0-aee2-3e612fcb1bc7")

CustomLineItem field identifiers

The following identifiers reference fields on a Order's CustomLineItems.

You can only use CustomLineItem predicate field identifiers for the following:

As a part of a Order Predicate Function.
money - MoneyString
money.centAmount - Number
money.currencyCode - CurrencyCode
slug - String
quantity - Number
This field cannot be used in predicates for MultiBuyCustomLineItemsTarget or CartDiscountPatternTarget predicates.
taxCategory.id - String
taxCategory.key - String
taxRate - TaxRate field identifiers
custom.<name> - CustomField
Matches a custom field on the custom line item by its name given a certain predicate.
custom.type.id - id of a Type
custom.type.key - key of a Type

CustomLineItem predicate examples


// matches all custom line items
true

// matches custom line items with price of individual items bigger than 10.50 EUR only if the price is a net price
money > "10.50 EUR" and taxRate.includedInPrice = false

// matches a custom line item by slug
slug = "adidas-superstar-2"

// matches a custom line item that has the custom field "gender" to be "alien"
custom.gender = "alien"

CustomField field identifiers

The following identifiers reference custom fields on a Order, or a line item in a order.

You can use CustomField field identifiers for the following:

custom.<name> - CustomField
Matches a custom field by its name.
If a field name contains a dash (-) or starts with a digit, escape it using backticks (`): custom.\`1stYear\`

Supported custom field types

The following field types are supported as individual values or as Sets:

Boolean
String
Number
DateTime
Date
Time
Enum
LocalizedEnum
Reference

Custom Fields using the Money type are also supported, but Sets with the Money type are not supported.

CustomField predicate examples

Predicates on a reference match on the ID.
Examples:

//identifies a custom field by ID (where the field is a Reference type)
custom.<name> = "<id>"

//checks if a custom field is contained in a collection, where the field is a reference type
custom.<name> contains any ("<id1>", "<id2>")

//checks if a custom field has a value equal to 18.00 EUR, if the field is a Money type
custom.<name> = "18.00 EUR"

//checks if
custom.<name>.centAmount = 18

//checks if
custom.<name>.currencyCode = "EUR"

Order Predicate functions

In addition to accessing specific field information, you can use the following predicate functions when constructing Order Predicates.

All functions accept a LineItemPredicate or CustomLineItemPredicate as an argument, which allows you to limit function to a subset of matching (custom) line items. You can also provide a simple predicate, like true, as an argument if you want to sum or count all line items.

lineItemCount(predicate: LineItemPredicate) – Number
Counts matching line items.
customLineItemCount(predicate: CustomLineItemPredicate) – Number
Counts matching custom line items.
lineItemTotal(predicate: LineItemPredicate) – Money
Sums the total of matching line items.
customLineItemTotal(predicate: CustomLineItemPredicate) – Money
Sums the quantity * money of matching custom line items.
lineItemNetTotal(predicate: LineItemPredicate) – Money
Sums the total of matching line items only if the price is a net price (only valid for tax-exclusive taxRate).
customLineItemNetTotal(predicate: CustomLineItemPredicate) – Money
Sums the quantity * money of matching custom line items only if the price is a net price (only valid for tax-exclusive taxRate).
lineItemGrossTotal(predicate: LineItemPredicate) – Money
Sums the total of matching line items only if the price is a gross price (only valid for tax-inclusive taxRate).
customLineItemGrossTotal(predicate: CustomLineItemPredicate) – Money
Sums the quantity * money of matching custom line items only if the price is a gross price (only valid for tax-inclusive taxRate).
lineItemExists(predicate: LineItemPredicate) – Boolean
Returns true if at least one line item matches the predicate, otherwise false.
forAllLineItems(predicate: LineItemPredicate) – Boolean
Returns true if all line items matching the predicate, otherwise false.

The total of a line item depends on the line item price mode and the discounts that may apply.

Order Predicate examples


// matches an order with total line item cost bigger or equal to 10 USD (which excludes other costs, like shipping)
lineItemTotal(true) >  "10.00 USD"

// matches an order only when it has exactly 2 like items that have product with size "xxl" or "xl"
lineItemCount(attributes.size in ("xxl", "xl")) = 2

// matches an order by customer information
customer.email = "john@example.com" and customer.customerGroup.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7"

// matches an order with a minimum total price and at least one lineItem that satisfies a price, a productType, a size attribute or a specific product
totalPrice > "800.00 EUR" and lineItemCount(price > "10.50 EUR" and productType.id = "f6a19a23-14e3-40d0-aee2-3e612fcb1bc7" and attributes.size in ("xl", "xxl") or product.id = "abcd9a23-14e3-40d0-aee2-3e612fcbefgh") > 0

// matches an order with custom.bookingStart = 2016-11-24 and custom.bookingEnd = 2016-12-04
custom.bookingStart = "2016-11-24" and custom.bookingEnd = "2016-12-04"

// matches an order for a family (at least 2 adults and at least one youth)
lineItemCount(custom.age = "adult") >=2 and lineItemCount(custom.age = "youth") >=1