Build Version:
GET catalogs/{catalogId}
Gets a catalog.
Request Information
» Parameters
| Name | Description | Additional information |
|---|---|---|
| catalogId | The ID of the catalog. |
Define this parameter in the request URI. |
» Expands
| Name | Description | Usage |
|---|---|---|
| categories | This will retrieve the related list of categories. | GET catalogs/{catalogId}?expand=categories |
| productIds | This will retrieve the related list of product IDs. | GET catalogs/{catalogId}?expand=productids |
Response Information
» Response Body Formats
If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.
Sample:
{
"Catalog": {
"CatalogId": 1,
"ExternalId": null,
"IsActive": true,
"Name": "Fine Foods Catalog",
"PortalId": null,
"PreserveCategories": false,
"IsDefault": false,
"IsFromSitecore": false,
"ProductIds": null,
"ProductCount": 0,
"CategoryCount": 0
},
"ErrorCode": null,
"ErrorMessage": null,
"StackTrace": null,
"AllowHtmlResponse": false,
"HasError": false,
"StringResponse": null
}