store v2 stores

Description

This service allows users to find store information based on location number or store number.  You can also return store information base on location specified in a variety of ways.  In addition you can request store availability information for products and upc's.

back to top

HTTP Method and Request URL

GET

http://api.macys.com/store/v2/stores/[locationNumber]?

GET

http://api.macys.com/store/v2/stores?storeNumber=[storeNumber]

 

back to top

Path and Query Parameters

HTTP Header Parameters
Parameter Description Mandatory Sample Value
Accept Detemines output format. Can be application/json or application/xml. Yes

application/json

application/xml

x-macys-webservice-client-id Pass the api key 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

Path Parameters

Parameter

Description

Mandatory

Sample Value

locationNumber

Location number for the store information being requested.You can return multiple storeinformation by comma separating.

No

73,63

 

Query Parameters

Parameter Description Mandatory Sample Value
storeNumber This is the MST Store Number ZL_STORE_NBR. You can return multiple storeinformation by comma separating. No 428,49

searchAddress

Input a string for this query parameter.  This can be a city state combo, a full address, a general area, or even a zip code No  680 Folsom St San Francisco CA

latitude

longitude

Query parameters that look up by global coordinates.  No latitude=37.355965&longitude=-122.01318
radius Radius (in miles) in which store should be located. Specified as Mnn e.g. M50.
if not specified is set to M200 by default.  Maximum radius is M200
No M100
feature Response will be filtered by support of specific features in store. Supported values:
  • BOPS - returns BOPS eligible stores only
  • BRIDAL - return stores with bridal attribute = TRUE
  • HAS_EVENTS - returns only stores with events
  • MATTRESS
  • FURNITURE_GALLERY,
  • VISITOR_CENTER,
  • PERSONAL_SHOPPER,
  • RESTAURANT
No BOPS
_limit Filter the number of stores being returned. By default we return all the stores in a 200 mile radius unless the radius is defined to be less. No 5
_fields  Filter Parameter that allows you to return just the fields you would like in the response No name,address
upcNumber Provides instore availability of a specific UPC at the store(s) you query No 50946872827
productId Provides instore availability of a specific product at the store(s) you query No  77589

back to top

URL Examples:

http://api.macys.com/store/v2/stores (Returns all Store information)

http://api.macys.com/store/v2/stores/73,63  (Returns Store information for locationNumber 73 and63)

http://api.macys.com/store/v2/stores?storeNumber=428,49 (Returns Store information for storeNumber 428 and 49)

http://api.macys.com/store/v2/stores?searchAddress=680 Folsom St. San Francisco CA 94107&radius=M100 (Returns store information all stores near address provided in a 100 mile radius)

http://api.macys.com/store/v2/stores?searchAddress=94107 (Returns store information for all stores near zip code 94107)

http://api.macys.com/store/v2/stores?searchAddress=San Francisco CA (Returns store information for stores near city and state San Francisco, CA)

http://api.macys.com/store/v2/stores?searchAddress=San Francisco Bay Area (Returns store information for stores in the San Francisco bay area)

http://api.macys.com/store/v2/stores?latitude=37.355965&longitude=-122.01318&_limit=10 (Returns store information for the Lat/Long specified. Only information for 10 stores will be returned)

http://api.macys.com/store/v2/stores?searchAddress=94107&upcNumber=50875809918 (Returns a availability of product (upc: 50875809918) within a 200 mile radius of zip code 94107)

 

 

Sample Requests and Responses

Sample Request

Request URL:

GET

http://api.macys.com/store/v2/stores?searchAddress=94107&upcNumber=50946872827&_limit=1&_fields=features,address,inventories,mapUrl,phoneNumber

HTTP Headers:

x-macys-webservice-client-idxmj9js4jkdpe1983fmwu98gh 

Accept:application/json

Sample Response

 

{
    "stores": {
        "store": [
            {
                "address": {
                    "id": 212,
                    "line1": "170 O'Farrell Street",
                    "line2": "",
                    "line3": "",
                    "city": "San Francisco",
                    "state": "CA",
                    "zipCode": "94102-2202",
                    "countryCode": "USA "
                },
                "schedule": {},
                "features": {
                    "feature": [
                        "PERSONAL_SHOPPER",
                        "VISITOR_CENTER",
                        "RESTAURANT",
                        "BRIDAL",
                        "FURNITURE_GALLERY",
                        "MATTRESS",
                        "BOPS",
                        "HAS_EVENTS"
                    ]
                },
                "mapUrl": "http://maps.googleapis.com/maps/api/staticmap?format=JPEG&zoom=14&size=400x400&sensor=false&markers=icon:http://www.macys.com/dyn_img/google_maps/no_letter_red_icon_2.png%7C37.7868326,%20-122.4074627&client=gme-macysinc&signature=kYeCMtr_Jf2-hvIpBhnWMCqcdbs%3D",
                "geoLocation": {},
                "inventories": {
                    "inventory": [
                        {
                            "upcNumber": 50946872827,
                            "storeInventory": {
                                "bopsAvailability": "AVAILABLE",
                                "storeAvailability": "AVAILABLE",
                                "bopsEligibility": "ELIGIBLE"
                            }
                        }
                    ]
                },
                "phoneNumber": "415-397-3333",
                "link": []
            }
        ]
    }
}

back to top

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top

Docs Navigation