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

Description

The Category service can retrieve information on the hierarchy of product categories as on Macys.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.macys.com/v3/catalog/category/[categoryID]

Path and Query Parameters

HTTP Header Parameters

Path Parameters 

Query Parameters

back to top

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.

Examples: 

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

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

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

back to top

Sample Request and Response

Sample Request

Request URL:

GET

https://api.macys.com/v3/catalog/category/118?show=attribute

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "resultsperpage": 0,
    "currentpage": 0,
    "totalresults": 1,
    "resptime": "15ms",
    "querydate": "2013-06-04T14:59:07.212-04:00",
    "category": [{
        "id": 118,
        "attribute": [{
            "name": "CATEGORY_BANNER_IMAGE_1",
            "values": [{
                "value": "4017373"
            }]
        }, {
            "name": "CATEGORY_BRAND_FLYOUT",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "CATEGORY_BROWSE_TYPE",
            "values": [{
                "value": "Flexible Template"
            }]
        }, {
            "name": "CATEGORY_FACET_STOP",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "CATEGORY_PAGE_TITLE",
            "values": [{
                "value": "Women's Clothing, Clothes and designer fashions for Plus Size, Petite, and tall women at Macys"
            }]
        }, {
            "name": "CATEGORY_USE_POOL",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "CAT_BANNER_INHERITANCE_SITE",
            "values": [{
                "value": "Y"
            }]
        }, {
            "name": "CAT_EXCLUDE_ADSENSE",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "CAT_MAGIC_BANNER_SITE",
            "values": [{
                "value": "536503"
            }]
        }, {
            "name": "DYCES_CAT_HEADER_LABEL",
            "values": [{
                "value": "RECOMMENDATIONS FOR YOU"
            }]
        }, {
            "name": "DYCES_CAT_POOL",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "INSTORE_ELIGIBILITY",
            "values": [{
                "value": "Y"
            }]
        }, {
            "name": "INTL_SUPPRESS_CAT",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "META_DESC",
            "values": [{
                "value": "Shop Women's Clothing at Macy's. Macy's.com carries clothing for Plus Size, Petite, and Tall Women."
            }]
        }, {
            "name": "MOBILE_PUBLISH",
            "values": [{
                "value": "Y"
            }]
        }, {
            "name": "POS_SEARCHABLE",
            "values": [{
                "value": "Y"
            }]
        }, {
            "name": "REGISTRABLE",
            "values": [{
                "value": "Wedding"
            }]
        }, {
            "name": "SEARCH_DESCRIPTION",
            "values": [{
                "value": "Women's Clothing"
            }]
        }, {
            "name": "SITECHANNEL",
            "values": [{
                "value": "1"
            }]
        }, {
            "name": "SUPPRESS_TAG_CLOUD",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "SUPRESS_COLOR_SWATCHES",
            "values": [{
                "value": "N"
            }]
        }, {
            "name": "WEDDING_BROWSE_TYPE",
            "values": [{
                "value": "Browse"
            }]
        }]
    }]
}

back to top

cURL Example

curl -X GET -H "X-Macys-Webservice-Client-ID: XXXXXXXXXX" -H "Accept: application/json" "https://api.macys.com/v3/catalog/category/118?show=attribute"

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top