Search Lists


This service enables users to find friends or other wishlists via search option using first name, last name and state fields 


back to top

HTTP Method and Request URL




back to top

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


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


Request Body Parameters

Parameter Description Mandatory Sample Value


The first name of the User Yes John
lastName The last name of the User Yes Smith
state The state in which the user resides No CA


back to top

Sample Requests and Responses

Sample Request

Request URL:



Sample Header:

X-Macys-Webservice-Client-Id: xmj9js4jkdpe198hu567
Accept: application/json
Content-type: application/json

Sample Response

	"lists": {
		"lists": [{
			"listGuid": "47e60011-6e52-46b9-b5e8-5da4a45897",
			"name": "John Smith's List",
			"listType": "W",
			"defaultList": false,
			"onSaleNotify": false,
			"searchable": true,
			"numberOfItems": 3,
			"lastModified": "2016-02-25 05:28:02.262832",
			"user": {
				"id": 2158536013,
				"profileAddress": {
					"firstName": "John",
					"lastName": "Smith",
					"state": "FL"
				"guestUser": false
			"listId": 1121032

back to top

Error Codes

Call Specific Error Codes:

  • Error Code: 10103 Error Message : Either user id or user guid missing or invalid

  • Error Code: 100104 Error Message : List type not supported

  • Error Code: 100105 Error Message : Invalid list type

  • Error Code: 100106 Error Message : Requested Functionality not supported currently

  • Error Code: 100108 Error Message : Unsupported sort by value

  • Error Code: 100109 Error Message : Invalid sort order value. Valid values are asc/desc

  • Error Code: 100110 Error Message : Unable to find upc/product info from fcc

  • Error Code: 100111 Error Message : Incorrect request

  • Error Code: 100117 Error Message : Invalid User


General Error Handling Documentation:

Click Here

back to top

Docs Navigation