store v1 events

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

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.bloomingdales.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 application/xml

Query Parameters

Parameter	Description	Mandatory	Sample Value
storeId	Store number.	Yes(not neeeded if searching by storeNumber or locationNumber)	110039 (Note you can return events for multiple stores by separating them by a comma. Ex. 110039, 70)
storeNumber	MST Store number	Yes (not neeeded if searching by storeId or locationNumber)	22 (Note you can return events for multiple stores by separating them by a comma. Ex. 22,31)
locationNumber	Location number for the store.	Yes (not neeeded if searching by storeId or storeNumber)	2371 (Note you can return events for multiple stores by separating them by a comma. Ex. 63, 73)
startDate	Starting date of events.	No	2015-01-01
finishDate	Ending date of events.	No	2015-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.bloomingdales.com/store/v1/events?storeId=110039&startDate=2015-01-01&finishDate=2015-12-01&_fields=name,locationNumber,attributes(attribute(name))

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "events": {
        "event": [
            {
                "id": 0,
                "name": "Creme de La Mer Facial Event",
                "locationNumber": 2371,
                "attributes": {
                    "attribute": [
                        {
                            "name": "EVENT_DETAIL_ENABLED"
                        },
                        {
                            "name": "SHORT_DESC"
                        },
                        {
                            "name": "STORE_EVENT_TYPE"
                        },
                        {
                            "name": "WC_EVENT"
                        },
                        {
                            "name": "END_TIME"
                        },
                        {
                            "name": "START_TIME"
                        }
                    ]
                },
                "link": []
            },
            {
                "id": 0,
                "name": "La Prairie, Caviar Facial",
                "locationNumber": 2371,
                "attributes": {
                    "attribute": [
                        {
                            "name": "EVENT_DETAIL_ENABLED"
                        },
                        {
                            "name": "SHORT_DESC"
                        },
                        {
                            "name": "STORE_EVENT_TYPE"
                        },
                        {
                            "name": "WC_EVENT"
                        },
                        {
                            "name": "END_TIME"
                        },
                        {
                            "name": "START_TIME"
                        }
                    ]
                },
                "link": []
            }
        ]
    }
}

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here