• Register

Category 3.0 Browse Category

GetCategoryIndex

Description

This API provides an option to obtain all the categoryIDs in a hierarchical structure by making a call with the ‘index’ parameter.  Then you can use the GetCategoryBrowse call (Below) to make subsequent calls to get the more detailed category info.

Obtain the category hierarchy

The API enables users to discover all available categories by invoking a category\index method. Every categoryID found in the index can then be used to query for more information on that category.

HTTP Method and Request URL

GET

https://api.bloomingdales.com/v3/catalog/category/index

back to top

Path and Query Parameters

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

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. Go to http://developer.macys.com/apps/mykeys for a list of your API keys.

Yes

xmj9js4jkdpe1983fmwu98gh

Accept

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

Yes

application/json
application/xml

Query Parameters

Parameter

Description

Mandatory

Sample Value

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 Request

Request URL:

GET

https://api.bloomingdales.com/v3/catalog/category/index

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "resultsperpage": 0,
    "currentpage": 0,
    "totalresults": 230,
    "resptime": "915ms",
    "querydate": "2014-04-09T13:22:11.526-04:00",
    "category": [{
        "id": 21791,
        "name": "Theory 38 Lookbook",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/theory-38-lookbook?id=21791&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/photo-galleries/theory-look-book.jsp",
        "mobilePublish": "Y"
    }, {
        "id": 22865,
        "name": "Sterling Silver Collection",
        "categorytype": "Browse",
        "categorypageurl": "http://www1.bloomingdales.com/shop/sterling-silver-collection?id=22865&edge=hybrid",
        "brandflyout": false,
        "mobilePublish": "Y"
    }, {
        "id": 23375,
        "name": "Barware Essentials",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/barware-essentials?id=23375&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/registry/wedding/m/barware-essentials",
        "mobilePublish": "Y"
    }, {
        "id": 23589,
        "name": "COOKWARE SEEKER",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/cookware-seeker?id=23589&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/registry/wedding/m/product-guide/cookware-seeker",
        "mobilePublish": "Y"
    }, {
        "id": 1000355,
        "name": "Legacy Handbags",
        "categorytype": "Coach Browse",
        "categorypageurl": "http://www1.bloomingdales.com/shop/legacy-handbags?id=1000355&edge=hybrid",
        "clickable": "Browse Click",
        "brandflyout": false,
        "mobilePublish": "Y"
    }, {
        "id": 1000376,
        "name": "Moments",
        "categorytype": "Browse",
        "categorypageurl": "http://www1.bloomingdales.com/shop/moments?id=1000376&edge=hybrid",
        "brandflyout": false,
        "mobilePublish": "Y"
    }, {
        "id": 1000606,
        "name": "Best Sellers",
        "categorytype": "Hide",
        "categorypageurl": "http://www1.bloomingdales.com/shop/best-sellers?id=1000606&edge=hybrid",
        "brandflyout": false,
        "mobilePublish": "Y"
    }, {
        "id": 1001245,
        "name": "Theory Classics",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/theory-classics?id=1001245&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/shop/womens-apparel/theory?id=10201",
        "overridecatid": 10201,
        "mobilePublish": "Y"
    }, {
        "id": 1001387,
        "name": "The Dress Code: 2013",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/the-dress-code-2013?id=1001387&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/fashion-index/dress-code-2013.jsp",
        "mobilePublish": "Y"
    }, {
        "id": 1001401,
        "name": "The Dress Code",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/the-dress-code?id=1001401&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/fashion-index/dress-code-2013.jsp",
        "mobilePublish": "Y"
    }, {
        "id": 1001410,
        "name": "Swim 2013 Lookbook",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/swim-2013-lookbook?id=1001410&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/fashion-index/swim-lookbook-2013.jsp",
        "mobilePublish": "Y"
    }, {
        "id": 1001501,
        "name": "D&P Ghost Category",
        "categorytype": "Flexible Template",
        "categorypageurl": "http://www1.bloomingdales.com/shop/d-p-ghost-category?id=1001501&edge=hybrid",
        "brandflyout": false,
        "pageType": "Browse",
        "mobilePublish": "Y"
    }, {
        "id": 1001736,
        "name": "About Illamasqua Sub Splash HTML Test",
        "categorytype": "Sub Splash",
        "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test?id=1001736&edge=hybrid",
        "brandflyout": false,
        "mobilePublish": "Y",
        "category": [{
            "id": 1001743,
            "name": "Shop All Illamasqua",
            "categorytype": "GoTo",
            "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test/shop-all-illamasqua?id=1001743&edge=hybrid",
            "brandflyout": false,
            "overrideUrl": "/shop/beauty/illamasqua?id=1001528",
            "overridecatid": 1001528,
            "mobilePublish": "Y"
        }, {
            "id": 1001737,
            "name": "Eyes",
            "categorytype": "GoTo",
            "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test/eyes?id=1001737&edge=hybrid",
            "brandflyout": false,
            "overrideUrl": "/shop/beauty/eyes?id=1001530",
            "overridecatid": 1001530,
            "mobilePublish": "Y"
        }, {
            "id": 1001738,
            "name": "Lips",
            "categorytype": "GoTo",
            "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test/lips?id=1001738&edge=hybrid",
            "brandflyout": false,
            "overrideUrl": "/shop/beauty/lips?id=1001532",
            "overridecatid": 1001532,
            "mobilePublish": "Y"
        }, {
            "id": 1001740,
            "name": "Nails",
            "categorytype": "GoTo",
            "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test/nails?id=1001740&edge=hybrid",
            "brandflyout": false,
            "overrideUrl": "/shop/beauty/nails?id=1001533",
            "overridecatid": 1001533,
            "mobilePublish": "Y"
        }, {
            "id": 1001739,
            "name": "Face & Body",
            "categorytype": "GoTo",
            "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test/face-body?id=1001739&edge=hybrid",
            "brandflyout": false,
            "overrideUrl": "/shop/beauty/face-body?id=1001531",
            "overridecatid": 1001531,
            "mobilePublish": "Y"
        }, {
            "id": 1001741,
            "name": "Accessories",
            "categorytype": "GoTo",
            "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test/accessories?id=1001741&edge=hybrid",
            "brandflyout": false,
            "overrideUrl": "/shop/beauty/accessories?id=1001529",
            "overridecatid": 1001529,
            "mobilePublish": "Y"
        }, {
            "id": 1001742,
            "name": "Fragrance",
            "categorytype": "GoTo",
            "categorypageurl": "http://www1.bloomingdales.com/shop/about-illamasqua-sub-splash-html-test/fragrance?id=1001742&edge=hybrid",
            "brandflyout": false,
            "overrideUrl": "/shop/beauty/fragrance?id=1001535",
            "overridecatid": 1001535,
            "mobilePublish": "Y"
        }]
    }, {
        "id": 1002360,
        "name": "Alex and Ani",
        "categorytype": "Flexible Template",
        "categorypageurl": "http://www1.bloomingdales.com/shop/alex-and-ani?id=1002360&edge=hybrid",
        "brandflyout": false,
        "pageType": "Browse",
        "mobilePublish": "Y"
    }, {
        "id": 20873,
        "name": "Holiday Style Guide",
        "categorytype": "Browse",
        "categorypageurl": "http://www1.bloomingdales.com/shop/holiday-style-guide?id=20873&edge=hybrid",
        "brandflyout": false,
        "mobilePublish": "Y",
        "category": [{
            "id": 20875,
            "name": "Animalistic",
            "categorytype": "Browse",
            "categorypageurl": "http://www1.bloomingdales.com/shop/holiday-style-guide/animalistic?id=20875&edge=hybrid",
            "brandflyout": false,
            "mobilePublish": "Y"
        }, {
            "id": 20877,
            "name": "Lace",
            "categorytype": "Browse",
            "categorypageurl": "http://www1.bloomingdales.com/shop/holiday-style-guide/lace?id=20877&edge=hybrid",
            "brandflyout": false,
            "mobilePublish": "Y"
        }, {
            "id": 20874,
            "name": "Shine",
            "categorytype": "Browse",
            "categorypageurl": "http://www1.bloomingdales.com/shop/holiday-style-guide/shine?id=20874&edge=hybrid",
            "brandflyout": false,
            "mobilePublish": "Y"
        }, {
            "id": 20878,
            "name": "Sorbets",
            "categorytype": "Browse",
            "categorypageurl": "http://www1.bloomingdales.com/shop/holiday-style-guide/sorbets?id=20878&edge=hybrid",
            "brandflyout": false,
            "mobilePublish": "Y"
        }, {
            "id": 20879,
            "name": "Statement Accessories",
            "categorytype": "Browse",
            "categorypageurl": "http://www1.bloomingdales.com/shop/holiday-style-guide/statement-accessories?id=20879&edge=hybrid",
            "brandflyout": false,
            "mobilePublish": "Y"
        }]
    }, {
        "id": 22866,
        "name": "18 Kt Gold Collection",
        "categorytype": "Browse",
        "categorypageurl": "http://www1.bloomingdales.com/shop/18-kt-gold-collection?id=22866&edge=hybrid",
        "brandflyout": false,
        "mobilePublish": "Y"
    }, {
        "id": 1001388,
        "name": "Plus Style Guide: Spring 2013",
        "categorytype": "GoTo",
        "categorypageurl": "http://www1.bloomingdales.com/shop/plus-style-guide-spring-2013?id=1001388&edge=hybrid",
        "brandflyout": false,
        "overrideUrl": "/plus-style-guide-spring-2013.jsp",
        "mobilePublish": "Y"
    }, {
        "id": 22867,
        "name": "Men's Collection",
        "categorytype": "Browse",
        "categorypageurl": "http://www1.bloomingdales.com/shop/mens-collection?id=22867&edge=hybrid",
        "brandflyout": false,
        "mobilePublish": "Y"
          }
    }]
}

 

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

 

