• Register

Address v1 Address

Description

The address API is used to perform validation on the address supplied by the client in the request. 

 

back to top

HTTP Method and Request URL

POST

https://api.macys.com/address/v1/address

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/xml

 

Request Body Parameters
Parameter Description Mandatory Sample Value
userId
  User id of the customer checking out No 54281 
orderNumber order number for the current order   No 1231
addressDOs  Container for the list of addresses Yes Array containing one or multiple addressDo
addressDO Container to hold the current address Yes
addressLine1 Address line 1 Yes 151 W 34th St
addressLine2 Address line 2 No  
city Address city  Yes New York
state Address state Yes NY
postalCode Adddress zip code Yes 10001
addressSequenceNumber Address sequence number in order to differentiate multiple addresses within the same request. Acceptable values are from 1 to 99. Yes 1

 

back to top

Sample Requests and Responses

Sample Request

Request URL:

POST

 https://api.macys.com/address/v1/address

Sample Header:

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

Request Body(Payload)

<address>
<userId>54281</userId>
<orderNumber>1231</orderNumber>
       <addressDOs>
               <addressDO>
                       <addressLine1>151 W 34th St</addressLine1>
                       <city>New York</city>
                       <state>NY</state>
                       <postalCode>10001</postalCode>
              	       <addressSequenceNumber>1</addressSequenceNumber>
               </addressDO>
       &lt;/addressDOs&gt;
</address>

Sample Response

{
    "address": {
        "userId": 54281,
        "addressDOs": [
            {
                "addressLine1": "151 W 34th St",
                "city": "New York",
                "postalCode": "10001",
                "state": "NY",
                "validatedFlag": true,
                "addressSequenceNumber": 1,
                "invalidAddressStatus": ""
            }
        ],
        "orderNumber": "1231",
        "authenticated": false
    }
}

back to top

Error Codes

Call Specific Error Codes:

 

General Error Handling Documentation:

Click Here

back to top

version 4 as of 7 years ago by Gaku Kelliher

Docs Navigation