Review v1 Questions

Description

Returns all customers' questions for the specified product and the corresponding answers.

HTTP Method and Request URL

GET

http://api.macys.com/review/v1/questions?prodId=[productId]&_fields=[fields]&_offset=[offset]&_limit=[limit]&_sortby=[columnname]&_sortorder=[order]&moderationStatus=[status]

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

prodId

Product id to get reviews for. 
NOTE: Multiple product IDs are not supported.

yes 828
_fields
Expression of what fields should be returned. 
Syntax: field-name-1,field-name-2,...,complex-field-name-1(sub-field-name-1,...),...
no

questionDetails,answers(userId)

_offset

Part of pagination mechanism. Specifies the offset to count the records from.

For correct pagination through all the records it's best to use "next" link which is given in the response of request

no

1

_limit Part of pagination mechanism. Specifies the page size. no

8

_sortby Part of the ordering mechanism. Specifies the column to sort by. Currently, the only possible value is submissionTime
no

submissionTime

_sortorder It's a part of the ordering mechanism. Specifies the sorting order. 
Only ASCENDING and DESCENDING values are possible.
no

ASCENDING or DESCENDING

moderationStatus Specifies to filter reviews by moderation status. 
The value should be one of: NONE, SUBMITTED, APPROVED, HOLD, PENDING, REJECTED, REMOVEDBYCLIENT, REMOVEDTEST, AUTOMATEDHOLD, EXPIRED
no

SUBMITTED

back to top

Sample Request and Response

Sample Request

Request URL:

GET

http://api.macys.com/review/v1/questions?prodId=77589&_fields=id,userName,questionDetails,answers(userId,answerText)

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
  "questions": {
    "question": [
      {
        "id": 2090051,
        "userName": "Dustybucket",
        "questionDetails": "some other websites have it in a dull green calling it bay leaf green and that scares me. i really like this bright bay leaf green color that is featured here when i select bay leaf green for this 5 QT artisan stand mixer by Kitchen Aid and i want to make sure it will come in this really great looking Bay Leaf Green color. please let me know.\r\n Thank You.",
        "answers": [
          {
            "userId": "BRAND_ANSWERS_KitchenAidBrand",
            "answerText": "The Bay Leaf color is darker and has a high gloss finish than what is shown, it is not bright green."
          }
        ]
      },
      {
        "id": 2090032,
        "userName": "Dustybucket",
        "questionDetails": "i like this bright bay leaf Green color of this Kitchen Aid 5 QT Artisan Stand mixer on macys.com and i hope this is the true bright Bay Leaf Green color that it will come in. some other websites have it in such a dull green color and that scares me. i don't want it in a Dull green color posing as a bright Bay Leaf green color",
        "answers": [
          {
            "userId": "BRAND_ANSWERS_KitchenAidBrand",
            "answerText": "The Bay Leaf color is darker and has a high gloss finish than what is shown, it is not bright green."
          },
          {
            "userId": "BRAND_ANSWERS_KitchenAidBrand",
            "answerText": "The Bay Leaf Green pictured is the true Bay Leaf Green stand mixer."
          }
        ]
      },
      {
        "id": 144614,
        "userName": "jeanzboy",
        "questionDetails": "Is this heavy?",
        "answers": [
          {
            "userId": "7030086962",
            "answerText": "Nope. I lifted the very well packed mixer out of the box with no difficulty. It is well made and sturdy, but not particularly heavy"
          },
          {
            "userId": "875743041",
            "answerText": "YES"
          },
          {
            "userId": "6546057513",
            "answerText": "It has the proper weight to support the speeds and weight of the food in the bowl. It is easily carried from one area to the next."
          },
          {
            "userId": "6804216356",
            "answerText": "it is but its not something you would carry it goes on the counter and stays the parts are light"
          },
          {
            "userId": "7646905650",
            "answerText": "yes its pretty heavy."
          },
          {
            "userId": "6737860854",
            "answerText": "Hi jeanzboy,\n\nThis item is certainly heavier than a handmixer and needs to be lifted with 2 hands, but absolutely manageable!\n\nThanks for asking and buy away!! The maroon is gorgeous!"
          },
          {
            "userId": "2396265356",
            "answerText": "Yes it is, a good mixer will always be heavy, but it's lighter compare to the professional series"
          },
          {
            "userId": "7428428856",
            "answerText": "Very, but it needs the weight to counter the forces behind the dough being tossed around."
          },
          {
            "userId": "1670710538",
            "answerText": "I am a man and I think it is heavy--too heavy for me to keep putting away. So I leave it on the counter."
          },
          {
            "userId": "2551537794",
            "answerText": "No"
          },
          {
            "userId": "macys_christie_s",
            "answerText": "The weight of this product is 27.9 lbs."
          }
        ]
      }
    ],
    "link": [
      {
        "rel": "self",
        "ref": "http://32.83.67.26:80/api/review/v1/questions?sdpGrid=cellA&prodId=77589&_fields=id%2CuserName%2CquestionDetails%2Canswers%28userId%2CanswerText%29"
      }
    ]
  }
}

 

cURL Example

curl -X GET -H "X-Macys-Webservice-Client-ID: XXXXXXXXXX" -H "Accept: application/json" "http://api.macys.com/review/v1/questions?prodId=77589&_fields=id,userName,questionDetails,answers(userId,answerText)"

 

 

 

back to top

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top

Docs Navigation