Znode

Build Version:

GET products

Gets a list of products.

Request Information

» Expands

Name Description Usage
addOns This will retrieve the related list of addons. GET products?expand=addons
attributes This will retrieve the related list of attributes. GET products?expand=attributes
categories This will retrieve the related list of categories. GET products?expand=categories
crossSells This will retrieve the related list of cross sells. GET products?expand=crosssells
frequentlyboughttogether This will retrieve the list of products that are frequently bought together. GET products?expand=frequentlyboughttogether
highlights This will retrieve the related list of highlights. GET products?expand=highlights
images This will retrieve the related list of images. GET products?expand=images
manufacturer This will retrieve the related manufacturer. GET products?expand=manufacturer
productType This will retrieve the related product type. GET products?expand=producttype
promotions This will retrieve the related list of promotions. GET products?expand=promotions
reviews This will retrieve the related list of reviews. GET products?expand=reviews
skus This will retrieve the related list of SKUs. GET products?expand=skus
tiers This will retrieve the related tiers. GET products?expand=tiers
youMayAlsoLike This will retrieve the list of products that you may also like. GET products?expand=youmayalsolike

» Filters

Name Description Usage
accountId This will filter the request by account ID. GET products?filter=accountid~{operator}~{value}
externalId This will filter the request by external ID. GET products?filter=externalid~{operator}~{value}
isActive This will filter the request by the is active flag. GET products?filter=isactive~{operator}~{value}
isFeatured This will filter the request by the is featured flag. GET products?filter=isfeatured~{operator}~{value}
isNew This will filter the request by the is new flag. GET products?filter=isnew~{operator}~{value}
manufacturerId This will filter the request by manufacturer ID. GET products?filter=manufacturerid~{operator}~{value}
name This will filter the request by name. GET products?filter=name~{operator}~{value}
number This will filter the request by number. GET products?filter=number~{operator}~{value}
portalId This will filter the request by portal ID. GET products?filter=portalid~{operator}~{value}
productTypeId This will filter the request by product type ID. GET products?filter=producttypeid~{operator}~{value}
retailPrice This will filter the request by retail price. GET products?filter=retailprice~{operator}~{value}
salePrice This will filter the request by sale price. GET products?filter=saleprice~{operator}~{value}
shippingRuleTypeId This will filter the request by shipping rule type ID. GET products?filter=shippingruletypeid~{operator}~{value}
supplierId This will filter the request by supplier ID. GET products?filter=supplierid~{operator}~{value}
taxClassId This will filter the request by tax class ID. GET products?filter=taxclassid~{operator}~{value}
wholesalePrice This will filter the request by wholesale price. GET products?filter=wholesaleprice~{operator}~{value}

» Sorting

