Get Default List

Description

This service enables users to retrieve a default list. This particular call is for unauthenticated (guest) users.

NOTE: If no user or list is specified when adding an item, a guest list is created. To merge your guest list to an authenticated user, please follow merge list.

back to top

HTTP Method and Request URL

GET

http://api.macys.com/customer/v1/lists

back to top

HTTP, Path and Query Parameters

HTTP Header Parameters

back to top

Sample Requests and Responses

Sample Request

Request URL:

GET

http://api.macys.com/customer/v1/lists?userid=9190455502

http://api.macys.com/customer/v1/lists?userguid=4f212734-34bd-493c-89e9-20a178405b40

Sample Header:

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

Sample Response

{
    "lists": {
        "lists": [
            {
                "listGuid": "a64a92fb-7eee-4ba8-97f9-a9baa826d14b",
                "name": "John Doe's List",
                "defaultList": true,
                "onSaleNotify": false,
                "searchable": false,
                "numberOfItems": 0,
                "filterResultItem": 0,
                "showPurchaseInfo": true,
                "createdDate": "2015-03-19 18:02:10.900054",
                "lastModified": "2015-03-19 18:02:10.900054",
                "links": [
                    {
                        "rel": "user",
                        "ref": "http://32.83.67.26/api/customer/v1/users/guestUser?userGuid=4f212734-34bd-493c-89e9-20a178405b41"
                    },
                    {
                        "rel": "SELF",
                        "ref": "http://32.83.67.26/api/customer/v1/users/guestUser?userGuid=4f212734-34bd-493c-89e9-20a178405b41"
                    }
                ],
                "user": {
                    "id": 9190455502,
                    "guid": "4f212734-34bd-493c-89e9-20a178405b40",
                    "profileAddress": {
                        "firstName": "John",
                        "lastName": "Doe",
                        "state": "CA"
                    },
                    "passwordSplashScreenEnabled": false,
                    "guestUser": false
                }
            }
        ]
    }
}

cURL Example

curl -X GET -H "X-Macys-Webservice-Client-Id: xxxxxxxxx" -H "Accept: application/json" -H "http://api.macys.com/customer/v1/lists?userguid=4f212734-34bd-493c-89e9-20a178405b40"

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