GET api/v7/Taxonomies?organizationName={organizationName}

Returns a taxonomy record and its entire parent chain.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
organizationName *

Name of the taxonomy record.

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

A response containing an acknowledgement and the requested taxonomy information.

OrgUnitInfo
NameDescriptionType
name

Organizational unit name.

 string
description

Organizational unit description

 string
externalCode

External id of the organizational unit

 string
cultureName

Default culture for a organizational unit.

 string
orgUnitLevelSummary

Corresponding organizational unit id.

 OrgUnitLevelSummary
timeZone

The time zone associated with the organizational unit.

 TimeZoneDto
parentInfo

Parent organizational unit

 Collection of OrgUnitInfo
address

Address of the organizational unit.

 AddressDto
location

Location of the organizational unit.

 TaxonomyCoordinateDto
is24HourStore

Indicates whether this is a 24 hour store.

 boolean
phone

Phone number of the organizational unit.

 string
fax

Fax number of the organizational unit.

 string
email

Email address of the organizational unit.

 string
locationType

CMA Inventory location type: Store or DC.

 string
region

A grouping of stores in the same shipping zone.

 string
openTimeUTC

The store's opening time.

 time interval
closeTimeUTC

The store's closing time.

 time interval
trackInventoryFlag

A flag to indicate when the location's inventory is tracked by DSR/CMA.

 boolean
shipRoutingPriority

Determines order in which location will fulfill OMS orders..

 integer
sendEligibilityFlag

Defines location as able to fulfill orders or not.

 boolean
customerAuditDate

Last modified audit information

 date

Response Formats

application/json, text/json

Sample: 
{
  "name": "111",
  "description": "First sample store",
  "externalCode": "100",
  "orgUnitLevelSummary": {
    "orgUnitLevelName": "Store",
    "orgUnitLevelDescription": "Store level",
    "isStoreLevel": true
  },
  "parentInfo": [
    {
      "name": "Retailer X",
      "description": "A sample retailer",
      "externalCode": "root",
      "orgUnitLevelSummary": {
        "orgUnitLevelName": "Corporate",
        "orgUnitLevelDescription": "Corporate level",
        "isStoreLevel": false
      },
      "location": {
        "longitude": -84.101671,
        "latitude": 33.969061
      }
    }
  ],
  "locationType": "Store",
  "openTimeUTC": "10:30:00",
  "closeTimeUTC": "22:00:00",
  "trackInventoryFlag": true,
  "sendEligibilityFlag": true,
  "customerAuditDate": "2018-01-01T00:00:00"
}

application/xml, text/xml

Sample: 
<Taxonomy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <name>111</name>
  <description>First sample store</description>
  <externalCode>100</externalCode>
  <orgUnitLevelSummary>
    <orgUnitLevelName>Store</orgUnitLevelName>
    <orgUnitLevelDescription>Store level</orgUnitLevelDescription>
    <isStoreLevel>true</isStoreLevel>
  </orgUnitLevelSummary>
  <parentInfo>
    <OrgUnitInfo>
      <name>Retailer X</name>
      <description>A sample retailer</description>
      <externalCode>root</externalCode>
      <orgUnitLevelSummary>
        <orgUnitLevelName>Corporate</orgUnitLevelName>
        <orgUnitLevelDescription>Corporate level</orgUnitLevelDescription>
        <isStoreLevel>false</isStoreLevel>
      </orgUnitLevelSummary>
      <location>
        <longitude>-84.101671</longitude>
        <latitude>33.969061</latitude>
      </location>
      <is24HourStore xsi:nil="true" />
      <openTimeUTC xsi:nil="true" />
      <closeTimeUTC xsi:nil="true" />
      <trackInventoryFlag xsi:nil="true" />
      <shipRoutingPriority xsi:nil="true" />
      <sendEligibilityFlag xsi:nil="true" />
      <customerAuditDate xsi:nil="true" />
    </OrgUnitInfo>
  </parentInfo>
  <is24HourStore xsi:nil="true" />
  <locationType>Store</locationType>
  <openTimeUTC />
  <closeTimeUTC />
  <trackInventoryFlag>true</trackInventoryFlag>
  <shipRoutingPriority xsi:nil="true" />
  <sendEligibilityFlag>true</sendEligibilityFlag>
  <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
</Taxonomy>