Product Detail (Using Product ID) V4

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

Description

The format of the URL for the V4 service has greatly changed from V3 to V4.  Instead of using a Parameter=Value the logic includes nested attributes that control the content returned for a product.  For instance, in V3 the show parameter was used and if this parameter was not defined we returned default results based on default Vales.  You then could use the "show" parameter to specify what specific attributes you wanted. Ex: http://api.macys.com/v3/catalog/product/520910?show=price

In v4 you return the items by listing the items in braces where you follow the logic of the nested objects.  For instance the productdetails object includes the following nested objects:"sizemap, colormap,typemap, domainvaluesmap, price, summary, badges, collection, childproducts, masterproducts, shipping, attributes, primaryimage, additionalimages, brand, corpclass, availability, urlmetadata"  So to make the same kind of call as above using V4 service you would format you URL as follows:  Ex: http://api.macys.com/v4/catalog/product/520910(productdetails(price))

back to top

HTTP Method and Request URL

GET

https://api.macys.com/v4/catalog/product/[ProductID](object(nestedobject))

back to top

Path and Query Parameters

HTTP Header Parameters

Path Parameters

Object Parameters

Query Parameters

back to top

Sample Requests and Responses

Sample Requests

Request URL:

GET

https://api.macys.com/v4/catalog/product/77589(productdetails(price,summary,availability),promotions,rebates)

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "product": [{
        "id": 77589,
        "productDetails": {
            "summary": {
                "name": "KitchenAid KSM150PS Artisan 5 Qt. Stand Mixer",
                "productURL": "http://www1.macys.com/shop/product/kitchenaid-ksm150ps-artisan-5-qt-stand-mixer?ID=77589",
                "description": "Retro styled and easy to use, the KitchenAid Artisan stand mixer is the perfect kitchen companion. Employing a unique tilting head to facilitate bowl and content removal, this mixer is undeniably handy. 1-year hassle-free replacement warranty. Model KSM150PS. ",
                "typeName": "MIXER",
                "available": true,
                "productStartDays": 1384,
                "metricNumberOfReviews": 994,
                "isNew": false,
                "taxwareCode": 91000,
                "productGroup": false,
                "checkInStoreEligibility": true,
                "maxQuantity": 6,
                "bullets": ["Imported", "Includes flat beater, wire whip, dough hook, pouring shield and polished bowl with handles", "Mirror-polished stainless steel mixing bowl features an extra-large 5-qt. capacity and ergonomic handle", "Average capacity: nine cups of flour", "Prepare up to four loaves of bread, nine dozen cookies or seven pounds of mashed potatoes", "Powerful 325-watt motor effectively mixes even the toughest dough and batter", "Pouring shield reduces mess by channeling ingredients into bowl", "Measures 13.9\" x 8.7\" X 14.1\""],
                "comparable": true,
                "active": true,
                "defaultCategoryId": 7554,
                "giftWrappable": false,
                "visible": true,
                "clearanceStartDays": 16151,
                "countryEligible": true,
                "primaryPortraitSource": "397865_fpx.tif",
                "additionalImageSource": ["2027761_fpx.tif", "2072718_fpx.tif"],
                "rebateId": ["600377"]
            },
            "price": {
                "retail": {
                    "pricelabel": "Sale",
                    "pricevalue": {
                        "low": 349.99
                    }
                },
                "original": {
                    "pricelabel": "Reg.",
                    "pricevalue": {
                        "low": 499.99
                    }
                },
                "pricetype": 3,
                "onsale": true,
                "saleends": "2014-03-23T23:59:59-04:00",
                "pricingpolicy": "/catalog/product/pricingpolicy.ognc?fpriceTypeId=3&daysInC=16151&ID=77589"
            },
            "availability": {
                "available": true
            }
        },
        "promotions": [{
            "promotionID": 19831908,
            "promotionType": "Percent Off Order",
            "description": "Enjoy 10% off select watches, electrics, electronics, furniture, mattresses & area rugs during the VIP Sale!",
            "promotionCode": "VIPMOB"
        }, {
            "promotionID": 19832227,
            "promotionType": "Percent Off Order",
            "offerDescription": "Enjoy 10% off select merchandise! CODE: FIVE",
            "description": "Enjoy 10% off select watches, furniture, mattresses, electrics & electronics, area rugs during the 5 Day Super Sale!",
            "attributes": [{
                "name": "BADGE_TEXT",
                "values": [{
                    "value": "EXTRA 10% OFF",
                    "seqnum": 1
                }]
            }, {
                "name": "IS_OFFERS_ELIGIBLE",
                "values": [{
                    "value": "N",
                    "seqnum": 1
                }]
            }],
            "promotionCode": "FIVE"
        }],
        "rebates": [{
            "text": "Purchase a KitchenAid 5 Qt Artisan Standmixer (KSM150 or KSM155) & receive a $30 MIR. ",
            "description": "Purchase a KitchenAid 5 Qt Artisan Standmixer (KSM150 or KSM155) & receive a $30 MIR.",
            "mediaGroupID": 600377
        }]
    }]
}

back to top

cURL Examples

curl -X GET -H "x-macys-webservice-client-id: xxxxxxxxxxx" -H "Accept: application/json" "https://api.macys.com/v4/catalog/product/77589(productdetails(price,summary,availability),promotions,rebates)"

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top