Products

Output representation of the list of retrieved products.

JSON Example 

1{
2  "correlationId": "9b6bc520-3c82-4d6c-a458-47590370681a",
3  "facets":[
4    {
5      "attributeType": "ProductStandard",
6      "displayName": "Product Type",
7      "displayRank": 1,
8      "displayType": "MultiSelect",
9      "nameOrId": "Type",
10      "values": [
11        {
12          "displayName": "Simple",
13          "nameOrId": "Simple",
14          "productCount": 9
15        }
16      ]
17    },
18    {
19      "attributeType": "ProductStandard",
20      "displayName": "Active",
21      "displayRank": 2,
22      "displayType": "MultiSelect",
23      "nameOrId": "IsActive",
24      "values": [
25        {
26          "displayName": "true",
27          "nameOrId": "true",
28          "productCount": 47
29        }
30      ]
31    }
32  ],
33  "count": 3,
34  "products": [
35    {
36      "attributeCategory": [],
37      "attributes": [],
38      "categories": [],
39      "childProducts": [],
40      "description": "Keep your organization connected with seamless collaboration across distributed teams. No matter where employees are located, organizations are seeking stronger employee engagement and customer experiences to enable more productivity and greater business agility. More effective collaboration helps organizations work smarter.",
41      "displayUrl": "https://dispatch.m.io/wp-content/uploads/2023/01/History-of-Webex.png",
42      "id": "01t1Q000008CD2eQAG",
43      "isActive": true,
44      "isAssetizable": true,
45      "isSoldOnlyWithOtherProds": false,
46      "name": "SmartBytes Collaboration Suite",
47      "nodeType": "bundleProduct",
48      "productClassification": {
49        "id": "11B1Q0000008OMGUA2"
50      },
51      "productCode": "P0143",
52      "productComponentGroups": [],
53      "productSellingModelOptions": [
54        {
55          "id": "0iO1Q0000008OkeUAE",
56          "productId": "01t1Q000008CD2eQAG",
57          "productSellingModel": {
58            "id": "0jP1Q000000CaVFUA0",
59            "name": "One Time",
60            "sellingModelType": "OneTime",
61            "status": "Active"
62          }
63        }
64      ],
65      "productSpecificationType": {
66        "name": "None"
67      }
68    },
69    {
70      "attributeCategory": [],
71      "attributes": [],
72      "categories": [],
73      "childProducts": [],
74      "configureDuringSale": "Allowed",
75      "displayUrl": "https://www.cisco.com/c/dam/en/us/products/collateral/wireless/small-business-300-series-wireless-access-points/datasheet-c78-732143.doc/_jcr_content/renditions/datasheet-c78-732143_1.jpg",
76      "id": "01t1Q000008CD36QAG",
77      "isActive": true,
78      "isAssetizable": true,
79      "isSoldOnlyWithOtherProds": false,
80      "name": "SmartBytes Repeater",
81      "nodeType": "simpleProduct",
82      "productClassification": {
83        "id": "11B1Q0000008OMMUA2"
84      },
85      "productCode": "BS_R001",
86      "productComponentGroups": [],
87      "productSellingModelOptions": [
88        {
89          "id": "0iO1Q0000008OlsUAE",
90          "productId": "01t1Q000008CD36QAG",
91          "productSellingModel": {
92            "id": "0jP1Q000000CaVFUA0",
93            "name": "One Time",
94            "sellingModelType": "OneTime",
95            "status": "Active"
96          }
97        }
98      ],
99      "productSpecificationType": {
100        "name": "COM_Offer"
101      }
102    },
103    {
104      "attributeCategory": [],
105      "attributes": [],
106      "categories": [],
107      "childProducts": [],
108      "configureDuringSale": "Allowed",
109      "description": "A converged data center architecture that integrates computing, networking and storage resources to increase efficiency and enable centralized management. UCS products are designed and configured to work together effectively.",
110      "displayUrl": "https://www.cisco.com/c/dam/en/us/products/collateral/servers-unified-computing/ucs-x-series-modular-system/sap-hana-scaleup-appliance-with-xseries-wp.docx/_jcr_content/renditions/sap-hana-scaleup-appliance-with-xseries-wp_3.png",
111      "id": "01t1Q000008CD2sQAG",
112      "isActive": true,
113      "isAssetizable": true,
114      "isSoldOnlyWithOtherProds": false,
115      "name": "SmartBytes Unified Computing System",
116      "nodeType": "bundleProduct",
117      "productCode": "P0157",
118      "productComponentGroups": [],
119      "productSellingModelOptions": [
120        {
121          "id": "0iO1Q0000008OkzUAE",
122          "productId": "01t1Q000008CD2sQAG",
123          "productSellingModel": {
124            "id": "0jP1Q000000CaVFUA0",
125            "name": "One Time",
126            "sellingModelType": "OneTime",
127            "status": "Active"
128          }
129        },
130        {
131          "id": "0iO1Q0000008OlWUAU",
132          "productId": "01t1Q000008CD2sQAG",
133          "productSellingModel": {
134            "id": "0jP1Q000000CaVHUA0",
135            "name": "Evergreen",
136            "pricingTerm": 1,
137            "pricingTermUnit": "Months",
138            "sellingModelType": "Evergreen",
139            "status": "Active"
140          }
141        }
142      ],
143      "productSpecificationType": {
144        "name": "None"
145      }
146    }
147  ],
148  "status": {
149    "code": "200",
150    "errors": [],
151    "message": "Successfully fetched the product records."
152  }
153}

