GET api/v7/Hierarchies?hierarchyLevelCode={hierarchyLevelCode}

Retrieve the hierarchy information for the given hierarchy level code.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
hierarchyLevelCode *

the hierarchy level code

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

Returns hierarchy information for specified level

Collection of HierarchyDto
NameDescriptionType
hierarchyCode

Hiearchy Code

 string
hierarchyLevelCode

Hierarchy Level Code

 string
description

Hierarchy Description

 string
culture

Culture

 string
parentHierarchyCode

Parent Hierarhcy Code

 string
externalId

External Hierarchy ID

 string
taxClassCode

TaxClass Code for the hierarchy

 string
taxTypeCodes

Hierarchy Tax Type

 Collection of string
salesCategoryCode

Sales Category Code for the hierarchy

 string
maxAllowedQuantity

Maximum sales quantity allowed for any item under this Hierarchy

 integer
ubcRequired

Flag which indicates if UBC is required for item sold at hierarchy

 boolean
nonReturnable

Flag which represents if an item sold by hierarchy is returnable

 boolean
customerAuditDate

Last modified audit information

 date

Response Formats

application/json, text/json

Sample: 
[
  {
    "hierarchyCode": "sample string 1",
    "hierarchyLevelCode": "sample string 2",
    "description": "sample string 3",
    "culture": "sample string 4",
    "parentHierarchyCode": "sample string 5",
    "externalId": "sample string 6",
    "taxClassCode": "sample string 7",
    "taxTypeCodes": [
      "sample string 1",
      "sample string 2"
    ],
    "salesCategoryCode": "sample string 8",
    "maxAllowedQuantity": 1,
    "ubcRequired": true,
    "nonReturnable": true,
    "customerAuditDate": "2018-01-01T00:00:00"
  },
  {
    "hierarchyCode": "sample string 1",
    "hierarchyLevelCode": "sample string 2",
    "description": "sample string 3",
    "culture": "sample string 4",
    "parentHierarchyCode": "sample string 5",
    "externalId": "sample string 6",
    "taxClassCode": "sample string 7",
    "taxTypeCodes": [
      "sample string 1",
      "sample string 2"
    ],
    "salesCategoryCode": "sample string 8",
    "maxAllowedQuantity": 1,
    "ubcRequired": true,
    "nonReturnable": true,
    "customerAuditDate": "2018-01-01T00:00:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfHierarchyDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <HierarchyDto>
    <hierarchyCode>sample string 1</hierarchyCode>
    <hierarchyLevelCode>sample string 2</hierarchyLevelCode>
    <description>sample string 3</description>
    <culture>sample string 4</culture>
    <parentHierarchyCode>sample string 5</parentHierarchyCode>
    <externalId>sample string 6</externalId>
    <taxClassCode>sample string 7</taxClassCode>
    <taxTypeCodes>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </taxTypeCodes>
    <salesCategoryCode>sample string 8</salesCategoryCode>
    <maxAllowedQuantity>1</maxAllowedQuantity>
    <ubcRequired>true</ubcRequired>
    <nonReturnable>true</nonReturnable>
    <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
  </HierarchyDto>
  <HierarchyDto>
    <hierarchyCode>sample string 1</hierarchyCode>
    <hierarchyLevelCode>sample string 2</hierarchyLevelCode>
    <description>sample string 3</description>
    <culture>sample string 4</culture>
    <parentHierarchyCode>sample string 5</parentHierarchyCode>
    <externalId>sample string 6</externalId>
    <taxClassCode>sample string 7</taxClassCode>
    <taxTypeCodes>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </taxTypeCodes>
    <salesCategoryCode>sample string 8</salesCategoryCode>
    <maxAllowedQuantity>1</maxAllowedQuantity>
    <ubcRequired>true</ubcRequired>
    <nonReturnable>true</nonReturnable>
    <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
  </HierarchyDto>
</ArrayOfHierarchyDto>