Custom Aggregate Field Management
July 20, 2026
Summary
Custom Aggregate Fields (CAFs) aggregate price or quantity from only the sources you map, giving channel-specific control that standard Aggregate Rules cannot.
Overview
Custom Aggregate Fields (CAFs) are custom price or quantity fields that aggregate values from only the sources you map, giving channel-specific control the standard Aggregate Rules cannot. A common use is excluding a source that cannot fulfill a marketplace so its stock is not counted for that channel.
Create a CAF, map only the sources that should count toward it, then set the CAF as a product or listing price/quantity field through a workflow.
- Selective aggregation: aggregate price or quantity from only the sources you map to the field.
- Channel-specific: feed a channel listing's price or quantity from a CAF, e.g. quantity allowed on Amazon.
- Data types: each CAF is Price or Quantity, aggregated as Highest, Lowest, Sum, or Average.
- Committed stock: map the CAF to Available Quantity so committed stock is not overstated.
Creating a caf
| Field | Detail |
|---|---|
| Setup path | Settings → Products → Aggregate Rules → Custom Aggregate Fields. |
| Display Name | The field name used in mapping templates and rules. |
| Data Type | Price or Quantity. |
| Option | Highest, Lowest, Sum, or Average. |
| Exclude Out of Stock | Omits out-of-stock inventory unless all other data is empty. Sources with zero or negative available quantity both count as out of stock. |
Important notes
Note: Once created, a CAF cannot be edited or deleted in the UI or API. Contact support to remove one, so create carefully.
Note: Only map sources that should count. A source left on a shared template is still included unless you use a unique template for it.
Note: For each solution create both a price and a quantity CAF, so an excluded source's cost is left out alongside its quantity.
Note: With Committed Stock, map the CAF to Available Quantity, otherwise the supplier's total quantity is used and the CAF is overstated (Total minus Committed Stock is correct).
Note: Negative available quantity counts as out of stock. With Exclude Out of Stock enabled, an over-committed source (negative available quantity) is excluded from the CAF value exactly like a zero-quantity source. With the option off, negative values are included in the aggregation. A product whose only sources are negative still produces a value rather than going blank.
Common issues
After deleting a source, CAF mappings are orphaned and an API push to update them fails or silently drops the data.
Because CAFs cannot be edited or deleted in the UI or API, orphaned source mappings must be reset by support. Contact support with the CAF field IDs and the new source ID to re-associate them.
CAF quantity is overstated for a committed-stock source.
Change the CAF mapping rule to use Available Quantity rather than the supplier's total quantity, so the value reflects Total minus Committed Stock.
FAQs
When should I use a CAF instead of standard Aggregate Rules?
When at least one (but not all) source should be excluded for a channel, or a channel needs a different aggregate option than the global rules.
Can I edit or delete a CAF?
No. Contact support to remove or change one.
Do I need a unique mapping template per source?
Only when two sources share a template but one must be excluded from the CAF.
I use both GIP and GIS: how do I map a CAF?
Add both CAF names to each template and set the value to Don't Map on the feed that does not provide that value.