Get All Lists

Description

This service enables users to retrieve all a user's lists. 

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?userid=(userid)&default=false 

OR

http://api.macys.com/customer/v1/lists?userguid=(userguid)&default=false

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=1234&default=false

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

Sample Header:

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

Sample Response

{
    "list": {
        "listGuid": "241885ba-adc9-4503-96a9-58668ad68de4",
        "name": "John's Guest List",
        "listType": "W",
        "defaultList": true,
        "onSaleNotify": false,
        "searchable": false,
        "numberOfItems": 1,
        "showPurchaseInfo": true,
        "createdDate": "2015-08-31 15:44:29.317944",
        "lastModified": "2015-08-31 15:44:29.317944",
        "user": {
            "id": 1234,
            "guid": "6beadb27-8ee3-4394-a76c-757db7ac0dd2",
            "guestUser": false
        },
        "items": [
            {
                "itemGuid": "6330e4b4-decd-4b32-8f27-9fa92074dd29",
                "ItemId": 667952027,
                "retailPriceWhenAdded": 0,
                "qtyRequested": 1,
                "qtyStillNeeded": 0,
                "upc": {
                    "id": 1675059,
                    "upcNumber": 855329105154,
                    "price": {
                        "retailPrice": 0,
                        "originalPrice": 0,
                        "intermediateSalesValue": 0,
                        "salesValue": 0,
                        "onSale": false,
                        "priceType": 0,
                        "basePriceType": 0
                    },
                    "availability": {
                        "available": false
                    },
                    "product": {
                        "id": 381150,
                        "name": "Soprano Plus Size Short-Sleeve Smocked-Waist Dress",
                        "active": false
                    }
                }
            }
        ]
    }
}

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?userid=1234&default=false"

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