{
  "name": "api-product-recommendations-lat",
  "description": "Product recommendations for lord and taylor mobile. To be consumed by Skava",
  "base_url": "https://m.lordandtaylor.com/api-product-suggestions",
  "info": {
    "contact": {
      "name": "Personalization",
      "email": "alessandro.marrella@hbc.com",
      "url": "http://github.com/saksdirect"
    }
  },
  "enums": {
    "similarProductContext": {
      "values": [
        {
          "name": "pdp",
          "description": "PDP page. (Strict category match)"
        }
      ]
    }
  },
  "models": {
    "price": {
      "description": "Product price in USD",
      "fields": [
        {
          "name": "was",
          "type": "string",
          "description": "formatted price in USD"
        },
        {
          "name": "now",
          "type": "string",
          "description": "formatted price in USD"
        },
        {
          "name": "onSale",
          "type": "boolean",
          "description": "true if now price is < was price. Used to ",
          "default": "false"
        }
      ]
    },
    "recommendation": {
      "fields": [
        {
          "name": "productId",
          "type": "string"
        },
        {
          "name": "productName",
          "type": "string"
        },
        {
          "name": "productUrl",
          "type": "string"
        },
        {
          "name": "productImageUrl",
          "type": "string"
        },
        {
          "name": "brandName",
          "type": "string"
        },
        {
          "name": "price",
          "type": "price"
        },
        {
          "name": "rating",
          "type": "double",
          "description": "customer review's rating",
          "required": false
        },
        {
          "name": "numReviews",
          "type": "long",
          "description": "number of customers that reviewed the product",
          "required": false
        }
      ]
    },
    "similarProductRecommendation": {
      "fields": [
        {
          "name": "recommendations",
          "type": "[recommendation]"
        }
      ]
    }
  },
  "resources": {
    "similarProductRecommendation": {
      "operations": [
        {
          "method": "GET",
          "path": "/:context/:productId",
          "description": "Gets similar products recommendations inferring the org from the domain referrer",
          "parameters": [
            {
              "name": "productId",
              "type": "string",
              "description": "Product code for which we want to return similar products"
            },
            {
              "name": "context",
              "type": "similarProductContext",
              "description": "Context in which to show similar products, eg: PDP",
              "default": "pdp"
            },
            {
              "name": "color",
              "type": "string",
              "description": "plain text color",
              "required": false,
              "example": "grey"
            },
            {
              "name": "limit",
              "type": "integer",
              "description": "Limit on number of recommendations to be returned",
              "default": 10,
              "required": true
            },
	    {
	      "name": "Referer",
	      "type": "string",
	      "location": "header",
	      "required": true,
	      "description": "The service will use the content of this header to infer the org",
	      "example": "https://m.lordandtaylor.com/main/ProductDetail.jsp?FOLDER<>folder_id=2534374302030592&PRODUCT<>prd_id=845524442518220&R=845279061075"
	    },
            {
              "name": "abTestName",
              "type": "string",
              "description": "Name of the abTest being run (if any)",
              "required": false
            },
            {
              "name": "abTestVariant",
              "type": "string",
              "description": "Variant in the abTest (if any)",
              "required": false
            }
          ],
          "responses": {
            "200": {
              "type": "similarProductRecommendation"
            }
          }
        }
      ]
    }
  }
}