Freebie Condition Field Reference

The Freebie Condition object stores conditions that should be met to distribute freebies.

Object API name: orders__FreebieCondition__c

Field API Name Type Description

Active

orders__IsActive__c

Checkbox

Defines if the record is active and should be applied in business logic.

Adding Method

orders__AddingMethod__c

Picklist

Select a principle according to which freebies will be added to the order:

  • List Based

    To distribute products that are added to the related Freebie Line Item records.

  • Criteria Based

    Freebies are selected based on the SOQL filter in the Condition Details field.

  • Similar

    To distribute the same product that is added to the order cart in the required number.

Condition Details

orders__ConditionDetails__c

Long Text Area(32768)

Stores fields values that initialize freebies calculation or the advance conditions in JSON to check if freebies should be added to the order. The following operators are available for specifying the SOQL request:

  • equal

  • notEqual

  • contain

  • notContain

Cannot bed edited in the layout form if the orders__PromotionId__c of the freebie condition is specified.

Criteria Details

orders__CriteriaDetails__c

Long Text Area(32768)

Criteria that define which Freebies will be available for a Group Freebie.

Delivery Control

orders__DeliveryControl__c

Picklist

Defines whether the freebies will be added only to the first/last or across the deliveries.

End Date

orders__EndDate__c

Date

Last date when the condition is applied.

External Id

orders__ExternalId__c

Text(255) (External ID) (Unique Case Sensitive)

External record identifier for ERP/CRM system (if required).

Freebie Type

orders__FreebieTypeId__c

Master-Detail(Freebie Type)

A freebie type related to the Freebie Condition record.

Freebie Value

orders__FreebieValueField__c

Text(255)

Specify a field with the value on the corresponding Product object, for example, CTCPG__ParentId__r.Value__c.

  • The field must be with the Number, Currency, or Percent type.

  • The mobile user should have access to the specified field.

  • The specified field will be automatically added into the Condition Fields List field of the corresponding Freebie Type record.

Ignore Product Availability

orders__IgnoreProductAvailability__c

Checkbox

It defines whether the product availability should be considered for the freebie condition.

The default value is false.

Level Formula

orders__LevelFormula__c

Long Text Area(32768)

The formula in JSON format that is used to calculate quantity across multiple fields.

Order

orders__Order__c

Number(18, 0)

The ordinal number of a record for prioritization during condition search.

Promotion

orders__PromotionId__c

Lookup

Related promotion identifier. If specified, the orders__ConditionDetails__c of the freebie condition cannot be edited in the layout form.

Proportional

orders__IsProportional__c

Checkbox

An attribute that defines if products must be distributed proportionally.

Restrict by Order content

orders__isRestrictByOrderContent__c

Checkbox
Available only if the Adding Method is set to List Based or Criteria Based.

If true, then only Order Line Items with Quantity > 0 will be distributed as freebies. Default value is false.

The field requires the following permissions:

  • Read/Write for Administrator and Sales Administrator roles

  • Read for Sales Representative role

Start Date

orders__StartDate__c

Date

Since this date, the freebie condition will be applied.

Unique Id

orders__UniqueId__c

Text(255) (External ID) (Unique Case Insensitive)

The unique identifier for a freebie condition.
``