CatalogItemList

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
(New page: ==Summary== Returns a list of catalog items in the specified catalog and category. '''Resource''' GET api/v1/catalogItemList '''Parameters''' catalog category sortBy sortOrder '''Exam...)
Current revision (22:39, 29 June 2016) (edit) (undo)
m (→Summary)
 
(One intermediate revision not shown.)
Line 4: Line 4:
'''Resource'''
'''Resource'''
-
GET
+
GET api/v1/catalogItemList
-
api/v1/catalogItemList
+
'''Parameters'''
'''Parameters'''
-
catalog
+
* catalog
-
category
+
* category
-
sortBy
+
* sortBy
-
sortOrder
+
* sortOrder
-
'''Example Call'''
+
Example Request Body
-
http://demo-loyalty.promodev.eprize.com api/v1/catalogItemList
+
{
-
{
+
"catalog": "demoCatalog",
-
“catalog”: “demoCatalog”,
+
"category": "all",
-
"category": all,
+
"sortBy": "FromQuantity",
-
“sortBy”:”FromQuantity”,
+
"sortOrder": "ASC"
-
“sortOrder”: “ASC”,
+
}
-
}
+
-
�
 
Example Response: Success
Example Response: Success
-
{
+
{
-
"Response":{
+
"Response":{
-
"__Type__":"VoList",
+
"__Type__":"VoList",
-
"List":[
+
"List":[
-
{
+
{
-
"UserId":288000000034,
+
"UserId":288000000034,
-
"CategoryId":0,
+
"CategoryId":0,
-
"RedemptionExchangeRate":{
+
"RedemptionExchangeRate":{
-
"Id":216778000000224,
+
"Id":216778000000224,
-
"ExchangeRateId":216778000000224,
+
"ExchangeRateId":216778000000224,
-
"ExchangeRateMultiple":1,
+
"ExchangeRateMultiple":1,
-
"FromQuantity":20,
+
"FromQuantity":20,
-
"ToQuantity":1,
+
"ToQuantity":1,
-
"CatalogId":211332000000056,
+
"CatalogId":211332000000056,
-
"ExchangeFromGoods":{
+
"ExchangeFromGoods":{
-
"__Type__":"Vo",
+
"__Type__":"Vo",
-
"__TypeCode__":"Common.PointsCurrency",
+
"__TypeCode__":"Common.PointsCurrency",
-
"__DesignId__":208762000000015,
+
"__DesignId__":208762000000015,
-
"Id":210578000000007,
+
"Id":210578000000007,
-
"SupplierId":208762000000015,
+
"SupplierId":208762000000015,
-
"GoodsTypeId":990850001,
+
"GoodsTypeId":990850001,
-
"PrimaryIdentifier":"demoPoints",
+
"PrimaryIdentifier":"demoPoints",
-
"Name":{
+
"Name":{
-
"en":"Demo Points"
+
"en":"Demo Points"
-
},
+
},
-
"Active":true,
+
"Active":true,
-
"Description":{
+
"Description":{
-
"en":""
+
"en":""
-
},
+
},
-
"DetailedDescription":{
+
"DetailedDescription":{
-
"en":""
+
"en":""
-
},
+
},
-
"ValidFromDate":null,
+
"ValidFromDate":null,
-
"ValidToDate":null,
+
"ValidToDate":null,
-
"ImageUrl":{
+
"ImageUrl":{
-
"en":""
+
"en":""
-
},
+
},
-
"ThumbnailImageUrl":{
+
"ThumbnailImageUrl":{
-
"en":""
+
"en":""
-
},
+
},
-
"FulfilmentDescription":{
+
"FulfilmentDescription":{
-
"en":""
+
"en":""
-
},
+
},
-
"SupplierProductCode":"",
+
"SupplierProductCode":"",
-
"SupplierPrice":0,
+
"SupplierPrice":0,
-
"RetailValue":0,
+
"RetailValue":0,
-
"StreetValue":0,
+
"StreetValue":0,
-
"RequiresUserInformation":false,
+
"RequiresUserInformation":false,
-
"ElectronicallyFulfilled":false,
+
"ElectronicallyFulfilled":false,
-
"NumberOfDecimals":0,
+
"NumberOfDecimals":0,
-
"ThirdPartyFulfilled":false,
+
"ThirdPartyFulfilled":false,
-
"MaximumPerFulfilmentRequest":0,
+
"MaximumPerFulfilmentRequest":0,
-
"ExpiryCycle":"",
+
"ExpiryCycle":"",
-
"MonthsToExpiry":0,
+
"MonthsToExpiry":0,
-
"AutomaticallyExpired":false,
+
"AutomaticallyExpired":false,
-
"ExpiryMessageCode":"",
+
"ExpiryMessageCode":"",
-
"AllowNegativeBalance":false,
+
"AllowNegativeBalance":false,
-
"CashValueOfAPoint":1,
+
"CashValueOfAPoint":1,
-
"itemDisclaimer":{
+
"itemDisclaimer":{},
 +
"prizeId":0,
 +
"RecordCode":103430000000002
 +
},
 +
"ExchangeForGoods":{
 +
"__Type__":"Vo",
 +
"__TypeCode__":"Common.Merchandise",
 +
"__DesignId__":208762000000015,
 +
"Id":216778000000224,
 +
"SupplierId":208762000000015,
 +
"GoodsTypeId":211332000000046,
 +
"PrimaryIdentifier":"multisweepsItem0",
 +
"Name":{
 +
"en":"Multi-Sweeps"
 +
},
 +
"Active":true,
 +
"Description":{
 +
"en":"Multi-sweeps are great point-burning options for the Rewards Catalog. Members can redeem points for chances to win the item. HelloWorld can offer a variety of sweepstakes prize ideas that will be attractive to members!"
 +
},
 +
"DetailedDescription":{
 +
"en":""
 +
},
 +
"ValidFromDate":null,
 +
"ValidToDate":null,
 +
"ImageUrl":{
 +
"en":"/images/preview1.png"
 +
},
 +
"ThumbnailImageUrl":{
 +
"en":""
 +
},
 +
"FulfilmentDescription":{
 +
"en":""
 +
},
 +
"SupplierProductCode":"",
 +
"SupplierPrice":20,
 +
"RetailValue":0,
 +
"StreetValue":0,
 +
"RequiresUserInformation":false,
 +
"ElectronicallyFulfilled":false,
 +
"Brand":"",
 +
"itemDisclaimer":{
 +
"en":""
 +
},
 +
"prizeId":0,
 +
"RecordCode":104888000000010
 +
},
 +
"NodeId":75000000013,
 +
"OutOfInventory":true,
 +
"CurrentInventory":0
 +
}
 +
},
 +
{
 +
"UserId":288000000034,
 +
"CategoryId":0,
 +
"RedemptionExchangeRate":{
 +
"Id":211602000000061,
 +
"ExchangeRateId":211602000000061,
 +
"ExchangeRateMultiple":1,
 +
"FromQuantity":1000,
 +
"ToQuantity":1,
 +
"CatalogId":211332000000056,
 +
"ExchangeFromGoods":{
 +
"__Type__":"Vo",
 +
"__TypeCode__":"Common.PointsCurrency",
 +
"__DesignId__":208762000000015,
 +
"Id":210578000000007,
 +
"SupplierId":208762000000015,
 +
"GoodsTypeId":990850001,
 +
"PrimaryIdentifier":"demoPoints",
 +
"Name":{
 +
"en":"Demo Points"
 +
},
 +
"Active":true,
 +
"Description":{
 +
"en":""
 +
},
 +
"DetailedDescription":{
 +
"en":""
 +
},
 +
"ValidFromDate":null,
 +
"ValidToDate":null,
 +
"ImageUrl":{
 +
"en":""
 +
},
 +
"ThumbnailImageUrl":{
 +
"en":""
 +
},
 +
"FulfilmentDescription":{
 +
"en":""
 +
},
 +
"SupplierProductCode":"",
 +
"SupplierPrice":0,
 +
"RetailValue":0,
 +
"StreetValue":0,
 +
"RequiresUserInformation":false,
 +
"ElectronicallyFulfilled":false,
 +
"NumberOfDecimals":0,
 +
"ThirdPartyFulfilled":false,
 +
"MaximumPerFulfilmentRequest":0,
 +
"ExpiryCycle":"",
 +
"MonthsToExpiry":0,
 +
"AutomaticallyExpired":false,
 +
"ExpiryMessageCode":"",
 +
"AllowNegativeBalance":false,
 +
"CashValueOfAPoint":1,
 +
"itemDisclaimer":{},
 +
"prizeId":0,
 +
"RecordCode":103430000000002
 +
},
 +
"ExchangeForGoods":{
 +
"__Type__":"Vo",
 +
"__TypeCode__":"Common.Merchandise",
 +
"__DesignId__":208762000000015,
 +
"Id":211602000000061,
 +
"SupplierId":208762000000015,
 +
"GoodsTypeId":211332000000046,
 +
"PrimaryIdentifier":"demoPhysicalItem0",
 +
"Name":{
 +
"en":"Physical Item A"
 +
},
 +
"Active":true,
 +
"Description":{
 +
"en":"This area would include more information about the physical item being offered, including information on how long it would take to receive the item in the mail, along with any restrictions."
 +
},
 +
"DetailedDescription":{
 +
"en":""
 +
},
 +
"ValidFromDate":null,
 +
"ValidToDate":null,
 +
"ImageUrl":{
 +
"en":"/images/catalog/physical.jpg"
 +
},
 +
"ThumbnailImageUrl":{
 +
"en":""
 +
},
 +
"FulfilmentDescription":{
 +
"en":""
 +
},
 +
"SupplierProductCode":"",
 +
"SupplierPrice":1000,
 +
"RetailValue":0,
 +
"StreetValue":0,
 +
"RequiresUserInformation":false,
 +
"ElectronicallyFulfilled":false,
 +
"Brand":"",
 +
"itemDisclaimer":{
 +
"en":""
 +
},
 +
"prizeId":0,
 +
"RecordCode":104888000000008
 +
},
 +
"NodeId":75000000013,
 +
"OutOfInventory":false,
 +
"CurrentInventory":983
 +
}
 +
},
 +
{
 +
"UserId":288000000034,
 +
"CategoryId":0,
 +
"RedemptionExchangeRate":{
 +
"Id":211602000000036,
 +
"ExchangeRateId":211602000000036,
 +
"ExchangeRateMultiple":1,
 +
"FromQuantity":2007,
 +
"ToQuantity":1,
 +
"CatalogId":211332000000056,
 +
"ExchangeFromGoods":{
 +
"__Type__":"Vo",
 +
"__TypeCode__":"Common.PointsCurrency",
 +
"__DesignId__":208762000000015,
 +
"Id":210578000000007,
 +
"SupplierId":208762000000015,
 +
"GoodsTypeId":990850001,
 +
"PrimaryIdentifier":"demoPoints",
 +
"Name":{
 +
"en":"Demo Points"
 +
},
 +
"Active":true,
 +
"Description":{
 +
"en":""
 +
},
 +
"DetailedDescription":{
 +
"en":""
 +
},
 +
"ValidFromDate":null,
 +
"ValidToDate":null,
 +
"ImageUrl":{
 +
"en":""
 +
},
 +
"ThumbnailImageUrl":{
 +
"en":""
 +
},
 +
"FulfilmentDescription":{
 +
"en":""
 +
},
 +
"SupplierProductCode":"",
 +
"SupplierPrice":0,
 +
"RetailValue":0,
 +
"StreetValue":0,
 +
"RequiresUserInformation":false,
 +
"ElectronicallyFulfilled":false,
 +
"NumberOfDecimals":0,
 +
"ThirdPartyFulfilled":false,
 +
"MaximumPerFulfilmentRequest":0,
 +
"ExpiryCycle":"",
 +
"MonthsToExpiry":0,
 +
"AutomaticallyExpired":false,
 +
"ExpiryMessageCode":"",
 +
"AllowNegativeBalance":false,
 +
"CashValueOfAPoint":1,
 +
"itemDisclaimer":{},
 +
"prizeId":0,
 +
"RecordCode":103430000000002
 +
},
 +
"ExchangeForGoods":{
 +
"__Type__":"Vo",
 +
"__TypeCode__":"Common.Merchandise",
 +
"__DesignId__":208762000000015,
 +
"Id":211602000000036,
 +
"SupplierId":208762000000015,
 +
"GoodsTypeId":211332000000046,
 +
"PrimaryIdentifier":"demoDigital1",
 +
"Name":{
 +
"en":"Digital Item"
 +
},
 +
"Active":true,
 +
"Description":{
 +
"en":"This area would provide more information on the digital item being offered, including any restrictions, legal disclaimers, and expiration date."
 +
},
 +
"DetailedDescription":{
 +
"en":""
 +
},
 +
"ValidFromDate":null,
 +
"ValidToDate":null,
 +
"ImageUrl":{
 +
"en":"/images/catalog/giftcard.jpg"
 +
},
 +
"ThumbnailImageUrl":{
 +
"en":""
 +
},
 +
"FulfilmentDescription":{
 +
"en":""
 +
},
 +
"SupplierProductCode":"",
 +
"SupplierPrice":2007,
 +
"RetailValue":0,
 +
"StreetValue":0,
 +
"RequiresUserInformation":false,
 +
"ElectronicallyFulfilled":false,
 +
"Brand":"",
 +
"itemDisclaimer":{
 +
"en":""
 +
},
 +
"prizeId":0,
 +
"RecordCode":105186000000002
 +
},
 +
"NodeId":75000000013,
 +
"OutOfInventory":false,
 +
"CurrentInventory":994
 +
}
 +
}
 +
],
 +
"TotalRecords":3,
 +
"RecordsPerPage":500,
 +
"CurrentDataRecordNumber":0
 +
}
 +
}
-
},
+
Example Response: Error passing in invalid category named badCat
-
"prizeId":0,
+
-
"RecordCode":103430000000002
+
-
},
+
-
"ExchangeForGoods":{
+
-
"__Type__":"Vo",
+
-
"__TypeCode__":"Common.Merchandise",
+
-
"__DesignId__":208762000000015,
+
-
"Id":216778000000224,
+
-
"SupplierId":208762000000015,
+
-
"GoodsTypeId":211332000000046,
+
-
"PrimaryIdentifier":"multisweepsItem0",
+
-
"Name":{
+
-
"en":"Multi-Sweeps"
+
-
},
+
-
"Active":true,
+
-
"Description":{
+
-
"en":"Multi-sweeps are great point-burning options for the Rewards Catalog. Members can redeem points for chances to win the item. HelloWorld can offer a variety of sweepstakes prize ideas that will be attractive to members!"
+
-
},
+
-
"DetailedDescription":{
+
-
"en":""
+
-
},
+
-
"ValidFromDate":null,
+
-
"ValidToDate":null,
+
-
"ImageUrl":{
+
-
"en":"/images/preview1.png"
+
-
},
+
-
"ThumbnailImageUrl":{
+
-
"en":""
+
-
},
+
-
"FulfilmentDescription":{
+
-
"en":""
+
-
},
+
-
"SupplierProductCode":"",
+
-
"SupplierPrice":20,
+
-
"RetailValue":0,
+
-
"StreetValue":0,
+
-
"RequiresUserInformation":false,
+
-
"ElectronicallyFulfilled":false,
+
-
"Brand":"",
+
-
"itemDisclaimer":{
+
-
"en":""
+
-
},
+
-
"prizeId":0,
+
-
"RecordCode":104888000000010
+
-
},
+
-
"NodeId":75000000013,
+
-
"OutOfInventory":true,
+
-
"CurrentInventory":0
+
-
}
+
-
},
+
-
{
+
-
"UserId":288000000034,
+
-
"CategoryId":0,
+
-
"RedemptionExchangeRate":{
+
-
"Id":211602000000061,
+
-
"ExchangeRateId":211602000000061,
+
-
"ExchangeRateMultiple":1,
+
-
"FromQuantity":1000,
+
-
"ToQuantity":1,
+
-
"CatalogId":211332000000056,
+
-
"ExchangeFromGoods":{
+
-
"__Type__":"Vo",
+
-
"__TypeCode__":"Common.PointsCurrency",
+
-
"__DesignId__":208762000000015,
+
-
"Id":210578000000007,
+
-
"SupplierId":208762000000015,
+
-
"GoodsTypeId":990850001,
+
-
"PrimaryIdentifier":"demoPoints",
+
-
"Name":{
+
-
"en":"Demo Points"
+
-
},
+
-
"Active":true,
+
-
"Description":{
+
-
"en":""
+
-
},
+
-
"DetailedDescription":{
+
-
"en":""
+
-
},
+
-
"ValidFromDate":null,
+
-
"ValidToDate":null,
+
-
"ImageUrl":{
+
-
"en":""
+
-
},
+
-
"ThumbnailImageUrl":{
+
-
"en":""
+
-
},
+
-
"FulfilmentDescription":{
+
-
"en":""
+
-
},
+
-
"SupplierProductCode":"",
+
-
"SupplierPrice":0,
+
-
"RetailValue":0,
+
-
"StreetValue":0,
+
-
"RequiresUserInformation":false,
+
-
"ElectronicallyFulfilled":false,
+
-
"NumberOfDecimals":0,
+
-
"ThirdPartyFulfilled":false,
+
-
"MaximumPerFulfilmentRequest":0,
+
-
"ExpiryCycle":"",
+
-
"MonthsToExpiry":0,
+
-
"AutomaticallyExpired":false,
+
-
"ExpiryMessageCode":"",
+
-
"AllowNegativeBalance":false,
+
-
"CashValueOfAPoint":1,
+
-
"itemDisclaimer":{
+
-
},
+
{
-
"prizeId":0,
+
"Error": {
-
"RecordCode":103430000000002
+
"Code": "error.business.InvalidArgument",
-
},
+
"Message": "Invalid Argument",
-
"ExchangeForGoods":{
+
"Reference": "Category :badCat not found."
-
"__Type__":"Vo",
+
}
-
"__TypeCode__":"Common.Merchandise",
+
}
-
"__DesignId__":208762000000015,
+
-
"Id":211602000000061,
+
-
"SupplierId":208762000000015,
+
-
"GoodsTypeId":211332000000046,
+
-
"PrimaryIdentifier":"demoPhysicalItem0",
+
-
"Name":{
+
-
"en":"Physical Item A"
+
-
},
+
-
"Active":true,
+
-
"Description":{
+
-
"en":"This area would include more information about the physical item being offered, including information on how long it would take to receive the item in the mail, along with any restrictions."
+
-
},
+
-
"DetailedDescription":{
+
-
"en":""
+
-
},
+
-
"ValidFromDate":null,
+
-
"ValidToDate":null,
+
-
"ImageUrl":{
+
-
"en":"/images/catalog/physical.jpg"
+
-
},
+
-
"ThumbnailImageUrl":{
+
-
"en":""
+
-
},
+
-
"FulfilmentDescription":{
+
-
"en":""
+
-
},
+
-
"SupplierProductCode":"",
+
-
"SupplierPrice":1000,
+
-
"RetailValue":0,
+
-
"StreetValue":0,
+
-
"RequiresUserInformation":false,
+
-
"ElectronicallyFulfilled":false,
+
-
"Brand":"",
+
-
"itemDisclaimer":{
+
-
"en":""
+
-
},
+
-
"prizeId":0,
+
-
"RecordCode":104888000000008
+
-
},
+
-
"NodeId":75000000013,
+
-
"OutOfInventory":false,
+
-
"CurrentInventory":983
+
-
}
+
-
},
+
-
{
+
-
"UserId":288000000034,
+
-
"CategoryId":0,
+
-
"RedemptionExchangeRate":{
+
-
"Id":211602000000036,
+
-
"ExchangeRateId":211602000000036,
+
-
"ExchangeRateMultiple":1,
+
-
"FromQuantity":2007,
+
-
"ToQuantity":1,
+
-
"CatalogId":211332000000056,
+
-
"ExchangeFromGoods":{
+
-
"__Type__":"Vo",
+
-
"__TypeCode__":"Common.PointsCurrency",
+
-
"__DesignId__":208762000000015,
+
-
"Id":210578000000007,
+
-
"SupplierId":208762000000015,
+
-
"GoodsTypeId":990850001,
+
-
"PrimaryIdentifier":"demoPoints",
+
-
"Name":{
+
-
"en":"Demo Points"
+
-
},
+
-
"Active":true,
+
-
"Description":{
+
-
"en":""
+
-
},
+
-
"DetailedDescription":{
+
-
"en":""
+
-
},
+
-
"ValidFromDate":null,
+
-
"ValidToDate":null,
+
-
"ImageUrl":{
+
-
"en":""
+
-
},
+
-
"ThumbnailImageUrl":{
+
-
"en":""
+
-
},
+
-
"FulfilmentDescription":{
+
-
"en":""
+
-
},
+
-
"SupplierProductCode":"",
+
-
"SupplierPrice":0,
+
-
"RetailValue":0,
+
-
"StreetValue":0,
+
-
"RequiresUserInformation":false,
+
-
"ElectronicallyFulfilled":false,
+
-
"NumberOfDecimals":0,
+
-
"ThirdPartyFulfilled":false,
+
-
"MaximumPerFulfilmentRequest":0,
+
-
"ExpiryCycle":"",
+
-
"MonthsToExpiry":0,
+
-
"AutomaticallyExpired":false,
+
-
"ExpiryMessageCode":"",
+
-
"AllowNegativeBalance":false,
+
-
"CashValueOfAPoint":1,
+
-
"itemDisclaimer":{
+
-
 
+
-
},
+
-
"prizeId":0,
+
-
"RecordCode":103430000000002
+
-
},
+
-
"ExchangeForGoods":{
+
-
"__Type__":"Vo",
+
-
"__TypeCode__":"Common.Merchandise",
+
-
"__DesignId__":208762000000015,
+
-
"Id":211602000000036,
+
-
"SupplierId":208762000000015,
+
-
"GoodsTypeId":211332000000046,
+
-
"PrimaryIdentifier":"demoDigital1",
+
-
"Name":{
+
-
"en":"Digital Item"
+
-
},
+
-
"Active":true,
+
-
"Description":{
+
-
"en":"This area would provide more information on the digital item being offered, including any restrictions, legal disclaimers, and expiration date."
+
-
},
+
-
"DetailedDescription":{
+
-
"en":""
+
-
},
+
-
"ValidFromDate":null,
+
-
"ValidToDate":null,
+
-
"ImageUrl":{
+
-
"en":"/images/catalog/giftcard.jpg"
+
-
},
+
-
"ThumbnailImageUrl":{
+
-
"en":""
+
-
},
+
-
"FulfilmentDescription":{
+
-
"en":""
+
-
},
+
-
"SupplierProductCode":"",
+
-
"SupplierPrice":2007,
+
-
"RetailValue":0,
+
-
"StreetValue":0,
+
-
"RequiresUserInformation":false,
+
-
"ElectronicallyFulfilled":false,
+
-
"Brand":"",
+
-
"itemDisclaimer":{
+
-
"en":""
+
-
},
+
-
"prizeId":0,
+
-
"RecordCode":105186000000002
+
-
},
+
-
"NodeId":75000000013,
+
-
"OutOfInventory":false,
+
-
"CurrentInventory":994
+
-
}
+
-
}
+
-
],
+
-
"TotalRecords":3,
+
-
"RecordsPerPage":500,
+
-
"CurrentDataRecordNumber":0
+
-
}
+
-
}
+
-
 
+
-
Example Response: Error passing in invalid category named badCat
+
-
{
+
-
"Error": {
+
-
"Code": "error.business.InvalidArgument",
+
-
"Message": "Invalid Argument",
+
-
"Reference": "Category :badCat not found."
+
-
}
+
-
}
+

Current revision

Summary

Returns a list of catalog items in the specified catalog and category.

Resource GET api/v1/catalogItemList

Parameters

  • catalog
  • category
  • sortBy
  • sortOrder

Example Request Body 

   {
       "catalog":  "demoCatalog",
       "category":  "all",
       "sortBy": "FromQuantity",
       "sortOrder": "ASC"
   }

Example Response: Success 

   {  
       "Response":{  
           "__Type__":"VoList",
           "List":[  
               {  
                   "UserId":288000000034,
                   "CategoryId":0,
                   "RedemptionExchangeRate":{  
                       "Id":216778000000224,
                       "ExchangeRateId":216778000000224,
                       "ExchangeRateMultiple":1,
                       "FromQuantity":20,
                       "ToQuantity":1,
                       "CatalogId":211332000000056,
                       "ExchangeFromGoods":{  
                           "__Type__":"Vo",
                           "__TypeCode__":"Common.PointsCurrency",
                           "__DesignId__":208762000000015,
                           "Id":210578000000007,
                           "SupplierId":208762000000015,
                           "GoodsTypeId":990850001,
                           "PrimaryIdentifier":"demoPoints",
                           "Name":{  
                               "en":"Demo Points"
                           },
                           "Active":true,
                           "Description":{  
                               "en":""
                           },
                           "DetailedDescription":{  
                               "en":""
                           },
                           "ValidFromDate":null,
                           "ValidToDate":null,
                           "ImageUrl":{  
                               "en":""
                           },
                           "ThumbnailImageUrl":{  
                               "en":""
                           },
                           "FulfilmentDescription":{  
                               "en":""
                           },
                           "SupplierProductCode":"",
                           "SupplierPrice":0,
                           "RetailValue":0,
                           "StreetValue":0,
                           "RequiresUserInformation":false,
                           "ElectronicallyFulfilled":false,
                           "NumberOfDecimals":0,
                           "ThirdPartyFulfilled":false,
                           "MaximumPerFulfilmentRequest":0,
                           "ExpiryCycle":"",
                           "MonthsToExpiry":0,
                           "AutomaticallyExpired":false,
                           "ExpiryMessageCode":"",
                           "AllowNegativeBalance":false,
                           "CashValueOfAPoint":1,
                           "itemDisclaimer":{},
                           "prizeId":0,
                           "RecordCode":103430000000002
                       },
                       "ExchangeForGoods":{  
                           "__Type__":"Vo",
                           "__TypeCode__":"Common.Merchandise",
                           "__DesignId__":208762000000015,
                           "Id":216778000000224,
                           "SupplierId":208762000000015,
                           "GoodsTypeId":211332000000046,
                           "PrimaryIdentifier":"multisweepsItem0",
                           "Name":{  
                               "en":"Multi-Sweeps"
                           },
                           "Active":true,
                           "Description":{  
                               "en":"Multi-sweeps are great point-burning options for the Rewards Catalog. Members can redeem points for chances to win the item. HelloWorld can offer a variety of sweepstakes prize ideas that will be attractive to members!"
                           },
                           "DetailedDescription":{  
                               "en":""
                           },
                           "ValidFromDate":null,
                           "ValidToDate":null,
                           "ImageUrl":{  
                               "en":"/images/preview1.png"
                           },
                           "ThumbnailImageUrl":{  
                               "en":""
                           },
                           "FulfilmentDescription":{  
                               "en":""
                           },
                           "SupplierProductCode":"",
                           "SupplierPrice":20,
                           "RetailValue":0,
                           "StreetValue":0,
                           "RequiresUserInformation":false,
                           "ElectronicallyFulfilled":false,
                           "Brand":"",
                           "itemDisclaimer":{  
                               "en":""
                           },
                           "prizeId":0,
                           "RecordCode":104888000000010
                       },
                       "NodeId":75000000013,
                       "OutOfInventory":true,
                       "CurrentInventory":0
                   }
               },
               {  
                   "UserId":288000000034,
                   "CategoryId":0,
                   "RedemptionExchangeRate":{  
                       "Id":211602000000061,
                       "ExchangeRateId":211602000000061,
                       "ExchangeRateMultiple":1,
                       "FromQuantity":1000,
                       "ToQuantity":1,
                       "CatalogId":211332000000056,
                       "ExchangeFromGoods":{  
                           "__Type__":"Vo",
                           "__TypeCode__":"Common.PointsCurrency",
                           "__DesignId__":208762000000015,
                           "Id":210578000000007,
                           "SupplierId":208762000000015,
                           "GoodsTypeId":990850001,
                           "PrimaryIdentifier":"demoPoints",
                           "Name":{  
                               "en":"Demo Points"
                           },
                           "Active":true,
                           "Description":{  
                               "en":""
                           },
                           "DetailedDescription":{  
                               "en":""
                           },
                           "ValidFromDate":null,
                           "ValidToDate":null,
                           "ImageUrl":{  
                               "en":""
                           },
                           "ThumbnailImageUrl":{  
                               "en":""
                           },
                           "FulfilmentDescription":{  
                               "en":""
                           },
                           "SupplierProductCode":"",
                           "SupplierPrice":0,
                           "RetailValue":0,
                           "StreetValue":0,
                           "RequiresUserInformation":false,
                           "ElectronicallyFulfilled":false,
                           "NumberOfDecimals":0,
                           "ThirdPartyFulfilled":false,
                           "MaximumPerFulfilmentRequest":0,
                           "ExpiryCycle":"",
                           "MonthsToExpiry":0,
                           "AutomaticallyExpired":false,
                           "ExpiryMessageCode":"",
                           "AllowNegativeBalance":false,
                           "CashValueOfAPoint":1,
                           "itemDisclaimer":{},
                           "prizeId":0,
                           "RecordCode":103430000000002
                       },
                       "ExchangeForGoods":{  
                           "__Type__":"Vo",
                           "__TypeCode__":"Common.Merchandise",
                           "__DesignId__":208762000000015,
                           "Id":211602000000061,
                           "SupplierId":208762000000015,
                           "GoodsTypeId":211332000000046,
                           "PrimaryIdentifier":"demoPhysicalItem0",
                           "Name":{  
                               "en":"Physical Item A"
                           },
                           "Active":true,
                           "Description":{  
                               "en":"This area would include more information about the physical item being offered, including information on how long it would take to receive the item in the mail, along with any restrictions."
                           },
                           "DetailedDescription":{  
                               "en":""
                           },
                           "ValidFromDate":null,
                           "ValidToDate":null,
                           "ImageUrl":{  
                               "en":"/images/catalog/physical.jpg"
                           },
                           "ThumbnailImageUrl":{  
                               "en":""
                           },
                           "FulfilmentDescription":{  
                               "en":""
                           },
                           "SupplierProductCode":"",
                           "SupplierPrice":1000,
                           "RetailValue":0,
                           "StreetValue":0,
                           "RequiresUserInformation":false,
                           "ElectronicallyFulfilled":false,
                           "Brand":"",
                           "itemDisclaimer":{  
                               "en":""
                           },
                           "prizeId":0,
                           "RecordCode":104888000000008
                       },
                       "NodeId":75000000013,
                       "OutOfInventory":false,
                       "CurrentInventory":983
                   }
               },
               {  
                   "UserId":288000000034,
                   "CategoryId":0,
                   "RedemptionExchangeRate":{  
                       "Id":211602000000036,
                       "ExchangeRateId":211602000000036,
                       "ExchangeRateMultiple":1,
                       "FromQuantity":2007,
                       "ToQuantity":1,
                       "CatalogId":211332000000056,
                       "ExchangeFromGoods":{  
                           "__Type__":"Vo",
                           "__TypeCode__":"Common.PointsCurrency",
                           "__DesignId__":208762000000015,
                           "Id":210578000000007,
                           "SupplierId":208762000000015,
                           "GoodsTypeId":990850001,
                           "PrimaryIdentifier":"demoPoints",
                           "Name":{  
                               "en":"Demo Points"
                           },
                           "Active":true,
                           "Description":{  
                               "en":""
                           },
                           "DetailedDescription":{  
                               "en":""
                           },
                           "ValidFromDate":null,
                           "ValidToDate":null,
                           "ImageUrl":{  
                               "en":""
                           },
                           "ThumbnailImageUrl":{  
                               "en":""
                           },
                           "FulfilmentDescription":{  
                               "en":""
                           },
                           "SupplierProductCode":"",
                           "SupplierPrice":0,
                           "RetailValue":0,
                           "StreetValue":0,
                           "RequiresUserInformation":false,
                           "ElectronicallyFulfilled":false,
                           "NumberOfDecimals":0,
                           "ThirdPartyFulfilled":false,
                           "MaximumPerFulfilmentRequest":0,
                           "ExpiryCycle":"",
                           "MonthsToExpiry":0,
                           "AutomaticallyExpired":false,
                           "ExpiryMessageCode":"",
                           "AllowNegativeBalance":false,
                           "CashValueOfAPoint":1,
                           "itemDisclaimer":{},
                           "prizeId":0,
                           "RecordCode":103430000000002
                       },
                       "ExchangeForGoods":{  
                           "__Type__":"Vo",
                           "__TypeCode__":"Common.Merchandise",
                           "__DesignId__":208762000000015,
                           "Id":211602000000036,
                           "SupplierId":208762000000015,
                           "GoodsTypeId":211332000000046,
                           "PrimaryIdentifier":"demoDigital1",
                           "Name":{  
                               "en":"Digital Item"
                           },
                           "Active":true,
                           "Description":{  
                               "en":"This area would provide more information on the digital item being offered, including any restrictions, legal disclaimers, and expiration date."
                           },
                           "DetailedDescription":{  
                               "en":""
                           },
                           "ValidFromDate":null,
                           "ValidToDate":null,
                           "ImageUrl":{  
                               "en":"/images/catalog/giftcard.jpg"
                           },
                           "ThumbnailImageUrl":{  
                               "en":""
                           },
                           "FulfilmentDescription":{  
                               "en":""
                           },
                           "SupplierProductCode":"",
                           "SupplierPrice":2007,
                           "RetailValue":0,
                           "StreetValue":0,
                           "RequiresUserInformation":false,
                           "ElectronicallyFulfilled":false,
                           "Brand":"",
                           "itemDisclaimer":{  
                               "en":""
                           },
                           "prizeId":0,
                           "RecordCode":105186000000002
                       },
                       "NodeId":75000000013,
                       "OutOfInventory":false,
                       "CurrentInventory":994
                   }
               }
           ],
           "TotalRecords":3,
           "RecordsPerPage":500,
           "CurrentDataRecordNumber":0
       }
   }

Example Response: Error passing in invalid category named badCat 

   {
       "Error": {    
           "Code": "error.business.InvalidArgument", 
           "Message": "Invalid Argument",    
           "Reference": "Category :badCat not found."   
       }
   }
Retrieved from "https://code.helloworld.com/wiki/index.php/CatalogItemList"
Personal tools