Newer Version Available
Product Overview Collection
- JSON example
-
1{ 2 "products": [ 3 { 4 "defaultImage": { 5 "alternateText": "", 6 "contentVersionId": null, 7 "id": "2pmxx000000010yAAA", 8 "mediaType": "Image", 9 "sortOrder": 0, 10 "thumbnailUrl": null, 11 "title": "image", 12 "url": "/img/b2b/default-product-image.svg" 13 }, 14 "error": {}, 15 "fields": { 16 "Description": "One box of Alpine Energy Post Workout single serve, compostable Eco Pods. Chai Flavor.", 17 "ProductCode": "r7832487624876423867", 18 "Name": "Alpine Energy Post Eco Pod, Chai", 19 "ProductClass": "Simple" 20 }, 21 "id": "01txx0000006mCXAAY", 22 "name": "Alpine Energy Post Eco Pod, Chai", 23 "productClass": "Simple", 24 "productSellingModels": [ 25 { 26 "displayName": "PSM2", 27 "id": "0jPxx000000001dEAA", 28 "name": "PSM1", 29 "pricingTerm": 1, 30 "pricingTermUnit": "Months", 31 "sellingModelType": "TermDefined", 32 "subscriptionTermRule": { 33 "increment": 2, 34 "maximum": 10, 35 "minimum": 2 36 } 37 } 38 ], 39 "purchaseQuantityRule": { 40 "increment": "1.0", 41 "maximum": "1.0E+8", 42 "minimum": "1.0" 43 }, 44 "sku": "6010019", 45 "success": true 46 }, 47 { 48 "defaultImage": { 49 "alternateText": "", 50 "contentVersionId": null, 51 "id": "2pmxx000000010wAAA", 52 "mediaType": "Image", 53 "sortOrder": 0, 54 "thumbnailUrl": null, 55 "title": "image", 56 "url": "/img/b2b/default-product-image.svg" 57 }, 58 "error": {}, 59 "fields": { 60 "Description": "A signature Alpine health and fitness beverage. This post-workout beverage with Chai flavor is designed to help athletes maximize recovery and gains. 0.5L PET", 61 "Name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", 62 "Family": "Alpine Energy", 63 "ProductClass": "VariationParent" 64 }, 65 "id": "01txx0000006mCWAAY", 66 "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", 67 "productClass": "VariationParent", 68 "productSellingModels": [ 69 { 70 "id": "0jPxx000000003FEAQ", 71 "name": "PSM2", 72 "pricingTerm": null, 73 "pricingTermUnit": null, 74 "sellingModelType": "OneTime" 75 }, 76 { 77 "description": "<p>377834kajhsbfkhjdabf</p>", 78 "displayName": "PSM", 79 "id": "0jPxx000000001dEAA", 80 "name": "PSM1", 81 "pricingTerm": 1, 82 "pricingTermUnit": "Months", 83 "sellingModelType": "TermDefined", 84 "subscriptionTermRule": { 85 "increment": 2, 86 "maximum": 4, 87 "minimum": 2 88 } 89 } 90 ], 91 "purchaseQuantityRule": { 92 "increment": "1.0", 93 "maximum": "1.0E+8", 94 "minimum": "1.0" 95 }, 96 "sku": "6010009", 97 "Success": true, 98 "variationAttributeSet": { 99 "attributes": { 100 "Size__c": null, 101 "Color__c": null 102 }, 103 "developerName": "Apparel", 104 "id": null 105 }, 106 "variationInfo": { 107 "attributesToProductMappings": [ 108 { 109 "canonicalKey": "Blue_Large", 110 "productId": "01txx0000006mNpAAI", 111 "selectedAttributes": [ 112 { 113 "apiName": "Color__c", 114 "label": "Color", 115 "sequence": 0, 116 "value": "Blue" 117 }, 118 { 119 "apiName": "Size__c", 120 "label": "Size", 121 "sequence": 1, 122 "value": "Large" 123 } 124 ], 125 "urlName": null, 126 "image": { 127 "alternateText": "", 128 "contentVersionId": null, 129 "id": "2pmxx000000012jAAA", 130 "mediaType": "Image", 131 "sortOrder": 0, 132 "thumbnailUrl": null, 133 "title": "image", 134 "url": "/img/b2b/default-product-image.svg" 135 } 136 }, 137 { 138 "canonicalKey": "Green_Medium", 139 "productId": "01txx0000006mNqAAI", 140 "selectedAttributes": [ 141 { 142 "apiName": "Color__c", 143 "label": "Color", 144 "sequence": 0, 145 "value": "Green" 146 }, 147 { 148 "apiName": "Size__c", 149 "label": "Size", 150 "sequence": 1, 151 "value": "Medium" 152 } 153 ], 154 "urlName": null, 155 "image": { 156 "alternateText": "", 157 "contentVersionId": null, 158 "id": "2pmxx000000012jAAA", 159 "mediaType": "Image", 160 "sortOrder": 0, 161 "thumbnailUrl": null, 162 "title": "image", 163 "url": "/img/b2b/default-product-image.svg" 164 } 165 }, 166 { 167 "canonicalKey": "Red_Small", 168 "productId": "01txx0000006mNrAAI", 169 "selectedAttributes": [ 170 { 171 "apiName": "Color__c", 172 "label": "Color", 173 "sequence": 0, 174 "value": "Red" 175 }, 176 { 177 "apiName": "Size__c", 178 "label": "Size", 179 "sequence": 1, 180 "value": "Small" 181 } 182 ], 183 "urlName": null, 184 "image": { 185 "alternateText": "", 186 "contentVersionId": null, 187 "id": "2pmxx000000012jAAA", 188 "mediaType": "Image", 189 "sortOrder": 0, 190 "thumbnailUrl": null, 191 "title": "image", 192 "url": "/img/b2b/default-product-image.svg" 193 } 194 } 195 ], 196 "variationAttributeInfo": { 197 "Color__c": { 198 "allowableValues": [ 199 "Blue", 200 "Green", 201 "Red" 202 ], 203 "apiName": "Color__c", 204 "availableValues": [ 205 "Blue", 206 "Green", 207 "Red" 208 ], 209 "options": [ 210 { 211 "label": "Red", 212 "api": "red__c", 213 "color": "#FF0000", 214 "isAvailable": true 215 }, 216 { 217 "label": "Blue", 218 "api": "blue__c", 219 "color": "#0000FF", 220 "isAvailable": true 221 }, 222 { 223 "label": "Green", 224 "api": "green__c", 225 "color": "#0000FF", 226 "isAvailable": false 227 } 228 ], 229 "viewType": "ColorSwatch", 230 "fieldEnumOrId": "00Nxx000001G3XI", 231 "label": "Color", 232 "objectName": "ProductAttribute", 233 "sequence": 0 234 }, 235 "Size__c": { 236 "allowableValues": [ 237 "Large", 238 "Medium", 239 "Small" 240 ], 241 "apiName": "Size__c", 242 "availableValues": [ 243 "Large", 244 "Medium", 245 "Small" 246 ], 247 "viewType": "DropDown", 248 "options": [ 249 { 250 "label": "Large", 251 "api": "Large__c", 252 "isAvailable": true 253 }, 254 { 255 "label": "Medium", 256 "api": "Medium__c", 257 "isAvailable": true 258 }, 259 { 260 "label": "Small", 261 "api": "Small__C", 262 "isAvailable": true 263 } 264 ] 265 }, 266 "fieldEnumOrId": "00Nxx000001G3XJ", 267 "label": "Size", 268 "objectName": "ProductAttribute", 269 "sequence": 1 270 } 271 } 272 }, 273 { 274 "error": { 275 "errorCode": "PRODUCT_NOT_FOUND", 276 "message": "You can't view 234423." 277 }, 278 "success": false 279 } 280 ], 281 "total": 3 282}
| 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 |