CRM360° CustomerApi Documentation

Customer - LoyaltyCard

LoyaltyCard entities

Required HTTP Headers

  • X-Crm360Api-Token
  • X-Crm360Api-CustomerName
  • X-Crm360Api-DatabaseAlias

Functions

Entity Properties

Name Type Is Mandatory
LoyaltyCardId Int32
LoyaltyCardCode String
ContactId Int32
LoyaltyCardCodeTypeId Int16
LoyaltyCardTypeId Int16
LoyaltyCardStateId Int16
FreeField1 String
FreeField2 String
FreeField3 String
FreeField4 String
FreeField5 String
FreeFieldDateTime1 DateTime
FreeFieldDateTime2 DateTime
FreeFieldDateTime3 DateTime
FreeFieldDateTime4 DateTime
FreeFieldDateTime5 DateTime
FreeFieldNumber1 Decimal
FreeFieldNumber2 Decimal
FreeFieldNumber3 Decimal
FreeFieldNumber4 Decimal
FreeFieldNumber5 Decimal
FreeFieldBoolean1 Boolean
FreeFieldBoolean2 Boolean
FreeFieldBoolean3 Boolean
FreeFieldBoolean4 Boolean
FreeFieldBoolean5 Boolean
BrandId Int32
ValidityStartDate DateTime
ValidityEndDate DateTime
DeletionFlag Boolean
StoreId Int32
AdvertiserCreationDate DateTime
SourceId Int16
Contact Contact
Brand Brand
LoyaltyCardType LoyaltyCardType
LoyaltyCardCodeType LoyaltyCardCodeType
LoyaltyCardState LoyaltyCardState
LoyaltyCardActions Collection of LoyaltyCardAction
LoyaltyPoints Collection of LoyaltyPoint
Store Store
PurchaseHeaders Collection of PurchaseHeader
Vouchers Collection of Voucher
Source Source

Actions

Action Name Method Parameters Description Return
SumLoyaltyPoint POST
  • column (String)
  • loyaltyPointTypeId (Int32)
  • loyaltyCardTypeId (Int32)
  • brandId (Int32)
Compute Sum of chosen column of related LoyaltyPoint entities Decimal

Examples

Select all LoyaltyCards

https://customerapi.fts-crm360.com/data/LoyaltyCards()
HttpMethod : GET
Json Result :
[ { "LoyaltyCardId" : "78", "LoyaltyCardCode" : "y C5bPWX k", "ContactId" : "41", "LoyaltyCardCodeTypeId" : "3", "LoyaltyCardTypeId" : "6", "LoyaltyCardStateId" : "2", "FreeField1" : "4AZD oAaEG", "FreeField2" : "ibMmvC0d1LAQ J0", "FreeField3" : "K2kmkz0iLX8tw", "FreeField4" : "8yrr4JZ WcIVK", "FreeField5" : "vZ49oePMhJ9nWCjq3v", "FreeFieldDateTime1" : "1997-06-28T00:00:00", "FreeFieldDateTime2" : "2012-11-30T00:00:00", "FreeFieldDateTime3" : "1996-07-25T00:00:00", "FreeFieldDateTime4" : "2008-11-14T00:00:00", "FreeFieldDateTime5" : "2003-11-11T00:00:00", "FreeFieldNumber1" : "5982452.536", "FreeFieldNumber2" : "9885913.373", "FreeFieldNumber3" : "5738437.643", "FreeFieldNumber4" : "6831418.497", "FreeFieldNumber5" : "4779437.297", "FreeFieldBoolean1" : "True", "FreeFieldBoolean2" : "False", "FreeFieldBoolean3" : "True", "FreeFieldBoolean4" : "False", "FreeFieldBoolean5" : "False", "BrandId" : "77", "ValidityStartDate" : "2014-04-18T00:00:00", "ValidityEndDate" : "1996-08-26T00:00:00", "DeletionFlag" : "False", "StoreId" : "9", "AdvertiserCreationDate" : "2019-06-05T00:00:00", "SourceId" : "5" }, { "LoyaltyCardId" : "6", "LoyaltyCardCode" : "DIgrC6R6aD008RZEedq", "ContactId" : "72", "LoyaltyCardCodeTypeId" : "5", "LoyaltyCardTypeId" : "3", "LoyaltyCardStateId" : "5", "FreeField1" : "UpYuj", "FreeField2" : "13nx5PvEJ9Y21NY5z", "FreeField3" : "pslW1Ufymc", "FreeField4" : "ZhhWmN7MKX", "FreeField5" : "V UsVka", "FreeFieldDateTime1" : "2003-11-18T00:00:00", "FreeFieldDateTime2" : "2014-10-25T00:00:00", "FreeFieldDateTime3" : "2007-02-26T00:00:00", "FreeFieldDateTime4" : "2019-08-26T00:00:00", "FreeFieldDateTime5" : "1995-03-26T00:00:00", "FreeFieldNumber1" : "1835133.263", "FreeFieldNumber2" : "7748531.476", "FreeFieldNumber3" : "1542129.943", "FreeFieldNumber4" : "8955554.799", "FreeFieldNumber5" : "9351763.512", "FreeFieldBoolean1" : "False", "FreeFieldBoolean2" : "False", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "True", "FreeFieldBoolean5" : "False", "BrandId" : "57", "ValidityStartDate" : "2009-08-22T00:00:00", "ValidityEndDate" : "1996-03-05T00:00:00", "DeletionFlag" : "False", "StoreId" : "89", "AdvertiserCreationDate" : "2003-11-02T00:00:00", "SourceId" : "3" }, ... ]

Select LoyaltyCard by Id