This example shows a sample response with data from Enterprise Product Catalog.

1{
2  "correlationId": "4cf1997d-5d86-4997-9c6b-55842442f325",
3  "facets": [],
4  "products": [
5    {
6      "additionalFields": {},
7      "attributeCategory": [
8        {
9          "attributes": [
10            {
11              "additionalFields": {
12                "OptOutAssetization": true,
13                "OptOutDecompositionAction": false,
14                "OptOutSupplementalAction": false
15              },
16              "attributeNameOverride": "ATTRIBUTE-ABP-INT",
17              "code": "ABP-INT",
18              "dataType": "Number",
19              "developerName": "ABP-INT",
20              "id": "ABP-INT",
21              "isHidden": false,
22              "isPriceImpacting": false,
23              "isReadOnly": false,
24              "isRequired": false,
25              "name": "ATTRIBUTE-ABP-INT",
26              "sequence": 3,
27              "status": "Active"
28            },
29            {
30              "additionalFields": {
31                "OptOutAssetization": false,
32                "OptOutDecompositionAction": false,
33                "OptOutSupplementalAction": false
34              },
35              "attributeNameOverride": "ATTRIBUTE-ABP-CHECKBOX",
36              "code": "ABP-CHECKBOX",
37              "dataType": "Checkbox",
38              "developerName": "ABP-CHECKBOX",
39              "id": "ABP-CHECKBOX",
40              "isHidden": false,
41              "isPriceImpacting": false,
42              "isReadOnly": false,
43              "isRequired": false,
44              "name": "ATTRIBUTE-ABP-CHECKBOX",
45              "sequence": 2,
46              "status": "Active"
47            }
48          ],
49          "code": "CATEGORY-ABP",
50          "id": "a0Zxx000000c3tNEAQ",
51          "name": "ATTRIBUTE_CATEGORY-ABP"
52        }
53      ],
54      "attributes": [],
55      "catalogs": [],
56      "categories": [],
57      "childProducts": [],
58      "id": "01txx0000006kFYAAY",
59      "isActive": true,
60      "isAssetizable": true,
61      "name": "ARProduct",
62      "nodeType": "simpleProduct",
63      "productCode": "ARProduct",
64      "productComponentGroups": [],
65      "productSellingModelOptions": [],
66      "productUnitOfMeasures": []
67    }
68  ],
69  "status": {
70    "code": "200",
71    "errors": [],
72    "message": "Successfully fetched Product records."
73  }
74}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
correlation​IdStringUnique token to track and associate related events or transactions across different components of the application. If unspecified, a Universally Unique Identifier (UUID) is generated.Small, 60.060.0
countIntegerTotal count of the products matching the request query.Small, 60.060.0
facetsSearch FacetDetails of the faceted search. This property is applicable if the Use Indexed Data For Product Listing and Search toggle from the Product Discovery Settings page from Setup is enabled.Small, 63.063.0
productsProduct[]List of products matching the request query.Small, 60.060.0
statusStatusStatus of the request.Small, 60.060.0