Newer Version Available
Product Child Collection
- JSON example
- Example response for a product
set:
1{ 2 "count": 2, 3 "currentPageToken": "eyJwIjoyMCwibyI6MH0=", 4 "currentPageUrl": "/services/data/v63.0/commerce/webstores/0ZExx000000004tGAA/products/01txx0000006iGyAAI/children?mediaGroups=productListImage&pageToken=eyJwIjoyMCwibyI6MH0%3D", 5 "items": [ 6 { 7 "defaultQuantity": "1.0", 8 "isEntitled": true, 9 "productInfo": { 10 "defaultImage": null, 11 "fields": { 12 "LastModifiedDate": "2024-10-31T18:14:13Z", 13 "DisplayUrl": null, 14 "IsDeleted": "false", 15 "Description": "A signature Alpine health and fitness beverage. This post-workout beverage with Tart Cherry flavor is designed to help athletes maximize recovery and gains. 0.5L PET", 16 "ProductCode": null, 17 "IsActive": "true", 18 "ExternalId": null, 19 "LastViewedDate": "2024-11-07T00:06:06Z", 20 "UserRecordAccessId": null, 21 "LastReferencedDate": "2024-11-07T00:06:06Z", 22 "StockKeepingUnit": "6010015", 23 "CurrencyIsoCode": "USD", 24 "Name": "Alpine Energy Drink Tart Cherry Post 0.5L PET - 6 pack", 25 "SystemModstamp": "2024-11-04T18:40:55Z", 26 "IsArchived": "false", 27 "Type": null, 28 "CreatedById": "005xx000001X7zp", 29 "CloneSourceId": null, 30 "QuantityUnitOfMeasure": null, 31 "CreatedDate": "2024-10-31T18:14:13Z", 32 "Family": "Alpine Energy", 33 "ProductClass": "Simple", 34 "LastModifiedById": "005xx000001X7zp" 35 }, 36 "id": "01txx0000006iCGAAY", 37 "mediaGroups": [ 38 { 39 "developerName": "productListImage", 40 "id": "2mgxx000000004sAAA", 41 "mediaItems": [ 42 { 43 "alternateText": "", 44 "contentVersionId": null, 45 "id": "2pmxx000000005AAAQ", 46 "mediaType": "Image", 47 "sortOrder": 0, 48 "thumbnailUrl": null, 49 "title": "/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Tart-Cherry-Post-Large.jpg", 50 "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Tart-Cherry-Post-Large.jpg" 51 } 52 ], 53 "name": "Product List Image", 54 "usageType": "Listing" 55 } 56 ], 57 "productClass": "Simple", 58 "productSellingModels": [ 59 { 60 "id": "0jPxx000000003FEAQ", 61 "name": "PSM Evergreen", 62 "pricingTerm": 1, 63 "pricingTermUnit": "Annual", 64 "sellingModelType": "Evergreen" 65 } 66 ], 67 "purchaseQuantityRule": null, 68 "urlName": null 69 } 70 }, 71 { 72 "defaultQuantity": "1.0", 73 "isEntitled": true, 74 "productInfo": { 75 "defaultImage": null, 76 "fields": { 77 "LastModifiedDate": "2024-10-31T18:14:13Z", 78 "DisplayUrl": null, 79 "IsDeleted": "false", 80 "Description": "One box of Alpine Energy During Workout single serve, compostable Eco Pods. Chai Flavor.", 81 "ProductCode": null, 82 "IsActive": "true", 83 "ExternalId": null, 84 "LastViewedDate": "2024-11-12T19:38:36Z", 85 "UserRecordAccessId": null, 86 "LastReferencedDate": "2024-11-12T19:38:36Z", 87 "StockKeepingUnit": "6010018", 88 "CurrencyIsoCode": "USD", 89 "Name": "Alpine Energy During Eco Pod, Chai", 90 "SystemModstamp": "2024-10-31T18:14:13Z", 91 "IsArchived": "false", 92 "Type": null, 93 "CreatedById": "005xx000001X7zp", 94 "CloneSourceId": null, 95 "QuantityUnitOfMeasure": null, 96 "CreatedDate": "2024-10-31T18:14:13Z", 97 "Family": "Alpine Energy", 98 "ProductClass": "Simple", 99 "LastModifiedById": "005xx000001X7zp" 100 }, 101 "id": "01txx0000006iCBAAY", 102 "mediaGroups": [ 103 { 104 "developerName": "productListImage", 105 "id": "2mgxx000000004sAAA", 106 "mediaItems": [ 107 { 108 "alternateText": "", 109 "contentVersionId": null, 110 "id": "2pmxx000000004zAAA", 111 "mediaType": "Image", 112 "sortOrder": 0, 113 "thumbnailUrl": null, 114 "title": "/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/alpine_energy_product_ecopod-chai.jpg", 115 "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/alpine_energy_product_ecopod-chai.jpg" 116 } 117 ], 118 "name": "Product List Image", 119 "usageType": "Listing" 120 } 121 ], 122 "productClass": "Simple", 123 "productSellingModels": [ 124 { 125 "id": "0jPxx000000001dEAA", 126 "name": "PSM Term", 127 "pricingTerm": 1, 128 "pricingTermUnit": "Months", 129 "sellingModelType": "TermDefined", 130 "subscriptionTermRule": { 131 "increment": 1, 132 "maximum": null, 133 "minimum": 1 134 } 135 }, 136 { 137 "id": "0jPxx000000003FEAQ", 138 "name": "PSM Evergreen", 139 "pricingTerm": 1, 140 "pricingTermUnit": "Annual", 141 "sellingModelType": "Evergreen" 142 } 143 ], 144 "purchaseQuantityRule": null, 145 "urlName": null 146 } 147 } 148 ], 149 "nextPageToken": null, 150 "nextPageUrl": null, 151 "previousPageToken": null, 152 "previousPageUrl": null, 153 "productClass": "Set", 154 "total": 2 155} - Example response for a product
bundle:
1{ 2 "count": 1, 3 "currentPageToken": "eyJwIjoyMCwibyI6MH0=", 4 "currentPageUrl": "/services/data/v65.0/commerce/webstores/0ZExx000000009hGAA/products/01txx0000006j8CAAQ/children?pageToken=eyJwIjoyMCwibyI6MH0%3D", 5 "items": [ 6 { 7 "defaultQuantity": "2.0", 8 "isEntitled": true, 9 "isPriceIncludedInParent": false, 10 "isRequired": false, 11 "isDefault": true, 12 "componentGroup": { 13 "id": "0y7xx000000006T", 14 "name": "pcg1" 15 }, 16 "productInfo": { 17 "defaultImage": { 18 "alternateText": "", 19 "contentVersionId": null, 20 "id": null, 21 "mediaType": "Image", 22 "sortOrder": 0, 23 "thumbnailUrl": null, 24 "title": "image", 25 "url": "/img/b2b/default-product-image.svg" 26 }, 27 "fields": { 28 "LastModifiedDate": "2025-06-10T09:31:43Z", 29 "FulfillmentQtyCalcMethod": null, 30 "Description": "testBundleChild1", 31 "StockCheckMethod": null, 32 "SpecificationType": "Commercial", 33 "IsActive": "true", 34 "LastReferencedDate": null, 35 "StockKeepingUnit": "testBundleChild1", 36 "ExternalDataSourceId": null, 37 "Name": "testBundleChild1", 38 "ShippingWeightUnitOfMeasure": null, 39 "CreatedById": "005xx000001X8Er", 40 "RecordTypeId": "012xx0000005pnQ", 41 "DiscontinuedDate": null, 42 "ProductClass": "Simple", 43 "CanRamp": "false", 44 "DisplayUrl": null, 45 "IsDeleted": "false", 46 "ConfigureDuringSale": null, 47 "IsAssetizable": "false", 48 "ProductCode": "testBundleChild1", 49 "UsageModelType": null, 50 "ExternalId": null, 51 "ProductPurpose": "Sell", 52 "LastViewedDate": null, 53 "UserRecordAccessId": null, 54 "HelpText": null, 55 "CurrencyIsoCode": "USD", 56 "AvailabilityDate": null, 57 "BasedOnId": null, 58 "SystemModstamp": "2025-06-10T09:35:22Z", 59 "IsArchived": "false", 60 "DecompositionScope": null, 61 "BillingPolicyId": null, 62 "Type": null, 63 "EndOfLifeDate": null, 64 "IsShippingChargeNotApplicable": "false", 65 "QuantityUnitOfMeasure": null, 66 "CreatedDate": "2025-06-10T09:31:43Z", 67 "Family": null, 68 "UnitOfMeasureId": null, 69 "ShippingWeight": null, 70 "LastModifiedById": "005xx000001X8Er", 71 "TaxPolicyId": null, 72 "IsSoldOnlyWithOtherProds": "false" 73 }, 74 "id": "01txx0000006j9oAAA", 75 "mediaGroups": [ 76 { 77 "developerName": "productListImage", 78 "id": "2mgxx000000009kAAA", 79 "mediaItems": [ 80 { 81 "alternateText": "", 82 "contentVersionId": null, 83 "id": null, 84 "mediaType": "Image", 85 "sortOrder": 0, 86 "thumbnailUrl": null, 87 "title": "image", 88 "url": "/img/b2b/default-product-image.svg" 89 } 90 ], 91 "name": "Product List Image", 92 "usageType": "Listing" 93 }, 94 { 95 "developerName": "productDetailImage", 96 "id": "2mgxx000000009jAAA", 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 Detail Images", 110 "usageType": "Standard" 111 } 112 ], 113 "productClass": "Simple", 114 "purchaseQuantityRule": null, 115 "urlName": null 116 } 117 } 118 ], 119 "nextPageToken": "eyJwIjoyMCwibyI6MjB9", 120 "nextPageUrl": "/services/data/v65.0/commerce/webstores/0ZExx000000009hGAA/products/01txx0000006j8CAAQ/children?pageToken=eyJwIjoyMCwibyI6MjB9", 121 "previousPageToken": null, 122 "previousPageUrl": null, 123 "productClass": "Bundle", 124 "total": 1 125}
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| count | Integer | Number of child products returned on this page. | Small, 57.0 | 57.0 |
| currentPageToken | String | Current page token, if any. | Small, 57.0 | 57.0 |
| currentPageUrl | String | URL of the current page in the response. | Small, 57.0 | 57.0 |
| items | Product Child[] | Collection of child products related to the parent product. The child products are sorted by their configured sequence values, in ascending order, with null values sorted last. If there are no configured sequence values, the child products are sorted by createdDate, in ascending order. | Small, 57.0 | 57.0 |
| nextPageToken | String | Token for the next page, if any. A value is included in the response only if a value is returned for nextPageUrl. | Small, 57.0 | 57.0 |
| nextPageUrl | String | URL of the next page, if any. | Small, 57.0 | 57.0 |
| previousPageToken | String | Token for the previous page, if any. A value is included in the response only if a value is returned for previousPageUrl. | Small, 57.0 | 57.0 |
| previousPageUrl | String | URL of the previous page, if any. | Small, 57.0 | 57.0 |
| productClass | String | Class of product. Values are:
|
Small, 62.0 | 62.0 |
| total | Integer | Total number of child products in the collection. | Small, 57.0 | 57.0 |