• Register

Retrieve by Name

Description

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

back to top

HTTP Method and Request URL

GET

https://api.bloomingdales.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. mandatory Accept:application/json
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. Go to http://developer.bloomingdales.com/apps/mykeys for a list of your API keys. mandatory x-macys-webservice-client-id:1y5hsssd9h9pkk5efjt362cj
Query Parameters
Parameter Description Mandatory Sample Value
firstName First Name of Registrant or Co-Registrant        
mandatory Mary
lastName Last Name of Registrant or Co-Registrant mandatory Jones
eventMonth Month of Registry Event (integer) optional 3
eventYear Year of Registry Event (integer) optional 2012
registryType Default to WEDDING optional 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. optional magicofbloomingdalesapi

back to top

Sample Requests and Responses

Sample Request

GET

http://api.bloomingdales.com/v2/registry/by-name?firstName=Mary&lastName=Jones&eventMonth=3&eventYear=2012&registryType=WEDDING&callback=<CALLBACK_FUNCTION>

Sample Response - JSON

[{
    "coRegistrantContactInfo": {
        "lastName": "Smith",
        "firstname": "David"
    },
    "registryInfo": {
        "registryId": "6140600",
        "eventDate": "2014-07-04T00:00:00-04:00",
        "registryType": "WEDDING"
    },
    "registrantContactInfo": {
        "lastName": "Smith",
        "firstname": "Patti"
    }
}, {
    "coRegistrantContactInfo": {
        "lastName": "Smith",
        "firstname": "David"
    },
    "registryInfo": {
        "registryId": "6151149",
        "eventDate": "2014-06-17T00:00:00-04:00",
        "eventLocationStateName": "California",
        "registryType": "WEDDING"
    },
    "registrantContactInfo": {
        "lastName": "Khamneipur",
        "firstname": "Sanam"
    }
}, {
    "coRegistrantContactInfo": {
        "lastName": "Smith",
        "firstname": "David"
    },
    "registryInfo": {
        "registryId": "32313",
        "eventDate": "2013-08-18T00:00:00-04:00",
        "registryType": "WEDDING"
    },
    "registrantContactInfo": {
        "lastName": "Adams",
        "firstname": "Haley"
    }
}, {
    "coRegistrantContactInfo": {
        "lastName": "Smith",
        "firstname": "David"
    },
    "registryInfo": {
        "registryId": "419913",
        "eventDate": "2012-02-04T00:00:00-05:00",
        "registryType": "WEDDING"
    },
    "registrantContactInfo": {
        "lastName": "Spector",
        "firstname": "Kyley"
    }
}, {
    "coRegistrantContactInfo": {
        "lastName": "Smith",
        "firstname": "David"
    },
    "registryInfo": {
        "registryId": "2017866",
        "eventDate": "2014-05-24T00:00:00-04:00",
        "registryType": "WEDDING"
    },
    "registrantContactInfo": {
        "lastName": "Daley",
        "firstname": "Lauren"
    }
}]

back to top

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 11 as of 11 years ago by Damian Bennett

Docs Navigation