store v1 events
Description
Provides a list of events in store for a given Store and date range.
The search can be made by the storeID or storeNumber. storeNumber is the MST store number.
HTTP Method and Request URL
GET
http://api.macys.com/store/v1/events?storeId=[storeid]&startDate=[date]&finishDate=[date]
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 | Specifies the output format. Can be application/json or application/xml. | Yes |
application/json |
Query Parameters
| Parameter | Description | Mandatory | Sample Value |
| storeId | Store number. | Yes(not neeeded if searching by storeNumber or locationNumber) | 212 (Note you can return events for multiple stores by separating them by a comma. Ex. 212, 70) |
| storeNumber | MST Store number | Yes (not neeeded if searching by storeId or locationNumber) | 428 (Note you can return events for multiple stores by separating them by a comma. Ex. 428,31) |
| locationNumber | Location number for the store. | Yes (not neeeded if searching by storeId or storeNumber) | 73(Note you can return events for multiple stores by separating them by a comma. Ex. 63, 73) |
|
startDate |
Starting date of events. | No | 2014-01-01 |
| finishDate | Ending date of events. | No | 2014-12-01 |
| _fields | Filter Parameter that allows you to return just the fields you would like in the response | No | name,locationNumber,attributes(attribute(name)) |
Sample Requests and Responses
Sample Request
Request URL:
GET
http://api.macys.com/store/v1/events?storeId=212&startDate=2014-01-01&finishDate=2014-12-01
HTTP Header:
x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Sample Response
{
"events": {
"event": [
{
"id": 14507,
"name": "Meet Handbag Designer Patricia Nash!",
"storeId": 212,
"storeNumber": 428,
"locationNumber": 5133,
"startDate": "2014-09-26T00:00:00.999",
"finishDate": "2014-09-26T23:59:59.000",
"attributes": {
"attribute": [
{
"name": "EVENT_DETAIL_ENABLED",
"value": [
"FALSE"
]
},
{
"name": "FACEBOOK_EVENT",
"value": [
"FALSE"
]
},
{
"name": "LONG_DESCRIPTION",
"value": [
"Meet handbag designer Patricia Nash! Be one of the first ten customers to spend $100 or more with Patricia Nash and you will receive a $20 Macy's gift card*. During the event, you may also enter for a chance to win a one-of-a-kind handbag, signed by Patricia Nash!
*While supplies last."
]
},
{
"name": "SHORT_DESC",
"value": [
"Meet handbag designer Patricia Nash! Be one of the first ten customers to spend $100 or more with Patricia Nash and you will receive a $20 Macy's gift card*. During the event, you may also enter for a chance to win a one-of-a-kind handbag, signed by Patricia Nash!
*While supplies last."
]
},
{
"name": "THISIT_EVENT",
"value": [
"FALSE"
]
},
{
"name": "WC_EVENT",
"value": [
"FALSE"
]
},
{
"name": "IN_STORE_LOCATION",
"value": [
"3002_1002"
]
},
{
"name": "START_TIME",
"value": [
"3:00 PM"
]
}
]
},
"link": [
{
"rel": "self",
"ref": "/api/store/v1/events?eventId=14507"
},
{
"rel": "events",
"ref": "/api/store/v2/stores/5133"
}
]
},
{
"id": 14622,
"name": "Macy's Welcomes Tout Sweet's Yigit Pura for a Cooking Demo!",
"storeId": 212,
"storeNumber": 428,
"locationNumber": 5133,
"startDate": "2014-11-15T00:00:00.999",
"finishDate": "2014-11-16T23:59:59.000",
"attributes": {
"attribute": [
{
"name": "EVENT_DETAIL_ENABLED",
"value": [
"FALSE"
]
},
{
"name": "FACEBOOK_EVENT",
"value": [
"FALSE"
]
},
{
"name": "SHORT_DESC",
"value": [
"Join Macy's in welcoming Tout Sweet's Yigit Pura for a special cooking demo!!
Yigit Pura is passionate about teaching you how to bring a little good sugar into your life. In his new book, Sweet Alchemy, he shares his imaginative approach to dessert and his trademark techniques in 78 recipes, many made famous from his time on Top Chef: Just Desserts and at his acclaimed San Francisco pâtisserie, Tout Sweet. Inspirational and truly original, Sweet Alchemy will bring you into Yigit's irresistible world. Yigit will be demonstrating \"The Sexy Chocolate Coupe\" from Sweet Alchemy.Immediately following the demonstration come up to Tout Sweet on the 3rd floor and purchase Sweet Alchemy and Yigit will auotograph your copy!
All who attend Yigit's demo will recieve a 10% discount in Tout Sweet that day so don't miss out!
Make sure to RSVP, seats are limited!
https://yigitpuramacys.eventbrite.com
Macy's Union Square, Cellar Demo Kitchen, Lower Level
Saturday, November 15, 2014 2:00 PM
"
]
},
{
"name": "THISIT_EVENT",
"value": [
"FALSE"
]
},
{
"name": "WC_EVENT",
"value": [
"FALSE"
]
},
{
"name": "FAST_PASS",
"value": [
"FALSE"
]
}
]
},
"link": [
{
"rel": "self",
"ref": "/api/store/v1/events?eventId=14622"
},
{
"rel": "events",
"ref": "/api/store/v2/stores/5133"
}
]
},
{
"id": 14669,
"name": "Join Macy's in Welcoming Marc Dym",
"storeId": 212,
"storeNumber": 428,
"locationNumber": 5133,
"startDate": "2014-11-22T00:00:00.999",
"finishDate": "2014-11-22T23:59:59.000",
"attributes": {
"attribute": [
{
"name": "EVENT_DETAIL_ENABLED",
"value": [
"FALSE"
]
},
{
"name": "FACEBOOK_EVENT",
"value": [
"FALSE"
]
},
{
"name": "SHORT_DESC",
"value": [
"Join Macy's in welcoming Chef Marc
Dym from Little River Inn!
Five star chef Marc Dym was named Executive Chef at Little River Inn in 2006. Dym brings a modern twist to the classic American-regional cuisine of Little River Inn, garnering high Zagat ratings, including the Top Food Ranking for the entire country in 2012.
For Chef Dym, Little River Inn offers the best of both worlds. On the dining room menu, Dym relies on his classical Culinary Institute of American training to create dishes that are at once familiar and modern.
Cellar Demo Kitchen, Lower Level at 2:00PM"
]
},
{
"name": "THISIT_EVENT",
"value": [
"FALSE"
]
},
{
"name": "WC_EVENT",
"value": [
"FALSE"
]
},
{
"name": "FAST_PASS",
"value": [
"FALSE"
]
},
{
"name": "START_TIME",
"value": [
"2:00 PM"
]
}
]
},
"link": [
{
"rel": "self",
"ref": "/api/store/v1/events?eventId=14669"
},
{
"rel": "events",
"ref": "/api/store/v2/stores/5133"
}
]
}
]
}
}
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