Guided Selection

Output representation of the details of a guided selection.

JSON Example 

1{
2  "apiStatus": {
3    "messages": [],
4    "statusCode": "FETCHED_DETAILS_SUCCESSFULLY"
5  },
6  "correlationId": "corrId",
7  "cursor": "MTAwMDAwMDAwNg==",
8  "searchTerms": [
9    {
10      "term": "IPhone"
11    },
12    {
13      "term": "4GB"
14    },
15    {
16      "term": "64GB"
17    }
18  ],
19  "result": [
20    {
21      "additionalFields": {
22        "CustomField1__c": "TextValue",
23        "CustomField2__c": "10",
24        "StandardField1": "false"
25      },
26      "description": "IPhone-13",
27      "id": "01txx0000006kYwAAI",
28      "name": "Sample product 1",
29      "prices": [
30        {
31          "price": 150,
32          "priceBookEntryId": "12Axx0000004DF7EAM",
33          "priceBookId": "01sxx0000005puLAAQ",
34          "pricingModel": {
35            "frequency": "Monthly",
36            "id": "12Bxx000000CiCDEA0",
37            "name": "IPhone-13",
38            "occurrence": 6,
39            "pricingModelType": "Recurring"
40          }
41        },
42        {
43          "price": 400,
44          "priceBookEntryId": "12Axx0000004DGjEAM",
45          "priceBookId": "01sxx0000005puLAAQ",
46          "pricingModel": {
47            "id": "12Bxx000000CiCCEA0",
48            "name": "IPhone-13",
49            "pricingModelType": "OneTime"
50          }
51        }
52      ],
53      "qualificationContext": {
54        "isQualified": true
55      }
56    }
57  ]
58}

This example shows a sample response with details of eligible promotions.

1{
2  "apiStatus": {
3    "messages": [],
4    "statusCode": "FETCHED_DETAILS_SUCCESSFULLY"
5  },
6  "correlationId": "corrId",
7  "cursor": "MTAwMDAwMDAwNg==",
8  "searchTerms": [
9    {
10      "term": "IPhone",
11      "tags": [
12        "deviceType",
13        "mobile"
14      ]
15    },
16    {
17      "term": "4GB",
18      "tags": [
19        "RAM"
20      ]
21    },
22    {
23      "term": "64GB",
24      "tags": [
25        "Storage"
26      ]
27    }
28  ],
29  "result": [
30    {
31      "additionalFields": {
32        "CustomField1__c": "TextValue",
33        "CustomField2__c": "10",
34        "StandardField1": "false"
35      },
36      "description": "IPhone-13",
37      "id": "01txx0000006kYwAAI",
38      "name": "Sample product 1",
39      "prices": [
40        {
41          "price": 150,
42          "priceBookEntryId": "12Axx0000004DF7EAM",
43          "priceBookId": "01sxx0000005puLAAQ",
44          "pricingModel": {
45            "frequency": "Monthly",
46            "id": "12Bxx000000CiCDEA0",
47            "name": "IPhone-13",
48            "occurrence": 6,
49            "pricingModelType": "Recurring"
50          }
51        },
52        {
53          "price": 400,
54          "priceBookEntryId": "12Axx0000004DGjEAM",
55          "priceBookId": "01sxx0000005puLAAQ",
56          "pricingModel": {
57            "id": "12Bxx000000CiCCEA0",
58            "name": "IPhone-13",
59            "pricingModelType": "OneTime"
60          }
61        }
62      ],
63      "qualificationContext": {
64        "isQualified": true
65      },
66      "eligiblePromotions": [
67        {
68          "id": "0ZPxx0000000001AAA",
69          "name": "IPhone_Promotion_2025",
70          "displayName": "iPhone Special Offer",
71          "description": "Get 15% off on iPhone 13",
72          "priority": 100,
73          "startDateTime": "2025-03-01T00:00:00Z",
74          "endDateTime": "2025-03-31T23:59:59Z",
75          "isAutomatic": true,
76          "isCategoryPromo": false,
77          "isProductPromo": true,
78          "couponCode": null,
79          "termsAndConditions": "Valid on iPhone 13 models only."
80        },
81        {
82          "id": "0ZPxx0000000002AAA",
83          "name": "Memory_Upgrade_Deal",
84          "displayName": "Free Memory Upgrade",
85          "description": "Upgrade to 128GB for the price of 64GB",
86          "priority": 90,
87          "startDateTime": "2025-02-01T00:00:00Z",
88          "endDateTime": "2025-12-31T23:59:59Z",
89          "isAutomatic": false,
90          "isCategoryPromo": false,
91          "isProductPromo": true,
92          "couponCode": "MEMORY128",
93          "termsAndConditions": "Applies to select iPhone models."
94        }
95      ]
96    }
97  ]
98}

