User Hint Question V2
Description
This document covers the API information to retreive the security question associated with users profile.
HTTP Method and Request URL
GET
https://api.macys.com/v2/user/hintquestion
HTTP, 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 |
emailaddress |
the email address of the customer used to login to the website |
Yes | test123@macys.com |
callback | If sent, the format is JSONP (JSON with Padding) with the callback returned with the JSON response. You can put anything in the callback parameter and whatever you send is returned. | No |
magicofmacysapi |
Sample Requests and Responses
Sample Request
Request URL:
GET
https://api.macys.com/v2/user/hintquestion?emailaddress=user@gmail.com
HTTP Header:
x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Sample Response
{ success: true hintQuestion: "What was the name of your first pet?" userName: "email@macys.com" userId: 2156951897 }
Error Codes
Call Specific Error Codes:
ERROR CODE | DESCRIPTION |
UserProfileServiceProfileUserNameInputInvalidErrorCode |
If emailaddress is Empty/null |
UserProfileServiceUserNotFoundErrorCode |
If emailaddress is not in database |
USERNOTLOCKED |
If user is not Locked |
General Error Handling Documentation:
Docs Navigation
- Overview
- Customer Services
- Common API Characteristics
- Ad Media
- Catalog Services
- Order Services
- Mobile Utilities
- Promotion and Coupon Services
- Registry Services
- Review Services
- Store Services
- User Services
- Error Handling
- Deprecated Services
- Macy's API FAQ
- BOPS Stores
- What's New