Znode

GET highlights

Gets a list of highlights.

Request Information

» Expands

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

» Filters

Name Description Usage
highlightTypeId This will filter the request by highlight type ID. GET highlights?filter=highlighttypeid~{operator}~{value}
isActive This will filter the request by the is active flag. GET highlights?filter=isactive~{operator}~{value}
localeId This will filter the request by locale ID. GET highlights?filter=localeid~{operator}~{value}
name This will filter the request by name. GET highlights?filter=name~{operator}~{value}
portalId This will filter the request by portal ID. GET highlights?filter=portalid~{operator}~{value}

» Sorting

Name Description Usage
displayOrder This will sort the response by display order. GET highlights?sort=displayorder
highlightId This will sort the response by highlight ID. GET highlights?sort=highlightid
name This will sort the response by name. GET highlights?sort=name

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET highlights?page=index~{value}
size The size of the page when retrieving paged results. GET highlights?page=size~{value}

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:
	{
  "Highlights": [
    {
      "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
    }
  ],
  "HighlightTypes": null,
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}