Newer Version Available

This content describes an older version of this product. View Latest

Attribute Detail

Output representation of product attribute details.
JSON example
This request shows a sample success response.
1"attributes": [
2    {
3        "id": "0tjSG0000001embYAA",
4        "sequence": 1, #optional
5        "name": "Copay",
6        "label": "Copay Currency", #optional
7        "dataType": "CURRENCY",
8        "keyHidden":false,
9        "isActive": true
10    },
11    {
12        "id": "0tjSG0000001eoDYAQ",
13        "sequence": 1,
14        "name": "Coinsurance",
15        "label": "Coinsurance Percentage",
16        "dataType": "PERCENTAGE",
17        "keyHidden":false,
18        "isActive": true
19    }
20]
Property Name Type Description Filter Group and Version Available Version
attributeDefinitionId String ID of the attribute definition. Small, 63.0 63.0
attributePicklistValueId String ID of the attribute picklist value. Small, 63.0 63.0
dataType String Data type of attribute, such as Percentage. Small, 63.0 63.0
id String ID of the product. Small, 63.0 63.0
isActive Boolean Indicates whether the attribute is active (true) or not (false). Small, 63.0 63.0
keyHidden Boolean Indicates whether the attribute key is hidden (true) or (not). Small, 63.0 63.0
label String Label of the attribute. Small, 63.0 63.0
name String Name of the attribute. Small, 63.0 63.0
picklistValues Attribute Picklist Value[] List of picklist values. Small, 63.0 63.0
sequence Integer Sequence of attribute. Small, 63.0 63.0
value String Value of attribute. Small, 63.0 63.0