API Documentation

For a dynamic view of our documentation, try our Active Docs!  Active Docs allows you to make live calls to our APIs while getting a stronger understanding for all of the resources and parameters involved.  

Our Version 1.0 API contains six categories: Brands, Departments, Products, Reviews, Search and Filtering. All requests are returned in JSON's format making it easy for your programs to consume. Below are a summary list of the request URLs you can perform. For more detail information on each categories, click on its hyperlinks in the Docs Navigation section.  


  • Brands Listhttp://api.sierratradingpost.com/api/1.0/brands/?api_key=YourApiKey
            -Listing of all brands

  • Brand Detailshttp://api.sierratradingpost.com/api/1.0/brand/[id]/?api_key=YourApiKey

            -Individual brand details where [id] is the brand's unique identifier

  • Brand Reviewshttp://api.sierratradingpost.com/api/1.0/reviewsbybrand/[id]/?api_key=YourApiKey

            -Brand reviews where [id] is the brand's unique identifier

Products:

  • Product Listhttp://api.sierratradingpost.com/api/1.0/products/?api_key=YourApiKey

            -Listing of all products; default to 24 items per page.

  • Product Detailshttp://api.sierratradingpost.com/api/1.0/product/[id]/?api_key=YourApiKey

            -Individual product details where [id] is the product's unique identifier

  • Product Reviewshttp://api.sierratradingpost.com/api/1.0/reviewsbyproduct/[id]/?api_key=YourApiKey

            -Individual product reviews where [id] is the product's unique identifier

Departments:

  • Dept Listhttp://api.sierratradingpost.com/api/1.0/departments/?api_key=YourApiKey

             -Listing of all departments starting at the root level then decends to its children.

  • Dept Detailshttp://api.sierratradingpost.com/api/1.0/department/[id]/?api_key=YourApiKey

            -Individual department detail where [id] is the department's unique identifier

Reviews:

  • Brand Reviewshttp://api.sierratradingpost.com/api/1.0/reviewsbybrand/[id]/?api_key=YourApiKey

            -Brand reviews where [id] is the brand's unique identifier

  • Product Reviewshttp://api.sierratradingpost.com/api/1.0/reviewsbyproduct/[id]/?api_key=YourApiKey

            -Individual product review summaries where [id] is the product's unique identifier

  • Review Detailshttp://api.sierratradingpost.com/api/1.0/review/[id]/?api_key=YourApiKey

            -Individual review details where [id] is the review's unique identifier


Syntax: http://api.sierratradingpost.com/api/1.0/products/search~{search-term-url-encoded-with-hyphens}/?api_key=YourApiKey
Examples: To search for "columbia jackets", append the term "columbia-jackets" at the end of .../products/search~
  • http://api.sierratradingpost.com/api/1.0/products/search~columbia-jackets/?api_key=YourApiKey

Request Parameters/Filtering

 
You could pass the following request parameters/filtering in conjunction with a search term, a list of reviews or products to filter your results.

type parameter {values}

 description 

int page {1-N}  
Current page number, default 1. 
 
int perpage {1-100}
Number of items per page, default 24. 
 
enum sort { RatingHighToLow, RatingLowToHigh, HelpfulScoreHighToLow, HelpfulScoreLowToHigh, SubmissionDateNewToOld, SubmissionDateOldToNew }
-Sorting method for a list of reviews, default in bold. 
 
enum sort { Brand, Newest, SavingsHighToLow, DiscountHighToLow, LowestPrice, HighestPrice, HighestRated, MostReviewed, SearchRanking, CostAndQuantityAscending, OnSale, TopSellersScore, EndecaRelevance }
-Sorting method for a list of products, default in bold.

Example: 
 -The request below will returned a list of products starting from page#2 showing 100 products per page and sort by SearchRanking. 
http://api.sierratradingpost.com/api/1.0/products/?page=2&perpage=100&sort=SearchRanking&api_key=YourApiKey

Sample API Response

  {
	    "Count": 275,
	    "Page": 1,
	    "PerPage": 24,
	    "NextPageUrl": "/api/1.0/products/search~columbia-jackets/?page=2",
	    "LastPageUrl": "/api/1.0/products/search~columbia-jackets/?page=11",
	    "RefinementsUrl": "/api/1.0/refinements/search~columbia-jackets/?sort=Brand",
	    "Result": [
	        {
	            "Id": "3341D",
	            "Url": "/api/1.0/product/3341d/",
	            "WebUrl": "http://www.sierratradingpost.com/product/bounce/3341d/",
	            "AffiliateWebUrl": "http://www.avantlink.com/click.php?tt=cl&mi=10888&pw=55&url=http%3A%2F%2Fwww.sierratradingpost.com%2Fproduct%2Fbounce%2F3341d%2F",
	            "Reviews": {
	                "ReviewsUrl": "/api/1.0/reviewsbyproduct/3341d/",
	                "ReviewCount": 80,
	                "AverageRating": 4.48
	            },
	            "Name": "Columbia Sportswear Bugaboo Omni-Tech® Parka - Insulated, 3-in-1 (For Men)",
	            "Images": {
	                "PrimarySmall": "http://i.stpost.com/erez4/erez?src=ProductImages/3341D_03.tif&tmp=SmallThumbnail&redirect=0&headers=proxy",
	                "PrimaryMedium": "http://i.stpost.com/erez4/erez?src=ProductImages/3341D_03.tif&tmp=MediumLargeG4&redirect=0&headers=proxy",
	                "PrimaryLarge": "http://i.stpost.com/erez4/erez?src=ProductImages/3341D_03.tif&tmp=LargeMobile&redirect=0&headers=proxy",
	                "PrimaryExtraLarge": "http://i.stpost.com/erez4/erez?src=ProductImages/3341D_03.tif&tmp=FullSize&redirect=0&headers=proxy",
	                "ExtraImages": [
	                    {
	                        "Title": "Hood View ",
	                        "Src": "http://s.stpost.com/eccStoreFront/product_images/3341D/3341D_2"
	                    }
	                ]
	       }
	}