Settings
Configure SDK
Using Business Entity Filters in Product Catalog List APIs
Before exploring the following scenario, you need to know the below pointers:
-
The
include_site_level_resourcesvalue istrueby default. Therefore, if you do not provide a value for this parameter, it will consider the default value. -
The
business_entity_idin context can be passed in an input parameter or custom header.
Assume you have two active business entities associated with your site. Each resource has the following identifiers:
-
Site-level resource: Resource 1
-
Business entity resource 1: Resource 2 (Entity ID 1)
-
Business entity resource 2: Resource 3 (Entity ID 2)
Primary Scenarios
The table below outlines the behavior of the Product Catalog’s List API based on different combinations of parameters: include_site_level_resources, business_entity_id[is_present], business_entity_id in context, and business_entity_id[is]. The column API Response shows the Site or Business Entity resources returned by the API for each combination of these parameters. This table covers primary scenarios for how the List API responds to these inputs.
|
include_site_level_resources |
business_entity_id[is_present] |
business_entity_id in context |
business_entity_id[is] |
API Response |
|
No value provided |
No value provided |
No value provided |
No value provided |
Resource 1, Resource 2, Resource 3 |
|
false |
No value provided |
No value provided |
No value provided |
Resource 2, Resource 3 |
|
No value provided |
false |
No value provided |
No value provided |
Resource 1 |
|
No value provided |
No value provided |
No value provided |
Entity ID 1 |
Resource 2 |
*The cells say, “No value provided”, which means no value is passed in the respective filter parameters.
Other Scenarios
The table below outlines the behavior of the Product Catalog’s List API based on different combinations of parameters: include_site_level_resources, business_entity_id[is_present], business_entity_id in context, and business_entity_id[is]. The column API Response shows the Site or Business Entity resources returned by the API for each combination of these parameters. This table covers other possible scenarios for how the List API responds to these inputs.
|
include_site_level_resources |
business_entity_id[is_present] |
business_entity_id in context |
business_entity_id[is] |
API Response |
|---|---|---|---|---|
|
false |
false |
No value provided |
No value provided |
No Resource will be returned |
|
false |
true |
No value provided |
No value provided |
Resource 2, Resource 3 |
|
No value provided |
No value provided |
Entity ID 1 |
No value provided |
Resource 1, Resource 2 |
|
No value provided |
No value provided |
Entity ID 2 |
No value provided |
Resource 1, Resource 3 |
|
false |
No value provided |
Entity ID 1 |
No value provided |
Resource 2 |
|
false |
No value provided |
Entity ID 2 |
No value provided |
Resource 3 |
|
No value provided |
false |
No value provided |
Entity ID 1 |
No Resource will be returned |
|
No value provided |
No value provided |
No value provided |
Entity ID 2 |
Resource 3 |
|
No value provided |
false |
Entity ID 1 |
No value provided |
Resource 1 |
|
No value provided |
true |
Entity ID 1 |
No value provided |
Resource 2 |
|
No value provided |
false |
Entity ID 2 |
No value provided |
Resource 1 |
|
No value provided |
true |
Entity ID 2 |
No value provided |
Resource 3 |
*The cells say, “No value provided”, which means no value is passed in the respective filter parameters.