• Register

Create New List

Description

This service enables users to create a default wish list for a given user, if it does not previously exist, or creates a non-default list.

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

POST

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

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

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

application/json

application/xml
Content-type Specifies the format of body sent. Can be application/json or application/xml. Yes

application/json

application/xml
Request Body Parameters

Parameter Description Mandatory Sample Value

userid

ID of the user Yes, if userguid is not available See sample payload below
userguid Unique GUID for the user Yes, if userid is not available W

listType

 if the listType is null, "w" is set to the request Yes See sample payload below

name

Name of the list passed in the request body

 Yes See sample payload below

 

back to top

 

Sample Requests and Responses

Sample Request

 

Request URL:

POST

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

Sample Header:

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

Request Body(Payload)

{
"list": {
"listType": "w",
"name": "John Doe",
"user": { "id": "2186811747" }
}
}

OR

 

{
"list": {
"listType": "w",
"name": "John Doe",
"user": { "guid": "e49ae465-f787-4fcd-9976-5d054d830c1d" }
}
}

 

Sample Response

{
    "list": {
        "listGuid": "5a01b200-7a26-424b-9471-bacaa68a5333",
        "name": "John Doe",
        "listType": "W",
        "defaultList": true,
        "onSaleNotify": false,
        "searchable": false,
        "user": {
            "id": 10130820900,
            "guid": "e49ae465-f787-4fcd-9976-5d054d830c1d",
            "guestUser": false
        }
    }
}

 

Error Codes

Call Specific Error Codes:

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

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

  • Error Code: 10105 Error Message : Invalid list type

  • Error Code: 100113 Error Message : Item details missing

  • Error Code: 100114 Error Message : Upc details missing

  • Error Code: 100115 Error Message : Item qty details missing

  • Error Code: 100116 Error Message : Adding Mulitple items in single call not supported

  • Error Code: 100117 Error Message : Invalid User

 

General Error Handling Documentation:

Click Here

back to top

version 13 as of 9 years ago by Unknown

Docs Navigation