This example shows a sample request to run visibility rules.

1{
2  "apiStatus": {
3    "messages": [],
4    "statusCode": "FetchedDetailsSuccessfully"
5  },
6  "correlationId": "ef4f324d-b6d9-47ca-9e78-c6ec60ca5b23",
7  "cursor": "MTAwMDAwMDAwNg==",
8  "offSet": 1,
9  "result": [
10    {
11      "additionalFields": {},
12      "attributeCategories": [],
13      "catalogs": [
14        {
15          "customFields": {},
16          "id": "0ZSVW000000AhdC4AS",
17          "name": "QuantumBit Hardware",
18          "numberOfCategories": 11
19        }
20      ],
21      "categories": [
22        {
23          "catalogId": "0ZSVW000000AhdC4AS",
24          "childCategories": [],
25          "customFields": {},
26          "eligiblePromotions": [],
27          "id": "0ZGVW000000IUEC4A4",
28          "name": "Memory"
29        }
30      ],
31      "childProducts": [],
32      "childVariationIds": [],
33      "configurationRules": [
34        {
35          "details": [
36            {
37              "message": "32GB RDIMM disables 128GB LRDIMM"
38            }
39          ],
40          "type": "disable"
41        }
42      ],
43      "configureDuringSale": "Allowed",
44      "description": "128GB RDIMM",
45      "displayUrl": "/resource/ram_32GB_RDIMM",
46      "eligiblePromotions": [],
47      "id": "01tVW000003l7v5YAA",
48      "isActive": true,
49      "isAssetizable": true,
50      "isSoldOnlyWithOtherProds": false,
51      "name": "128GB LRDIMM",
52      "nodeType": "simpleProduct",
53      "prices": [
54        {
55          "currencyIsoCode": "USD",
56          "isDefault": true,
57          "isDerived": false,
58          "isSelected": false,
59          "price": 0,
60          "priceBookEntryId": "01uVW000000jzfJYAQ",
61          "priceBookId": "01sVW0000024PZlYAM",
62          "pricingModel": {
63            "id": "0jPVW0000001fh42AA",
64            "name": "One-Time",
65            "pricingModelType": "OneTime"
66          }
67        }
68      ],
69      "productClass": "Simple",
70      "productClassification": {},
71      "productCode": "QB-MEM 128GB",
72      "productComponentGroups": [],
73      "productSellingModelOptions": [
74        {
75          "id": "0iOVW00000049xS2AQ",
76          "isDefault": true,
77          "productId": "01tVW000003l7v5YAA",
78          "productSellingModel": {
79            "doesAutoRenewByDefault": false,
80            "id": "0jPVW0000001fh42AA",
81            "name": "One-Time",
82            "sellingModelType": "OneTime",
83            "status": "Active"
84          },
85          "productSellingModelId": "0jPVW0000001fh42AA"
86        }
87      ],
88      "productUnitOfMeasures": []
89    }
90  ],
91  "searchTerms": [
92    {
93      "tags": [],
94      "term": "128GB LRDIMM"
95    }
96  ]
97}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
apiStatusAPI StatusStatus of the API request.Small, 62.062.0
correlation​IdStringUnique ID of the request.Small, 62.062.0
cursorStringUnique ID to represent the position of each product in the dataset.Small, 62.062.0
resultAny response bodyResult that contains the list of products as per the requested resource.Small, 62.062.0
searchTermsGuided Selection Search Term[]Search terms for the guided selection.Small, 62.062.0