Resources

Concepts

Resources root

All api requests to the current version of Gilt APIs begin with https://api.gilt.com/v1/.

Store keys

Any time a store is referred to in the API documentation, there are four possible values to match the four stores currently on Gilt.com. These stores are:

  • women: for the Women's store
  • men: for the Men's store
  • kids: for the Baby & Kids store
  • home: for the Home store

Sales

Active sales

This method returns a list of active sales.

Example request for all current active sales:

curl "https://api.gilt.com/v1/sales/active.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

The response will be a sale list object.

Sales can be scoped to a specific store by nesting the store identifier. Example request for all current active sales in the women store:

curl "https://api.gilt.com/v1/sales/women/active.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

Active sales that have products available will return a list of product IDs, which can be used with any available product methods.

Upcoming sales

This method returns a list of upcoming sales. If a store is specified, the returned list will only include sales from that store.

Example request for all upcoming sales:

curl "https://api.gilt.com/v1/sales/upcoming.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

The response will be a sale list object.

Sales can be scoped to a specific store by nesting the store identifier. Example request for all current active sales in the women store:

curl "https://api.gilt.com/v1/sales/women/upcoming.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

Active sales that have products available will return a list of product IDs, which can be used with any available product methods.

Sale detail

Information about a single sale can be retrieved by requesting the API resource provided by the sale field. This endpoint will only return data for as long as the sale is active or upcoming. Example request:

curl "https://api.gilt.com/v1/sales/women/spring-just-arou-108/detail.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

The response will be a sale detail object.

Note: sale details for upcoming sales will not contain products data until the sale become active (i.e. goes live).

Products

Product details

This method provides detailed information about a product currently on sale. Information provided is cached and may not reflect live information. The amount by which it is cached may change to ensure maximum API availability; this may mean that information such as whether an item is out of stock will appear inaccurate for a few minutes. Example:

curl "https://api.gilt.com/v1/products/147555589/detail.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

The response will be a product detail object.

Product categories

This endpoint returns a list of all categories assigned to products that are currently available via the API. This list could be used to filter products after downloading them. Example:

curl "https://api.gilt.com/v1/products/categories.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

The response will be a product categories object.

Product search

With the search endpoint you can search for products that are currently available on sale based on the following parameters:

  • q (*required*) full text search in the product description
  • store: wether women, men, children or home
  • brand: full text search on the brand name
  • color: a color group like black, grey, white, brown, beige, green, blue, purple, red, pink, yellow, orangeor miscellaneous (for mixed colors)
  • gender: wether boy, girl or unisex
  • size: a size key (see below)
  • rows: used for pagination, how many rows to return on each search (maximum allowed is 100)
  • start: used for pagination, skips the passed number of products when returning the results

The store, brand, color, gender and size parameters can be specified multiple times in the query string to search for multiple value (inclusion).

Size keys

The value for the size parameter depends on the kind of product your looking for, the following endpoint provides the size key codes you'll need to search for the products available on sale:

curl "https://api.gilt.com/v1/products/sizes.json?apikey=abcdefghi123abcdefghi123abcdefghi123"

You can find an example of the output in the data structures section.

Examples

Search for a queen size bed:

curl "https://api.gilt.com/v1/products?q=bed&size=Be%3AKing&apikey=abcdefghi123abcdefghi123abcdefghi123"

Search for a blue or red shirt in the men store:

curl "https://api.gilt.com/v1/products?q=shirt&color=blue&color=red&store=men&apikey=abcdefghi123abcdefghi123abcdefghi123"

Search for a summer sandal size 8 in the women store:

curl "https://api.gilt.com/v1/products?q=summer+sandal&store=women&size=WoSh%3A8&apikey=abcdefghi123abcdefghi123abcdefghi123"