Get List by List GUID

Description

This service enables users to retrieve a list by the list GUID. 

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/(listguid)

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/a64a92fb-7eee-4ba8-98f9-a9baa826d14b

Sample Header:

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

Sample Response

{
    "list": {
        "listGuid": "a64a92fb-7eee-4ba8-98f9-a9baa826d14b",
        "name": "John's List",
        "listType": "W",
        "defaultList": true,
        "onSaleNotify": false,
        "searchable": false,
        "numberOfItems": 2,
        "showPurchaseInfo": true,
        "createdDate": "2015-03-19 18:02:10.900054",
        "lastModified": "2015-03-19 18:02:10.900054",
        "links": [
            {
                "rel": "user",
                "ref": "http://api.macys.com/customer/v1/users/userdetails/getuser?userid=9190455504"
            },
            {
                "rel": "self",
                "ref": "http://api.macys.com/customer/v1/lists?userid=9190455504"
            },
            {
                "rel": "items",
                "ref": "http://api.macys.com/customer/v1/lists/a64a92fb-7eee-4ba8-98f9-a9baa826d14b?_expand=items"
            }
        ]
    }
}

back to top

cURL Example

curl -X GET -H "X-Macys-Webservice-Client-ID: XXXXXXXXXX" -H "Accept: application/json" "http://api.macys.com/customer/v1/lists/a64a92fb-7eee-4ba8-98f9-a9baa826d14b"

Error Codes

Call Specific Error Codes

• Error Code: 100122 Error Message : Invalid list guid
• Error Code: 100104 Error Message : List type not supported
• Error Code: 100109 Error Message : Invalid sort order value. Valid values are asc/desc
• Error Code: 100108 Error Message : Unsupported sort by value
• Error Code: 100129 Error Message : Invalid expand option
• Error Code: 100130 Error Message : Invalid fields option

General Error Handling Documentation:

Click Here

back to top