Enabling API Filters

Digital Commerce contains headless APIs, which are used from the SDK and can be used independently too. The Query API accepts JSON input with filters, conditions, fields, lookups, and relationships for an object to fetch records. Implementing Digital Commerce applies global filters by default. You can bypass and override by adding a record to the APTS_Admin__c object named APTS_EnableAPIFilters with values True and False. By default, this flag is set to True. To override global filters, you must set this flag to False.

Important

Disabling global filters disables all the filters across the application. For using filters of your choice, you must explicitly pass appropriate parameters.

The following global filters are applied:

API	Version	Condition
carts	All	OwnerId = Current User Id
carts	All	Account = Current Account
carts	All	PriceListId = Current Price List
carts	3	BusinessObjectId != null
carts	3	BusinessObjectType != null
products	All	IsActive = true
products	All	Has a valid price list item in the current price list (price list item inherits price list item filters)
pricelistitems	All	Effective Date == null OR Effective Date <= TODAY
pricelistitems	All	Expiration Date == null OR Expiration Date >= TODAY
pricelistitems	All	Active = true
pricelistitems	All	PriceListId = Current Price List
pricelistitems	All	ListPrice != null
quotes	All	OwnerId = Current User Id
quotes	All	Account = Current Account
quotes	All	Primary_Contact = Current User Contact Id
assets	All	AccountId = Current Account
categories	All	IsHidden = false
categories	All	Hierarchy.Type = ‘Offering’ OR Hierarchy.Type = ‘Both’
categories	All	AncestorId != null OR PrimordialId = null
categories	All	IsLeaf = No OR ProductCount > 0
orders	All	OwnerId = Current User Id
orders	All	SoldToAccountId = Current Account Id
orders	All	PrimaryContactId = Current User Contact Id