CRM360° CustomerApi Documentation

Customer - Zone

Zone entities

Required HTTP Headers

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

Functions

Entity Properties

Name Type Is Mandatory
HierarchyNode String
ParentHierarchyNode String
HierarchyLevel Int16
ZoneId Int32
Label String
DeletionFlag Boolean
ZoneHierarchyLabel String
Contacts Collection of Contact
Stores Collection of Store
ZoneTranslations Collection of ZoneTranslation
MarketingActions Collection of MarketingAction

Examples

Select all Zones

https://customerapi.fts-crm360.com/data/Zones()
HttpMethod : GET
Json Result :
[ { "HierarchyNode" : "TOwtDVkMIgq", "ParentHierarchyNode" : "u Hvxow", "HierarchyLevel" : "2", "ZoneId" : "4", "Label" : "RHGx1MMkTN5", "DeletionFlag" : "True", "ZoneHierarchyLabel" : "Gv9g4nx" }, { "HierarchyNode" : "K HQgYAjp Z47om", "ParentHierarchyNode" : "eX jNcPpL", "HierarchyLevel" : "1", "ZoneId" : "1", "Label" : "H1dP k8Gokqziuifp", "DeletionFlag" : "False", "ZoneHierarchyLabel" : "GWO Qwa" }, ... ]

Select Zone by Id

https://customerapi.fts-crm360.com/data/Zones(44)
HttpMethod : GET
Json Result :
{ "HierarchyNode" : "tvdDfYMaz7Id", "ParentHierarchyNode" : "rfo4sM d4v", "HierarchyLevel" : "9", "ZoneId" : "87", "Label" : "4b4aNe GOWKfK VTv", "DeletionFlag" : "True", "ZoneHierarchyLabel" : "0za1kgij z" }

Create a Zone

https://customerapi.fts-crm360.com/data/Zones()
HttpMethod : POST
Json Post :
{
"HierarchyNode" : "MoewhXtpdPbI",
"ParentHierarchyNode" : "YgxqJILdBCck",
"HierarchyLevel" : "3",
"Label" : "p5kG WrTh6kxX01Wi9",
"DeletionFlag" : "False",
"ZoneHierarchyLabel" : "HBxv0p"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a Zone

https://customerapi.fts-crm360.com/data/Zones(44)
HttpMethod : PUT
Json Post :
{
"HierarchyNode" : "JlAKMcDu4HAxyE 1",
"ParentHierarchyNode" : "YxVnqe",
"HierarchyLevel" : "5",
"ZoneId" : "86",
"Label" : "ymI Rvhs",
"DeletionFlag" : "False",
"ZoneHierarchyLabel" : "4 j5xGba86TBC5pb3dX"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a Zone

https://customerapi.fts-crm360.com/data/Zones(44)
HttpMethod : PATCH
Json Post :
{
"ParentHierarchyNode" : "FhS9qblD1QPF",
"HierarchyLevel" : "9"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Zone

https://customerapi.fts-crm360.com/data/Zones(44)
HttpMethod : DELETE

Translate a Zone label

https://customerapi.fts-crm360.com/data/Zones(44)/Label
HttpMethod : GET
Required Fields :
Http Header for language : X-Crm360Api-Language-3