Product Detail

Details of a product.

JSON example

1{
2  "products": [
3    {
4      "defaultImage": {
5        "alternateText": "",
6        "contentVersionId": null,
7        "id": null,
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        "ConfigureDuringSale": "NotAllowed",
17        "StockKeepingUnit": null,
18        "Name": "KeyBoard"
19      },
20      "id": "01tSG00000BpCgKYAV",
21      "isConfigurationAllowed": false,
22      "mediaGroups": [
23        {
24          "developerName": "productListImage",
25          "id": "2mgSG000001u6JwYAI",
26          "mediaItems": [
27            {
28              "alternateText": "",
29              "contentVersionId": null,
30              "id": null,
31              "mediaType": "Image",
32              "sortOrder": 0,
33              "thumbnailUrl": null,
34              "title": "image",
35              "url": "/img/b2b/default-product-image.svg"
36            }
37          ],
38          "name": "Product List Image",
39          "usageType": "Listing"
40        }
41      ],
42      "name": "KeyBoard",
43      "productClass": "Simple",
44      "productSellingModels": [
45        {
46          "id": "0jPSG000000B2he2AC",
47          "name": "One Time",
48          "pricingTerm": null,
49          "pricingTermUnit": null,
50          "sellingModelType": "OneTime"
51        },
52        {
53          "id": "0jPSG000000B2hd2AC",
54          "name": "Term Based - Monthly",
55          "pricingTerm": 1,
56          "pricingTermUnit": "Months",
57          "sellingModelType": "TermDefined",
58          "subscriptionTermRule": {
59            "increment": 1,
60            "maximum": null,
61            "minimum": 1
62          }
63        },
64        {
65          "id": "0jPSG000000B2hi2AC",
66          "name": "Evergreen - Monthly",
67          "pricingTerm": 1,
68          "pricingTermUnit": "Months",
69          "sellingModelType": "Evergreen"
70        }
71      ],
72      "success": true
73    },
74    {
75      "defaultImage": {
76        "alternateText": "",
77        "contentVersionId": null,
78        "id": null,
79        "mediaType": "Image",
80        "sortOrder": 0,
81        "thumbnailUrl": null,
82        "title": "image",
83        "url": "/img/b2b/default-product-image.svg"
84      },
85      "error": {},
86      "fields": {
87        "ConfigureDuringSale": "NotAllowed",
88        "StockKeepingUnit": "M-0002",
89        "Name": "Mac Bundle"
90      },
91      "id": "01tSG00000BpCgJYAV",
92      "isConfigurationAllowed": false,
93      "mediaGroups": [
94        {
95          "developerName": "productListImage",
96          "id": "2mgSG000001u6JwYAI",
97          "mediaItems": [
98            {
99              "alternateText": "",
100              "contentVersionId": null,
101              "id": null,
102              "mediaType": "Image",
103              "sortOrder": 0,
104              "thumbnailUrl": null,
105              "title": "image",
106              "url": "/img/b2b/default-product-image.svg"
107            }
108          ],
109          "name": "Product List Image",
110          "usageType": "Listing"
111        }
112      ],
113      "name": "Mac Bundle",
114      "productClass": "Bundle",
115      "productSellingModels": [
116        {
117          "id": "0jPSG000000B2he2AC",
118          "name": "One Time",
119          "pricingTerm": null,
120          "pricingTermUnit": null,
121          "sellingModelType": "OneTime"
122        },
123        {
124          "id": "0jPSG000000B2hd2AC",
125          "name": "Term Based - Monthly",
126          "pricingTerm": 1,
127          "pricingTermUnit": "Months",
128          "sellingModelType": "TermDefined"
129        },
130        {
131          "id": "0jPSG000000B2hi2AC",
132          "name": "Evergreen - Monthly",
133          "pricingTerm": 1,
134          "pricingTermUnit": "Months",
135          "sellingModelType": "Evergreen"
136        }
137      ],
138      "sku": "M-0002",
139      "success": true
140    },
141    {
142      "defaultImage": {
143        "alternateText": "",
144        "contentVersionId": null,
145        "id": null,
146        "mediaType": "Image",
147        "sortOrder": 0,
148        "thumbnailUrl": null,
149        "title": "image",
150        "url": "/img/b2b/default-product-image.svg"
151      },
152      "error": {},
153      "fields": {
154        "ConfigureDuringSale": null,
155        "StockKeepingUnit": null,
156        "Name": "subproduct"
157      },
158      "id": "01tSG00000BpCgFYAV",
159      "isConfigurationAllowed": false,
160      "mediaGroups": [
161        {
162          "developerName": "productListImage",
163          "id": "2mgSG000001u6JwYAI",
164          "mediaItems": [
165            {
166              "alternateText": "",
167              "contentVersionId": null,
168              "id": null,
169              "mediaType": "Image",
170              "sortOrder": 0,
171              "thumbnailUrl": null,
172              "title": "image",
173              "url": "/img/b2b/default-product-image.svg"
174            }
175          ],
176          "name": "Product List Image",
177          "usageType": "Listing"
178        }
179      ],
180      "name": "subproduct",
181      "productClass": "Simple",
182      "productSellingModels": [
183        {
184          "id": "0jPSG000000B2hd2AC",
185          "name": "Term Based - Monthly",
186          "pricingTerm": 1,
187          "pricingTermUnit": "Months",
188          "sellingModelType": "TermDefined"
189        },
190        {
191          "id": "0jPSG000000B2hh2AC",
192          "name": "Evergreen - Yearly",
193          "pricingTerm": 1,
194          "pricingTermUnit": "Annual",
195          "sellingModelType": "Evergreen"
196        }
197      ],
198      "success": true
199    },
200    {
201      "defaultImage": {
202        "alternateText": "",
203        "contentVersionId": null,
204        "id": null,
205        "mediaType": "Image",
206        "sortOrder": 0,
207        "thumbnailUrl": null,
208        "title": "image",
209        "url": "/img/b2b/default-product-image.svg"
210      },
211      "error": {},
212      "fields": {
213        "ConfigureDuringSale": null,
214        "StockKeepingUnit": null,
215        "Name": "testproduct1"
216      },
217      "id": "01tSG00000BpCgDYAV",
218      "isConfigurationAllowed": false,
219      "mediaGroups": [
220        {
221          "developerName": "productListImage",
222          "id": "2mgSG000001u6JwYAI",
223          "mediaItems": [
224            {
225              "alternateText": "",
226              "contentVersionId": null,
227              "id": null,
228              "mediaType": "Image",
229              "sortOrder": 0,
230              "thumbnailUrl": null,
231              "title": "image",
232              "url": "/img/b2b/default-product-image.svg"
233            }
234          ],
235          "name": "Product List Image",
236          "usageType": "Listing"
237        }
238      ],
239      "name": "testproduct1",
240      "productClass": "Simple",
241      "productSellingModels": [
242        {
243          "id": "0jPSG000000B2hd2AC",
244          "name": "Term Based - Monthly",
245          "pricingTerm": 1,
246          "pricingTermUnit": "Months",
247          "sellingModelType": "TermDefined"
248        },
249        {
250          "id": "0jPSG000000B2hf2AC",
251          "name": "Term Based - Yearly",
252          "pricingTerm": 1,
253          "pricingTermUnit": "Annual",
254          "sellingModelType": "TermDefined"
255        }
256      ],
257      "success": true
258    },
259    {
260      "defaultImage": {
261        "alternateText": "",
262        "contentVersionId": null,
263        "id": null,
264        "mediaType": "Image",
265        "sortOrder": 0,
266        "thumbnailUrl": null,
267        "title": "image",
268        "url": "/img/b2b/default-product-image.svg"
269      },
270      "error": {},
271      "fields": {
272        "ConfigureDuringSale": null,
273        "StockKeepingUnit": null,
274        "Name": "testproduct"
275      },
276      "id": "01tSG00000BpCgCYAV",
277      "isConfigurationAllowed": false,
278      "mediaGroups": [
279        {
280          "developerName": "productListImage",
281          "id": "2mgSG000001u6JwYAI",
282          "mediaItems": [
283            {
284              "alternateText": "",
285              "contentVersionId": null,
286              "id": null,
287              "mediaType": "Image",
288              "sortOrder": 0,
289              "thumbnailUrl": null,
290              "title": "image",
291              "url": "/img/b2b/default-product-image.svg"
292            }
293          ],
294          "name": "Product List Image",
295          "usageType": "Listing"
296        }
297      ],
298      "name": "testproduct",
299      "productClass": "Simple",
300      "success": true
301    }
302  ],
303  "total": 5
304}

