Coupon V2

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

Description

The coupon API call allows users to get all active coupons that can be used in-store.

HTTP Method and Request URL

GET

https://api.macys.com/v2/promotions/coupons

Path and Query Parameters

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

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. Click here for a list of your API keys..

Yes

xmj9js4jkdpe1983fmwu98gh

Query Parameters

Parameter	Description	Mandatory	Sample Value
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/promotions/coupons

Headers:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json

Sample Request

{
 "couponList": [{
  "id": "1",
  "name": "VETSLP",
  "type": "Search Marketing",
  "couponNbr": "00014906100318241415\n",
  "displayStart": "2012-11-11T00:00:00-05:00",
  "displayEnd": "2014-11-11T00:00:00-05:00",
  "webPromoCode": "MEMSLP\n",
  "url": "Macys"
 }, {
  "id": "2",
  "name": "FIT_MATTERS_Sale_20percent_off_W3040168wis",
  "type": "Other",
  "couponNbr": "06216111000330051417\n",
  "displayStart": "2013-05-31T00:00:00-04:00",
  "displayEnd": "2013-06-10T00:00:00-04:00",
  "webPromoCode": "FITWIS\n",
  "url": "http://www1.macys.com/cms/deals/FIT_MATTERS_Sale_20percent_off_W3040168wis"
 }]
}

Note: The Time stamp in the response comes over in East Coast GMT time which does take into account Day light savings time which is why you will see a variation in the time returned based on the Month of the year displayed in the date. For example:

"displayStart": "2012-08-07T00:00:00-04:00", "displayEnd": "2013-01-15T00:00:00-05:00",

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here