CPQ Base Details

Output representation of the catalog, category, or product details based on the request.

JSON Example

This example shows the sample catalog details.

1{
2  "result": {
3    "name": "Printer",
4    "productCode": "PRN001",
5    "prices": [{
6      "price": 199.0,
7      "currencyIsoCode": "USD",
8      "priceBookEntryId": "...",
9      "pricingModel": {
10        "id": "...",
11        "name": "One Time",
12        "pricingModelType": "OneTime"
13      }
14    }]
15  },
16  "apiStatus": {
17    "statusCode": "FetchedDetailsSuccessfully"
18  }
19}

This example shows the sample category details.

1{
2  "apiStatus": {
3    "messages": [
4      
5    ],
6    "statusCode": "FetchedDetailsSuccessfully"
7  },
8  "correlationId": "f9fb90de-36aa-44a1-9961-a9ef5fc0cad8",
9  "result": {
10    "catalogId": "0ZSxx0000000001GAA",
11    "childCategories": [
12      
13    ],
14    "description": "Category for Samsung phones",
15    "id": "0ZGxx000000004rGAA",
16    "name": "Samsung",
17    "isNavigational": true,
18    "sortOrder": 2
19  }
20}

This example shows the sample product details.

1{
2  "apiStatus": {
3    "messages": [
4      
5    ],
6    "statusCode": "FetchedDetailsSuccessfully"
7  },
8  "correlationId": "822a8941-7412-4883-bb80-e488f908471e",
9  "result": {
10    "additionalFields": {
11        "CustomField1__c": "TextValue",
12        "CustomField2__c": "10",
13        "StandardField1": "false"
14    },
15    "attributeCategories": [
16      
17    ],
18    "attributes": [
19      
20    ],
21    "catalogs": [
22      
23    ],
24    "childProducts": [
25      
26    ],
27    "id": "01txx0000006i2WAAQ",
28    "isActive": true,
29    "isAssetizable": true,
30    "isSoldOnlyWithOtherProds": false,
31    "name": "iPhone15",
32    "nodeType": "simpleProduct",
33    "prices": [
34      
35    ],
36    "productClassification": {
37      
38    },
39    "productCode": "iPhone15",
40    "productComponentGroups": [
41      
42    ],
43    "productSellingModelOptions": [
44      {
45        "id": "0iOxx0000000003EAA",
46        "productId": "01txx0000006i2WAAQ",
47        "productSellingModel": {
48          "id": "0jPxx0000000001EAA",
49          "name": "OneTime",
50          "sellingModelType": "OneTime",
51          "status": "Active"
52        },
53        "productSellingModelId": "0jPxx0000000001EAA"
54      },
55      {
56        "id": "0iOxx0000000004EAA",
57        "productId": "01txx0000006i2WAAQ",
58        "productSellingModel": {
59          "id": "0jPxx0000000002EAA",
60          "name": "Monthly",
61          "pricingTerm": 1,
62          "pricingTermUnit": "Months",
63          "sellingModelType": "TermDefined",
64          "status": "Active"
65        },
66        "productSellingModelId": "0jPxx0000000002EAA"
67      }
68    ],
69    "productSpecificationType": {
70      "name": "ProdSpecRecType1",
71      "productSpecificationRecordType": {
72        
73      }
74    }
75  }
76}
Property Name Type Description Filter Group and Version Available Version
api​Status API Status Status of the API request. Small, 60.0 60.0
context​Id String ID of the context. Small, 60.0 60.0
correlation​Id String Unique identifier of the request. Small, 60.0 60.0
result Any response body Result that contains the details of catalogs, categories, or products as per the requested resource. Small, 60.0 60.0
user​Context User Context User context details. For example, account ID or contact ID. Small, 60.0 60.0