Promotions V2
Description
The Promotions API call allows the users to get active promotions.
HTTP Method and Request URL
GET
https://api.macys.com/v2/promotions?promoid=[promoid]&global=[Y/N]&sourcecode=[B/Z/D]&type=[type]&promo_code=[promo_code]
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 |
promoid | Promotion Id |
No | 431690 |
global | Is the promotion global? (Y for Yes, N for No) |
No | Y, N |
sourcecode | Promotion Source Code |
No | B, Z, D |
type | Promotion Type |
No | Percent Off Order |
promo_code | Promotion Code | No | VETDAY |
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/v2/promotions?promoid=431690&global=Y&sourcecode=D&promo_code=VETDAY
HTTP Header:
x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
{ "promotionDetailsResponse": [{ "promotionName": "Emeril by All-Clad Bonus ", "description": "Get Free Nonstick Hard Anodized Round Grill Pan with Qualifying Emeril by All-Clad Cookware Set Purchase.", "global": true, "promoId": "431690", "promotionType": "Bundled GWP", "effectiveMonth": 7, "effectiveDay": 18, "effectiveYear": 2012, "expirationMonth": 12, "expirationDay": 31, "expirationYear": 2037, "promotionSource": ["MACYS", "BLOOMIES"], "promotionSourceCode": "D", "offerDescription": "Bonus with Select Emeril by All-Clad Sets.", "promotionAttributeDTO": [{ "promotionId": 431690, "promotionAttributeName": "BADGE_TEXT", "attributeSeqNumber": 1, "promotionAttributeValue": [{ "promotionId": 431690, "attributeValueSequenceNumber": 1, "promotionAttributeName": "BADGE_TEXT", "promotionAttributeValue": "Free Gift With Purchase " }] }] }] }
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