Data Structures

Sale objects

Sale list object

{
  "sales": [{
    "name": "Spring: Just Around the Corner",
    "sale": "https://api.gilt.com/v1/sales/men/spring-just-arou-108/detail.json",
    "sale_key": "spring-just-arou-108",
    "store": "men",
    "description": "Were you aware that there are seasons? Spring will start soon so etc",
    "sale_url": "http://www.gilt.com/sale/men/spring-just-arou-108",
    "begins": "2012-02-09T17:00:00Z",
    "image_urls": {
      "91x121": [{
        "url": "...",
        "width": 91,
        "height": 121
      }]
    }
  }]
}

Sale detail object

{
  "name": "Winter Weather",
  "sale": "https://api.gilt.com/v1/sales/men/winter-weather-48/detail.json",
  "sale_key": "winter-weather-48",
  "store": "men",
  "description": "Get out of the cold and into these great blah blah blah",
  "sale_url": "http://www.gilt.com/sale/men/winter-weather-48",
  "begins": "2012-02-04T17:00:00Z",
  "ends": "2012-02-07T17:00:00Z",
  "image_urls": {
    "91x121": [{
      "url": "...",
      "width": 91,
      "height": 121
    }]
  },
  "products": ["https://api.gilt.com/v1/products/124344157/detail.json", "https://api.gilt.com/v1/products/121737201/detail.json"]
}

Description of sale fields

Field Type Description
name String Sale name
sale String URL to single sale object
sale_key String unique identifier for sale
store String Store key
description String A description of the sale's theme or brand
sale_url String Permalink to sale website
begins String ISO8601-formatted time for beginning of sale
ends String ISO-8601-formatted time for end of sale
image_urls Object See Image URLs objects
products String[] List of URLs to individual product objects (not available if sale is upcoming or sold out)

Product objects

Product detail object

{
  "name": "Fake Product",
  "product": "https://api.gilt.com/v1/products/1268792864/detail.json",
  "brand": "Fake Corp",
  "content": {
    "description": "...",
    "material": "Stainless steel and plastic",
    "origin": "China"
  },
  "image_urls": {
    "91x121": [{
      "url": "...",
      "width": 91,
      "height": 121
    }, {
      "url": "...",
      "width": 91,
      "height": 121
    }]
  },
  "skus": [{
    "id": 1445982,
    "inventory_status": "sold out",
    "msrp_price": "449.00",
    "sale_price": "340.00",
    "attributes": [{
      "name": "color",
      "value": "choc brown"
    }]
  }]
}

Product categories object

{
  "categories": ["Boots", "Dresses", "Earrings", "Luggage", "Sofas"]
}

Description of product fields

Field Type Description
name String Product name
product String URL to product object
id String Unique identifier for product
brand String Brand name
url String Link to product detail page where item can be purchased
brand String Brand name
image_urls Object See Image URLs objects
skus String See SKUs objects
categories String[] A list of categories to which this product belongs
content Object See Product content objects

Product content objects

Field Type Description
description String Product description
fit_notes String Sizing information
material String Materials list
care_instructions String Additional care information
origin String Place of manufacture

Image objects

Image URLs object

Sale and product methods can both contain structures that expose image URLs. Images are provided at multiple resolutions and a particular resolution can also have more than one image associated with it. An image_url object consists of a set of key/value pairs with the key being the image resolution WIDTHxHEIGHT and the value being an array of image objects.

{
  "image_urls": {
    "91x121": [{
      "url": "http://cdn1.gilt.com/images/share/uploads/0000/0001/3294/132948322/91x121.jpg",
      "width": 91,
      "height": 121
    }, {
      "url": "http://cdn1.gilt.com/images/share/uploads/0000/0001/3258/132588431/91x121.jpg",
      "width": 91,
      "height": 121
    }],
    "300x400": [{
      "url": "http://cdn1.gilt.com/images/share/uploads/0000/0001/3294/132948322/300x400.jpg",
      "width": 300,
      "height": 400
    }, {
      "url": "http://cdn1.gilt.com/images/share/uploads/0000/0001/3258/132588431/300x400.jpg",
      "width": 300,
      "height": 400
    }],
    "420x560": [{
      "url": "http://cdn1.gilt.com/images/share/uploads/0000/0001/3294/132948322/420x560.jpg",
      "width": 420,
      "height": 560
    }, {
      "url": "http://cdn1.gilt.com/images/share/uploads/0000/0001/3258/132588431/420x560.jpg",
      "width": 420,
      "height": 560
    }]
  }
}

