GET 3dCartWebAPI/v1/GiftRegistries/{giftregistryid}

Get a specific GiftRegistry

Request Information

URI Parameters

Name	Description	Type	Additional information
giftregistryid	Gift Resitry ID	integer	Required

Body Parameters

None.

Sample Request

PHP

Python

Ruby

Please click here to download the C# Rest API Client project from GitHub.

not yet available

Response Information

Resource Description

Collection of GiftRegistry

Name	Description	Type	Additional information
GiftRegistryID	Primary key. Auto-incremented. database reference = WSH_wishlist.WSH_Id	integer	None.
Name	database reference = WSH_wishlist.WSH_Name	string	String length: inclusive between 0 and 50
Created	database reference = WSH_wishlist.WSH_Created	date	None.
LastUpdate	database reference = WSH_wishlist.WSH_LastMod	date	None.
Expires	database reference = WSH_wishlist.WSH_Expiration	date	None.
Event	database reference = WSH_wishlist.WSH_EventDate	date	None.
Message	database reference = WSH_wishlist.WSH_Message	string	String length: inclusive between 0 and 65535
ShipToAddress	database reference = WSH_wishlist.WSH_ShipMyAddress	boolean	None.
Sold	calculated field:	integer	None.
Items	calculated field:	integer	None.
GiftRegistryItemList		Collection of GiftRegistryItem	None.
CustomerAddressBook		CustomerAddressBook	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomerAddressBook": {
      "CustomerAddressId": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "ZipCode": "sample string 7",
      "Country": "sample string 8",
      "Company": "sample string 9",
      "PhoneNumber": "sample string 10"
    },
    "GiftRegistryID": 1,
    "Name": "sample string 1",
    "Created": "10/24/2025 03:53",
    "LastUpdate": "10/24/2025 03:53",
    "Expires": "10/24/2025 03:53",
    "Event": "10/24/2025 03:53",
    "Message": "sample string 2",
    "ShipToAddress": true,
    "Sold": 1,
    "Items": 1,
    "GiftRegistryItemList": [
      {
        "CatalogID": 1,
        "SKU": "sample string 1",
        "ItemName": "sample string 2",
        "Listed": 1,
        "Price": 1.1,
        "Subtotal": 1.1,
        "Sold": 1,
        "SoldOffline": 1
      },
      {
        "CatalogID": 1,
        "SKU": "sample string 1",
        "ItemName": "sample string 2",
        "Listed": 1,
        "Price": 1.1,
        "Subtotal": 1.1,
        "Sold": 1,
        "SoldOffline": 1
      }
    ]
  },
  {
    "CustomerAddressBook": {
      "CustomerAddressId": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "ZipCode": "sample string 7",
      "Country": "sample string 8",
      "Company": "sample string 9",
      "PhoneNumber": "sample string 10"
    },
    "GiftRegistryID": 1,
    "Name": "sample string 1",
    "Created": "10/24/2025 03:53",
    "LastUpdate": "10/24/2025 03:53",
    "Expires": "10/24/2025 03:53",
    "Event": "10/24/2025 03:53",
    "Message": "sample string 2",
    "ShipToAddress": true,
    "Sold": 1,
    "Items": 1,
    "GiftRegistryItemList": [
      {
        "CatalogID": 1,
        "SKU": "sample string 1",
        "ItemName": "sample string 2",
        "Listed": 1,
        "Price": 1.1,
        "Subtotal": 1.1,
        "Sold": 1,
        "SoldOffline": 1
      },
      {
        "CatalogID": 1,
        "SKU": "sample string 1",
        "ItemName": "sample string 2",
        "Listed": 1,
        "Price": 1.1,
        "Subtotal": 1.1,
        "Sold": 1,
        "SoldOffline": 1
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfGiftRegistry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <GiftRegistry>
    <CustomerAddressBook>
      <CustomerAddressId>1</CustomerAddressId>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <ZipCode>sample string 7</ZipCode>
      <Country>sample string 8</Country>
      <Company>sample string 9</Company>
      <PhoneNumber>sample string 10</PhoneNumber>
    </CustomerAddressBook>
    <GiftRegistryID>1</GiftRegistryID>
    <Name>sample string 1</Name>
    <Created>2025-10-24T03:53:07.807895-04:00</Created>
    <LastUpdate>2025-10-24T03:53:07.807895-04:00</LastUpdate>
    <Expires>2025-10-24T03:53:07.807895-04:00</Expires>
    <Event>2025-10-24T03:53:07.807895-04:00</Event>
    <Message>sample string 2</Message>
    <ShipToAddress>true</ShipToAddress>
    <Sold>1</Sold>
    <Items>1</Items>
    <GiftRegistryItemList>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <SKU>sample string 1</SKU>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <Subtotal>1.1</Subtotal>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
      </GiftRegistryItem>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <SKU>sample string 1</SKU>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <Subtotal>1.1</Subtotal>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
      </GiftRegistryItem>
    </GiftRegistryItemList>
  </GiftRegistry>
  <GiftRegistry>
    <CustomerAddressBook>
      <CustomerAddressId>1</CustomerAddressId>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <ZipCode>sample string 7</ZipCode>
      <Country>sample string 8</Country>
      <Company>sample string 9</Company>
      <PhoneNumber>sample string 10</PhoneNumber>
    </CustomerAddressBook>
    <GiftRegistryID>1</GiftRegistryID>
    <Name>sample string 1</Name>
    <Created>2025-10-24T03:53:07.807895-04:00</Created>
    <LastUpdate>2025-10-24T03:53:07.807895-04:00</LastUpdate>
    <Expires>2025-10-24T03:53:07.807895-04:00</Expires>
    <Event>2025-10-24T03:53:07.807895-04:00</Event>
    <Message>sample string 2</Message>
    <ShipToAddress>true</ShipToAddress>
    <Sold>1</Sold>
    <Items>1</Items>
    <GiftRegistryItemList>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <SKU>sample string 1</SKU>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <Subtotal>1.1</Subtotal>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
      </GiftRegistryItem>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <SKU>sample string 1</SKU>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <Subtotal>1.1</Subtotal>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
      </GiftRegistryItem>
    </GiftRegistryItemList>
  </GiftRegistry>
</ArrayOfGiftRegistry>