Perhaps there is something about the API that I am not understanding but in poking around at the api and reading the docs I have found a few things that confused me.
says it will return a "sale list object" but actually it is neither a list nor detail object.
It is missing the products list from the sale detail and it has an extra "end date" on top of the sale list.
2) Products are not contained in sale detail (or sale detail is not defined correctly)
From your doc:
Sale detail
Information about a single sale can be retrieved by saving the store and sale_key from an active or upcoming fetch. This endpoint will only return data for as long as the sale is active or upcoming. Example request for all upcoming sales:
So, using the store and sale_key for this upcoming sale...
<fault>
<faultstring>Service Identification Failure</faultstring>
<detail>
<errorcode>26108</errorcode>
<trace>
Fault Name: ServiceIdentificationFailure
Error Type: NotFound
Description: Service Identification Failure
Service: null
Endpoint: null
Operation (Client):
</trace>
</detail>
</fault>
However using the "Sale" field return a sale item object, not a sale detail...
{"name":"Little Giraffe Blankets & More","sale":"
https://api.gilt.com/v1/sales/home/little-giraffe-blankets-6832/detail.json","sale_key":"little-giraffe-blankets-6832","store":"home","sale_url":"
http://www.gilt.com/home/sale/little-giraffe-blankets-6832?utm_medium=api&utm_campaign=TestApp&utm_source=salesapi","image_urls":{"744x281":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636538/orig.jpg","width":744,"height":281}],"366x186":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636540/orig.jpg","width":366,"height":186}],"185x173":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636551/orig.jpg","width":185,"height":173}],"320x153":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636543/orig.jpg","width":320,"height":153}],"490x250":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636539/orig.jpg","width":490,"height":250}],"650x280":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636544/orig.jpg","width":650,"height":280}],"240x163":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636541/orig.jpg","width":240,"height":163}],"300x184":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636552/orig.jpg","width":300,"height":184}],"287x195":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636527/orig.jpg","width":287,"height":195}],"80x85":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636546/orig.jpg","width":80,"height":85}],"590x213":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636525/orig.jpg","width":590,"height":213}],"300x280":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636521/orig.jpg","width":300,"height":280}],"100x93":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636548/orig.jpg","width":100,"height":93}],"636x400":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636529/orig.jpg","width":636,"height":400}],"385x173":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636554/orig.jpg","width":385,"height":173}],"455x172":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636530/orig.jpg","width":455,"height":172}],"370x345":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636553/orig.jpg","width":370,"height":345}],"620x280":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636522/orig.jpg","width":620,"height":280}],"612x526":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636534/orig.jpg","width":612,"height":526}],"140x130":[{"url":"
http://cdn1.gilt.com/images/share/uploads/0000/0002/0063/200636549/orig.jpg","width":140,"height":130}]},"begins":"2013-04-09T16:00:00Z","ends":"2013-04-11T04:00:00Z"}
(there's no products list here)
How does a "sale" link to a "product" or how do you get a "sale_detail" from a list? Or do you just need to use the category or search api to get a product?