back to top

GetCategoryBrowse

Description

The Category service can retrieve information on the hierarchy of product categories as on bloomingdales.com. In addition to the hierarchy details such as category description, Product IDs within the category & facets that can appear for those products can be retrieved.The API enables users to obtain category details by specifying a category ID.(all of these category ID's can be pulled from the GetCategoryIndex call (above)  Multiple category IDs can be specified in each request separated by commas & a max of 250 categories per request is supported. 

back to top

HTTP Method and Request URL

GET

 https://api.bloomingdales.com/v3/catalog/category/[categoryID]

Path and Query Parameters

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

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. Go to http://developer.bloomingdales.com/apps/mykeys for a list of your API keys.

Yes

xmj9js4jkdpe1983fmwu98gh

Accept

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

Yes

application/json

application/xml

 

Path Parameters

Parameter

Description

Mandatory

Sample Value

CategoryID

Unique ID for each category. Multiple categoryIDs can be sent in one call, limited to max 250

Yes

21683 or 21683,2910

 

Query Parameters

Parameter

Description

Mandatory

Sample Value

show

Every show parameter specified would enable users to restrict the service response to contain only the desired details about the category. By default all details of a category are shown

No

Facet, product, attribute
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 magicofmacysapi

Optional ‘show’ parameter explained:

The API enables users to choose specific details with a category detail response they want returned. A list of all values supported in the ‘show’ parameters are listed below. By default all details of a category are shown regardless of whether the users need it or not.

Users are provided an option to control the details returned for a category by using this show parameter & specifying details to return.

Parameter

Description

facet

Displays all facets & number of products within each facet

product

Lists an index of productIDs that are assigned to the category
attribute Lists an index of attributes that are assigned to category

 

Examples: 

Displays only facet details of category 21683
https://api.bloomingdales.com/v3/catalog/category/21683?show=facet

Displays list of products assigned to category 21683
https://api.bloomingdales.com/v3/catalog/category/21683?show=product

Displays both facet & product details of category 21683
https://api.bloomingdales.com/v3/catalog/category/21683?show=facet,product
                                    or
https://api.bloomingdales.com/v3/catalog/category/21683

back to top

Sample Request and Response

Sample Response

Request URL:

GET

http://api.bloomingdales.com/v3/catalog/category/21683?show=attribute

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "resultsperpage": 0,
    "currentpage": 0,
    "totalresults": 1,
    "resptime": "93ms",
    "querydate": "2014-04-09T13:16:08.953-04:00",
    "category": [{
        "id": 21683,
        "summary": {
            "name": "Dresses",
            "categorytype": "Flexible Template",
            "categorypageurl": "http://www1.bloomingdales.com/shop/womens-apparel/dresses?id=21683&edge=hybrid",
            "categoryHighlight": false,
            "pageId": "splash_women_apparel_dresses",
            "pageType": "Browse",
            "pageTitle": "Women's Dresses,  Cocktail, Prom, Evening, Maxi",
            "metaDesc": "Shop for Womens Dresses at Bloomingdales.com"
        }
    }]
}

 

back to top

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top

version 23 as of 10 years ago by Damian Bennett

Docs Navigation