Description of image URL fields

Field Type Description
url String The URL to the image
width String The width of the image in pixels
height String The height of the image in pixels

SKU objects

SKU objects

Some fields may not be available for all products.

{
  "skus": [{
    "id": 1445982,
    "inventory_status": "sold out",
    "msrp_price": "449.00",
    "sale_price": "340.00",
    "attributes": [{
      "name": "color",
      "value": "choc brown"
    }]
  }]
}

Description of SKU fields

Field Type Description
id Integer The SKU unique identifier
inventory_status String Describes product availability. One of: sold out, for sale or reserved
msrp_price String MSRP price of SKU in US Dollars
sale_price String Sale price of SKU in US Dollars
shipping_surcharge String If absent, standard Gilt.com shipping policy and any resulting charges apply. If present, standard shipping charge is overridden by amount listed here in US Dollars
attributes Object SKU attributes like color and size

Product search objects

Size keys

The size keys map is grouped into product categories (e.g. Bedding, Children's Apparel & Accessories, etc.). Each group maps a size value (US sizes) into a size key you need to pass to the product search endpoint.

For instance you you want to search for Queen size beds you need to use set the size query parameter to Be:Queen.

{
  "Bedding": {
    "Cal King": "Be:CalKing",
    "Full": "Be:Full",
    "King": "Be:King",
    "Queen": "Be:Queen",
    "Twin": "Be:Twin",
    "Twin XL": "Be:TwinXL"
  },
  "Children's Apparel & Accessories": {
    "0-3m": "ChApAc:0-3m",
    "0m": "ChApAc:0m",
    "10 years": "ChApAc:10years",
    "11 years": "ChApAc:11years",
    "11-12 years": "ChApAc:11-12years",
    "12 years": "ChApAc:12years",
    "12-18m": "ChApAc:12-18m",
    "12-24 months": "ChApAc:12-24months",
    "12m": "ChApAc:12m",
    "13 years": "ChApAc:13years",
    "13-14 years": "ChApAc:13-14years",
    "14 years": "ChApAc:14years",
    "15 years": "ChApAc:15years",
    "15-16 years": "ChApAc:15-16years",
    "16 years": "ChApAc:16years",
    "17 years": "ChApAc:17years",
    "18 months": "ChApAc:18months",
    "18 years": "ChApAc:18years",
    "18-24m": "ChApAc:18-24m",
    "19 years": "ChApAc:19years",
    "2 years": "ChApAc:2years",
    "20 years": "ChApAc:20years",
    "24 months": "ChApAc:24months",
    "3 years": "ChApAc:3years",
    "3-6m": "ChApAc:3-6m",
    "4 years": "ChApAc:4years",
    "5 years": "ChApAc:5years",
    "6 years": "ChApAc:6years",
    "6-12m": "ChApAc:6-12m",
    "6-9m": "ChApAc:6-9m",
    "7 years": "ChApAc:7years",
    "8 years": "ChApAc:8years",
    "9 years": "ChApAc:9years",
    "9-10 years": "ChApAc:9-10years"
  },
  "Children's Shoes": {
    "0 Infant": "ChSh:0Infant",
    "0.5 Infant": "ChSh:0.5Infant",
    "1 Infant": "ChSh:1Infant",
    "1 Youth": "ChSh:1Youth",
    "1.5 Infant": "ChSh:1.5Infant",
    "1.5 Youth": "ChSh:1.5Youth",
    "10 Toddler": "ChSh:10Toddler",
    "10.5 Toddler": "ChSh:10.5Toddler",
    "11 Toddler": "ChSh:11Toddler",
    "11.5 Toddler": "ChSh:11.5Toddler",
    "12 Toddler": "ChSh:12Toddler",
    "12.5 Youth": "ChSh:12.5Youth",
    "13 Youth": "ChSh:13Youth",
    "13.5 Youth": "ChSh:13.5Youth",
    "2 Infant": "ChSh:2Infant",
    "2 Youth": "ChSh:2Youth",
    "2.5 Infant": "ChSh:2.5Infant",
    "2.5 Youth": "ChSh:2.5Youth",
    "3 Infant": "ChSh:3Infant",
    "3 Youth": "ChSh:3Youth",
    "3.5 Infant": "ChSh:3.5Infant",
    "3.5 Youth": "ChSh:3.5Youth",
    "4 Infant": "ChSh:4Infant",
    "4 Youth": "ChSh:4Youth",
    "4.5 Infant": "ChSh:4.5Infant",
    "4.5 Youth": "ChSh:4.5Youth",
    "5 Infant": "ChSh:5Infant",
    "5 Youth": "ChSh:5Youth",
    "5.5 Infant": "ChSh:5.5Infant",
    "5.5 Youth": "ChSh:5.5Youth",
    "6 Toddler": "ChSh:6Toddler",
    "6 Youth": "ChSh:6Youth",
    "6.5 Toddler": "ChSh:6.5Toddler",
    "6.5 Youth": "ChSh:6.5Youth",
    "7 Toddler": "ChSh:7Toddler",
    "7 Youth": "ChSh:7Youth",
    "7.5 Toddler": "ChSh:7.5Toddler",
    "7.5 Youth": "ChSh:7.5Youth",
    "8 Toddler": "ChSh:8Toddler",
    "8 Youth": "ChSh:8Youth",
    "8.5 Toddler": "ChSh:8.5Toddler",
    "8.5 Youth": "ChSh:8.5Youth",
    "9 Toddler": "ChSh:9Toddler",
    "9.5 Toddler": "ChSh:9.5Toddler"
  },
  "Intimates & Swim": {
    "28A": "InSw:28A",
    "28B": "InSw:28B",
    "28C": "InSw:28C",
    "28D": "InSw:28D",
    "30A": "InSw:30A",
    "30B": "InSw:30B",
    "30C": "InSw:30C",
    "30D": "InSw:30D",
    "30DD": "InSw:30DD",
    "30E": "InSw:30E",
    "30F": "InSw:30F",
    "32A": "InSw:32A",
    "32B": "InSw:32B",
    "32C": "InSw:32C",
    "32D": "InSw:32D",
    "32DD": "InSw:32DD",
    "32DDD": "InSw:32DDD",
    "32E": "InSw:32E",
    "32F": "InSw:32F",
    "32FF": "InSw:32FF",
    "32G": "InSw:32G",
    "34A": "InSw:34A",
    "34AA": "InSw:34AA",
    "34B": "InSw:34B",
    "34C": "InSw:34C",
    "34D": "InSw:34D",
    "34DD": "InSw:34DD",
    "34DDD": "InSw:34DDD",
    "34E": "InSw:34E",
    "34F": "InSw:34F",
    "34FF": "InSw:34FF",
    "34G": "InSw:34G",
    "36A": "InSw:36A",
    "36AA": "InSw:36AA",
    "36B": "InSw:36B",
    "36C": "InSw:36C",
    "36D": "InSw:36D",
    "36DD": "InSw:36DD",
    "36DDD": "InSw:36DDD",
    "36E": "InSw:36E",
    "36F": "InSw:36F",
    "36FF": "InSw:36FF",
    "36G": "InSw:36G",
    "38A": "InSw:38A",
    "38B": "InSw:38B",
    "38C": "InSw:38C",
    "38D": "InSw:38D",
    "38DD": "InSw:38DD",
    "38DDD": "InSw:38DDD",
    "38E": "InSw:38E",
    "38F": "InSw:38F",
    "38FF": "InSw:38FF",
    "38G": "InSw:38G",
    "40A": "InSw:40A",
    "40B": "InSw:40B",
    "40C": "InSw:40C",
    "40D": "InSw:40D",
    "40DD": "InSw:40DD",
    "40DDD": "InSw:40DDD",
    "40F": "InSw:40F",
    "40G": "InSw:40G",
    "42C": "InSw:42C",
    "42D": "InSw:42D",
    "42DD": "InSw:42DD",
    "42F": "InSw:42F",
    "42G": "InSw:42G",
    "44D": "InSw:44D",
    "44DD": "InSw:44DD",
    "44F": "InSw:44F"
  },
  "Men's Belts": {
    "26": "MeBe:26",
    "27": "MeBe:27",
    "28": "MeBe:28",
    "29": "MeBe:29",
    "30": "MeBe:30",
    "31": "MeBe:31",
    "32": "MeBe:32",
    "33": "MeBe:33",
    "34": "MeBe:34",
    "35": "MeBe:35",
    "36": "MeBe:36",
    "37": "MeBe:37",
    "38": "MeBe:38",
    "39": "MeBe:39",
    "40": "MeBe:40",
    "41": "MeBe:41",
    "42": "MeBe:42",
    "43": "MeBe:43",
    "44": "MeBe:44",
    "46": "MeBe:46",
    "48": "MeBe:48"
  },
  "Men's Bottoms": {
    "26": "MeBo:26",
    "27": "MeBo:27",
    "28": "MeBo:28",
    "29": "MeBo:29",
    "30": "MeBo:30",
    "31": "MeBo:31",
    "32": "MeBo:32",
    "33": "MeBo:33",
    "34": "MeBo:34",
    "35": "MeBo:35",
    "36": "MeBo:36",
    "37": "MeBo:37",
    "38": "MeBo:38",
    "39": "MeBo:39",
    "40": "MeBo:40",
    "41": "MeBo:41",
    "42": "MeBo:42",
    "43": "MeBo:43",
    "44": "MeBo:44",
    "46": "MeBo:46",
    "48": "MeBo:48"
  },
  "Men's Gloves": {
    "L": "MeGl:L",
    "M": "MeGl:M",
    "S": "MeGl:S",
    "XL": "MeGl:XL"
  },
  "Men's Hats": {
    "6 3/4": "MeHa:63/4",
    "6 7/8": "MeHa:67/8",
    "7": "MeHa:7",
    "7 1/2": "MeHa:71/2",
    "7 1/4": "MeHa:71/4",
    "7 1/8": "MeHa:71/8",
    "7 3/4": "MeHa:73/4",
    "7 3/8": "MeHa:73/8",
    "7 5/8": "MeHa:75/8",
    "7 7/8": "MeHa:77/8"
  },
  "Men's Outerwear": {
    "L": "MeOu:L",
    "M": "MeOu:M",
    "S": "MeOu:S",
    "XL": "MeOu:XL",
    "XS": "MeOu:XS",
    "XXL": "MeOu:XXL",
    "XXS": "MeOu:XXS",
    "XXXL": "MeOu:XXXL",
    "XXXS": "MeOu:XXXS"
  },
  "Men's Shirts & Sweaters": {
    "L": "MeShSw:L",
    "M": "MeShSw:M",
    "S": "MeShSw:S",
    "XL": "MeShSw:XL",
    "XS": "MeShSw:XS",
    "XXL": "MeShSw:XXL",
    "XXS": "MeShSw:XXS",
    "XXXL": "MeShSw:XXXL",
    "XXXS": "MeShSw:XXXS"
  },
  "Men's Shoes": {
    "10": "MeSh:10",
    "10.5": "MeSh:10.5",
    "11": "MeSh:11",
    "11.5": "MeSh:11.5",
    "12": "MeSh:12",
    "12.5": "MeSh:12.5",
    "13": "MeSh:13",
    "13.5": "MeSh:13.5",
    "14": "MeSh:14",
    "15": "MeSh:15",
    "16": "MeSh:16",
    "3": "MeSh:3",
    "3.5": "MeSh:3.5",
    "4": "MeSh:4",
    "4.5": "MeSh:4.5",
    "5": "MeSh:5",
    "5.5": "MeSh:5.5",
    "6": "MeSh:6",
    "6.5": "MeSh:6.5",
    "7": "MeSh:7",
    "7.5": "MeSh:7.5",
    "8": "MeSh:8",
    "8.5": "MeSh:8.5",
    "9": "MeSh:9",
    "9.5": "MeSh:9.5"
  },
  "Men's Socks": {
    "10": "MeSo:10",
    "10.5": "MeSo:10.5",
    "11": "MeSo:11",
    "11.5": "MeSo:11.5",
    "12": "MeSo:12",
    "12.5": "MeSo:12.5",
    "13": "MeSo:13",
    "13.5": "MeSo:13.5",
    "14": "MeSo:14",
    "15": "MeSo:15",
    "16": "MeSo:16",
    "3": "MeSo:3",
    "3.5": "MeSo:3.5",
    "4": "MeSo:4",
    "4.5": "MeSo:4.5",
    "5": "MeSo:5",
    "5.5": "MeSo:5.5",
    "6": "MeSo:6",
    "6.5": "MeSo:6.5",
    "7": "MeSo:7",
    "7.5": "MeSo:7.5",
    "8": "MeSo:8",
    "8.5": "MeSo:8.5",
    "9": "MeSo:9",
    "9.5": "MeSo:9.5"
  },
  "Men's Suiting": {
    "30": "MeSu:30",
    "31": "MeSu:31",
    "32": "MeSu:32",
    "32.5": "MeSu:32.5",
    "33": "MeSu:33",
    "33.5": "MeSu:33.5",
    "34": "MeSu:34",
    "34.5": "MeSu:34.5",
    "35": "MeSu:35",
    "35.5": "MeSu:35.5",
    "36": "MeSu:36",
    "36.5": "MeSu:36.5",
    "37": "MeSu:37",
    "37.5": "MeSu:37.5",
    "37.75": "MeSu:37.75",
    "38": "MeSu:38",
    "38.5": "MeSu:38.5",
    "39": "MeSu:39",
    "39.5": "MeSu:39.5",
    "39.75": "MeSu:39.75",
    "40": "MeSu:40",
    "40.5": "MeSu:40.5",
    "41": "MeSu:41",
    "41.5": "MeSu:41.5",
    "41.75": "MeSu:41.75",
    "42": "MeSu:42",
    "42.5": "MeSu:42.5",
    "43": "MeSu:43",
    "43.5": "MeSu:43.5",
    "44": "MeSu:44",
    "44.5": "MeSu:44.5",
    "44.75": "MeSu:44.75",
    "45": "MeSu:45",
    "45.5": "MeSu:45.5",
    "46": "MeSu:46",
    "46.5": "MeSu:46.5",
    "46.75": "MeSu:46.75",
    "47": "MeSu:47",
    "47.5": "MeSu:47.5",
    "48": "MeSu:48",
    "48.5": "MeSu:48.5",
    "49": "MeSu:49",
    "49.5": "MeSu:49.5",
    "50": "MeSu:50",
    "50.5": "MeSu:50.5",
    "51": "MeSu:51",
    "51.5": "MeSu:51.5",
    "52": "MeSu:52",
    "52.5": "MeSu:52.5",
    "53": "MeSu:53",
    "54": "MeSu:54",
    "56": "MeSu:56"
  },
  "Rings": {
    "10": "Ri:10",
    "10.5": "Ri:10.5",
    "10.75": "Ri:10.75",
    "11": "Ri:11",
    "11.5": "Ri:11.5",
    "12": "Ri:12",
    "12.5": "Ri:12.5",
    "13": "Ri:13",
    "13.5": "Ri:13.5",
    "14": "Ri:14",
    "14.5": "Ri:14.5",
    "15": "Ri:15",
    "15.5": "Ri:15.5",
    "16": "Ri:16",
    "16.5": "Ri:16.5",
    "17": "Ri:17",
    "17.5": "Ri:17.5",
    "18": "Ri:18",
    "3": "Ri:3",
    "4": "Ri:4",
    "4.25": "Ri:4.25",
    "4.5": "Ri:4.5",
    "4.75": "Ri:4.75",
    "5": "Ri:5",
    "5.25": "Ri:5.25",
    "5.5": "Ri:5.5",
    "5.75": "Ri:5.75",
    "6": "Ri:6",
    "6.25": "Ri:6.25",
    "6.5": "Ri:6.5",
    "6.75": "Ri:6.75",
    "7": "Ri:7",
    "7.25": "Ri:7.25",
    "7.5": "Ri:7.5",
    "7.75": "Ri:7.75",
    "8": "Ri:8",
    "8.25": "Ri:8.25",
    "8.5": "Ri:8.5",
    "9": "Ri:9",
    "9.5": "Ri:9.5"
  },
  "Women's Apparel": {
    "0": "WoAp:0",
    "00": "WoAp:00",
    "10": "WoAp:10",
    "12": "WoAp:12",
    "14": "WoAp:14",
    "16": "WoAp:16",
    "18": "WoAp:18",
    "2": "WoAp:2",
    "20": "WoAp:20",
    "22": "WoAp:22",
    "24": "WoAp:24",
    "26": "WoAp:26",
    "28": "WoAp:28",
    "4": "WoAp:4",
    "6": "WoAp:6",
    "8": "WoAp:8",
    "one size": "WoAp:onesize"
  },
  "Women's Belts": {
    "L": "WoBe:L",
    "M": "WoBe:M",
    "One Size": "WoBe:OneSize",
    "S": "WoBe:S",
    "XL": "WoBe:XL",
    "XS": "WoBe:XS",
    "XXL": "WoBe:XXL",
    "XXS": "WoBe:XXS",
    "XXXL": "WoBe:XXXL"
  },
  "Women's Gloves": {
    "L": "WoGl:L",
    "M": "WoGl:M",
    "S": "WoGl:S",
    "XL": "WoGl:XL",
    "XS": "WoGl:XS"
  },
  "Women's Hosiery": {
    "L": "WoHo:L",
    "M": "WoHo:M",
    "One Size": "WoHo:OneSize",
    "S": "WoHo:S",
    "XL": "WoHo:XL",
    "XS": "WoHo:XS",
    "XXL": "WoHo:XXL",
    "XXS": "WoHo:XXS",
    "XXXL": "WoHo:XXXL"
  },
  "Women's Petite Apparel": {
    "000P": "WoPeAp:000P",
    "00P": "WoPeAp:00P",
    "0P": "WoPeAp:0P",
    "10P": "WoPeAp:10P",
    "12P": "WoPeAp:12P",
    "14P": "WoPeAp:14P",
    "2P": "WoPeAp:2P",
    "4P": "WoPeAp:4P",
    "6P": "WoPeAp:6P",
    "8P": "WoPeAp:8P"
  },
  "Women's Shoes": {
    "10": "WoSh:10",
    "10.5": "WoSh:10.5",
    "11": "WoSh:11",
    "11.5": "WoSh:11.5",
    "12": "WoSh:12",
    "12.5": "WoSh:12.5",
    "13": "WoSh:13",
    "13.5": "WoSh:13.5",
    "14": "WoSh:14",
    "14.5": "WoSh:14.5",
    "15": "WoSh:15",
    "16": "WoSh:16",
    "17": "WoSh:17",
    "18": "WoSh:18",
    "19": "WoSh:19",
    "4": "WoSh:4",
    "4.5": "WoSh:4.5",
    "5": "WoSh:5",
    "5.5": "WoSh:5.5",
    "6": "WoSh:6",
    "6.5": "WoSh:6.5",
    "7": "WoSh:7",
    "7.5": "WoSh:7.5",
    "8": "WoSh:8",
    "8.5": "WoSh:8.5",
    "9": "WoSh:9",
    "9.5": "WoSh:9.5"
  }
}