• Register

Store Offers (Non-Protected)

Description

This API is built to provide offers for users that are available in a specific store.

HTTP Method and Request URL

GET

http://api.bloomingdales.com/order/v2/promotions/storeoffers?storeNumber=[store#]&userGuid=[GUID]

Path and Query Parameters

 

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

Accept

Specifies the output format. Can be application/json or application/xml.

Yes

application/json

application/xml

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. 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

Query Parameters

Parameter

Description

Mandatory

Sample Value

storeNumber

Number for the selected store

 no 22
userGuid GUID for the user
 no

9405d016-1575-490e-b4b9-495bf1d50f13

back to top

Sample Request and Response

Sample Request

Request URL:

GET

 http://api.bloomingdales.com/order/v2/promotions/storeoffers?storeNumber=22&userGuid=9405d016-1575-490e-b4b9-495bf1d50f13

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
  "offer": {
    "storeNumber": 22,
    "userGuid": "9405d016-1575-490e-b4b9-495bf1d50f13",
    "eligibleOffers": [
      {
        "expiringOn": "12/31/9999 12:00:00 AM ",
        "startsOn": "03/10/2015 12:00:00 AM ",
        "title": "Free Shipping for Loyallists",
        "description": "Loyallists get free shipping on online orders!",
        "disclaimer": "Loyallists receive free standard shipping on online orders placed as of February 18, 2014. Purchases must be shipped to a single U.S. address. No adjustments to prior purchases. Offer excludes Gift Cards, Furniture and Mattresses. Must pay with a Bloomingdale's card or use a Loyallist ID. In-store free shipping offer only applies to merchandise that is not available in the store where the order is placed, but is available at another Bloomingdale's Department Store location. Additional delivery charges may apply in-store. Not valid in Bloomingdale's the Outlet Stores. Free standard shipping every day on online orders of $150 or more. Not valid when shipping to multiple addresses. No adjustments to prior purchases. Offer excludes Gift Cards, Furniture, and Mattresses. Not valid in Bloomingdale's stores or Bloomingdale's The Outlet stores. Valid only when shipping within the U.S. Delivery charges may apply in store. See a sales associate for details.",
        "category": "GLOBAL_LOYALLIST",
        "categoryRank": 1,
        "dateRank": 1,
        "savingsPassURL": "http://www1.bloomingdales.com/shop/womens-apparel/new-arrivals?id=1001037",
        "fob": "Loyallist",
        "promotionId": 3341,
        "discountValue": 0,
        "discountType": "Deals"
      },
      {
        "expiringOn": "12/31/9999 12:00:00 AM ",
        "startsOn": "02/29/2016 12:00:00 AM ",
        "title": "FREE SHIPPING ON ORDERS OF $150+ & FREE RETURNS",
        "description": "Free standard shipping every day on online orders of $150 or more, and free returns.",
        "disclaimer": "Free standard shipping every day on online orders of $150+ or beauty orders of $50+. No adjustments to prior purchases. Offer excludes Gift Cards, Furniture, and Mattresses. Not valid in Bloomingdale's stores or Bloomingdale's The Outlet stores. Valid only when shipping within the U.S. Delivery charges may apply in store. See a sales associate for details.

 Free returns every day on online orders. You have 365 days to return from the shipment date. Items must be in saleable condition. Some departments, such as dresses, have special return policies. Offer excludes gift cards, furniture, mattresses, mirrors, lamps, wall art and Michael Aram 25th Anniversary Sculptures. Only valid when shipping within the U.S. No adjustments to prior purchases. ",
        "category": "GLOBAL",
        "categoryRank": 2,
        "dateRank": 2,
        "savingsPassURL": "http://www1.bloomingdales.com/shop/womens-apparel/new-arrivals?id=1001037",
        "fob": "Sitewide",
        "promotionId": 4601,
        "discountValue": 0,
        "discountType": "Deals"
      }
    ]
  }
}

back to top

cURL Example

curl -X GET -H "X-Macys-Webservice-Client-ID: XXXXXXXXXX" -H "Accept: application/json" "http://api.bloomingdales.com/order/v2/promotions/storeoffers?storeNumber=22&userGuid=9405d016-1575-490e-b4b9-495bf1d50f13"

back to top

Error Codes

Call Specific Error Codes:

HTTP Status Error Codes Description
400

{

"errors": {
"error": [
{
"requestId": "xxxxxxxxxx",
"clientId": "xxxxx",
"errorCode": "02016",
"message": "Could not extract a value for the parameter 'storeNumber'",
"developerMessage": "Caused by org.glassfish.jersey.server.internal.inject.ExtractorExce…"
}
]
}
}
  • Store number is in incorrect format
  • If store number was sourced from stores API
    1. Check if store is setup with incorrect division ID
    2. Check if MST DB contains the store
400

{

"errors": {
"error": [
{
"requestId": "xxxxxxxxxx",
"clientId": "xxxxx",
"errorCode": "13017",
"message": "UYC_OFFER_UNAVAILABLE",
"developerMessage": "Unable to retrieve/validate UYC data from smartPE service"
}
]
}
}
  • smartPE is down & the backend is unable to retrieve UYC info
400

{

"errors": {
"error": [
{
"requestId": "xxxxxxxxxx",
"clientId": "xxxxx",
"errorCode": "13018",
"message": "LOYALTY_OFFER_UNAVAILABLE",
"developerMessage": "For a signed-in BCOM user, unable to retrieve targeted loyalist offers from loyalty service"

}
]
}
}
  • Loyalty API unavailable
400

{

"errors": {
"error": [
{
"requestId": "xxxxxxxxxx",
"clientId": "xxxxx",
"errorCode": "13016",
"message": "INVALID_USER",
"developerMessage": "The user GUID has wrong format or user is not in the system"

}
]
}
}
  • User GUID in incorrect format

General Error Handling Documentation:

Click Here

back to top

version 5 as of 8 years ago by Gaku Kelliher

Docs Navigation