Category Ad Media V2
- Description
- Request URL
- Path and Query Parameters
- Sample Requests and Responses
- cURL Example
- Error Codes
Description
The Category Ad Media Service is a read only resource that returns all the media information for a given category Id.
HTTP Method and Request URL
GET
https://api.macys.com/v2/admedia/category?categoryId=[categoryId]&channel=[Channel]&secure=[true/false]
HTTP Header Parameters
|
Parameter |
Description |
Mandatory |
Sample Value |
|---|---|---|---|
|
Accept |
Specifies the output format. Can be application/json or application/xml. |
Yes |
application/json application/xml |
|
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 |
Query Parameters
|
Parameter |
Description |
Mandatory |
Sample Value |
|---|---|---|---|
|
categoryId |
Specify one or more category Id's separated by comma. A list of Category ID's can be pulled by making a Category Index call |
Yes | 27058 |
| channel | Channel can be either SITE or REGISTRY |
Yes |
SITE |
| secure | By default this is set to false. If set to true links in response will be https NOT http | No |
true or false |
| 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 Request and Response
Sample Request
Request URL:
GET
https://api.macys.com/v2/admedia/category?categoryId=27058&channel=SITE
HTTP Header:
x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Sample Response
{
"mediaPoolMapper": {
"mediaPoolItem": [{
"poolName": "GLOBALABOVEFOOTERBANNER",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "635,0,902,76",
"text": "a million reasons to Believe: Create your letter to Santa ",
"linkType": "STATIC",
"value": "http://social.macys.com/believe/#/createyourletter",
"fullLinkURL": "http://social.macys.com/believe/#/createyourletter"
}, {
"coordinates": "0,0,642,76",
"text": "Make a list, check it twice. Be Santa anytime, anywhere. Shop the Holiday Gift Guide. ",
"linkType": "STATIC",
"value": "http://www.macys.com/campaign/social?campaign_id=213&channel_id=1",
"fullLinkURL": "http://www.macys.com/campaign/social?campaign_id=213&channel_id=1"
}]
},
"filename": "1101_ElectionDay_hp_gfb_1076497.jpg",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/1101_ElectionDay_hp_gfb_1076497.jpg",
"height": 74,
"width": 900,
"text": "Make a list, check it twice. Be Santa anytime, anywhere. Shop the Holiday Gift Guide. a million reasons to Believe: Create your letter to Santa ",
"description": "1101ElectionDaySaleHPEventBanner",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "552791"
}]
}
}, {
"poolName": "SITE_OP_BANNER",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "javascript:pop('/m/campaign/free-shipping/free-shipping-everyday','myDynaPop','scrollbars=yes,width=900,height=900')",
"fullLinkURL": "javascript:pop('/m/campaign/free-shipping/free-shipping-everyday','myDynaPop','scrollbars=yes,width=900,height=900')"
}]
},
"filename": "0221_FS_search_bnr_01_1030783.gif",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0221_FS_search_bnr_01_1030783.gif",
"height": 0,
"width": 0,
"text": "Free Shipping Everyday of the Year",
"description": "0221FlatfeeGenericCatbrowsebanner",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "536503"
}]
}
}, {
"poolName": "2143024",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"text": "",
"linkType": "PRODUCT",
"value": "595257",
"fullLinkURL": ""
}, {
"text": "",
"linkType": "PRODUCT",
"value": "728879",
"fullLinkURL": ""
}, {
"text": "",
"linkType": "PRODUCT",
"value": "728872",
"fullLinkURL": ""
}, {
"text": "",
"linkType": "PRODUCT",
"value": "728870",
"fullLinkURL": ""
}, {
"text": "",
"linkType": "PRODUCT",
"value": "728868",
"fullLinkURL": ""
}, {
"text": "",
"linkType": "PRODUCT",
"value": "728846",
"fullLinkURL": ""
}, {
"coordinates": "",
"text": "",
"linkType": "CATEGORY",
"value": "22911",
"fullLinkURL": "http://www1.macys.com/catalog/index.ognc?CategoryID=22911"
}]
},
"filename": "",
"fullImageURL": "",
"height": 0,
"width": 0,
"text": "Shop Toys and Games",
"description": "",
"mediaGroupType": "AD",
"mediaType": "PRODUCT_PANEL_CATEGORY_FACET"
}]
}
}, {
"poolName": "2142961",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"text": "",
"linkType": "PRODUCT",
"value": "733236",
"fullLinkURL": ""
}, {
"text": "",
"linkType": "PRODUCT",
"value": "733234",
"fullLinkURL": ""
}, {
"text": "",
"linkType": "PRODUCT",
"value": "335539",
"fullLinkURL": ""
}, {
"coordinates": "",
"text": "",
"linkType": "CATEGORY",
"value": "26073",
"fullLinkURL": "http://www1.macys.com/catalog/index.ognc?CategoryID=26073"
}]
},
"filename": "",
"fullImageURL": "",
"height": 0,
"width": 0,
"text": "Shop Holiday Dressing",
"description": "",
"mediaGroupType": "AD",
"mediaType": "PRODUCT_PANEL_CATEGORY_FACET"
}]
}
}, {
"poolName": "INTL_GNA",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://www.macys.com/store/about/visitor/index.jsp",
"fullLinkURL": "http://www.macys.com/store/about/visitor/index.jsp"
}]
},
"filename": "2012_gnas_10_1079150.png",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/2012_gnas_10_1079150.png",
"height": 39,
"width": 307,
"text": "visiting the united states? extra 10% off at any macy's store. details",
"description": "extra_off_visitingUS_GNA_307x40",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "548988"
}, {
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://prefcenter.email.macys.com/Macys_ISHIP/index.asp?rdn=700&aff_src=51",
"fullLinkURL": "http://prefcenter.email.macys.com/Macys_ISHIP/index.asp?rdn=700&aff_src=51"
}]
},
"filename": "sign_up_memail_GNA_307x40_1072362.jpg",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/sign_up_memail_GNA_307x40_1072362.jpg",
"height": 40,
"width": 308,
"text": "sign up for macy's emails saving & offers, right to your inbox! sign up",
"description": "newinternationalgnasignupforemails",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "549407"
}, {
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://www.macys.com/m/international-shipping/index",
"fullLinkURL": "http://www.macys.com/m/international-shipping/index"
}]
},
"filename": "ishipping_GNA_307x40_1072352.jpg",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/ishipping_GNA_307x40_1072352.jpg",
"height": 40,
"width": 307,
"text": "we ship to over 100 countries! find out more",
"description": "InternationalGNA100countries",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "549406"
}, {
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://www.macys.com/service/contact/international/faqs/index.jsp",
"fullLinkURL": "http://www.macys.com/service/contact/international/faqs/index.jsp"
}]
},
"filename": "2012_gnas_14_1079145.png",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/2012_gnas_14_1079145.png",
"height": 40,
"width": 307,
"text": "international shipping faqs get answers here",
"description": "questions_ishipping_GNA_307x40",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "548992"
}]
}
}, {
"poolName": "ABOVE_NAV_POOL",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "javascript:pop('/popup.ognc?popupID=551855','myDynaPop','width=365,scrollbars=yes,height=600')",
"fullLinkURL": "javascript:pop('/popup.ognc?popupID=551855','myDynaPop','width=365,scrollbars=yes,height=600')"
}]
},
"filename": "1111_vet_day_sale_HP_gna_4_1077412.png",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/1111_vet_day_sale_HP_gna_4_1077412.png",
"height": 40,
"width": 307,
"text": "Extra 15 percent or 10 percent off. promo code VETDAY.",
"description": "1111VetsDaySaleHPGNA",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "553776"
}, {
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://www.macys.com/registry/wedding/registryhome",
"fullLinkURL": "http://www.macys.com/registry/wedding/registryhome"
}]
},
"filename": "2012_gnas_16_1079147.png",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/2012_gnas_16_1079147.png",
"height": 40,
"width": 307,
"text": "going to a wedding? find a couple's registry",
"description": "registry_wo_shower_GNA_307x40",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "548996"
}, {
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://www.macys.com/campaign/thanksforsharing/index.jsp",
"fullLinkURL": "http://www.macys.com/campaign/thanksforsharing/index.jsp"
}]
},
"filename": "1015_sitewide_hp_gna_4_1075370.png",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/1015_sitewide_hp_gna_4_1075370.png",
"height": 43,
"width": 307,
"text": "thanks for sharing: join and get 10 percent rewards on most Macy's credit card purchases",
"description": "1015SitewideHPGNA",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "551593"
}, {
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://www.macys.com/m/international-shipping/index",
"fullLinkURL": "http://www.macys.com/m/international-shipping/index"
}]
},
"filename": "2012_gnas_12_1079143.png",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/2012_gnas_12_1079143.png",
"height": 40,
"width": 307,
"text": "we ship to over 100 countries! find out more",
"description": "ishipping_GNA_307x40",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "548989"
}]
}
}, {
"poolName": "FLEXWIDGET",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "Shop Holiday Dressing",
"linkType": "MEDIA",
"value": "2142961",
"fullLinkURL": ""
}, {
"coordinates": "",
"text": "Shop Toys and Games",
"linkType": "MEDIA",
"value": "2143024",
"fullLinkURL": ""
}]
},
"filename": "",
"fullImageURL": "",
"height": 0,
"width": 0,
"text": "",
"description": "Boys 2-7",
"mediaGroupType": "AD",
"mediaType": "WIDGET"
}]
}
}, {
"poolName": "GLOBALFOOTER",
"mediaItemMapper": {
"mediaItem": [{
"mediaLinkMapper": {
"mediaLinkItem": [{
"coordinates": "",
"text": "",
"linkType": "STATIC",
"value": "http://www.macys.com/m/campaign/splash/corporate/campaigns",
"fullLinkURL": "http://www.macys.com/m/campaign/splash/corporate/campaigns"
}]
},
"filename": "1111_vet_day_sale_HP_efb_1077413.jpg",
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/1111_vet_day_sale_HP_efb_1077413.jpg",
"height": 61,
"width": 209,
"text": "what's happening at Macy's",
"description": "1111VetsDaySaleHPEventBox",
"mediaGroupType": "AD",
"mediaType": "IMAGE",
"mediaGroupId": "553777"
}]
}
}]
}
}
cURL Example
curl -X GET -H "X-Macys-Webservice-Client-Id: xxxxxxxxxx" -H "Accept: application/json" -H "Content-Type: application/json" -H "https://api.macys.com/v2/admedia/category?categoryId=27058&channel=SITE"
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