Global Ad Media V3

Description

The Global Ad Media Service is a read only resource that returns all the media information for a given list of global header and footer pool names. The main differnce between v2 and v3 is in the response.
For example:
v2:
"fullImageURL": "http://assets.macys.com/navapp/dyn_img/site_ad......
v3:
"fullImageURL": "http://assets.macys.com/dyn_img/site_ads.......
 

HTTP Method and Request URL

GET

https://api.macys.com/v3/admedia/global?poolName=[poolName]&secure=[true/false]

Path and Query Parameters

 

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

poolName

Specify one or more pool names separated by comma.

Yes
poolName=GLOBALFOOTER
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

 

back to top

Sample Requests and Responses

 

Sample Request

Request URL:

GET

https://api.macys.com/v3/admedia/global?poolName=GLOBALFOOTER&strict=true&secure=true

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

back to top

Sample Response

{
{
    "mediaPoolMapper": {
        "mediaPoolItem": [{
            "poolName": "GLOBALABOVEFOOTERBANNER",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "0,0,441,75",
                            "text": "take $20 off your next purchase of $50 or more when you shop a couples registry. learn more",
                            "linkType": "STATIC",
                            "value": "http://www1.macys.com/registry/wedding/m/give-a-gift-get-a-gift-promo",
                            "fullLinkURL": "http://www1.macys.com/registry/wedding/m/give-a-gift-get-a-gift-promo"
                        }, {
                            "coordinates": "441,0,899,77",
                            "text": "shop the wedding shop and find everything you need for the big day, all in one place. shop now",
                            "linkType": "STATIC",
                            "value": "http://www.macys.com/campaign/social?campaign_id=200&channel_id=1",
                            "fullLinkURL": "http://www.macys.com/campaign/social?campaign_id=200&channel_id=1"
                        }]
                    },
                    "filename": "0624_Sitewide_Savings_HP_v2_gfb_1096466.jpg",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0624_Sitewide_Savings_HP_v2_gfb_1096466.jpg",
                    "height": 76,
                    "width": 900,
                    "text": "Take $20 Off, your next purchase of $50 or more when you shop a couple's registry and then save big! learn more. The wedding shop, everything you need for the big day, all in one place. shop now!",
                    "description": "0624SiteSavingsHPGFB",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "575500"
                }]
            }
        }, {
            "poolName": "COPY_BLOCK",
            "mediaItemMapper": {
                "mediaItem": [{
                    "filename": "/copyblock/2013/5/572308.jsp",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash//copyblock/2013/5/572308.jsp",
                    "height": 0,
                    "width": 0,
                    "text": "Toddler Boy Clothes",
                    "description": "Toddler Boy Clothes",
                    "mediaGroupType": "COPY_BLOCK",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "572308"
                }]
            }
        }, {
            "poolName": "Gift_Guide",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "http://www1.macys.com/campaign/social?campaign_id=259&channel_id=1",
                            "fullLinkURL": "http://www1.macys.com/campaign/social?campaign_id=259&channel_id=1"
                        }]
                    },
                    "filename": "0528_sitewide_HP_v1_secnav_01_1094451.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0528_sitewide_HP_v1_secnav_01_1094451.png",
                    "height": 33,
                    "width": 87,
                    "text": "the gift guide",
                    "description": "HFR_febwk2_secondary_nav_giftguide_ad1",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "561430"
                }]
            }
        }, {
            "poolName": "International_Footer_GFA",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "http://www.macys.com/m/campaign/sitelets/pride/index",
                            "fullLinkURL": "http://www.macys.com/m/campaign/sitelets/pride/index"
                        }]
                    },
                    "filename": "0513_Pride_Supporting_Asset_eb_1091982.jpg",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0513_Pride_Supporting_Asset_eb_1091982.jpg",
                    "height": 61,
                    "width": 209,
                    "text": "join macys at pride parades & in-store events near you. check it out",
                    "description": "0513 PRIDE Events Box",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "569282"
                }]
            }
        }, {
            "poolName": "Seasonal_Promotion",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "http://www.macys.com/campaign/social?campaign_id=360&channel_id=1",
                            "fullLinkURL": "http://www.macys.com/campaign/social?campaign_id=360&channel_id=1"
                        }]
                    },
                    "filename": "0528_sitewide_HP_v1_secnav_02_1094450.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0528_sitewide_HP_v1_secnav_02_1094450.png",
                    "height": 33,
                    "width": 147,
                    "text": "american icons",
                    "description": "AmericanIcons2ndNav",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "571624"
                }]
            }
        }, {
            "poolName": "SITE_OP_BANNER",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "javascript:pop('/popup.ognc?popupID=573222','myDynaPop','width=365,scrollbars=yes,height=600')",
                            "fullLinkURL": "javascript:pop('/popup.ognc?popupID=573222','myDynaPop','width=365,scrollbars=yes,height=600')"
                        }]
                    },
                    "filename": "062613_magic_banner1_1096340.gif",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/062613_magic_banner1_1096340.gif",
                    "height": 76,
                    "width": 686,
                    "text": "Extra 20 percent off + Free Shipping, Extra 15 percent or 10 percent off, select departments, Free Shipping With $99 Purchase applied at checkout and excludes furniture and mattresses, U.S. shipping only, other exclusions apply, details, extra savings promo code: HOT",
                    "description": "062613 Extra 20 percent - Checkout Extra 20 percent  - bnr1 Extra 15 percent  - bnr2 Extra 10 percent  - bnr3",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "575315"
                }]
            }
        }, {
            "poolName": "2143024",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "text": "",
                            "linkType": "PRODUCT",
                            "value": "595257",
                            "fullLinkURL": ""
                        }, {
                            "text": "",
                            "linkType": "PRODUCT",
                            "value": "628568",
                            "fullLinkURL": ""
                        }, {
                            "text": "",
                            "linkType": "PRODUCT",
                            "value": "728961",
                            "fullLinkURL": ""
                       
                        }, {
                            "coordinates": "",
                            "text": "",
                            "linkType": "CATEGORY",
                            "value": "22911",
                            "fullLinkURL": "https://www.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": "335537",
                            "fullLinkURL": ""
                        }, {
                            "text": "",
                            "linkType": "PRODUCT",
                            "value": "335539",
                            "fullLinkURL": ""
                        }, {
                            "text": "",
                            "linkType": "PRODUCT",
                            "value": "554861",
                            "fullLinkURL": ""
                        }, {
                            "coordinates": "",
                            "text": "",
                            "linkType": "CATEGORY",
                            "value": "26073",
                            "fullLinkURL": "https://www.macys.com/catalog/index.ognc?CategoryID=26073"
                        }]
                    },
                    "filename": "",
                    "fullImageURL": "",
                    "height": 0,
                    "width": 0,
                    "text": "Shop Special Occasion",
                    "description": "",
                    "mediaGroupType": "AD",
                    "mediaType": "PRODUCT_PANEL_CATEGORY_FACET"
                }]
            }
        }, {
            "poolName": "INTL_GNA",
            "mediaItemMapper": {
                "mediaItem": [{
                    "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"
                }, {
                    "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_1079936.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/2012_gnas_12_1079936.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"
                }, {
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "http://prefcenter.email.macys.com/Macys_ISHIP/index.asp?rdn=700&aff_src=51&cm_sp=intl_gna-_-sign-up-for-macy%27s-emails-saving-%26-offers%2C-right-to-your-inbox%21-sign-up",
                            "fullLinkURL": "http://prefcenter.email.macys.com/Macys_ISHIP/index.asp?rdn=700&aff_src=51&cm_sp=intl_gna-_-sign-up-for-macy%27s-emails-saving-%26-offers%2C-right-to-your-inbox%21-sign-up"
                        }]
                    },
                    "filename": "1125_1126_INT_CyberMon_hp_gna_3_1080464.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/1125_1126_INT_CyberMon_hp_gna_3_1080464.png",
                    "height": 40,
                    "width": 307,
                    "text": "Sign up for Macy's emails: save 15 percent on your next purchase!",
                    "description": "11252012INTCyberMondayHPGNA3",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "556892"
                }, {
                    "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"
                }]
            }
        }, {
            "poolName": "ABOVE_NAV_POOL",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "http://www1.macys.com/campaign/social?campaign_id=299&channel_id=1",
                            "fullLinkURL": "http://www1.macys.com/campaign/social?campaign_id=299&channel_id=1"
                        }]
                    },
                    "filename": "0610_SummerSale_HP_GNA4_1095683.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0610_SummerSale_HP_GNA4_1095683.png",
                    "height": 40,
                    "width": 307,
                    "text": "Macy's 4th of the July Fireworks, live in NYC and on NBC July 4 at 8pm EST! learn more",
                    "description": "0610 extra off GNA1 Macys 4 of the july GNA4",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "574221"
                }, {
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "http://www.macys.com/registry/wedding/m/give-a-gift-get-a-gift-promo",
                            "fullLinkURL": "http://www.macys.com/registry/wedding/m/give-a-gift-get-a-gift-promo"
                        }]
                    },
                    "filename": "052813_sitewide_HP_v1_GNA2_1094490.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/052813_sitewide_HP_v1_GNA2_1094490.png",
                    "height": 40,
                    "width": 307,
                    "text": "Take $20 Off, shop a couple's registry and then save big! learn more",
                    "description": "052813sitewideHPv1 Take $20 off - GNA2 Glamorama - GNA3 Give a Gift - GFA1",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "572476"
                }, {
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "http://www.macys.com/campaign/social?campaign_id=157&channel_id=1",
                            "fullLinkURL": "http://www.macys.com/campaign/social?campaign_id=157&channel_id=1"
                        }]
                    },
                    "filename": "052813_sitewide_HP_v1_GNA3_1094491.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/052813_sitewide_HP_v1_GNA3_1094491.png",
                    "height": 40,
                    "width": 307,
                    "text": "Glamorama a night of fun, fashion and philanthropy, get tickets now",
                    "description": "052813sitewideHPv1 Take $20 off - GNA2 Glamorama - GNA3 Give a Gift - GFA1",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "572481"
                }, {
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "",
                            "linkType": "STATIC",
                            "value": "javascript:pop('/popup.ognc?popupID=573222','myDynaPop','width=365,scrollbars=yes,height=600')",
                            "fullLinkURL": "javascript:pop('/popup.ognc?popupID=573222','myDynaPop','width=365,scrollbars=yes,height=600')"
                        }]
                    },
                    "filename": "062613_HotOneSale_HP_GNA4_1096336.png",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/062613_HotOneSale_HP_GNA4_1096336.png",
                    "height": 40,
                    "width": 307,
                    "text": "Extra Off, Extra 20 percent, 15 percent or 10 percent off, promo code: HOT, details",
                    "description": "062613 Extra Off - GNA4",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "575311"
                }]
            }
        }, {
            "poolName": "Leaf_and_Star",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "0,0,69,58",
                            "text": "turn over a new leaf",
                            "linkType": "STATIC",
                            "value": "http://www1.macys.com/campaign/earthday/index.jsp",
                            "fullLinkURL": "http://www1.macys.com/campaign/earthday/index.jsp"
                        }, {
                            "coordinates": "70,0,138,62",
                            "text": "Macy's Backstage",
                            "linkType": "STATIC",
                            "value": "http://www1.macys.com/campaign/social?campaign_id=207&channel_id=1",
                            "fullLinkURL": "http://www1.macys.com/campaign/social?campaign_id=207&channel_id=1"
                        }, {
                            "coordinates": "134,0,210,58",
                            "text": "give back",
                            "linkType": "STATIC",
                            "value": "http://www1.macys.com/m/campaign/give-back/index",
                            "fullLinkURL": "http://www1.macys.com/m/campaign/give-back/index"
                        }]
                    },
                    "filename": "MacySitewideFooterIcon_1095120.jpg",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/MacySitewideFooterIcon_1095120.jpg",
                    "height": 61,
                    "width": 209,
                    "text": "turn over a new leaf, macys backstage, magic of giving",
                    "description": "HFR_maywk3_bottomevents_209x61",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "561434"
                }]
            }
        }, {
            "poolName": "FLEXWIDGET",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "",
                            "text": "web busters, incredible specials, limited qua",
                            "linkType": "MEDIA",
                            "value": "557217",
                            "fullLinkURL": ""
                        }, {
                            "coordinates": "",
                            "text": "Shop Holiday Dressing",
                            "linkType": "MEDIA",
                            "value": "2142961",
                            "fullLinkURL": ""
                        }, {
                            "coordinates": "",
                            "text": "shop kids collection",
                            "linkType": "MEDIA",
                            "value": "566784",
                            "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/sitelets/pride/index",
                            "fullLinkURL": "http://www.macys.com/m/campaign/sitelets/pride/index"
                        }]
                    },
                    "filename": "0513_Pride_Supporting_Asset_eb_1091982.jpg",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0513_Pride_Supporting_Asset_eb_1091982.jpg",
                    "height": 61,
                    "width": 209,
                    "text": "join macys at pride parades & in-store events near you. check it out",
                    "description": "0513 PRIDE Events Box",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "569282"
                }]
            }
        }, {
            "poolName": "566784",
            "mediaItemMapper": {
                "mediaItem": [{
                    "mediaLinkMapper": {
                        "mediaLinkItem": [{
                            "coordinates": "139,14,353,150",
                            "text": "shop kids collection",
                            "linkType": "STATIC",
                            "value": "/campaign/social?campaign_id=231&channel_id=1",
                            "fullLinkURL": "https://www.macys.com/campaign/social?campaign_id=231&channel_id=1"
                        }]
                    },
                    "filename": "0213_kids_collection_1089784.JPG",
                    "fullImageURL": "http://assets.macys.com/navapp/dyn_img/cat_splash/0213_kids_collection_1089784.JPG",
                    "height": 161,
                    "width": 686,
                    "text": "shop kids collection",
                    "description": "Kids collection search banner repuposed for widget",
                    "mediaGroupType": "AD",
                    "mediaType": "IMAGE",
                    "mediaGroupId": "566784"
                }]
            }
        }]
    }
}

 

cURL Example

curl -X GET -H "X-Macys-Webservice-Client-Id: xxxxxxxxxxx" -H "Accept: application/json" -H "Content-Type: application/json" -H "https://api.macys.com/v3/admedia/global?poolName=GLOBALFOOTER&strict=true&secure=true"

 

 

back to top

Error Codes

Call Specific Error Codes:

{
                                       "errorCode": 409,
                                       "message": "No data for search criteria",
                                       "errorDetail": ["No global media data found for the search criteria"],
                                       "success": false
}

General Error Handling Documentation:

Click Here

back to top

Docs Navigation