GET 3dCartWebAPI/v1/GiftRegistries


Get all GiftRegistries

Request Information

URI Parameters

NameDescriptionTypeAdditional information
catalogid

Catalog ID

integer

Default value is 0

sku

SKU Code of the product

string

Default value is

datestartcreated

Created Date Start (mm/dd/yyyy hh:mm:ss)

string

Default value is

dateendcreated

Created Date End (mm/dd/yyyy hh:mm:ss)

string

Default value is

datestartevent

Event Date Start (mm/dd/yyyy hh:mm:ss)

string

Default value is

dateendevent

Event Date End (mm/dd/yyyy hh:mm:ss)

string

Default value is

datestartexpiration

Expiration Date Start (mm/dd/yyyy hh:mm:ss)

string

Default value is

dateendexpiration

Expiration Date End (mm/dd/yyyy hh:mm:ss)

string

Default value is

limit

Maximum number of items that can be returned

integer

Default value is 10

offset

Starting point for the return data

integer

Default value is 1

countonly

Count the number of rows only

integer

Default value is 0

Body Parameters

None.


Sample Request



Response Information

Resource Description

Collection of GiftRegistry
NameDescriptionTypeAdditional 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/16/2019 23:46",
    "LastUpdate": "10/16/2019 23:46",
    "Expires": "10/16/2019 23:46",
    "Event": "10/16/2019 23:46",
    "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/16/2019 23:46",
    "LastUpdate": "10/16/2019 23:46",
    "Expires": "10/16/2019 23:46",
    "Event": "10/16/2019 23:46",
    "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:i="http://www.w3.org/2001/XMLSchema-instance">
  <GiftRegistry>
    <Created>2019-10-16T23:46:18.0991458-04:00</Created>
    <CustomerAddressBook xmlns:d3p1="http://schemas.datacontract.org/2004/07/_3dCartWebAPI.Models">
      <d3p1:Address1>sample string 3</d3p1:Address1>
      <d3p1:Address2>sample string 4</d3p1:Address2>
      <d3p1:City>sample string 5</d3p1:City>
      <d3p1:Company>sample string 9</d3p1:Company>
      <d3p1:Country>sample string 8</d3p1:Country>
      <d3p1:CustomerAddressId>1</d3p1:CustomerAddressId>
      <d3p1:FirstName>sample string 1</d3p1:FirstName>
      <d3p1:LastName>sample string 2</d3p1:LastName>
      <d3p1:PhoneNumber>sample string 10</d3p1:PhoneNumber>
      <d3p1:State>sample string 6</d3p1:State>
      <d3p1:ZipCode>sample string 7</d3p1:ZipCode>
    </CustomerAddressBook>
    <Event>2019-10-16T23:46:18.0991458-04:00</Event>
    <Expires>2019-10-16T23:46:18.0991458-04:00</Expires>
    <GiftRegistryID>1</GiftRegistryID>
    <GiftRegistryItemList>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <SKU>sample string 1</SKU>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
        <Subtotal>1.1</Subtotal>
      </GiftRegistryItem>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <SKU>sample string 1</SKU>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
        <Subtotal>1.1</Subtotal>
      </GiftRegistryItem>
    </GiftRegistryItemList>
    <Items>1</Items>
    <LastUpdate>2019-10-16T23:46:18.0991458-04:00</LastUpdate>
    <Message>sample string 2</Message>
    <Name>sample string 1</Name>
    <ShipToAddress>true</ShipToAddress>
    <Sold>1</Sold>
  </GiftRegistry>
  <GiftRegistry>
    <Created>2019-10-16T23:46:18.0991458-04:00</Created>
    <CustomerAddressBook xmlns:d3p1="http://schemas.datacontract.org/2004/07/_3dCartWebAPI.Models">
      <d3p1:Address1>sample string 3</d3p1:Address1>
      <d3p1:Address2>sample string 4</d3p1:Address2>
      <d3p1:City>sample string 5</d3p1:City>
      <d3p1:Company>sample string 9</d3p1:Company>
      <d3p1:Country>sample string 8</d3p1:Country>
      <d3p1:CustomerAddressId>1</d3p1:CustomerAddressId>
      <d3p1:FirstName>sample string 1</d3p1:FirstName>
      <d3p1:LastName>sample string 2</d3p1:LastName>
      <d3p1:PhoneNumber>sample string 10</d3p1:PhoneNumber>
      <d3p1:State>sample string 6</d3p1:State>
      <d3p1:ZipCode>sample string 7</d3p1:ZipCode>
    </CustomerAddressBook>
    <Event>2019-10-16T23:46:18.0991458-04:00</Event>
    <Expires>2019-10-16T23:46:18.0991458-04:00</Expires>
    <GiftRegistryID>1</GiftRegistryID>
    <GiftRegistryItemList>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <SKU>sample string 1</SKU>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
        <Subtotal>1.1</Subtotal>
      </GiftRegistryItem>
      <GiftRegistryItem>
        <CatalogID>1</CatalogID>
        <ItemName>sample string 2</ItemName>
        <Listed>1</Listed>
        <Price>1.1</Price>
        <SKU>sample string 1</SKU>
        <Sold>1</Sold>
        <SoldOffline>1</SoldOffline>
        <Subtotal>1.1</Subtotal>
      </GiftRegistryItem>
    </GiftRegistryItemList>
    <Items>1</Items>
    <LastUpdate>2019-10-16T23:46:18.0991458-04:00</LastUpdate>
    <Message>sample string 2</Message>
    <Name>sample string 1</Name>
    <ShipToAddress>true</ShipToAddress>
    <Sold>1</Sold>
  </GiftRegistry>
</ArrayOfGiftRegistry>