GET highlights/{highlightId}

Gets a highlight.

Request Information

» Parameters

Name Description Additional information
highlightId The ID of the highlight.

Define this parameter in the request URI.

» Expands

Name Description Usage
highlightType This will retrieve the related highlight type. GET highlights/{highlightId}?expand=highlighttype

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.

  "Highlight": {
    "Description": "We offer free shipping on all items for purchases of $50 or more.",
    "DisplayOrder": 10,
    "ImageAltTag": "Free Shipping",
    "ImageFile": "FreeShipping.jpg",
    "ImageLargePath": "~/data/default/images/catalog/450/FreeShipping.png",
    "ImageMediumPath": "~/data/default/images/catalog/250/FreeShipping.png",
    "ImageSmallPath": "~/data/default/images/catalog/100/FreeShipping.png",
    "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/FreeShipping.png",
    "ImageThumbnailPath": "~/data/default/images/catalog/50/FreeShipping.png",
    "HighlightId": 2,
    "HighlightType": {
      "Description": "Default Highlight",
      "HighlightTypeId": 1,
      "Name": "Default Highlight"
    "HighlightTypeName": null,
    "HighlightTypeId": 1,
    "Hyperlink": "",
    "HyperlinkNewWindow": false,
    "IsActive": true,
    "LocaleId": 43,
    "Name": "Free Shipping",
    "PortalId": null,
    "ProductId": 0,
    "ShortDescription": "",
    "DisplayPopup": true,
    "ProductHighlightID": 0,
    "IsAssociatedProduct": false,
    "UserName": null,
    "UserType": null
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false