Category Brand Index V4
- Description
- Request URL
- Path and Query Parameters
- Sample Requests and Responses
- cURL Example
- Error Codes
Description
This API allows users to specify Category(s) and retrieve the complete list of Brands for that Category(s). This is called the Brand Index.
HTTP Method and Request URL
GET
https://api.macys.com/v4/catalog/category/brandindex/[CategoryID]?refcatid=[refcatid]
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. 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 |
Accept |
Specifies the output format. Can be application/json or application/xml. |
Yes |
application/json |
Path Parameters
Parameter | Description | Mandatory | Sample Value |
CategoryID | Unique ID for each category. Multiple categoryIDs can be sent in one call by comma separating them | Yes | 3111 or 3111,46905,5449 |
Query Parameters
Parameter |
Description |
Mandatory |
Sample Value |
refcatid | Reference Category ID. This is an higher level category ID for the category you are trying to get brand index information for. For instance your higher level Category would be Womens (refcatid=118) and your nested category ID would be Jeans (3111) | No | 118 |
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 |
Sample Requests and Responses
Sample Request
Request URL:
GET
https://api.macys.com/v4/catalog/category/brandindex/3111?refcatid=118
HTTP Header:
x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Sample Response
"brandIndex": [{ "brandName": "7 For All Mankind", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/7-for-all-mankind" }, { "brandName": "AG Adriano Goldschmied", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/ag-adriano-goldschmied" }, { "brandName": "Alfred Dunner", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/alfred-dunner" }, { "brandName": "American Rag", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/american-rag" }, { "brandName": "Calvin Klein Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/calvin-klein-jeans" }, { "brandName": "Charter Club", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/charter-club" }, { "brandName": "Citizens of Humanity", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/citizens-of-humanity" }, { "brandName": "DKNY Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/dkny-jeans" }, { "brandName": "Denim & Supply Ralph Lauren", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/denim-supply-ralph-lauren" }, { "brandName": "Eileen Fisher", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/eileen-fisher" }, { "brandName": "Ellen Tracy", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/ellen-tracy" }, { "brandName": "Else Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/else-jeans" }, { "brandName": "Free People", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/free-people" }, { "brandName": "GUESS?", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/guess" }, { "brandName": "Hudson Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/hudson-jeans" }, { "brandName": "INC International Concepts", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/inc-international-concepts" }, { "brandName": "JM Collection", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/jm-collection" }, { "brandName": "Jessica Simpson", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/jessica-simpson" }, { "brandName": "Joe's", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/joes" }, { "brandName": "Jones New York", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/jones-new-york" }, { "brandName": "Karen Kane", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/karen-kane" }, { "brandName": "Karen Scott", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/karen-scott" }, { "brandName": "Kut from the Kloth", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/kut-from-the-kloth" }, { "brandName": "Lauren Ralph Lauren", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/lauren-ralph-lauren" }, { "brandName": "Lee Platinum", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/lee-platinum" }, { "brandName": "Levi's", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/levis" }, { "brandName": "Lucky Brand Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/lucky-brand-jeans" }, { "brandName": "Michael Kors", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/michael-kors" }, { "brandName": "Miss Me", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/miss-me" }, { "brandName": "NYDJ", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/nydj" }, { "brandName": "Paige Denim", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/paige-denim" }, { "brandName": "QMack", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/qmack" }, { "brandName": "Rachel Rachel Roy", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/rachel-rachel-roy" }, { "brandName": "Silver Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/silver-jeans" }, { "brandName": "Style&co.", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/style-co." }, { "brandName": "Tommy Hilfiger", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/tommy-hilfiger" }, { "brandName": "True Religion", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/true-religion" }, { "brandName": "Vince Camuto", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/vince-camuto" }] }
cURL Example
curl -X GET -H "x-macys-webservice-client-id: xxxxxxxxxx" -H "Accept: application/json" "https://api.macys.com/v4/catalog/category/brandindex/3111?refcatid=118"
Error Codes
Call Specific Error Codes:
NONE
General Error Handling Documentation:
Docs Navigation
- Overview
- Customer Services
- Common API Characteristics
- Ad Media
- Catalog Services
- Order Services
- Mobile Utilities
- Promotion and Coupon Services
- Registry Services
- Review Services
- Store Services
- User Services
- Error Handling
- Deprecated Services
- Macy's API FAQ
- BOPS Stores
- What's New