Product Recommendations V4

Description
Request URL
Path and Query Parameters
Sample Requests and Responses
Error Codes

Description

The Product recommendations service allows you to specify a product and return related products that are recommended just as is done on Bloomingdales.com.

HTTP Method and Request URL

GET

http://api.macys.com/v4/recommendations/product/[productID]?visitorid=[visitorid]

Path and Query Parameters

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

Specifies the output format. Can be application/json or application/xml.

Yes

application/json

application/xml

x-macys-webservice-client-id

Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Click here for a list of your API keys.

Yes

xmj9js4jkdpe1983fmwu98gh

Path Parameters

Parameter	Description	Mandatory	Sample Value
productID	Unique ID for each product. Multiple productIDs can be sent in one call	optional, but you need at least upcNumber or productId.	540990 or multiple with comma separator

Query Parameters

Parameter	Description	Mandatory	Sample Value
visitorid	Visitor ID is a unique ID that captures a person's session	No	123456789
maxprods	Max product returned. Default is 10. This number should be between 1 and 9.	No	5
callback	If sent, the format is JSONP (JSON with Padding) with the callback returned with the JSON response. You can put anything in the callback parameter and whatever you send is returned.	No	magicofbloomingdalesapi

Sample Requests and Responses

Sample Requests

Request URL:

GET

http://api.bloomingdales.com/v4/recommendations/product/540990?visitorid=123456789&maxprods=5

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "recommendedproducts": [{
        "productid": 475297,
        "name": "Cuisinart \"Custom 14\" Food Processor",
        "primaryimage": "1252053_fpx.tif",
        "reviewrating": 5.0,
        "reviewsnumber": 1,
        "productprice": {
            "original": {
                "pricelabel": "Orig.",
                "pricevalue": {
                    "low": 350.0
                }
            },
            "retail": {
                "pricelabel": "Now",
                "pricevalue": {
                    "low": 199.99
                }
            }
        }
    }, {
        "productid": 564715,
        "name": "KitchenAid Flex Edge Beater Attachment",
        "primaryimage": "1223939_fpx.tif",
        "productprice": {
            "original": {
                "pricevalue": {
                    "low": 29.99
                }
            }
        }
    }, {
        "productid": 640897,
        "name": "Calphalon Nonstick Crown Bundt Form Pan",
        "primaryimage": "8097824_fpx.tif",
        "reviewrating": 5.0,
        "reviewsnumber": 1,
        "productprice": {
            "original": {
                "pricevalue": {
                    "low": 21.99
                }
            }
        }
    }, {
        "productid": 742604,
        "name": "KitchenAid Stand Mixer Cover",
        "primaryimage": "8338250_fpx.tif",
        "reviewrating": 5.0,
        "reviewsnumber": 1,
        "productprice": {
            "original": {
                "pricevalue": {
                    "low": 35.0
                }
            }
        }
    }, {
        "productid": 846325,
        "name": "Calphalon 10-Piece Bakeware Set, Dishwasher Safe",
        "primaryimage": "8406524_fpx.tif",
        "productprice": {
            "original": {
                "pricevalue": {
                    "low": 99.99
                }
            }
        }
    }]
}

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here