GET 3dCartWebAPI/v1/GiftRegistries/{giftregistryid}/Items
Gets the items from a specific Gift Registry
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
giftregistryid |
Gift Registry ID |
integer |
Default value is 0 |
limit |
Maximum number of items that can be returned |
integer |
Default value is 0 |
offset |
Starting point for the return data |
integer |
Default value is 0 |
Body Parameters
None.
Sample Request |
|
Please click here to download the C# Rest API Client project from GitHub.
not yet available
not yet available
Response Information
Resource Description
Collection of GiftRegistryItemName | Description | Type | Additional information |
---|---|---|---|
CatalogID |
database reference = WSI_WishlistItems.catalogid |
integer |
None. |
SKU |
database reference = WSI_WishlistItems.itemid |
string |
String length: inclusive between 0 and 300 |
ItemName |
database reference = WSI_WishlistItems.itemname |
string |
String length: inclusive between 0 and 65535 |
Listed |
database reference = WSI_WishlistItems.numitems |
integer |
None. |
Price |
database reference = WSI_WishlistItems.unitprice |
decimal number |
None. |
Subtotal |
calculated |
decimal number |
None. |
Sold |
database reference = WSI_WishlistItems.numitems |
integer |
None. |
SoldOffline |
database reference = WSI_WishlistItems.numitems |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "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:
<ArrayOfGiftRegistryItem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <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> </ArrayOfGiftRegistryItem>