Interactive API Console
Test Macy's API using our easy to use Interactive Console! You can also view more detailed written documentation . (Note: You must attain approval for an API key for one of the services in the drop-down menu below before being able to use the Macy's API Console.)
Please contact us if you are having trouble getting access to keys: Click Here
Select an API
Ad Media Services
Catalog Services
Bag Services
Promotion & Coupon Services
Registry Services
Store Services
Catalog Services give you access to the Macy's product line in a variety of ways:
Promotion & Coupon Services
Store Services give you access to the Macy's store information including in store availability of products:
GET
Category Index
v3/catalog/category/index
GET
Category Browse
v3/catalog/category/:categoryId
GET
Category Brand Index
v4/catalog/category/brandindex/:categoryId
GET
Category Browse Product
v3/catalog/category/:categoryId/browseproducts
GET
Product Index
v3/catalog/product/index
GET
Product Detail V3 (Using Product ID)
v3/catalog/product/:productId
GET
Product Detail V3 (Using UPC)
v3/catalog/product
GET
Product Detail V4 (Using Product ID)
v4/catalog/product/:productId
GET
Product Detail V4 (Using UPC ID)
v4/catalog/product/upc/:upcId
GET
Product Recommendations V4
v4/recommendations/product/:productId
GET
BOPS Product Availability (Using Product ID) V4
v4/catalog/bops/product/:productId
GET
BOPS Product Availability (Using UPC ID) V4
v4/catalog/bops/upc/:upcId
GET
Search Phrase
v4/catalog/search
GET
Reviews
v3/catalog/reviews
GET
Refresh Status
v3/job/refreshjobstatus
GET
Retrieve Bag
order/v1/bags
POST
Add to Bag
order/v1/bags
PATCH
Update Bag
order/v1/bags/:bagGuid/items
This service enables users update quantity of items that is already added to a shopping bag. It enables users edit multiple items with each request. Please click here for the additional documentation.
Request Body
{
"item":
{
"sequenceNumber":22,
"upcId": 185213,
"quantity": 2
}
}
{
"item":
{
"sequenceNumber":22,
"upcId": 185213,
"quantity": 2
}
}
DELETE
Delete Item from Bag
order/v1/bags/:bagGuid/items/:sequenceNumber
This service allows you to delete an item from the shopping bag. Please click here for the additional documentation.
Request Body
{
"deleteitemsrequest" :
{
"upcid":185213
}
}
{
"deleteitemsrequest" :
{
"upcid":185213
}
}
GET
Promotions
v2/promotions
This service allows to retrieve promotions. Please click here for the additional documentation.
GET
Promotions and Coupons
v3/promotions
This service allows to retrieve promotions, coupons, or both using one call. Please click here for the additional documentation.
GET
Promotions Sorted
v3/promotions/sorted
The Promotions Sorted API call allows the users to get Deals and Promotion data set grouped and sorted by FOB to match data rendered on website. Please click here for the additional documentation.
Parameter
Value
Type
Description
channel
SITE
MOBILE
string
Channel for the Promotion (Optional) Ex. SITE
POST
Promotions Share
v3/promotions/share
The Promotions Share API allows users to use a POST call to send automated emails to recipient(s) about MACY's Promotions or Coupons. Please click here for the additional documentation.
Parameter
Value
Type
Description
Request Body
{
"channel": "SITE",
"promoCode": "VETDAY",
"promoId": "431690",
"recipientEmailAddress": "linda.macysapi@macys.com",
"senderEmailAddress": "daniel.macysapi@macys.com",
"senderName": "Daniel",
"message": "Hey honey check out this promotion at Macy.com - Love Dad"
}
{
"channel": "SITE",
"promoCode": "VETDAY",
"promoId": "431690",
"recipientEmailAddress": "linda.macysapi@macys.com",
"senderEmailAddress": "daniel.macysapi@macys.com",
"senderName": "Daniel",
"message": "Hey honey check out this promotion at Macy.com - Love Dad"
}
GET
Coupons
v2/promotions/coupons
This service allows to retrieve coupons. Please click here for the additional documentation.
GET
Events
store/v1/events
GetStoreEvents Provides a list of events in store for a given Store and date range. The search can be made by the storeId, locationNumber, or storeNumber. Please click here for the additional documentation.
GET
Location (Using Location Number)
/store/v2/stores/:locationNumber
This service allows users to find store information based on Location Number. You can also request store availability information for products and upc's. Please click here for the additional documentation.
Parameter
Value
Type
Description
:locationNumber
int
Product ID of the product you would like to return recommendations for (Required) Ex. 73,63.
feature
string
Response will be filtered by support of specific features in store. You can return by multiple features by comma separating. Supported values: BOPS, BRIDAL, HAS_EVENTS, MATTRESS, FURNITURE_GALLERY,VISITOR_CENTER, PERSONAL_SHOPPER, RESTAURANT (Optional) Ex. BOPS,BRIDAL
_fields
string
Filter Parameter that allows you to return just the fields you would like in the response (Optional) Ex. features,address,inventories,mapUrl,phoneNumber
upcNumber
int
Provides instore availability of a specific UPC at the store(s) you query. (Optional) Ex. 50946872827
productId
int
Provides instore availability of a specific product at the store(s) you query (Optional) Ex. 77589
GET
Location
store/v2/stores
This service allows users to find store information based on 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. If no location query parameters are provided you will return all store information. Please click here for the additional documentation.
Parameter
Value
Type
Description
storeNumber
int
This is the MST Store Number ZL_STORE_NBR. You can return multiple store information by comma separating. (Optional) Ex. 428,49
searchAddress
string
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 (Optional) Ex. 680 Folsom St San Francisco CA
latitude
int
Stores look up by global coordinates. (Optional) Ex. 37.355965
longitude
int
Stores look up by global coordinates. (Optional) Ex. -122.01318
radius
string
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 (Optional)) Ex. M100
feature
string
Response will be filtered by support of specific features in store. You can return by multiple features by comma separating. Supported values: BOPS, BRIDAL, HAS_EVENTS, MATTRESS, FURNITURE_GALLERY,VISITOR_CENTER, PERSONAL_SHOPPER, RESTAURANT (Optional) Ex. BOPS,BRIDAL
_limit
int
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. (Optional) Ex. 5
_fields
string
Filter Parameter that allows you to return just the fields you would like in the response (Optional) Ex. features,address,inventories,mapUrl,phoneNumber
upcNumber
int
Provides instore availability of a specific UPC at the store(s) you query. (Optional) Ex. 50946872827
productId
int
Provides instore availability of a specific product at the store(s) you query (Optional) Ex. 77589