Product Details (Using Product ID) V4

• Description
• Request URL
• Path and Query Parameters
• Sample Requests and Responses
• 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.bloomingdales.com/v3/catalog/product/540990?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.bloomingdales.com/v4/catalog/product/540990(productdetails(price))

back to top

HTTP Method and Request URL

GET

https://api.bloomingdales.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.bloomingdales.com/v4/catalog/product/540990(productdetails(price,summary,availability),promotions,rebates)

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "product": [{
        "id": 540990,
        "productDetails": {
            "summary": {
                "name": "KitchenAid Artisan 5-Quart Tilt Head Stand Mixer",
                "productURL": "http://www1.bloomingdales.com/shop/product/kitchenaid-artisan-5-quart-tilt-head-stand-mixer?ID=540990",
                "description": "The stylish Artisan mixer achieves its luster with a special 2-coat finish that's complemented by a 5-quart stainless steel bowl with handle, pouring spout and measurement markings.",
                "typeName": "ELECTRIC",
                "available": true,
                "productStartDays": 1037,
                "metricNumberOfReviews": 10,
                "isNew": false,
                "taxwareCode": 61000,
                "productGroup": false,
                "checkInStoreEligibility": true,
                "maxQuantity": 12,
                "bullets": ["16.3\" x 11\" x 16.8\"", "Metal", "Includes handled stainless steel bowl, burnished flat beater, dough hook and stainless steel wire whip", "325-watt motor and 10 speed slide control. Tilt head design with planetary mixing", "Made in the USA", "View Demo Video", "Manufacturer's 1 year warranty"],
                "comparable": true,
                "active": true,
                "defaultCategoryId": 3865,
                "giftWrappable": true,
                "giftWrapId": 23,
                "visible": true,
                "clearanceStartDays": 16155,
                "countryEligible": true,
                "primaryPortraitSource": "1183878_fpx.tif"
            },
            "price": {
                "retail": {
                    "pricevalue": {
                        "low": 440.0
                    }
                },
                "original": {
                    "pricevalue": {
                        "low": 440.0
                    }
                },
                "pricetype": 0,
                "onsale": false
            },
            "availability": {
                "available": true
            }
        }
    }]
}

back to top

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top