Name Description Usage
displayOrder This will sort the response by display order. GET products?sort=displayorder
name This will sort the response by name. GET products?sort=name
number This will sort the response by number. GET products?sort=number
productId This will sort the response by product ID. GET products?sort=productid
retailPrice This will sort the response by retail price. GET products?sort=retailprice
salePrice This will sort the response by sale price. GET products?sort=saleprice
wholesalePrice This will sort the response by wholesale price. GET products?sort=wholesaleprice

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET products?page=index~{value}
size The size of the page when retrieving paged results. GET products?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: 
	{
  "Products": [
    {
      "AccountId": 33,
      "AdditionalInfo": "",
      "AdditionalInfoLink": "",
      "AdditionalInfoLinkLabel": "",
      "AddOns": [
        {
          "AccountId": null,
          "AddOnId": 1,
          "AllowBackOrder": true,
          "BackOrderMessage": "On back order",
          "Description": "",
          "DisplayOrder": 1,
          "DisplayType": "DropDownList",
          "ExternalApiId": "",
          "ExternalId": null,
          "InStockMessage": "In stock",
          "IsOptional": false,
          "LocaleId": 43,
          "Name": "Vase",
          "OutOfStockMessage": "Out of stock",
          "PortalId": null,
          "ProductId": 0,
          "ProductIds": null,
          "ProductCount": null,
          "PromptMessage": "",
          "Title": "Vase",
          "TrackInventory": true,
          "ProductAddOnId": 0,
          "AddOnValues": [],
          "IsAssociatedAddOnValue": false,
          "AddOnValueName": null,
          "UserName": null
        }
      ],
      "AffiliateUrl": "",
      "AllowBackOrder": true,
      "AllowDropShip": true,
      "AllowFreeShipping": true,
      "AllowRecurringBilling": false,
      "AllowRecurringBillingInstallment": false,
      "Attributes": [
        {
          "AttributeId": 2,
          "AttributeType": {
            "AttributeTypeId": 1,
            "Description": null,
            "DisplayOrder": 5,
            "IsPrivate": false,
            "LocaleId": 43,
            "Name": "Color",
            "PortalId": null
          },
          "AttributeTypeId": 1,
          "DisplayOrder": 1,
          "ExternalId": "",
          "IsActive": true,
          "Name": "Red",
          "OldAttributeId": null,
          "AttributeTypeName": ""
        }
      ],
      "BackOrderMessage": "",
      "BeginActiveDate": null,
      "BundledProductIds": null,
      "BundledProductExternalIds": null,
      "CallForPricing": false,
      "Categories": [
        {
          "AlternateDescription": "",
          "CategoryId": 85,
          "CategoryNodes": [],
          "CategoryProfiles": [],
          "CategoryUrl": "~/category/Fruits/85",
          "CreateDate": "2013-07-01T00:00:00",
          "Custom1": "",
          "Custom2": "",
          "Custom3": "",
          "Description": "",
          "DisplayOrder": 5,
          "ExternalId": null,
          "ImageAltTag": "Flowers",
          "ImageFile": "Poppy.jpg",
          "ImageLargePath": "~/data/default/images/catalog/450/Poppy.jpg",
          "ImageMediumPath": "~/data/default/images/catalog/250/Poppy.jpg",
          "ImageSmallPath": "~/data/default/images/catalog/100/Poppy.jpg",
          "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/Poppy.jpg",
          "ImageThumbnailPath": "~/data/default/images/catalog/50/Poppy.jpg",
          "IsVisible": true,
          "Name": "Fruit",
          "ProductIds": "302,303,304,305,306,307",
          "SeoDescription": "Fruits",
          "SeoKeywords": "Fruits",
          "SeoTitle": "Fruits",
          "SeoUrl": "Fruits",
          "ShortDescription": "",
          "RedirectUrlInd": false,
          "Subcategories": [],
          "SubcategoryGridIsVisible": true,
          "IsAssociate": false,
          "Title": "Fruit",
          "UpdateDate": "2013-07-31T23:59:59.999",
          "CategoryBanner": "",
          "PortalID": null,
          "ProductId": 0,
          "CategoryIds": null,
          "UserName": null,
          "IsFromSitecore": false,
          "ProductCount": 0,
          "ParentCategoryNodeId": 0,
          "IsActive": false,
          "ActiveProductCount": 0,
          "FacetsGroups": [],
          "Properties": {
            "IsFeatured": false
          },
          "CatalogCount": 0
        }
      ],
      "ProductCategories": [],
      "CreateDate": "2013-04-29T10:49:32.657",
      "CrossSells": [
        {
          "DisplayOrder": 10,
          "ProductCrossSellTypeId": 1,
          "ProductId": 302,
          "RelatedProductId": 329,
          "RelationTypeId": 4,
          "ProductName": null,
          "CrossSellProducts": null,
          "FrequentlyBoughtProduct1": null,
          "FrequentlyBoughtProduct2": null,
          "ProductRelation": 4
        }
      ],
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Description": "Product description",
      "DisplayOrder": 10,
      "DownloadLink": "",
      "DropShipEmailAddress": "",
      "EndActiveDate": null,
      "ExpirationFrequency": null,
      "ExpirationPeriod": null,
      "ExternalId": "",
      "FeaturesDescription": "Features description",
      "FrequentlyBoughtTogether": [
        {
          "DisplayOrder": 10,
          "ProductCrossSellTypeId": 1,
          "ProductId": 302,
          "RelatedProductId": 329,
          "RelationTypeId": 4,
          "ProductName": null,
          "CrossSellProducts": null,
          "FrequentlyBoughtProduct1": null,
          "FrequentlyBoughtProduct2": null,
          "ProductRelation": 4
        }
      ],
      "Height": 1.0,
      "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": null,
          "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
        }
      ],
      "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": [
        {
          "AlternateThumbnailImageFile": "",
          "DisplayOrder": 1,
          "ImageAltTag": "",
          "ImageFile": "j0422281.jpg",
          "ImageLargePath": "~/data/default/images/catalog/450/j0422281.jpg",
          "ImageMediumPath": "~/data/default/images/catalog/250/j0422281.jpg",
          "ImageSmallPath": "~/data/default/images/catalog/100/j0422281.jpg",
          "ImageSmallThumbnailPath": null,
          "ImageThumbnailPath": "~/data/default/images/catalog/50/j0422281.jpg",
          "IsActive": true,
          "Name": "Product Image",
          "ProductId": 304,
          "ProductImageId": 6,
          "ProductImageTypeId": 1,
          "ReviewStateId": 20,
          "ShowOnCategoryPage": false
        }
      ],
      "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": {
        "Custom1": "",
        "Custom2": "",
        "Custom3": "",
        "Description": "Whole Foods Corporation",
        "DisplayOrder": 0,
        "Email": "",
        "EmailNotificationTemplate": "",
        "IsActive": true,
        "IsDropShipper": true,
        "ManufacturerId": 1,
        "Name": "Whole Foods",
        "PortalId": null,
        "Website": ""
      },
      "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": {
        "Description": "Default Product",
        "OldProductTypeName": null,
        "Name": "Default",
        "DisplayOrder": 1,
        "ProductTypeId": 7,
        "PortalId": null,
        "IsFranchiseable": true,
        "IsGiftCard": false
      },
      "ProductTypeId": 8,
      "ProductUrl": "~/product/Apple/302",
      "PromotionMessage": "",
      "PromotionPrice": 0.25,
      "Promotions": [
        {
          "AccountId": null,
          "AddOnValueId": null,
          "CatalogId": 4,
          "CategoryId": 86,
          "CouponCode": "",
          "CouponQuantityAvailable": 0,
          "Custom1": "",
          "Custom2": "",
          "Custom3": "",
          "Description": "Applies a percent off order",
          "Discount": 10.00,
          "DiscountedProductId": null,
          "DiscountedProductQuantity": 0.0,
          "DisplayOrder": 1,
          "EnableCouponUrl": false,
          "EndDate": "2013-08-31T00:00:00",
          "ExternalId": "",
          "HasCoupon": false,
          "ManufacturerId": 3,
          "MinimumOrderAmount": 0.00,
          "Name": "Percent Off Order",
          "PortalId": 7,
          "ProfileId": 5,
          "PromoCode": "AUG2013",
          "PromotionId": 13,
          "PromotionMessage": "Good through August 31, 2013",
          "PromotionType": null,
          "StoreName": null,
          "Profile": null,
          "PromotionTypeId": 6,
          "RequiredProductId": 552,
          "RequiredProductMinimumQuantity": 1.0,
          "SkuId": null,
          "StartDate": "2013-08-01T00:00:00",
          "IsCouponAllowedWithOtherCoupons": false
        }
      ],
      "RecurringBillingFrequency": "",
      "RecurringBillingInitialAmount": 0.0,
      "RecurringBillingPeriod": "",
      "RecurringBillingTotalCycles": 0,
      "RetailPrice": 4.23,
      "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": null,
          "ProductId": 302,
          "Pros": "",
          "Rating": 5,
          "ReviewId": 1,
          "Status": "A",
          "Subject": "Very delicious apples!",
          "UserLocation": "Columbus, OH",
          "ProductName": null
        }
      ],
      "ReviewStateId": 20,
      "SalePrice": 3.50,
      "SelectedSku": {
        "Attributes": [],
        "CustomerPricingSku": [],
        "Custom1": "",
        "Custom2": "",
        "Custom3": "",
        "DisplayOrder": null,
        "ExternalId": "",
        "FinalPrice": null,
        "ImageAltTag": "Green Apple",
        "ImageFile": "apple-green.jpg",
        "ImageLargePath": "~/data/default/images/catalog/450/apple-green.jpg",
        "ImageMediumPath": "~/data/default/images/catalog/250/apple-green.jpg",
        "ImageSmallPath": "~/data/default/images/catalog/100/apple-green.jpg",
        "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/apple-green.jpg",
        "ImageThumbnailPath": "~/data/default/images/catalog/50/apple-green.jpg",
        "Inventory": {
          "InventoryId": 0,
          "QuantityOnHand": null,
          "ReorderLevel": null,
          "Sku": null,
          "Skus": []
        },
        "IsActive": true,
        "Note": "",
        "ProductId": 302,
        "ProductPrice": null,
        "PromotionPrice": 1.23,
        "RecurringBillingFrequency": "1",
        "RecurringBillingInitialAmount": 0.00,
        "RecurringBillingPeriod": "",
        "RecurringBillingTotalCycles": 1,
        "RetailPriceOverride": null,
        "SalePriceOverride": 2.99,
        "Sku": "apg234",
        "SkuId": 2,
        "Supplier": null,
        "SupplierId": 1,
        "UpdateDate": "2013-12-06T02:04:16.85",
        "WebServiceDownloadDate": null,
        "WeightAdditional": 0.70,
        "WholesalePriceOverride": null,
        "AttributesIds": null,
        "Error": null,
        "UserType": null,
        "UserName": null
      },
      "SeoDescription": "Delicious Apple",
      "SeoKeywords": "apple",
      "SeoTitle": "Delicious Apple",
      "SeoUrl": "Apple",
      "ShipEachItemSeparately": false,
      "ShippingRate": 0.56,
      "ShippingRuleTypeId": 0,
      "ShipSeparately": false,
      "ShortDescription": "Short description",
      "Skus": [
        {
          "Attributes": [],
          "CustomerPricingSku": [],
          "Custom1": "",
          "Custom2": "",
          "Custom3": "",
          "DisplayOrder": null,
          "ExternalId": "",
          "FinalPrice": null,
          "ImageAltTag": "Green Apple",
          "ImageFile": "apple-green.jpg",
          "ImageLargePath": "~/data/default/images/catalog/450/apple-green.jpg",
          "ImageMediumPath": "~/data/default/images/catalog/250/apple-green.jpg",
          "ImageSmallPath": "~/data/default/images/catalog/100/apple-green.jpg",
          "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/apple-green.jpg",
          "ImageThumbnailPath": "~/data/default/images/catalog/50/apple-green.jpg",
          "Inventory": {
            "InventoryId": 0,
            "QuantityOnHand": null,
            "ReorderLevel": null,
            "Sku": null,
            "Skus": []
          },
          "IsActive": true,
          "Note": "",
          "ProductId": 302,
          "ProductPrice": null,
          "PromotionPrice": 1.23,
          "RecurringBillingFrequency": "1",
          "RecurringBillingInitialAmount": 0.00,
          "RecurringBillingPeriod": "",
          "RecurringBillingTotalCycles": 1,
          "RetailPriceOverride": null,
          "SalePriceOverride": 2.99,
          "Sku": "apg234",
          "SkuId": 2,
          "Supplier": null,
          "SupplierId": 1,
          "UpdateDate": "2013-12-06T02:04:16.85",
          "WebServiceDownloadDate": null,
          "WeightAdditional": 0.70,
          "WholesalePriceOverride": null,
          "AttributesIds": null,
          "Error": null,
          "UserType": null,
          "UserName": null
        }
      ],
      "Specifications": "Product specifications",
      "SupplierId": 12,
      "TaxClassId": 1,
      "TieredPrice": 1.50,
      "Tiers": [
        {
          "Price": 1.25,
          "ProductId": 302,
          "ProductTierId": 1,
          "ProfileId": 3,
          "TierEnd": 5,
          "TierStart": 1,
          "ProfileName": null,
          "Discount": null,
          "IsPercentageAmount": null
        }
      ],
      "TrackInventory": true,
      "UpdateDate": "2013-08-12T07:12:34.407",
      "WebServiceDownloadDate": null,
      "Weight": 1.0,
      "Width": null,
      "WholesalePrice": 2.10,
      "YouMayAlsoLike": [
        {
          "DisplayOrder": 10,
          "ProductCrossSellTypeId": 1,
          "ProductId": 302,
          "RelatedProductId": 329,
          "RelationTypeId": 4,
          "ProductName": null,
          "CrossSellProducts": null,
          "FrequentlyBoughtProduct1": null,
          "FrequentlyBoughtProduct2": null,
          "ProductRelation": 4
        }
      ],
      "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
    }
  ],
  "ProductList": null,
  "CategoryAssociatedProducts": null,
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}