• Register

Promotions Share

Description

The Promotions Share API allows users to us a POST call to send automated emails to recipient(s) about Bloomingdale's Promotions or Coupons.

HTTP Method and Request URL

POST

https://api.bloomingdales.com/v3/promotions/share
 

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. Go tohttp://developer.bloomingdales.com/apps/mykeys for a list of your API keys. Yes xmj9js4jkdpe1983fmwu98gh
Accept Detemines output format. Can be application/json or application/xml. Yes

application/json

application/xml
Content-Type Specifies the format of body sent. Can be application/json or application/xml. Yes

application/json

application/xml
Request Body Parameters
Parameter Description Mandatory Sample Value
promoId Promotion Id
 Yes, either promoId or couponId is required 431690
couponId Coupon filter number
 Yes, either promoId or couponId is required 431690
senderName Contains the sender name if entered by the user No Daniel
senderEmailAddress Email address of the sender Yes daniel.smith@bloomingdales.com
recipientEmailAddress Email address of the recipient(s), to send multiple seperate them with a comma
 Yes linda.smith@bloomingdales.com
message personal message for recipient(s) (Up to 2000 characters) No Check out this promotion at Macys.com
promo_code Promotion Code No VETDAY
channel The source for the call. Should default to SITE, if not, it takes the given parameter No SITE

back to top

Sample Requests and Responses

Sample Request

Request URL:

POST

https://api.bloomingdales.com/v3/promotions/share

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Content-Type: application/json

Sample Request Body:

{
"promoId":"431690",
"couponId":"431690",
"channel": "SITE",
"promoCode": "VETDAY",
"recipientEmailAddress": "linda.smith@bloomingdales.com,kathy.smith@macys.com",
"senderEmailAddress": "daniel.smith@bloomingdales.com",
"senderName": "Daniel"
"message": "Hey girls check out this promotion at Bloomingdales.com - Love Dad" 
}

 back to top

Sample Responses

Sucess:

{
-promoShareOfferResponse: {
success: true
      }

}

Failure:

{
-promoShareOfferResponse: {
success: false
      }

}

 

back to top

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top

version 9 as of 9 years ago by Gaku Kelliher

Docs Navigation