Build Version:

GET reviews

Gets a list of reviews.

Request Information

» Expands

Name	Description	Usage
product	This will retrieve the related product.	GET reviews?expand=product

» Filters

Name	Description	Usage
accountId	This will filter the request by account ID.	GET reviews?filter=accountid~{operator}~{value}
productId	This will filter the request by product ID.	GET reviews?filter=productid~{operator}~{value}
rating	This will filter the request by rating.	GET reviews?filter=rating~{operator}~{value}
status	This will filter the request by review status.	GET reviews?filter=status~{operator}~{value}

» Sorting

Name	Description	Usage
createDate	This will sort the response by create date.	GET reviews?sort=createdate
productId	This will sort the response by product ID.	GET reviews?sort=productid
rating	This will sort the response by rating.	GET reviews?sort=rating
reviewId	This will sort the response by review ID.	GET reviews?sort=reviewid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET reviews?page=index~{value}
size	The size of the page when retrieving paged results.	GET reviews?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.

application/json

Sample:

	{
  "Reviews": [
    {
      "AccountId": null,
      "Comments": "These apples are very good, highly recommended.",
      "Cons": "",
      "CreateDate": "2013-06-14T19:24:51.45",
      "CreateUser": "John Smith",
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Product": {
        "AccountId": 33,
        "AdditionalInfo": "",
        "AdditionalInfoLink": "",
        "AdditionalInfoLinkLabel": "",
        "AddOns": [],
        "AffiliateUrl": "",
        "AllowBackOrder": true,
        "AllowDropShip": true,
        "AllowFreeShipping": true,
        "AllowRecurringBilling": false,
        "AllowRecurringBillingInstallment": false,
        "Attributes": [],
        "BackOrderMessage": "",
        "BeginActiveDate": null,
        "BundledProductIds": null,
        "BundledProductExternalIds": null,
        "CallForPricing": false,
        "Categories": [],
        "ProductCategories": [],
        "CreateDate": "2013-04-29T10:49:32.657",
        "CrossSells": [],
        "Custom1": "",
        "Custom2": "",
        "Custom3": "",
        "Description": "Product description",
        "DisplayOrder": 10,
        "DownloadLink": "",
        "DropShipEmailAddress": "",
        "EndActiveDate": null,
        "ExpirationFrequency": null,
        "ExpirationPeriod": null,
        "ExternalId": "",
        "FeaturesDescription": "Features description",
        "FrequentlyBoughtTogether": [],
        "Height": 1.0,
        "Highlights": [],
        "ImageAltTag": "Apple",
        "ImageFile": "apple.jpg",
        "ImageLargePath": "~/data/default/images/catalog/450/apple.jpg",
        "ImageMediumPath": "~/data/default/images/catalog/250/apple.jpg",
        "ImageSmallPath": "~/data/default/images/catalog/100/apple.jpg",
        "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/apple.jpg",
        "ImageThumbnailPath": "~/data/default/images/catalog/50/apple.jpg",
        "Images": [],
        "InStockMessage": "This item is in stock",
        "InventoryDisplay": 0,
        "IsActive": true,
        "IsCategorySpecial": false,
        "IsFeatured": false,
        "IsFranchisable": true,
        "IsHomepageSpecial": false,
        "IsMustLoginToView": false,
        "CalculateAddOnsOnlyOnceInTotal": false,
        "IsNewProduct": false,
        "IsShippable": true,
        "Keywords": "",
        "Length": 1.0,
        "Manufacturer": null,
        "ManufacturerId": 3,
        "MaxSelectableQuantity": 10.0,
        "MinSelectableQuantity": 0.0,
        "QuantityIncrement": null,
        "EnableFileUploads": false,
        "ProductSetting": {
          "ProductSettingId": 0,
          "ProductNumDifferent": false,
          "ProductId": 0,
          "EnableFileUploads": false,
          "ShipAttributeDifferent": false,
          "ShipWidth": null,
          "ShipHeight": null,
          "ShipLength": null,
          "ShipWeight": null,
          "IsCustom": false,
          "IsCustomReq": false,
          "DesignerType": null,
          "ImageArrayJSON": null,
          "CCStateID": null,
          "CCProofLocation": null,
          "IsHresPdfDownloadable": false
        },
        "Name": "Apple",
        "OutOfStockMessage": "This item is out of stock",
        "PortalId": 1,
        "ProductId": 302,
        "ProductNumber": "ap231",
        "ProductType": null,
        "ProductTypeId": 8,
        "ProductUrl": "~/product/Apple/302",
        "PromotionMessage": "",
        "PromotionPrice": 0.25,
        "Promotions": [],
        "RecurringBillingFrequency": "",
        "RecurringBillingInitialAmount": 0.0,
        "RecurringBillingPeriod": "",
        "RecurringBillingTotalCycles": 0,
        "RetailPrice": 4.23,
        "Reviews": [],
        "ReviewStateId": 20,
        "SalePrice": 3.50,
        "SelectedSku": null,
        "SeoDescription": "Delicious Apple",
        "SeoKeywords": "apple",
        "SeoTitle": "Delicious Apple",
        "SeoUrl": "Apple",
        "ShipEachItemSeparately": false,
        "ShippingRate": 0.56,
        "ShippingRuleTypeId": 0,
        "ShipSeparately": false,
        "ShortDescription": "Short description",
        "Skus": [],
        "Specifications": "Product specifications",
        "SupplierId": 12,
        "TaxClassId": 1,
        "TieredPrice": 1.50,
        "Tiers": [],
        "TrackInventory": true,
        "UpdateDate": "2013-08-12T07:12:34.407",
        "WebServiceDownloadDate": null,
        "Weight": 1.0,
        "Width": null,
        "WholesalePrice": 2.10,
        "YouMayAlsoLike": [],
        "IsChildProduct": null,
        "IsParentProductId": null,
        "NegotiatedPrice": null,
        "ProductNum": null,
        "Vendor": null,
        "IsGiftCard": false,
        "AttributeCount": 0,
        "ProductAttributes": null,
        "ProductAddOns": null,
        "BundleProductDict": null,
        "UserType": null,
        "UserName": null,
        "ReviewHistoryDescription": null,
        "ProductIds": null,
        "IsFromSitecore": false,
        "YouTubeVideoUrl": "",
        "ArtworkID": null,
        "RequireCustomization": false,
        "ArtworkLowResUri": null,
        "ArtworkThumbnailUri": null,
        "ProductAsset": [],
        "SupplierName": null,
        "SupplierTypeName": null,
        "ManufacturerName": null,
        "ProductTypeName": null,
        "SkuName": null,
        "TaxClassName": null,
        "SkuId": 0,
        "ShippingRule": null,
        "AttributeIds": null,
        "QuantityOnHand": null,
        "ReorderLevel": null,
        "RedirectUrlInd": false,
        "CategoryIds": null,
        "ReviewStateString": null,
        "UOM": null,
        "SizeOfPacket": null,
        "TierDiscountType": null,
        "CategoryCount": 0.0
      },
      "ProductId": 302,
      "Pros": "",
      "Rating": 5,
      "ReviewId": 1,
      "Status": "A",
      "Subject": "Very delicious apples!",
      "UserLocation": "Columbus, OH",
      "ProductName": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}