https://customerapi.fts-crm360.com/data/LoyaltyCards(78)
HttpMethod : GET
Json Result :
{ "LoyaltyCardId" : "77", "LoyaltyCardCode" : "fwM4YA1Rh", "ContactId" : "79", "LoyaltyCardCodeTypeId" : "7", "LoyaltyCardTypeId" : "7", "LoyaltyCardStateId" : "1", "FreeField1" : "ed3g1J hO", "FreeField2" : "h4 VQ mkcL", "FreeField3" : "6WWFBV s5fNj", "FreeField4" : "i9 xdlT", "FreeField5" : "h2XeBfAhLHT yjGh", "FreeFieldDateTime1" : "1995-02-02T00:00:00", "FreeFieldDateTime2" : "2019-06-17T00:00:00", "FreeFieldDateTime3" : "2004-05-17T00:00:00", "FreeFieldDateTime4" : "2019-05-31T00:00:00", "FreeFieldDateTime5" : "2004-04-24T00:00:00", "FreeFieldNumber1" : "4883982.886", "FreeFieldNumber2" : "4596989.274", "FreeFieldNumber3" : "9749854.673", "FreeFieldNumber4" : "2211237.754", "FreeFieldNumber5" : "1593265.881", "FreeFieldBoolean1" : "True", "FreeFieldBoolean2" : "True", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "False", "FreeFieldBoolean5" : "True", "BrandId" : "59", "ValidityStartDate" : "2007-05-09T00:00:00", "ValidityEndDate" : "2018-08-03T00:00:00", "DeletionFlag" : "False", "StoreId" : "53", "AdvertiserCreationDate" : "2008-03-29T00:00:00", "SourceId" : "5" }

Create a LoyaltyCard

https://customerapi.fts-crm360.com/data/LoyaltyCards()
HttpMethod : POST
Json Post :
{
"LoyaltyCardCode" : "jaLb6b",
"ContactId" : "76",
"LoyaltyCardCodeTypeId" : "2",
"LoyaltyCardTypeId" : "3",
"LoyaltyCardStateId" : "6",
"FreeField1" : "XcyJ N5i x",
"FreeField2" : "cmkoiz4T",
"FreeField3" : "hWYz9LmXC3uBOF7zQ",
"FreeField4" : "l4oTQ8j2",
"FreeField5" : "37M8nb FZ",
"FreeFieldDateTime1" : "2005-03-07T00:00:00",
"FreeFieldDateTime2" : "2019-07-18T00:00:00",
"FreeFieldDateTime3" : "1995-11-22T00:00:00",
"FreeFieldDateTime4" : "2004-02-21T00:00:00",
"FreeFieldDateTime5" : "2000-05-11T00:00:00",
"FreeFieldNumber1" : "7864457.759",
"FreeFieldNumber2" : "1419128.433",
"FreeFieldNumber3" : "5178483.849",
"FreeFieldNumber4" : "2237847.524",
"FreeFieldNumber5" : "6243824.913",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "66",
"ValidityStartDate" : "2000-11-30T00:00:00",
"ValidityEndDate" : "2017-09-04T00:00:00",
"DeletionFlag" : "True",
"StoreId" : "58",
"AdvertiserCreationDate" : "2001-04-30T00:00:00",
"SourceId" : "8"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a LoyaltyCard

https://customerapi.fts-crm360.com/data/LoyaltyCards(78)
HttpMethod : PUT
Json Post :
{
"LoyaltyCardId" : "36",
"LoyaltyCardCode" : "x6GSBn TN7tVrZ",
"ContactId" : "92",
"LoyaltyCardCodeTypeId" : "2",
"LoyaltyCardTypeId" : "4",
"LoyaltyCardStateId" : "4",
"FreeField1" : "G tcSAMN6gmJuxyf",
"FreeField2" : "FH2a2LNwRW9z1zN2DO",
"FreeField3" : "Cd R0Zey",
"FreeField4" : "x9j43 FOdXPNfs",
"FreeField5" : "pO Es",
"FreeFieldDateTime1" : "2006-05-06T00:00:00",
"FreeFieldDateTime2" : "2003-10-28T00:00:00",
"FreeFieldDateTime3" : "2014-09-10T00:00:00",
"FreeFieldDateTime4" : "2010-08-12T00:00:00",
"FreeFieldDateTime5" : "2012-01-07T00:00:00",
"FreeFieldNumber1" : "5538114.469",
"FreeFieldNumber2" : "3819879.479",
"FreeFieldNumber3" : "9578669.413",
"FreeFieldNumber4" : "5313468.444",
"FreeFieldNumber5" : "8897782.539",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "90",
"ValidityStartDate" : "2014-10-19T00:00:00",
"ValidityEndDate" : "2008-08-23T00:00:00",
"DeletionFlag" : "False",
"StoreId" : "45",
"AdvertiserCreationDate" : "1995-11-08T00:00:00",
"SourceId" : "9"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a LoyaltyCard

https://customerapi.fts-crm360.com/data/LoyaltyCards(78)
HttpMethod : PATCH
Json Post :
{
"FreeFieldDateTime2" : "2004-03-10T00:00:00",
"BrandId" : "38",
"LoyaltyCardCode" : "vudR5m8WIIp",
"LoyaltyCardCodeTypeId" : "1",
"StoreId" : "12",
"FreeFieldNumber1" : "7452186.357",
"FreeField4" : "3VI9T2fgLrHaA",
"FreeFieldDateTime3" : "2022-12-31T00:00:00",
"FreeFieldDateTime4" : "1997-03-10T00:00:00",
"ContactId" : "78",
"FreeFieldBoolean1" : "True",
"FreeFieldNumber2" : "6453645.158"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a LoyaltyCard

https://customerapi.fts-crm360.com/data/LoyaltyCards(78)
HttpMethod : DELETE