{
    "apidoc": {
        "version": "0.9.6"
    },
    "base_url": "https://api.gilt.com/v1",
    "name": "gilt-public-api",
    "namespace": "com.gilt.public.api",
    "description": "Gilt Public API: dev.gilt.com",
    "enums": {
        "store": {
            "description": "Gilt.com is divided into stores. Currently there are four stores exposed by the API: Women, Men, Baby & Kids and Home.",
            "plural": "stores",
            "values": [
                {
                    "name": "women"
                },
                {
                    "name": "men"
                },
                {
                    "name": "kids"
                },
                {
                    "name": "home"
                }
            ]
        }
    },
    "models": {
        "product": {
            "fields": [
                {
                    "description": "Product name",
                    "name": "name",
                    "type": "string"
                },
                {
                    "description": "URL to product object",
                    "name": "product",
                    "type": "string"
                },
                {
                    "description": "Unique identifier for product",
                    "name": "id",
                    "type": "long"
                },
                {
                    "description": "Brand name",
                    "name": "brand",
                    "type": "string"
                },
                {
                    "description": "Link to product detail page where item can be purchased",
                    "name": "url",
                    "type": "string"
                },
                {
                    "name": "content",
                    "type": "product_content"
                },
                {
                    "description": "A list of categories to which this product belongs.",
                    "name": "categories",
                    "type": "[string]"
                },
                {
                    "description": "A map of key/value pairs with the key being the image resolution WIDTHxHEIGHT and the value being an array of image objects.",
                    "name": "image_urls",
                    "type": "object"
                },
                {
                    "description": "List of Skus",
                    "name": "skus",
                    "type": "[sku]"
                }
            ],
            "plural": "products"
        },
        "product_categories": {
            "fields": [
              {
                  "description": "A list of categories to which this product belongs.",
                  "name": "categories",
                  "type": "[string]"
              }
            ]
        },
        "product_content": {
            "fields": [
                {
                    "description": "Product description.",
                    "name": "description",
                    "type": "string",
                    "required": false
                },
                {
                    "description": "Sizing information.",
                    "name": "fit_notes",
                    "type": "string",
                    "required": false
                },
                {
                    "description": "Materials list.",
                    "name": "material",
                    "type": "string",
                    "required": false
                },
                {
                    "description": "Additional care information.",
                    "name": "care_instructions",
                    "type": "string",
                    "required": false
                },
                {
                    "description": "Place of manufacture.",
                    "name": "origin",
                    "type": "string",
                    "required": false
                }
            ]
        },
        "sale_list": {
            "fields": [
                {
                    "description": "List of sales.",
                    "name": "sales",
                    "type": "[sale_detail]"
                }
            ],
            "plural": "sale_list"
        },
        "sale_detail": {
            "fields": [
                {
                    "description": "Sale name",
                    "name": "name",
                    "type": "string"
                },
                {
                    "description": "URL to single sale object",
                    "name": "sale",
                    "type": "string"
                },
                {
                    "description": "unique identifier for sale",
                    "name": "sale_key",
                    "type": "string"
                },
                {
                    "description": "Store key",
                    "name": "store",
                    "type": "store"
                },
                {
                    "description": "A description of the sale's theme or brand",
                    "name": "description",
                    "type": "string",
                    "required": false
                },
                {
                    "description": "Permalink to sale website",
                    "name": "sale_url",
                    "type": "string"
                },
                {
                    "description": "ISO8601-formatted time for beginning of sale",
                    "name": "begins",
                    "type": "date-time-iso8601"
                },
                {
                    "description": "ISO-8601-formatted time for end of sale",
                    "name": "ends",
                    "type": "date-time-iso8601",
                    "required": false
                },
                {
                    "description": "A map of key/value pairs with the key being the image resolution WIDTHxHEIGHT and the value being an array of image objects.",
                    "name": "image_urls",
                    "type": "object"
                },
                {
                    "description": "List of URLs to individual product objects (not available if sale is upcoming or sold out)",
                    "name": "products",
                    "type": "[string]",
                    "required": false
                }
            ],
            "plural": "sale_details"
        },
        "sku": {
            "fields": [
                {
                    "description": "The SKU unique identifier",
                    "name": "id",
                    "type": "long"
                },
                {
                    "description": "Describes product availability. One of: sold out, for sale or reserved.",
                    "name": "inventory_status",
                    "type": "string"
                },
                {
                    "description": "MSRP price of SKU in US Dollars.",
                    "name": "msrp_price",
                    "type": "decimal"
                },
                {
                    "description": "Sale price of SKU in US Dollars.",
                    "name": "sale_price",
                    "type": "decimal"
                },
                {
                    "description": "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.",
                    "name": "shipping_surcharge",
                    "required": false,
                    "type": "decimal"
                },
                {
                    "description": "SKU attributes like color and size.",
                    "name": "attributes",
                    "type": "[object]"
                }
            ]
        }
    },
    "resources": {
      "sale_list": {
        "path": "/sales",
        "operations": [
          {
            "method": "GET",
            "path": "/active.json",
            "parameters": [
              {
                "name": "apikey",
                "type": "string"
              }
            ],
            "responses": {
              "200": {
                "type": "sale_list"
              }
            }
          },
          {
            "method": "GET",
            "path": "/:store/active.json",
            "parameters": [
              {
                "name": "apikey",
                "type": "string"
              }
            ],
            "responses": {
              "200": {
                "type": "sale_list"
              }
            }
          },
          {
            "method": "GET",
            "path": "/upcoming.json",
            "parameters": [
              {
                "name": "apikey",
                "type": "string"
              }
            ],
            "responses": {
              "200": {
                "type": "sale_list"
              }
            }
          },
          {
            "method": "GET",
            "path": "/:store/upcoming.json",
            "parameters": [
              {
                "name": "apikey",
                "type": "string"
              }
            ],
            "responses": {
              "200": {
                "type": "sale_list"
              }
            }
          }
        ]
      },
      "sale_detail": {
        "path": "/sales/:store/:sale",
        "operations": [
          {
            "method": "GET",
            "path": "detail.json",
            "parameters": [
              {
                "name": "apikey",
                "type": "string"
              }
            ],
            "responses": {
              "200": {
                "type": "sale_detail"
              }
            }
          }
        ]
      },
      "product": {
        "path": "/products",
        "operations": [
          {
            "method": "GET",
            "path": "/:productId/detail.json",
            "parameters": [
              {
                "name": "apikey",
                "type": "string"
              }
            ],
            "responses": {
              "200": {
                "type": "product"
              }
            }
          },
          {
            "method": "GET",
            "path": "/categories.json",
            "parameters": [
              {
                "name": "apikey",
                "type": "string"
              }
            ],
            "responses": {
              "200": {
                "type": "product_categories"
              }
            }
          }
        ]
      }
    }
}