Promotions Sorted V3

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

Description

The Promotions Sorted API call allows the users to get Deals and Promotion data set grouped and sorted by FOB to match data rendered on website.

HTTP Method and Request URL

GET

https://api.macys.com/v3/promotions/sorted?channel=[SITE]

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. Click here for a list of your API keys.	Yes	xmj9js4jkdpe1983fmwu98gh
Accept	Detemines output format. Can be application/json or application/xml.	Yes	application/json application/xml

Query Parameters

Parameter	Description	Mandatory	Sample Value
channel	Channel for the Promotion	No	SITE or MOBILE
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/v3/promotions/sorted?channel=SITE

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
sortedPromotions: [9]
0:  {
fob: "Jewelry & Watches"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/JewelryCoupon"
couponHeading: "15% off necklaces"
couponDescription: "Jewelry Coupon Desc"
couponShortCode: "JEWEL "
couponNumber: "59005 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "587"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "jewelry seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "jewelry seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "jewelry seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
1:  {
fob: "Cosmetics & Fragrances"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/BeautyCoupon"
couponHeading: "mildly long 20% off beauty heading"
couponSubHeading: "shop now"
couponDescription: "Beauty Coupon Desc"
couponShortCode: "BEAUTY "
couponNumber: "59007 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "588"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "beauty seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "beauty seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "beauty seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
2:  {
fob: "Sitewide/Featured Offers"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/SitewideCoupon"
couponHeading: "20% off sitewide"
couponDescription: "Sitewide Coupon Desc"
couponMoreDescription: "sitewide desc 2"
couponShortCode: "SITE "
couponNumber: "59000 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "1000"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "sitewide seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "sitewide seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "sitewide seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
3:  {
fob: "Women"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/WomenCoupon"
couponHeading: "sample women coupon"
couponSubHeading: "15% off women"
couponDescription: "Women Coupon Desc"
couponShortCode: "WOMEN "
couponNumber: "59001 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "1001"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "women seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "women seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "women seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
4:  {
fob: "Handbags & Shoes"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/HandbagCoupon"
couponHeading: "buy one handbag get one free"
couponSubHeading: "save now"
couponDescription: "Handbag Coupon Desc"
couponMoreDescription: "handbag desc 2"
couponShortCode: "HAND "
couponNumber: "59002 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [6]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "1002"
}-
1:  {
attributeName: "CPN_PASSBK_URL"
attributeValue: "http://www.qa29creativemacys.fds.com/cms/deals/MORE_CHOICES_Sale_15percent_off_W3030173"
}-
2:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "handbag seo description"
}-
3:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "handbag seo keywords"
}-
4:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "handbag seo title"
}-
5:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
5:  {
fob: "Men"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/MenCoupon"
couponHeading: "epic pants sale"
couponSubHeading: "20% off mens pants"
couponDescription: "Men Coupon Desc"
couponShortCode: "MEN "
couponNumber: "59002 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "1003"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "men seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "men seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "men seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
6:  {
fob: "Home"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/HomeCoupon"
couponHeading: "free home appliance"
couponSubHeading: "with purchase"
couponDescription: "Home Coupon Desc"
couponShortCode: "HOME "
couponNumber: "59004 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "1004"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "home seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "home seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "home seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
7:  {
fob: "Kids"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/KidsCoupon"
couponHeading: "children sale"
couponDescription: "Kids Coupon Desc"
couponShortCode: "KIDS "
couponNumber: "59006 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "1005"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "kids seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "kids seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "kids seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
8:  {
fob: "Registry"
promotions: [1]
0:  {
global: false
promoId: "0"
coupon: {
couponUrl: "http://www1.macys.com/cms/deals/RegistryCoupon"
couponHeading: "10% off registry really long heading text in the coupon that spans across the page"
couponSubHeading: "this subheading will be really long too because it is a test case for us"
couponDescription: "Registry Coupon Desc"
couponShortCode: "REGIST "
couponNumber: "59008 "
couponType: "INC"
couponEffectiveDay: 30
couponEffectiveMonth: 5
couponEffectiveYear: 2013
couponExpirationDay: 1
couponExpirationMonth: 8
couponExpirationYear: 2013
displayStartDate: "2013-05-30T00:00:00-04:00"
displayEndDate: "2013-08-01T00:00:00-04:00"
couponAttributes: [5]
0:  {
attributeName: "CPN_ASSOCIATED_FOB_ID"
attributeValue: "1006"
}-
1:  {
attributeName: "CPN_SEO_DESCRIPTION"
attributeValue: "registry seo description"
}-
2:  {
attributeName: "CPN_SEO_KEYWORDS"
attributeValue: "registry seo keywords"
}-
3:  {
attributeName: "CPN_SEO_TITLE"
attributeValue: "registry seo title"
}-
4:  {
attributeName: "IS_OFFERS_ELIGIBLE"
attributeValue: "Y"
}-
-
}-
}-
-
}-
-
}

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here