Skip to main content
A sale represents a purchase made by one of your customers. It is a core behavior that programs seek to influence. Different facets of sales can be incentivized, such as ticket size, frequency, product mix, and more.

​
Processing

Sales are typically fed to Fielo from an external system of record via API, either in real time or by scheduled job. Fielo can process sales with line item granularity, as well as flat sales data. When a sale is registered into Fielo, it enters a queue which is cleared on a first-in, first-out basis. The sale is evaluated against the incentive rules of the program to which the customer belongs and, if any rules apply, the customer is rewarded.

​
Attributes

For small-scale testing purposes, sales can be created from the Sales page. Sales have the following attributes:
  • External ID: This is the unique identifier for the sale. It typically originates in the external system of record. It is required.
  • Sale Date Time: This is the day and time at which the sale occurred. Timeboxed incentives use it to determine whether the sale occurred within the incentive period. If left blank, it will be assumed that the sale occurred at the time it was registered inside Fielo.
  • Store: This is the physical location at which the sale occurred. It is optional.
  • Store Code: This is the unique identifier of the store at which the sale occurred. It is used to associate a store with the sale when creating the sale via API. It is optional.
  • Member: This is the customer associated with the sale.
  • Member External ID: This is the unique identifier of the member on the sale. It is used to associate a member with the sale when creating the sale via API.
  • Brand: This is the brand at which the sale was made. It is optional.
  • Sale Channel Code: This identifies the channel through which the sale occurred. It is optional.
  • Point of Sale ID: This identifies the POS at which the sale occurred. It is optional.
  • Total Amount: This is the total amount paid on the sale. If sale items are included on the sale, this will be calculated as the sum of the line item amounts. If flat sales data is provided, this should be filled in when registering the sale inside Fielo.
  • Incentivizable Amount: This is the amount eligible for incentivization. If sale items are included on the sale, this will be calculated as the sum of the line item amounts of the sale items marked as incentivizable. If flat sales data is provided, this should be filled in when registering the sale inside Fielo.

​
Sale Items

Sales can, optionally, be comprised of sale items. A sale item is a line item on the sale associated with a product. Sale items have the following attributes:
  • Line Number: The order in which the sale item appears on the sale. It is optional.
  • Product: The product that corresponds to the sale item.
  • Product Code: This is the unique identifier of the product that corresponds to the sale item. It is used to associate a product with the sale item when creating the sale via API.
  • Description: The description of the sale item’s product. Filled in automatically.
  • Incentivizable: Indicates if the sale item’s product is incentivizable. Filled in automatically.
  • Quantity: The number of units sold. It is optional.
  • Unit Price: The price per unit. It is optional.
  • Original Amount: The line item total before any discounts. It is optional. If desired, it must be filled in; it is not calculated.
  • Net Amount: The total paid net of any discounts.
  • Discount Amount: The difference between the original amount and the net amount. If the original amount is blank or less than the net amount, this will evaluate to 0. Filled in automatically.
  • Discount Percentage: The percentage of reduction from the original amount to the net amount. If the original amount is blank or less than the net amount, this will evaluate to 0. Filled in automatically.

​
Statuses

Sales can be in one of four statuses:
  • Pending-Ready to Process: The sale has entered the system and is waiting to be processed.
  • Pending-Processing: The sale is being processed against the incentive rules of the member’s program.
  • Resolved-Processed: The sale has been successfully processed against the incentive rules of the member’s program.
  • Resolved-Withdrawn: Sale processing was aborted either because the associated member’s status is not Open-Active or due to a system error.