v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Hierarchy Service

saveHierarchyV2

Create a new hierarchy. Update a hierarchy's details. Delete a hierarchy.

post/hierarchy/v2/saveHierarchy

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Request body

Example request

{
  "hierarchyDetails": {
    "hierarchyDetailDetails": [
      {
        "levelNumber": 1,
        "levelName": "Corp",
        "levelDescription": "Corporate",
        "logicalName": "Corporate",
        "parentLogicalName": "",
        "locationCode": ""
      },
      {
        "levelNumber": 2,
        "levelName": "Reg",
        "levelDescription": "Regions",
        "logicalName": "Northeast",
        "parentLogicalName": "Corporate",
        "locationCode": ""
      },
      {
        "levelNumber": 3,
        "levelName": "Store",
        "levelDescription": "Stores",
        "logicalName": "",
        "parentLogicalName": "Northeast",
        "locationCode": "Test11"
      },
      {
        "levelNumber": 3,
        "levelName": "Store",
        "levelDescription": "Stores",
        "logicalName": "",
        "parentLogicalName": "Northeast",
        "locationCode": "Test12"
      }
    ],
    "hierarchyHeaderDetails": {
      "deleteFlag": "N",
      "hierarchyType": "Corporate Structure",
      "locationCode": "129000"
    }
  }
}

Response

Success

object required