Configurator Attribute

Output representation of the attribute in a product configuration.
JSON example
1"attributeCategories": [
2      {
3        "attributes": [
4          {
5            "attributeCategoryId": "0v3xx0000000001AAA",
6            "attributeNameOverride": "Load Capacity",
7            "code": "CAP",
8            "dataType": "NUMBER",
9            "defaultValue": "1500",
10            "description": "Server racks are designed to support a specific load capacity, commonly measured in kilograms (kg) or pounds (lbs). Typical load capacities range from 500 kg (1102 lbs) to 1500 kg (3307 lbs) depending on the model.",
11            "id": "0tjxx00000001DpAAI",
12            "isCloneable": false,
13            "isConfigurable": true,
14            "isHidden": false,
15            "isPriceImpacting": false,
16            "isReadOnly": false,
17            "isRequired": false,
18            "label": "Load Capacity",
19            "name": "Load Capacity"
20          },
21          {
22            "attributeCategoryId": "0v3xx0000000001AAA",
23            "attributeNameOverride": "Expansion Slots",
24            "code": "SLOTCAP",
25            "dataType": "NUMBER",
26            "defaultValue": "12",
27            "id": "0tjxx00000001H3AAI",
28            "isCloneable": false,
29            "isConfigurable": true,
30            "isHidden": false,
31            "isPriceImpacting": false,
32            "isReadOnly": false,
33            "isRequired": true,
34            "label": "Expansion Slots",
35            "name": "Expansion Slots"
36          },
37          {
38            "attributeCategoryId": "0v3xx0000000001AAA",
39            "attributeNameOverride": "Memory",
40            "attributePicklist": {
41              "id": "0v5xx0000000001AAA",
42              "values": [
43                {
44                  "code": "MEM",
45                  "displayValue": "25",
46                  "id": "0v6xx0000000001AAA",
47                  "isBooleanValue": false,
48                  "name": "25Mem",
49                  "sequence": 0,
50                  "textValue": "25"
51                },
52                {
53                  "code": "50MEM",
54                  "displayValue": "50",
55                  "id": "0v6xx000000001eAAA",
56                  "isBooleanValue": false,
57                  "name": "50Mem",
58                  "sequence": 1,
59                  "textValue": "50"
60                },
61                {
62                  "code": "100MEM",
63                  "displayValue": "100",
64                  "id": "0v6xx000000003FAAQ",
65                  "isBooleanValue": false,
66                  "name": "100Mem",
67                  "sequence": 2,
68                  "textValue": "100"
69                }
70              ]
71            },
72            "dataType": "MULTIPICKLIST",
73            "defaultValue": "25",
74            "id": "0tjxx00000001IfAAI",
75            "isCloneable": false,
76            "isConfigurable": true,
77            "isHidden": false,
78            "isPriceImpacting": false,
79            "isReadOnly": false,
80            "isRequired": true,
81            "label": "Memory",
82            "name": "Memory"
83          }
84        ],
85        "code": "SPEC",
86        "name": "Server Rack Specifications"
87      }
88    ],
89    "description": "Introducing the Cisco Server Rack, a sleek and robust solution designed to streamline your data center infrastructure. With its scalable design and advanced cable management features, it ensures optimal performance, efficiency, and easy maintenance for your critical network equipment.",
90    "displayUrl": "https://www.cisco.com/content/dam/en/us/products/servers-unified-computing/ucs-c240-m4-rack-server/product-large.jpg",
91    "id": "01txx0000006jkuAAA",
92    "isActive": true,
93    "isAssetizable": true,
94    "isConfigurable": true,
95    "isSoldOnlyWithOtherProds": false,
96    "name": "Cisco Server Rack NX44",
97    "nodeType": "bundleProduct",
98    "prices": [],
99    "productClassification": {
100      "id": "11Bxx000002CC02EAG"
101    },
102    "productCode": "RACK",
103    "productComponentGroups": [
104      {
105        "classifications": [],
106        "code": "SERVICE",
107        "components": [
108          {
109            "additionalFields": [],
110            "attributeCategories": [],
111            "description": "Introducing the Cisco Rack Server NX44 Service, a comprehensive protection plan designed to safeguard your valuable data infrastructure. With extended coverage and rapid response times, this warranty ensures peace of mind and uninterrupted performance for your critical business operations.",
112            "id": "01txx0000006jmWAAQ",
113            "isActive": true,
114            "isAssetizable": true,
115            "isComponentRequired": false,
116            "isConfigurable": false,
117            "isDefaultComponent": false,
118            "isQuantityEditable": false,
119            "isSoldOnlyWithOtherProds": false,
120            "name": "Cisco Rack Server Service - 1 Year",
121            "nodeType": "simpleProduct",
122            "prices": [],
123            "productClassification": {},
124            "productCode": "SERVICE",
125            "productComponentGroups": [],
126            "productRelatedComponent": {
127              "childProductId": "01txx0000006jmWAAQ",
128              "childSellingModelId": "0jPxx000000004rEAA",
129              "doesBundlePriceIncludeChild": true,
130              "id": "0dSxx000000001dEAA",
131              "isComponentRequired": false,
132              "isDefaultComponent": false,
133              "isQuantityEditable": false,
134              "parentProductId": "01txx0000006jkuAAA",
135              "parentSellingModelId": "0jPxx000000004rEAA",
136              "productComponentGroupId": "0y7xx000000001dAAA",
137              "productRelationshipTypeId": "0yoxx00000001IfAAI",
138              "quantity": 1,
139              "quantityScaleMethod": "Proportional"
140            },
141            "productSellingModelOptions": [
142              {
143                "id": "0iOxx000000009hEAA",
144                "productId": "01txx0000006jmWAAQ",
145                "productSellingModel": {
146                  "id": "0jPxx000000004rEAA",
147                  "name": "Termed Annually",
148                  "pricingTerm": 1,
149                  "pricingTermUnit": "Annual",
150                  "sellingModelType": "TermDefined",
151                  "status": "Active"
152                },
153                "productSellingModelId": "0jPxx000000004rEAA"
154              },
155              {
156                "id": "0iOxx00000000PpEAI",
157                "productId": "01txx0000006jmWAAQ",
158                "productSellingModel": {
159                  "id": "0jPxx0000000085EAA",
160                  "name": "Evergreen Annually",
161                  "pricingTerm": 1,
162                  "pricingTermUnit": "Annual",
163                  "sellingModelType": "Evergreen",
164                  "status": "Active"
165                },
166                "productSellingModelId": "0jPxx0000000085EAA"
167              }
168            ]
169          }
170        ],
171        "description": "The services available for the Cisco Server Rack NX44 product provide comprehensive coverage and support for optimal performance and reliability, ensuring peace of mind for your data center infrastructure.",
172        "id": "0y7xx000000001dAAA",
173        "maxBundleComponents": 1,
174        "minBundleComponents": 0,
175        "name": "Services",
176        "parentProductId": "01txx0000006jkuAAA",
177        "sequence": 1
178      },
179      {
180        "classifications": [],
181        "code": "WARRANTY",
182        "components": [
183          {
184            "additionalFields": [],
185            "attributeCategories": [],
186            "description": "Introducing the Cisco Rack Server NX44 Warranty, a comprehensive protection plan designed to safeguard your valuable data infrastructure. With extended coverage and rapid response times, this warranty ensures peace of mind and uninterrupted performance for your critical business operations.",
187            "id": "01txx0000006jjIAAQ",
188            "isActive": true,
189            "isAssetizable": true,
190            "isComponentRequired": false,
191            "isConfigurable": false,
192            "isDefaultComponent": true,
193            "isQuantityEditable": true,
194            "isSoldOnlyWithOtherProds": false,
195            "name": "Cisco Rack Server Warranty - 1 Year",
196            "nodeType": "simpleProduct",
197            "prices": [],
198            "productClassification": {},
199            "productCode": "WARRANTY",
200            "productComponentGroups": [],
201            "productRelatedComponent": {
202              "childProductId": "01txx0000006jjIAAQ",
203              "childSellingModelId": "0jPxx000000001dEAA",
204              "doesBundlePriceIncludeChild": false,
205              "id": "0dSxx0000000001EAA",
206              "isComponentRequired": false,
207              "isDefaultComponent": true,
208              "isQuantityEditable": true,
209              "maxQuantity": 1,
210              "parentProductId": "01txx0000006jkuAAA",
211              "parentSellingModelId": "0jPxx000000001dEAA",
212              "productComponentGroupId": "0y7xx0000000001AAA",
213              "productRelationshipTypeId": "0yoxx00000001IfAAI",
214              "quantity": 1,
215              "quantityScaleMethod": "Proportional",
216              "sequence": 0
217            },
218            "productSellingModelOptions": [
219              {
220                "id": "0iOxx000000001dEAA",
221                "productId": "01txx0000006jjIAAQ",
222                "productSellingModel": {
223                  "id": "0jPxx000000001dEAA",
224                  "name": "One Time",
225                  "sellingModelType": "OneTime",
226                  "status": "Active"
227                },
228                "productSellingModelId": "0jPxx000000001dEAA"
229              },
230              {
231                "id": "0iOxx00000000HlEAI",
232                "productId": "01txx0000006jjIAAQ",
233                "productSellingModel": {
234                  "id": "0jPxx000000003FEAQ",
235                  "name": "Termed Monthly",
236                  "pricingTerm": 1,
237                  "pricingTermUnit": "Months",
238                  "sellingModelType": "TermDefined",
239                  "status": "Active"
240                },
241                "productSellingModelId": "0jPxx000000003FEAQ"
242              },
243              {
244                "id": "0iOxx00000000JNEAY",
245                "productId": "01txx0000006jjIAAQ",
246                "productSellingModel": {
247                  "id": "0jPxx000000004rEAA",
248                  "name": "Termed Annually",
249                  "pricingTerm": 1,
250                  "pricingTermUnit": "Annual",
251                  "sellingModelType": "TermDefined",
252                  "status": "Active"
253                },
254                "productSellingModelId": "0jPxx000000004rEAA"
255              },
256              {
257                "id": "0iOxx00000000KzEAI",
258                "productId": "01txx0000006jjIAAQ",
259                "productSellingModel": {
260                  "id": "0jPxx0000000085EAA",
261                  "name": "Evergreen Annually",
262                  "pricingTerm": 1,
263                  "pricingTermUnit": "Annual",
264                  "sellingModelType": "Evergreen",
265                  "status": "Active"
266                },
267                "productSellingModelId": "0jPxx0000000085EAA"
268              },
269              {
270                "id": "0iOxx00000000MbEAI",
271                "productId": "01txx0000006jjIAAQ",
272                "productSellingModel": {
273                  "id": "0jPxx000000006TEAQ",
274                  "name": "Evergreen Monthly",
275                  "pricingTerm": 1,
276                  "pricingTermUnit": "Months",
277                  "sellingModelType": "Evergreen",
278                  "status": "Active"
279                },
280                "productSellingModelId": "0jPxx000000006TEAQ"
281              }
282            ]
283          }
284        ],
285        "description": "The warranties available for the Cisco Server Rack NX44 product provide comprehensive coverage and support for optimal performance and reliability, ensuring peace of mind for your data center infrastructure.",
286        "id": "0y7xx0000000001AAA",
287        "maxBundleComponents": 1,
288        "minBundleComponents": 0,
289        "name": "Warranties",
290        "parentProductId": "01txx0000006jkuAAA",
291        "sequence": 0
292      }
293    ],
294    "productSellingModelOptions": [
295      {
296        "id": "0iOxx000000003FEAQ",
297        "productId": "01txx0000006jkuAAA",
298        "productSellingModel": {
299          "id": "0jPxx000000001dEAA",
300          "name": "One Time",
301          "sellingModelType": "OneTime",
302          "status": "Active"
303        },
304        "productSellingModelId": "0jPxx000000001dEAA"
305      },
306      {
307        "id": "0iOxx000000004rEAA",
308        "productId": "01txx0000006jkuAAA",
309        "productSellingModel": {
310          "id": "0jPxx000000003FEAQ",
311          "name": "Termed Monthly",
312          "pricingTerm": 1,
313          "pricingTermUnit": "Months",
314          "sellingModelType": "TermDefined",
315          "status": "Active"
316        },
317        "productSellingModelId": "0jPxx000000003FEAQ"
318      },
319      {
320        "id": "0iOxx000000006TEAQ",
321        "productId": "01txx0000006jkuAAA",
322        "productSellingModel": {
323          "id": "0jPxx000000004rEAA",
324          "name": "Termed Annually",
325          "pricingTerm": 1,
326          "pricingTermUnit": "Annual",
327          "sellingModelType": "TermDefined",
328          "status": "Active"
329        },
330        "productSellingModelId": "0jPxx000000004rEAA"
331      }
332    ],
333    "productType": "Bundle"
334  },
335  "errors": [],
336  "success": true,
337  "transactionContext": {
338    "SalesTransaction": [
339      {
340        "Status": "Draft",
341        "Account": "001xx000003GeIxAAK",
342        "BillingCity": "San Francisco",
343        "Subtotal": 152500,
344        "LastPricedDate": "2023-08-22T05:55:39Z",
345        "businessObjectType": "Quote",
346        "TotalAmount": 152500,
347        "ShippingStreet": "415 Mission St",
348        "SalesTransactionItem": [
349          {
350            "ProrationPolicy": null,
351            "Discount": null,
352            "ProductSellingModel": "0jPxx000000001dEAA",
353            "Product": "01txx0000006jkuAAA",
354            "businessObjectType": "QuoteLineItem",
355            "BasisTransactionItem": null,
356            "PartnerUnitPrice": null,
357            "StartingUnitPriceSource": "System",
358            "ListPrice": 150000,
359            "ItemTotalAdjustmentAmount": 0,
360            "SalesTransactionItemSource": "0QLxx0000004CQmGAM",
361            "SubscriptionTerm": null,
362            "StartDate": null,
363            "NetTotalPrice": 150000,
364            "TotalLineAmount": 150000,
365            "PeriodBoundaryStartMonth": null,
366            "ListPriceTotal": 150000,
367            "PartnerDiscountPercent": null,
368            "id": "0QLxx0000004CQmGAM",
369            "PriceWaterFall": "{
370                "currencyCode":"USD",
371                "executionEndTimestamp":"2023-09-18T20:11:15.016Z",
372                "executionId":"ruepwmHn2ZFvnQo5bjot",
373                "executionStartTimestamp":"2023-09-18T20:11:14.906Z",
374                "lineItemId":"0QLxx0000004CQmGAM",
375                "output":{
376                    "NetUnitPrice":150000.0,
377                    "Subtotal":0.0
378                 },
379                "success":true,
380                "waterfall":[
381                {
382                "fieldToTagNameMapping":{
383                "NetUnitPrice":"ItemUnitPrice",
384                "AdjustmentValue":"ItemAdjustmentValue",
385                "Subtotal":"ItemTotalAdjustmentAmount",
386                "Quantity":"ItemQuantity",
387                "LineItemId":"SalesTransactionItemSource",
388                "InputUnitPrice":"ItemUnitPrice"
389                },
390                "inputParameters":{
391                    "Quantity":1.0,
392                    "LineItemId":"0QLxx0000004CQmGAM",
393                    "InputUnitPrice":150000.0,
394                    "AdjustmentType":"Amount"
395                },
396                "outputParameters":{
397                    "NetUnitPrice":150000.0,
398                    "Subtotal":0.0
399                },
400            "pricingElement":{
401                "adjustments":[
402                  {
403                    "AdjustmentType":"Amount"
404                  }
405              ],
406            "elementType":"MANUALDISCOUNT",
407            "name":"ManualDiscount"
408            },
409            "sequence":1
410            }
411            ]
412            }",
413            "BillingFrequency": null,
414            "SalesTransactionItemParent": "0Q0xx0000004CAeCAM",
415            "StartingPriceTotal": 150000,
416            "Quantity": 1,
417            "PeriodBoundary": null,
418            "SalesTransactionItemAttribute": [
419              {
420                "AttributeKey": "0tjxx00000001H3AAI",
421                "AttributeValue": "30.0",
422                "AttributePicklistValue": null,
423                "IsPriceImpacting": true,
424                "businessObjectType": "QuoteLineItemAttribute",
425                "AttributeName": "Expansion Slots",
426                "AttributeDefinitionCode": "SLOTCAP",
427                "id": "0zuxx0000000001AAA",
428                "SalesTransactionItemAttrParent": "0QLxx0000004CQmGAM"
429              }
430            ],
431            "EndDate": null,
432            "DiscountAmount": null,
433            "PricebookEntry": "01uxx0000009154AAA",
434            "PricingTermCount": 1,
435            "NetUnitPrice": 150000,
436            "UnitPrice": 150000,
437            "StartingUnitPrice": 150000,
438            "SalesTrxnItemRelationship": [
439              {
440                "ProductRelationshipType": "0yoxx00000001IfAAI",
441                "MainItemRole": "Bundle",
442                "AssociatedItem": "0QLxx0000004CQnGAM",
443                "ProductRelatedComponent": "0dSxx0000000001EAA",
444                "MainItem": "0QLxx0000004CQmGAM",
445                "AssociatedQuantScaleMethod": "Proportional",
446                "businessObjectType": "QuoteLineRelationship",
447                "AssociatedItemRole": "BundleComponent",
448                "SalesTrnItemRelationshipParent": "0Q0xx0000004CAeCAM",
449                "id": "0yQxx000000001dEAA",
450                "AssociatedItemPricing": "NotIncludedInBundlePrice"
451              }
452            ],
453            "TotalPrice": 150000,
454            "PeriodBoundaryDay": null
455          },
456          {
457            "ProrationPolicy": null,
458            "Discount": null,
459            "ProductSellingModel": "0jPxx000000001dEAA",
460            "Product": "01txx0000006jjIAAQ",
461            "businessObjectType": "QuoteLineItem",
462            "BasisTransactionItem": null,
463            "PartnerUnitPrice": null,
464            "StartingUnitPriceSource": "System",
465            "ListPrice": 2000,
466            "ItemTotalAdjustmentAmount": 0,
467            "SalesTransactionItemSource": "0QLxx0000004CQnGAM",
468            "SubscriptionTerm": null,
469            "StartDate": null,
470            "NetTotalPrice": 2000,
471            "TotalLineAmount": 2000,
472            "PeriodBoundaryStartMonth": null,
473            "ListPriceTotal": 2000,
474            "PartnerDiscountPercent": null,
475            "id": "0QLxx0000004CQnGAM",
476            "PriceWaterFall": "{
477                "currencyCode":"USD",
478                "executionEndTimestamp":"023-09-18T20:11:15.016Z",
479                "executionId":"ruepwmHn2ZFvnQo5bjot",
480                "executionStartTimestamp":"2023-09-18T20:11:14.906Z",
481                "lineItemId":"0QLxx0000004CQnGAM",
482                "output":{
483                    "NetUnitPrice":2000.0,
484                    "Subtotal":0.0
485                 },
486                "success":true,
487                "waterfall":[
488                {
489                "fieldToTagNameMapping":{
490                "NetUnitPrice":"ItemUnitPrice",
491                "AdjustmentValue":"ItemAdjustmentValue",
492                "Subtotal":"ItemTotalAdjustmentAmount",
493                "Quantity":"ItemQuantity",
494                "LineItemId":"SalesTransactionItemSource",
495                "InputUnitPrice":"ItemUnitPrice"
496                },
497                "inputParameters":{
498                    "Quantity":1.0,
499                    "LineItemId":"0QLxx0000004CQnGAM",
500                    "InputUnitPrice":2000.0,
501                    "AdjustmentType":"Amount"
502                },
503                "outputParameters":{
504                    "NetUnitPrice":2000.0,
505                    "Subtotal":0.0
506                },
507            "pricingElement":{
508                "adjustments":[
509                  {}
510              ],
511            "elementType":"MANUALDISCOUNT",
512            "name":"ManualDiscount"
513            },
514            "sequence":1
515            }
516            ]
517            }",
518            "BillingFrequency": null,
519            "SalesTransactionItemParent": "0Q0xx0000004CAeCAM",
520            "StartingPriceTotal": 2000,
521            "Quantity": 1,
522            "PeriodBoundary": null,
523            "EndDate": null,
524            "DiscountAmount": null,
525            "PricebookEntry": "01uxx000000913SAAQ",
526            "PricingTermCount": 1,
527            "NetUnitPrice": 2000,
528            "UnitPrice": 2000,
529            "StartingUnitPrice": 2000,
530            "TotalPrice": 2000,
531            "PeriodBoundaryDay": null
532          }
533        ],
534        "BillingCountry": "US",
535        "BillingStreet": "415 Mission St",
536        "Pricebook": "01sxx0000005uDZAAY",
537        "ShippingPostalCode": "94105",
538        "SalesTransactionSource": "0Q0xx0000004CAeCAM",
539        "ShippingCountry": "US",
540        "ShippingCity": "San Francisco",
541        "ShippingState": "CA",
542        "BillingPostalCode": "94105",
543        "id": "0Q0xx0000004CAeCAM",
544        "BillToContact": null,
545        "Contract": null,
546        "BillingState": "CA"
547      }
548    ]
Property Name Type Description Filter Group and Version Available Version
attribute​CategoryId String ID of the attribute category. Small, 60.0 60.0
attribute​NameOverride String Name override value of the attribute. Small, 60.0 60.0
attribute​Picklist Configurator Attribute Picklist[] Picklist values of the attribute. Small, 60.0 60.0
code String Code of the attribute. Small, 60.0 60.0
dataType String Data type of the attribute. Small, 60.0 60.0
default​HelpText String Default help text value of the attribute. Small, 60.0 60.0
default​Value String Default value of the attribute. Small, 60.0 60.0
description String Description of the attribute. Small, 60.0 60.0
display​Type String Display type of the attribute. Small, 60.0 60.0
id String ID of the attribute. Small, 60.0 60.0
is​Cloneable Boolean Indicates if the attribute is cloneable (true) or not (false). Small, 60.0 60.0
is​Configurable Boolean Indicates if the attribute is configurable (true) or not (false). Small, 60.0 60.0
isEncrypted Boolean Indicates if the attribute is encrypted (true) or not (false). Small, 60.0 60.0
isHidden Boolean Indicates if the attribute is hidden (true) or not (false). Small, 60.0 60.0
isPrice​Impacting Boolean Indicates if this is a price impacting attribute (true) or not (false). Small, 60.0 60.0
isReadOnly Boolean Indicates if the attribute is read-only (true) or not (false). Small, 60.0 60.0
isRequired Boolean Indicates if the attribute is required (true) or not (false). Small, 60.0 60.0
label String Label of the attribute. Small, 60.0 60.0
maximum​Value String Maximum value for the product attribute. Small, 60.0 60.0
minimum​Value String Minimum value for the product attribute. Small, 60.0 60.0
name String Name of the attribute. Small, 60.0 60.0
sequence Integer Sequence values of the attribute. Small, 60.0 60.0
status String Status of the attribute. Small, 60.0 60.0
stepValue String Step value for the attribute. Small, 60.0 60.0
unitOfMeasure Configurator Unit Of Measure[] Details about the unit of measure associated with an attribute. Small, 63.0 63.0
userValue String User value of the attribute. Small, 60.0 60.0
value​Decoder String Value decoder for the attribute. Small, 60.0 60.0
value​Description String Value description of the attribute. Small, 60.0 60.0