Retrieve by ID

Description

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

back to top

HTTP Method and Request URL

GET

https://api.bloomingdales.com/v2/registry/by-id/registryID?type=GVR&calllback=callback

GET

https://api.bloomingdales.com/v2/registry?type=GVR|BVR&show=[bride,groom,shipping,items]&calllback=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.bloomindales.com/apps/mykeys for a list of your API keys. mandatory x-macys-webservice-client-id:1y5hsssd9h9pkk5efjt362cj
Path Parameters
Parameter Description Mandatory Sample Value
registryID (For GVR. BVR already has gotten it from user profile service) The unique identifier of this registry assigned when the registry was created.      
mandatory 234234239
Query Parameters
Parameter Description Mandatory Sample Value
GVR Specifies Guest's view. If GVR is chosen, none of the show parameters are allowed and minimal info will be sent.         Either GVR(guest) or BVR (Bride’s View) must be used Mary
BVR&show=

Specifies Bride’s View. If BVR is used, then at least one of the following show parameters must be provided:

  • show=bride
  • show=groom
  • show=shipping
  • show=items

You can issue several show parameters by separating them with commas, as foillows: show=shipping,items

Either GVR(guest) or BVR (Bride’s View) must be used BVR&show=shipping,items
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

Request URL:

GET

http://api.bloomindales.com/v2/registry/by-id/234234239?type=GVR&calllback=<CALLBACK_FUNCTION>

GET

http://api.bloomindales.com/v2/registry?type=BVR?show=basic,items&calllback=<CALLBACK_FUNCTION>

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json


Sample Response (GVR)

