Category Brand Index V4
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.bloomingdales.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 | 5545 or 5545,1001520,21683 |
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 | 2910 |
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 |
macgicofmacysapi |
Sample Requests and Responses
Sample Request
Request URL:
GET
https://api.bloomingdales.com/v4/catalog/category/brandindex/5545?refcatid=2910
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": "AQUA", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/aqua" }, { "brandName": "Adrianna Papell", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/adrianna-papell" }, { "brandName": "BASLER", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/basler" }, { "brandName": "BCBGMAXAZRIA", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/bcbgmaxazria" }, { "brandName": "BCBGeneration", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/bcbgeneration" }, { "brandName": "BLANKNYC", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/blanknyc" }, { "brandName": "Bella Dahl", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/bella-dahl" }, { "brandName": "Big Star", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/big-star" }, { "brandName": "Burberry", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/burberry" }, { "brandName": "C&C California", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/c-c-california" }, { "brandName": "Citizens of Humanity", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/citizens-of-humanity" }, { "brandName": "Current/Elliott", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/current-elliott" }, { "brandName": "Cut25 by Yigal Azrouel", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/cut25-by-yigal-azrouel" }, { "brandName": "D-ID", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/d-id" }, { "brandName": "DL1961", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/dl1961" }, { "brandName": "Dolce Vita", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/dolce-vita" }, { "brandName": "Earnest Sewn", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/earnest-sewn" }, { "brandName": "Eileen Fisher", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/eileen-fisher" }, { "brandName": "Eileen Fisher Petites", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/eileen-fisher-petites" }, { "brandName": "Elie Tahari", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/elie-tahari" }, { "brandName": "Escada", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/escada" }, { "brandName": "Flying Monkey", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/flying-monkey" }, { "brandName": "Frankie B", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/frankie-b" }, { "brandName": "Free People", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/free-people" }, { "brandName": "GENETIC", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/genetic" }, { "brandName": "GUESS", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/guess" }, { "brandName": "Helmut Lang", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/helmut-lang" }, { "brandName": "Hudson", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/hudson" }, { "brandName": "J Brand", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/j-brand" }, { "brandName": "Jack by BB DAKOTA", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/jack-by-bb-dakota" }, { "brandName": "James Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/james-jeans" }, { "brandName": "Joan Vass", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/joan-vass" }, { "brandName": "Joe's Jeans", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/joes-jeans" }, { "brandName": "Joie", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/joie" }, { "brandName": "Jones New York Collection", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/jones-new-york-collection" }, { "brandName": "Juicy Couture", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/juicy-couture" }, { "brandName": "KAREN MILLEN", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/karen-millen" }, { "brandName": "KORAL", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/koral" }, { "brandName": "Karen Kane", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/karen-kane" }, { "brandName": "LA't by L'Agence", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/lat-by-lagence" }, { "brandName": "Lafayette 148 New York", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/lafayette-148-new-york" }, { "brandName": "MARC BY MARC JACOBS", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/marc-by-marc-jacobs" }, { "brandName": "MICHAEL Michael Kors", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/michael-michael-kors" }, { "brandName": "MINKPINK", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/minkpink" }, { "brandName": "Maje", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/maje" }, { "brandName": "Max Mara", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/max-mara" }, { "brandName": "Miraclebody by Miraclesuit", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/miraclebody-by-miraclesuit" }, { "brandName": "NYDJ", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/nydj" }, { "brandName": "NYDJ Petites", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/nydj-petites" }, { "brandName": "Paige Denim", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/paige-denim" }, { "brandName": "Paige Maternity", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/paige-maternity" }, { "brandName": "REISS", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/reiss" }, { "brandName": "Rails", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/rails" }, { "brandName": "Ralph Lauren", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/ralph-lauren" }, { "brandName": "SOLD design lab", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/sold-design-lab" }, { "brandName": "Sanctuary", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/sanctuary" }, { "brandName": "Sandro", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/sandro" }, { "brandName": "Soft Joie", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/soft-joie" }, { "brandName": "Splendid", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/splendid" }, { "brandName": "TEXTILE Elizabeth and James", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/textile-elizabeth-james" }, { "brandName": "Ted Baker", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/ted-baker" }, { "brandName": "Theory", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/theory" }, { "brandName": "Tory Burch", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/tory-burch" }, { "brandName": "True Religion", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/true-religion" }, { "brandName": "Two by VINCE CAMUTO", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/two-by-vince-camuto" }, { "brandName": "VINCE CAMUTO", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/vince-camuto" }, { "brandName": "Vince", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/vince" }, { "brandName": "Vintage Havana", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/vintage-havana" }, { "brandName": "Weekend Max Mara", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/weekend-max-mara" }, { "brandName": "rag & bone/JEAN", "ozBrandId": 0, "brandURL": "http://www1.macys.com/buy/rag-bone-jean" }] }
Error Codes
Call Specific Error Codes:
NONE
General Error Handling Documentation:
Docs Navigation
- Overview
- Customer Services
- Loyalty Services
- customer v1 user profile services
- Common API Characteristics
- Ad Media
- Catalog and Store Services
- Order Services
- Mobile Utilities
- Promotion and Coupon Services
- Registry Services
- Store Services
- Error Handling
- Deprecated Services
- What's New
- Bloomingdale's API FAQ
- Quick Start Guide
- BOPS Stores
- user