Manage the categories of voucher entities.
| Name | Type | Is Mandatory |
|---|---|---|
| HierarchyNode | String | |
| ParentHierarchyNode | String | |
| HierarchyLevel | Int16 | |
| VoucherCategoryId | Int16 | |
| Label | String | |
| Identifier | String | |
| SourceId | Int16 | |
| DeletionFlag | Boolean | |
| VoucherCategoryPath | String | |
| VoucherTypeId | Int16 | |
| Amount | Decimal | |
| PointCost | Int32 | |
| LoyaltyCardTypeId | Int16 | |
| VoucherExpirationDelayDay | Int32 | |
| VoucherExpirationDelayMonth | Int32 | |
| VoucherExpirationDelayYear | Int32 | |
| Source | Source | |
| Vouchers | Collection of Voucher | |
| VoucherCategoryTranslations | Collection of VoucherCategoryTranslation | |
| VoucherType | VoucherType | |
| LoyaltyCardType | LoyaltyCardType |
Select all VoucherCategories
https://customerapi.fts-crm360.com/data/VoucherCategories()
HttpMethod : GET
Json Result :
[
{
"HierarchyNode" : "9tDxEQXK LJ",
"ParentHierarchyNode" : "0Xm13KuoM2 VosArn",
"HierarchyLevel" : "5",
"VoucherCategoryId" : "8",
"Label" : "aTgGQul5e",
"Identifier" : "Y7pt MYarplyx0Daa",
"SourceId" : "6",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "xuUm9h1ekJkz",
"VoucherTypeId" : "2",
"Amount" : "4517978.327",
"PointCost" : "18",
"LoyaltyCardTypeId" : "7",
"VoucherExpirationDelayDay" : "64",
"VoucherExpirationDelayMonth" : "53",
"VoucherExpirationDelayYear" : "68"
},
{
"HierarchyNode" : "0SAj",
"ParentHierarchyNode" : "omCuc",
"HierarchyLevel" : "4",
"VoucherCategoryId" : "9",
"Label" : "hDyoZWAvf2gKk9J4V",
"Identifier" : "Jcv1i",
"SourceId" : "3",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "0anLPd WOF",
"VoucherTypeId" : "9",
"Amount" : "1231182.185",
"PointCost" : "67",
"LoyaltyCardTypeId" : "5",
"VoucherExpirationDelayDay" : "15",
"VoucherExpirationDelayMonth" : "40",
"VoucherExpirationDelayYear" : "45"
},
...
]
Select VoucherCategory by Id
https://customerapi.fts-crm360.com/data/VoucherCategories(4)
HttpMethod : GET
Json Result :
{
"HierarchyNode" : "aFqfhfD",
"ParentHierarchyNode" : "kGTmCvNvC U3",
"HierarchyLevel" : "8",
"VoucherCategoryId" : "4",
"Label" : "CZNS2K9eyyS9Qi",
"Identifier" : "XeBza9dh9EO5Z",
"SourceId" : "2",
"DeletionFlag" : "False",
"VoucherCategoryPath" : "W anGTNMVlng",
"VoucherTypeId" : "7",
"Amount" : "8925688.117",
"PointCost" : "57",
"LoyaltyCardTypeId" : "8",
"VoucherExpirationDelayDay" : "24",
"VoucherExpirationDelayMonth" : "21",
"VoucherExpirationDelayYear" : "64"
}
Create a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories()
HttpMethod : POST
Json Post :
{
"HierarchyNode" : "kVuO79 6",
"ParentHierarchyNode" : "DR0d W8tNTRt",
"HierarchyLevel" : "9",
"Label" : "OtU9vCOE iEA",
"Identifier" : "ylzyHQ ii",
"SourceId" : "9",
"DeletionFlag" : "False",
"VoucherCategoryPath" : "VlIA4Wh",
"VoucherTypeId" : "6",
"Amount" : "8556118.393",
"PointCost" : "29",
"LoyaltyCardTypeId" : "4",
"VoucherExpirationDelayDay" : "80",
"VoucherExpirationDelayMonth" : "7",
"VoucherExpirationDelayYear" : "18"
}
Informations :
- Non mandatory fields are optional for Json Post
Update a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(4)
HttpMethod : PUT
Json Post :
{
"HierarchyNode" : "ZfJb68",
"ParentHierarchyNode" : "tyy bFCGMiWcSEM",
"HierarchyLevel" : "8",
"VoucherCategoryId" : "1",
"Label" : "wjQtJYQaAm",
"Identifier" : "MEu1zx Mpa",
"SourceId" : "2",
"DeletionFlag" : "False",
"VoucherCategoryPath" : "E0al3BM",
"VoucherTypeId" : "7",
"Amount" : "2124416.421",
"PointCost" : "8",
"LoyaltyCardTypeId" : "5",
"VoucherExpirationDelayDay" : "72",
"VoucherExpirationDelayMonth" : "99",
"VoucherExpirationDelayYear" : "46"
}
Informations :
- Non mandatory fields are optional for Json Post
Patch a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(4)
HttpMethod : PATCH
Json Post :
{
"VoucherExpirationDelayYear" : "63",
"PointCost" : "61",
"HierarchyNode" : "TYkY8moFnT7p",
"LoyaltyCardTypeId" : "5"
}
Informations :
- Non mandatory fields are optional for Json Post
Delete a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(4)
HttpMethod : DELETE
Translate a VoucherCategory label
https://customerapi.fts-crm360.com/data/VoucherCategories(4)/Label
HttpMethod : GET
Required Fields :
Http Header for language : X-Crm360Api-Language-3