• Register

Get Registry by Name (GVR) V2

Description

This service returns a registry when a request is made by name.            

back to top

HTTP Method and Request URL

GET

https://api.macys.com/v2/registry/by-name?firstName=firstName&lastName=lastName&eventMonth=eventMonth&eventYear=eventYear&RegistryType=registryType&callback=callback

back to top

Path and Query Parameters

HTTP Header Parameters

Parameter Description Mandatory Sample Value
Accept Specifies the output format. Can be application/json or application/xml. Yes

application/json

application/xml
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. You can find your keys by going to http://developer.macys.com/apps/mykeys

 Yes xmj9js4jkdpe1983fmwu98gh

Query Parameters

Parameter Description Mandatory Sample Value
firstName First Name of Registrant or Co-Registrant        
Yes David
lastName Last Name of Registrant or Co-Registrant Yes Smith
eventYear Year of Registry Event (integer)
No (Only needed if you choose to also query by month)
 2013
eventMonth Month of Registry Event (integer) No (Can not be specified unless eventYear of registy specified)
 3
registryType Default to WEDDING No
 WEDDING
callback If sent, the format is JSONP (JSON with Padding) with the callback returned with the JSON response. You can put anything in the callback parameter and whatever you send is returned.  No magicofmacysapi

 

back to top

Sample Request and Response

Sample Request


Request URL:

GET

https://api.macys.com/v2/registry/by-name?firstName=David&lastName=Smith&eventYear=2013&eventMonth=8&registryType=WEDDING

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

[
    {
        "coRegistrantContactInfo": {
            "lastName": "Smith",
            "firstname": "David"
        },
        "registryInfo": {
            "registryId": "2001152",
            "eventDate": "2013-08-03T00:00:00-04:00",
            "eventLocationStateName": "New Jersey",
            "registryType": "WEDDING"
        },
        "registrantContactInfo": {
            "lastName": "Majoros",
            "firstname": "Elizabeth"
        }
    },
    {
        "coRegistrantContactInfo": {
            "lastName": "Smith",
            "firstname": "David"
        },
        "registryInfo": {
            "registryId": "2055190",
            "eventDate": "2013-08-31T00:00:00-04:00",
            "eventLocationStateName": "California",
            "registryType": "WEDDING"
        },
        "registrantContactInfo": {
            "lastName": "Araujo",
            "firstname": "Paula"
        }
    }
]

 

back to top

Error Codes

Call Specific Error Codes:

Error Code
 Description
INVALID_REGISTRY_REQUEST_INFO 1.  InputDTO is null.
2. First Name for search critieria is missing.
3. Last Name for search critieria is missing.
NO_REGISTRY No matching records found for the search criteria given.
SEARCH_RESULT_EXCEED Too many matching records found for the search critieria.

General Error Handling Documentation:

Click Here

back to top

version 95 as of 9 years ago by Unknown

Docs Navigation