If optional Callback parameter included:
callbackstring(

If optional Callback parameter not included, start here:
{
    "name": "registryByGuestGetResponse", 
    "type": "object",
    "properties": [
	
	{
                    "name": "coRegistrantContactInfo",
                    "type": "object",
                    "properties": [
	    {
            "name": "lastName",
             "type": "string",
              "optional": false,
            "description": “last name of co-registrant”
        },
       {
            "name": "firstname",
             "type": "string",
             "optional": false,
            "description": “first name of co-registrant”
        }       
		]
	},
		
			
        {
                    "name": "registryInfo",
                    "type": "object",
                    "properties": [		
		
        {
            "name": "eventDate",
             "type": "calendar",
            "optional": false,
            "description": “Date of Marriage, Anniversary or Commitment”
        },
        {
            "name": "eventLocationStateName",
             "type": "string",
               "optional": false,
            "description": “State name of event location”
        },
        {
            "name": "registryType",
             "type": “string”
              "optional": false,
            "description": “WEDDING, COMMITTMENT, ANNIVERSARY (HOUSEWARMING not showing on website as yet)”
        },
        {
            "name": "couplesMessage",
             "type": “string”
             "optional": false,
            "description": “Couples Message to their family/friends visiting the registry site”
        }
       	]
		},
		
		
		{
                    "name": "registrantContactInfo",
                    "type": "object",
                    "properties": [
	    {
            "name": "lastName",
             "type": "string",
             "optional": false,
            "description": “last name of registrant”
        },
       {
            "name": "firstname",
             "type": "string",
              "optional": false,
            "description": “first name of registrant”
        }		
		]
		},
		{
            "name": "itemsMapper",
            "type": "array",
            "optional": true,
            "properties": [
			
		    {
                    "name": "lineItems",
                    "type": "object",
                    "properties": [
                         {
                            "name": "itmSeqNbr",
                            "type": "integer",
                            "description": "Sequence of the item shown in the list"
                        },
						   {
                            "name": "qtyRequested",
                            "type": " integer ",
                            "description": "On the website seen as -Would Love- Quantity
                        },
						   {
                            "name": "fulfilledQty",
                            "type": " integer ",
                            "description": "On the website seen as -Would Love- Quantity
                        },
						    {
                            "name": "manualQty",
                            "type": "integer",
                            "description": "Manual Quantity.  Should always be zero as this is a transaction field, i.e. I'm buying today this many but once trx done, that number will increment the fulfilledQty"
                        },
						     {
                            "name": "openToBuyQty",
                            "type": " integer ",
                            "description": "On the website seen as –Still Need- Quantity"
                        },
						 {
                            "name": "purchaserName",
                            "type": "string",
                            "optional": false,
                           "description": "Name of person who purchased this item."
                        },
                        {
                            "name": "purchaserComment",
                            "type": "string",
                             "optional": false,
                             "description": "Comment of person who purchased this item."
                        },
						       
                        {
                            "name": "patternDesc",
                            "type": "string",
                            "optional": true,
                             "description": "Pattern Description."
                        },
                     
                        {
                            "name": "BTL",
                            "type": "boolean",
                             "optional": false,
                             "description": “Boolean for Below the Line which means in store, not avail online”
                        },
                        {
                            "name": "upcID",
                            "type": "integer",
                            "description": "Actually the SKU number for this product"
                        },
						 {
                            "name": "upcNumber",
                            "type": "string",
                            "description": "Universal Product Code for this product"
                        },
						 {
                            "name": "upcRegisterable",
                            "type": "boolean",
                            "description": "Is this UPC able to be added to the Registry (e.g. kitchen,bedding is allowed but clothing is not) Other similar flags are prodRegisterable, notForWCSale, prodNotForRegistry. "
                        },
						   {
                            "name": "upcPrice",
                            "type": "double",
                             "description": “UPc Price of product”
                        },
						{
                            "name": "upcColor",
                            "type": "string",
                           "description": "Color of product"
                        },
						   {
                            "name": "upcSize",
                            "type": "string",
							    "minimum": 1, 
             	            "maxLength": 50,
                            "description": “Size of product”
                        },
						{
                            "name": "upcType",
                            "type": "string",
                           "description": “UPC Type of product”
                        },
							{
                            "name": "upcAvailabilityMessage",
                            "type": "string",
                            "description": “UPC Availability”
                        },
						{
                            "name": "upcNGF",
                            "type": "boolean",
                            "description": "UPC not going forward, not available after upcngfDate"
                        },
						{
                            "name": "upcAvailable",
                            "type": "boolean",
                            "description": "UPC Available"
                        },
						{
                            "name": "upcNGFDate",
                            "type": "string",
                            "description": "UPC NGF date"
                        },
						   {
                            "name": "categoryname",
                            "type": "string",
                             "description": "Name of the Category"
                        },
                        {
                            "name": "catSeqNbr",
                            "type": "integer",
                            "description": "Category Sequence Number"
                        },
                       {	
                            "name": "productId",
                            "type": "integer",
                            "description": "Unique id of the product"
                        },
						       {
                            "name": "productRegisterable",
                            "type": "boolean",
                             "description": "Is this Product able to be added to a registry. Other similar flags are notForWCSale, prodNotForRegistry, upcRegisterable "
                        },
						 {
                            "name": "productDescription",
                            "type": "string",
                            "description": "Product Description"
                        },
						 {
                            "name": "productThumbnail",
                            "type": "string",
                            "description": "Product Thumbnail"
                        },
                        {
                            "name": "productVendor",
                            "type": "string",
                           "description": "Name of Product Vendor"
                        },
							       {
                            "name": "productAvailable",
                            "type": "boolean",
                             "description": "Is this Product available for purchase"
                        },
                 
                      {
                            "name": "productName",
                            "type": "string",
                            "description": "Product Name"
                        },
                                           
                        {
                            "name": "productSalePrice",
                            "type": "double",
                             "description": “Sale Price of product. Duplicate of productSalesValue. One will be removed in later release ”
                        },
						{
                            "name": "productImageURL",
                            "type": "string",
                            "description": "Product Image URL"
                        },
					
						{
                            "name": "productGIFT_WRAPPABLE",
                            "type": "boolean",
                             "description": "Is this product able to be giftwrapped. Also good to check goGreen flag on RegistryDTO (no giftwrapping if goGreen Y)"
                        },
							{
                            "name": "productBULLET_TEXT",
                            "type": "List",
                            "description": "List of strings. Attributes of product"
                        },
							{
                            "name": "productWARRANTY_INFORMATION",
                            "type": "string",
                            "description": "Defaults to Request Warranty Information"
                        },
						   {
                            "name": "productOpenStockValue",
                            "type": "double",
                             "description": “Product Open Stock Value. Duplicate of productSalesPrice. One will be removed in later release”
                        },
						{
                            "name": "productGiftSetValue",
                            "type": "string",
							"minimum": 1, 
             	            "maxLength": 250,
                            "description": "Product Gift Set Value"
                        },
						{
                            "name": "productOnSale",
                            "type": "boolean",
                             "description": "Is this product on sale. Expect field productSalePrice should be populated if this is populated"
                        },
						{
                            "name": "productSaleValue",
                            "type": "double",
                             "description": “Sale Value of product. Similar to productSalePrice?”
                        },
						{
                            "name": "productPriceTypeId",
                            "type": "integer",
                             "description": “Product Price Type id”
                        },
						                       
						{
                            "name": "productDisplayCode",
                            "type": "string",
                            "description": "Product Display Code"
                        },
					    {
                            "name": "productIntermediateSaleValue",
                            "type": "double",
                             "description": “Intermediate Sale Value of product.”
                        },
						{
                            "name": "productWillBe",
                            "type": "boolean",
                             "description": "productWillBe"
                        },
						{
                            "name": "productBasePriceType",
                            "type": "integer",
                             "description": "Product Base Price Type"
                        },
						 {
                            "name": "productYourChoice",
                            "type": "double",
                             "description": “Product Your Choice.”
                        },					
						
                        {
                            "name": "productFindItInStore",
                            "type": "boolean",
                             "description": "Can find it in Store"
                        },
						  {
                            "name": "productNotForRegistry",
                            "type": "boolean",
                             "description": "Opposite productRegisterable and upcRegisterable. If Y, product should not be added to the registry. Related flags are prodRegisterable, notForWCSale, upcRegisterable "
                        },
						{
                            "name": "productDefaultCategoryId",
                            "type": "integer",
                            "description": "ProductDefaultCategory"
                        },
						{
                            "name": "productNotForWCSale",
                            "type": "boolean",
                            "description": "product not for WC Sale (wedding channel) The item cannot be added to the Bag(purchased on the registry website)"
                        },
						{
                            "name": "productValidParentCategoryId",
                            "type": "string",
                            "description": "product valid parent category id "
                        }
						
                    ]
            }
		  ]
		}	  
	]
	}
If callback:
)