Property Name	Type	Description	Filter Group and Version	Available Version
`attributeSetInfo`	Map<String, Product Attribute Set Info>	Map of the attribute set developer name to its metadata.	Small, 50.0	50.0
`defaultImage`	Product Media	Default image of the product.	Small, 49.0	49.0
`dynamicAttributeCount`	Integer	Count of dynamic attributes associated with the product. This field is supported for both simple products and dynamic product bundles.	Small, 66.0	66.0
`entitlement`	Product Entitlement	Entitlement details for the product. To get pricing information for products in version 57 and later, use Commerce Webstore Pricing Products.	Small, 49.0	49.0–56.0
`fields`	Map<String, String>	List of fields for the product.	Small, 49.0	49.0
`id`	String	ID of the product.	Small, 49.0	49.0
`mediaGroups`	Product Media Group[]	List of media groups of the product.	Small, 49.0	49.0
`primaryProductCategoryPath`	Product Category Path	Primary category path of the product.	Small, 49.0	49.0
`productClass`	String	Class of product. Values are: `Bundle` `Set` `Simple` `Variation` `VariationParent`	Small, 50.0	50.0
`productSellingModels`	Product Selling Model[]	List of product selling models for the product.	Small, 56.0	56.0
`purchaseQuantityRule`	Purchase Quantity Rule	If one exists, purchase quantity rule for the product.	Small, 52.0	52.0
`urlName`	String	SEO-friendly URL name for the product.	Small, 59.0	59.0
`variationAttributeSet`	Product Attribute Set	Variation attribute set for the product.	Small, 50.0	50.0
`variationInfo`	Product Variation Info	Available and allowable values for variation attributes and a map to resolve variation product IDs from attribute value combinations.	Small, 50.0	50.0
`variationParentId`	String	ID of the variation parent.	Small, 50.0	50.0

Connect REST API Developer Guide

Product Detail