Newer Version Available
Product Overview Collection
- JSON example
-
1{ 2 "products": [ 3 { 4 "defaultImage": { 5 "alternateText": "variations-amazon.png", 6 "contentVersionId": null, 7 "id": "2pmSG000005olVVYAY", 8 "mediaType": "Image", 9 "sortOrder": 0, 10 "thumbnailUrl": null, 11 "title": "variations-amazon.png", 12 "url": "/cms/delivery/media/MCVCHRIP72OVFIDPYX4R67HCC66U?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" 13 }, 14 "error": {}, 15 "fields": { 16 "LastModifiedDate": "2025-01-24T18:49:21Z", 17 "DisplayUrl": null, 18 "IsDeleted": "false", 19 "Description": null, 20 "ProductCode": null, 21 "IsActive": "true", 22 "ExternalId": null, 23 "LastViewedDate": null, 24 "UserRecordAccessId": null, 25 "LastReferencedDate": null, 26 "StockKeepingUnit": null, 27 "CurrencyIsoCode": "USD", 28 "Name": "color_size variation", 29 "SystemModstamp": "2025-01-24T18:49:22Z", 30 "IsArchived": "false", 31 "Type": "Base", 32 "CreatedById": "005SG00000CCGwX", 33 "CloneSourceId": null, 34 "QuantityUnitOfMeasure": null, 35 "CreatedDate": "2025-01-24T18:49:21Z", 36 "Family": null, 37 "ProductClass": "VariationParent", 38 "LastModifiedById": "005SG00000CCGwX" 39 }, 40 "id": "01tSG000003xbeXYAQ", 41 "mediaGroups": [ 42 { 43 "developerName": "productListImage", 44 "id": "2mgSG000000oceoYAA", 45 "mediaItems": [ 46 { 47 "alternateText": "variations-amazon.png", 48 "contentVersionId": null, 49 "id": "2pmSG000005olVVYAY", 50 "mediaType": "Image", 51 "sortOrder": 0, 52 "thumbnailUrl": null, 53 "title": "variations-amazon.png", 54 "url": "/cms/delivery/media/MCVCHRIP72OVFIDPYX4R67HCC66U?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" 55 } 56 ], 57 "name": "Product List Image", 58 "usageType": "Listing" 59 } 60 ], 61 "name": "color_size variation", 62 "productClass": "VariationParent", 63 "isConfigurationAllowed": true, 64 "success": true, 65 "variationAttributeSet": { 66 "apiName": "Color_Size", 67 "attributes": [], 68 "label": "Color_Size" 69 }, 70 "variationInfo": { 71 "attributesToProductMappings": [ 72 { 73 "canonicalKey": "Blue_Large", 74 "image": { 75 "alternateText": "blue.png", 76 "contentVersionId": null, 77 "id": "2pmSG000005olX7YAI", 78 "mediaType": "Image", 79 "sortOrder": 0, 80 "thumbnailUrl": null, 81 "title": "blue.png", 82 "url": "/cms/delivery/media/MCEOJ5CVZPPVEH5GZ7TJ2NUUUML4?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" 83 }, 84 "mediaItems": [ 85 { 86 "alternateText": "blue.png", 87 "contentVersionId": null, 88 "id": "2pmSG000005olX7YAI", 89 "mediaType": "Image", 90 "sortOrder": 0, 91 "thumbnailUrl": null, 92 "title": "blue.png", 93 "url": "/cms/delivery/media/MCEOJ5CVZPPVEH5GZ7TJ2NUUUML4?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" 94 }, 95 { 96 "alternateText": "Green.png", 97 "contentVersionId": null, 98 "id": "2pmSG000005olX7YAI", 99 "mediaType": "Image", 100 "sortOrder": 0, 101 "thumbnailUrl": null, 102 "title": "blue.png", 103 "url": "/cms/delivery/media/MCEOJ5CVZPPVEH5GZ7TJ2NUUUML4?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" 104 } 105 ], 106 "productId": "01tSG000003xbg9YAA", 107 "selectedAttributes": [ 108 { 109 "apiName": "Color__c", 110 "label": "Color", 111 "sequence": 0, 112 "value": "Blue" 113 }, 114 { 115 "apiName": "Size__c", 116 "label": "Size", 117 "sequence": 1, 118 "value": "Large" 119 } 120 ], 121 "urlName": null 122 } 123 ], 124 "variationAttributeInfo": { 125 "Color__c": { 126 "allowableValues": [ 127 "Blue", 128 "Green", 129 "Red" 130 ], 131 "apiName": "Color__c", 132 "availableValues": [ 133 "Blue", 134 "Green", 135 "Red" 136 ], 137 "fieldEnumOrId": "00NSG00000cFRYf", 138 "groupedBy": false, 139 "label": "Color", 140 "objectName": "ProductAttribute", 141 "options": [ 142 { 143 "apiName": "Blue", 144 "colorHexCode": "#292FD3", 145 "label": "Blue", 146 "variantAvailable": true 147 }, 148 { 149 "apiName": "Green", 150 "colorHexCode": "#28E72C", 151 "label": "Green", 152 "variantAvailable": true 153 }, 154 { 155 "apiName": "Red", 156 "colorHexCode": "#ED1111", 157 "label": "Red", 158 "variantAvailable": true 159 } 160 ], 161 "sequence": 0, 162 "viewType": "ColorSwatch" 163 }, 164 "Size__c": { 165 "allowableValues": [ 166 "Large", 167 "Medium", 168 "Small" 169 ], 170 "apiName": "Size__c", 171 "availableValues": [ 172 "Large" 173 ], 174 "fieldEnumOrId": "00NSG00000cFRYg", 175 "groupedBy": false, 176 "label": "Size", 177 "objectName": "ProductAttribute", 178 "options": [ 179 { 180 "apiName": "Large", 181 "colorHexCode": null, 182 "label": "Large", 183 "variantAvailable": true 184 }, 185 { 186 "apiName": "Medium", 187 "colorHexCode": null, 188 "label": "Medium", 189 "variantAvailable": false 190 }, 191 { 192 "apiName": "Small", 193 "colorHexCode": null, 194 "label": "Small", 195 "variantAvailable": false 196 } 197 ], 198 "sequence": 1, 199 "viewType": "Dropdown" 200 } 201 }, 202 "variationCount": 3 203 } 204 } 205 ], 206 "total": 1 207}
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| products | Product Overview[] | Collection of product overview. | Medium, 54.0 | 54.0 |
| total | Integer | Total number of products returned. | Small, 54.0 | 54.0 |