Sample Response (BVR)

If optional Callback parameter included:
callbackstring(

If optional Callback parameter not included, start here:
{
    "name": "registrybyIdBrideGetResponse",
    "type": "object",
    "properties": [
	
	{
                    "name": "coRegistrantContactInfo",
                    "type": "object",
                    "properties": [
	    {
            "name": "nickName",
              "type": "string",
            "optional": true,
            "description": “nickname of co-registrant”
        },
    {
            "name": "contactId",
              "type": "string",
             "description": “Id of this co-registrant”
        },
        {
            "name": "emailAddress",
              "type": "string",
            "optional": false,
            "description": “email of co-registrant”
        },
		
        {
            "name": "attention",
              "type": "string",
            "optional": true,
            "description": “attention to for co-registrant”
        },
	{
            "name": "bestPhone",
             "type": "string",
            "optional": false,
            "description": “best phone number for co-registrant”
        },
        {
            "name": "lastName",
             "type": "string",
            "optional": false,
            "description": “last name of co-registrant”
        },
       {
            "name": "firstname",
             "type": "string",
            "optional": false,
            "description": “first name of co-registrant”
        },
        {
            "name": "middlename",
             "type": "string",
            "optional": true,
            "description": “middle name of co-registrant”
        },
        {
            "name": "namePrefix",
             "type": "string",
            "optional": true,
            "description": “name prefix for co-registrant”
        },
        {
            "name": "nameSuffix",
             "type": "string",
            "optional": true,
            "description": “name suffix for co-registrant”
        },
		
		{
                    "name": "currentAddress",
                    "type": "object",
                    "properties": [
		
		
        {
            "name": "addressLine1",
             "type": "string",
            "optional": false,
            "description": “address line 1 for co-registrant”
        },
        {
            "name": "addressLine2",
             "type": "string",
            "optional": false,
            "description": “address line 2 for co-registrant”
        },
        {
            "name": "addressLine3",
             "type": "string",
            "optional": true,
            "description": “address line 3 for co-registrant”
        },
        {
            "name": "state",
             "type": "string",
             "optional": false,
            "description": “state for co-registrant”
        },

        {
            "name": "city",
             "type": "string",
            "optional": false,
            "description": “city  for co-registrant”
        },
        {
            "name": "postal code",
             "type": "string",
            "optional": false,
            "description": “zip for co-registrant”
        },
        {
            "name": "country",
             "type": "string",
            "optional": false,
            "description": “country for co-registrant”
        },
		 {
            "name": "addressId",
             "type": "string",
            "optional": true,
            "description": “address Id”
        }
		]
		},
		
		]
	},
		{
            "name": "coRegistrantAddressFromRegistrant",
             "type": "boolean",
            "optional": true,
            "description": “Did the Registrant give us the Co-Registrant Info”
        },
		
        {
            "name": "shippingAttention",
             "type": "string",
            "optional": true,
            "description": “attention for shipping address”
        },
		{
                    "name": "shippingAddress",
                    "type": "object",
                    "properties": [

        {
            "name": "addressLine1",
             "type": "string",
            "optional": false,
            "description": “address line 1 for shipping address”
        },
        {
            "name": "addressLine2",
             "type": "string",
            "optional": false,
            "description": “address line 2 for  shipping address”
        },
        {
            "name": "addressLine3",
             "type": "string",
            "optional": true,
            "description": “address line 3 for shipping address”
        },
        {
            "name": "state",
             "type": "string",
            "optional": false,
            "description": “state for future shipping address”
        },

        {
            "name": "city",
             "type": "string",
            "optional": false,
            "description": “city  for shipping address”
        },
        {
            "name": "postalCode",
             "type": "string",
            "optional": false,
            "description": “zip for future shipping address”
        },
	    {
            "name": "country",
             "type": "string",
            "optional": false,
            "description": “country for shipping address”
        },
		 {
            "name": "addressId",
             "type": "string",
            "optional": true,
            "description": “address Id”
        }
		]
	    },
		{
            "name": "isFutureAddress",
             "type": "boolean",
             "description": “States there is a future addrees for whomever is set below for futureShippingAddressSource" 
        },
		
		{
            "name": "futureShippingAddressEffectiveDate",
             "type": "calendar",
             "description": “Effective date of the future shipping address below”
        },	
		
		{
            "name": "futureShippingAddress",
            "type": "object",
            "properties": [
        {
            "name": "addressLine1",
            "type": "string",
            "optional": false,
            "description": “address line 1 for future shipping address”
        },
        {
            "name": "addressLine2",
             "type": "string",
            "optional": false,
            "description": “address line 2 for future shipping address”
        },
        {
            "name": "addressLine3",
             "type": "string",
            "optional": true,
            "description": “address line 3 for future shipping address”
        },
        {
            "name": "state",
             "type": "string",
            "optional": false,
            "description": “state for future shipping address”
        },

        {
            "name": "city",
             "type": "string",
            "optional": false,
            "description": “city  for future shipping address”
        },
        {
            "name": "postal code",
             "type": "string",
            "optional": false,
            "description": “zip for future shipping address”
        },
        {
            "name": "country",
             "type": "string",
            "optional": false,
            "description": “country for future shipping address”
        }
		]
		},
		{
            "name": "itemsMapper",
            "type": "array",
            "optional": true,
            "properties": [
                   
                {
                    "name": "lineItems",
                    "type": "object",
                    "properties": [
                        {
                            "name": "itmSeqNbr",
                            "type": "integer",
                            "description": "Sequence of the item shown in the list"
                        },
						   {
                            "name": "qtyRequested",
                            "type": " integer ",
                            "description": "On the website seen as -Would Love- Quantity
                        },
						   {
                            "name": "fulfilledQty",
                            "type": " integer ",
                            "description": "On the website seen as -Would Love- Quantity
                        },
						    {
                            "name": "manualQty",
                            "type": "integer",
                            "description": "Manual Quantity-   Should always be zero as this is a transaction field, i.e. I'm buying today this many but once trx done, that number will increment the fulfilledQty""
                        },
						     {
                            "name": "openToBuyQty",
                            "type": " integer ",
                            "description": "On the website seen as –Still Need- Quantity"
                        },
						 {
                            "name": "purchaserName",
                            "type": "string",
                           "optional": false,
                           "description": "Name of person who purchased this item."
                        },
                        {
                            "name": "purchaserComment",
                            "type": "string",
                            "optional": false,
                             "description": "Comment of person who purchased this item."
                        },
						       
                        {
                            "name": "patternDesc",
                            "type": "string",
                       "optional": true,
                             "description": "Pattern Description."
                        },
                     
                        {
                            "name": "BTL",
                            "type": "boolean",
                             "optional": false,
                             "description": “Boolean for Below the Line which means in store, not avail online””
                        },
                        {
                            "name": "upcID",
                            "type": "integer",
                            "description": "Actually the SKU number for this product"
                        },
						 {
                            "name": "upcNumber",
                            "type": "string",
                            "description": "Universal Product Code for this product"
                        },
						 {
                            "name": "upcRegisterable",
                            "type": "boolean",
                            "description": "Is this UPC able to be added to the Registry (e.g. kitchen,bedding is allowed but clothing is not) Other similar flags are prodRegisterable, notForWCSale, prodNotForRegistry. "
                        },
						   {
                            "name": "upcPrice",
                            "type": "double",
                             "description": “UPc Price of product”
                        },
						{
                            "name": "upcColor",
                            "type": "string",
                           "description": "Color of product"
                        },
						   {
                            "name": "upcSize",
                            "type": "string",
                            "description": “Size of product”
                        },
						{
                            "name": "upcType",
                            "type": "string",
                            "description": “UPC Type of product”
                        },
							{
                            "name": "upcAvailabilityMessage",
                            "type": "string",
                            "description": “UPC Availability”
                        },
						{
                            "name": "upcNGF",
                            "type": "boolean",
                            "description": "UPC not going forward, not available after upcngfDate"
                        },
						{
                            "name": "upcAvailable",
                            "type": "boolean",
                            "description": "UPC Available"
                        },
						{
                            "name": "upcNGFDate",
                            "type": "string",
                            "description": "UPC NGF date"
                        },
						   {
                            "name": "categoryname",
                            "type": "string",
                             "description": "Name of the Category"
                        },
                        {
                            "name": "catSeqNbr",
                            "type": "integer",
                            "description": "Category Sequence Number"
                        },
                       {	
                            "name": "productId",
                            "type": "integer",
                            "description": "Unique id of the product"
                        },
						       {
                            "name": "productRegisterable",
                            "type": "boolean",
                             "description": "Is this Product able to be added to a registry. Other similar flags are notForWCSale, prodNotForRegistry, upcRegisterable "
                        },
						 {
                            "name": "productDescription",
                            "type": "string",
                            "description": "Product Description"
                        },
						 {
                            "name": "productThumbnail",
                            "type": "string",
                            "description": "Product Thumbnail"
                        },
                        {
                            "name": "productVendor",
                            "type": "string",
                           "description": "Name of Product Vendor"
                        },
							       {
                            "name": "productAvailable",
                            "type": "boolean",
                             "description": "Is this Product available for purchase"
                        },
                 
                      {
                            "name": "productName",
                            "type": "string",
                            "description": "Product Name"
                        },
                                           
                        {
                            "name": "productSalePrice",
                            "type": "double",
                             "description": “Sale Price of product. Duplicate of productSalesValue. One will be removed in later release ”
                        },
						{
                            "name": "productImageURL",
                            "type": "string",
                            "description": "Product Image URL"
                        },
					
						{
                            "name": "productGIFT_WRAPPABLE",
                            "type": "boolean",
                             "description": "Is this product able to be giftwrapped. Also good to check goGreen flag on RegistryDTO (no giftwrapping if goGreen Y)"
                        },
							{
                            "name": "productBULLET_TEXT",
                            "type": "List",
                            "description": "List of strings. Attributes of product"
                        },
							{
                            "name": "productWARRANTY_INFORMATION",
                            "type": "string",
                            "description": "Defaults to Request Warranty Information"
                        },
						   {
                            "name": "productOpenStockValue",
                            "type": "double",
                             "description": “Product Open Stock Value. Duplicate of productSalesPrice. One will be removed in later release”
                        },
						{
                            "name": "productGiftSetValue",
                            "type": "string",
                            "description": "Product Gift Set Value"
                        },
						{
                            "name": "productOnSale",
                            "type": "boolean",
                             "description": "Is this product on sale. Expect field productSalePrice should be populated if this is populated"
                        },
						{
                            "name": "productSaleValue",
                            "type": "double",
                             "description": “Sale Value of product. Similar to productSalePrice?”
                        },
						{
                            "name": "productPriceTypeId",
                            "type": "integer",
                             "description": “Product Price Type id”
                        },
						                       
						{
                            "name": "productDisplayCode",
                            "type": "string",
                            "description": "Product Display Code"
                        },
					    {
                            "name": "productIntermediateSaleValue",
                            "type": "double",
                             "description": “Intermediate Sale Value of product.”
                        },
						{
                            "name": "productWillBe",
                            "type": "boolean",
                             "description": "productWillBe"
                        },
						{
                            "name": "productBasePriceType",
                            "type": "integer",
                             "description": "Product Base Price Type"
                        },
						 {
                            "name": "productYourChoice",
                            "type": "double",
                             "description": “Product Your Choice.”
                        },					
						
                        {
                            "name": "productFindItInStore",
                            "type": "boolean",
                             "description": "Can find it in Store"
                        },
						  {
                            "name": "productNotForRegistry",
                            "type": "boolean",
                             "description": "Opposite productRegisterable and upcRegisterable. If Y, product should not be added to the registry. Related flags are prodRegisterable, notForWCSale, upcRegisterable "
                        },
						{
                            "name": "productDefaultCategoryId",
                            "type": "integer",
                            "description": "ProductDefaultCategory"
                        },
						{
                            "name": "productNotForWCSale",
                            "type": "boolean",
                            "description": "product not for WC Sale (wedding channel) The item cannot be added to the Bag(purchased on the registry website)"
                        },
						{
                            "name": "productValidParentCategoryId",
                            "type": "string",
                            "description": "product valid parent category id "
                        }
                    ]
                }
			]	
		},
        {
            "name": "shippingAddressSource",
             "type": "string",
            "optional": false,
            "description": “REGISTRANT, CO-REGISTRANT, OTHER”
        },
		      {
            "name": "futureShippingAddressSource",
             "type": "string",
            "optional": false,
            "description": “REGISTRANT, CO-REGISTRANT, OTHER”
        },
		
        {
                    "name": "registryInfo",
                    "type": "object",
                    "properties": [		
		
		{
            "name": "registryId",
             "type": "string",
            "optional": false,
            "description": “Identifier for this Registry”
        },
        {
            "name": "estimatedNoOfGuests",
             "type": "string",
            "optional": false,
            "description": “estimated No Of Guests”
        },
        {
            "name": "eventDate",
             "type": "date",
            "optional": false,
            "description": “Date of Marriage, Anniversary or Commitment”
        },
       
        {
            "name": "preferredStoreID",
             "type": "integer",
            "optional": false,
            "description": “ID of preferred store”
        },
        {
            "name": "preferredStoreDivID",
             "type": "integer",
            "optional": false,
            "description": “ID of Division of preferred store”
        },
        {
            "name": "creationDate",
             "type": "date",
            "optional": false,
            "description": “Date of registry creation”
        },
        {
            "name": "datePrintFormat",
             "type": "string",
            "optional": false,
            "description": “print format for date”
        },
        {
            "name": "availableOnTheInternet",
             "type": "boolean",
            "optional": false,
            "description": “Is this registry available on the internet?”
        },
       {
            "name": "availableOnTheInternet",
             "type": "boolean",
            "optional": false,
            "description": “Is this registry available on the internet?”
        },
        {
            "name": "publicRegistry",
             "type": "boolean",
            "optional": false,
            "description": “Is it OK to show the registry as public”
        },
        {
            "name": "goGreen",
             "type": "boolean",
            "optional": false,
            "description": “Y means they prefer no gift wrapping”
        },

        {
            "name": "registryType",
             "type": “string”
            "optional": false,
            "description": “WEDDING, COMMITTMENT, ANNIVERSARY (HOUSEWARMING not showing on website as yet)”
        },
      
        {
            "name": "subscribeWeddingEmailSalesEvents",
             "type": “boolean”
            "optional": false,
            "description": “Default to N. Do you want to subscribe to the Wedding Email Sales Events”
        },
       
        {
            "name": "registryRewardStatus",
             "type": “string”
            "optional": false,
            "description": “ACCEPTED, DECLINED, INELIGIBLE, UNENROLLED”
        }
      	]
		},
		
		
		{
                    "name": "registrantContactInfo",
                    "type": "object",
                    "properties": [
	    {
            "name": "nickName",
              "type": "string",
            "optional": true,
            "description": “nickname of registrant”
        },
        {
            "name": "emailAddress",
              "type": "string",
            "optional": false,
            "description": “email of registrant”
        },
		
        {
            "name": "attention",
              "type": "string",
            "optional": true,
            "description": “attention to for registrant”
        },
	{
            "name": "bestPhone",
             "type": "string",
            "optional": false,
            "description": “best phone number for registrant”
        },
        {
            "name": "lastName",
             "type": "string",
            "optional": false,
            "description": “last name of registrant”
        },
       {
            "name": "firstname",
             "type": "string",
            "optional": false,
            "description": “first name of registrant”
        },
        {
            "name": "middlename",
             "type": "string",
            "optional": true,
            "description": “middle name of registrant”
        },
        {
            "name": "namePrefix",
             "type": "string",
            "optional": true,
            "description": “name prefix for registrant”
        },
        {
            "name": "nameSuffix",
             "type": "string",
            "optional": true,
            "description": “name suffix for registrant”
        },
		
		{
                    "name": "contactAddress",
                    "type": "object",
                    "properties": [
		
		
        {
            "name": "addressLine1",
             "type": "string",
            "optional": false,
            "description": “address line 1 for registrant”
        },
        {
            "name": "addressLine2",
             "type": "string",
            "optional": false,
            "description": “address line 2 for registrant”
        },
        {
            "name": "addressLine3",
             "type": "string",
            "optional": true,
            "description": “address line 3 for registrant”
        },
        {
            "name": "state",
             "type": "string",
            "optional": false,
            "description": “state for registrant”
        },

        {
            "name": "city",
             "type": "string",
            "optional": false,
            "description": “city  for registrant”
        },
        {
            "name": "postal code",
             "type": "string",
            "optional": false,
            "description": “zip for registrant”
        },
        {
            "name": "country",
             "type": "string",
            "optional": false,
            "description": “country for registrant”
        }
		]
		}
			
		]
	    }    
        ]
}
If callback:
)

 

back to top

Error Codes

ERROR CODE DESCRIPTION
INVALID_REGISTRY Input DTO is Null
INVALID_REGISTRY_ID Registry Id is missing in input.
INVALID_REGISTRY_REQUEST_INFO

Input Request is not valid.

1. If both BVR and GVR Set to true/false.

2. IsBVR set to true but returns all other parameters not set.

NO_REGISTRY Unable to find information for provided registry Id.
UNAVAILBLE_ONLINE Registry which user trying to get is not available online.

General Error Handling Documentation:

Click Here

back to top

Docs Navigation