POST api/v7/Taxonomies
Accepts a taxonomy record to add to the database.
Tables Impacted
OrgUnit, TimeZone, Address
Request Information
URI Parameters
None.
Body Parameters
The actual taxonomy data.
Org Unit| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| name * |
Organizational unit name. |
string |
Yes |
String length: between 1 and 50, inclusive |
| description |
Organizational unit description |
string |
No |
String length: between 1 and 50, inclusive |
| externalCode |
External id of the organizational unit |
string |
No |
String length: between 1 and 128, inclusive |
| cultureName |
Default culture for a organizational unit. |
string |
No |
String length: between 1 and 50, inclusive |
| orgUnitLevelName * |
Corresponding organizational unit id. |
string |
Yes |
String length: between 1 and 50, inclusive |
| timeZone |
The time zone associated with the organizational unit. |
TimeZoneDto |
No |
None. |
| parentName |
Parent organizational unit name |
string |
No |
String length: between 1 and 50, inclusive |
| address |
Address of the organizational unit. |
AddressDto |
No |
None. |
| location |
Location of the organizational unit. |
TaxonomyCoordinateDto |
No |
None. |
| is24HourStore |
Indicates whether this is a 24 hour store. |
boolean |
No |
None. |
| phone |
Phone number of the organizational unit. |
string |
No |
String length: between 1 and 16, inclusive |
| fax |
Fax number of the organizational unit. |
string |
No |
String length: between 1 and 16, inclusive |
|
Email address of the organizational unit. |
string |
No |
String length: between 1 and 55, inclusive |
|
| locationType |
CMA Inventory location type: Store or DC. |
string |
No |
String length: between 1 and 50, inclusive |
| region |
A grouping of stores in the same shipping zone. |
string |
No |
String length: between 1 and 50, inclusive |
| openTimeUTC |
The store's opening time. |
time interval |
No |
None. |
| closeTimeUTC |
The store's closing time. |
time interval |
No |
None. |
| trackInventoryFlag |
A flag to indicate when the location's inventory is tracked by DSR/CMA. |
boolean |
No |
None. |
| shipRoutingPriority |
Determines order in which location will fulfill OMS orders.. |
integer |
No |
None. |
| sendEligibilityFlag |
Defines location as able to fulfill orders or not. |
boolean |
No |
None. |
| customerAuditDate |
Last modified audit information |
date |
No |
None. |
Request Formats
application/json, text/json
{
"name": "Store 4",
"description": "Retail Store #4",
"externalCode": "300",
"cultureName": "en-US",
"orgUnitLevelName": "Store",
"timeZone": {
"timezoneName": "EDT",
"timezoneDescription": "Eastern Time Zone",
"gmtOffset": -5.0
},
"parentName": "Retailer X",
"address": {
"addressLine1": "2651 Satellite Blvd",
"city": "Duluth",
"administrativeArea": "Georgia",
"postalCode": "30096",
"country": "USA"
},
"location": {
"longitude": 2.0,
"latitude": 1.0
},
"is24HourStore": false,
"phone": "55587654321",
"fax": "55512345678",
"email": "email@webmail.com",
"locationType": "Store",
"region": "Southeast",
"openTimeUTC": "09:00:00",
"closeTimeUTC": "17:00:00",
"trackInventoryFlag": true,
"shipRoutingPriority": 2,
"sendEligibilityFlag": true,
"customerAuditDate": "2018-01-01T00:00:00"
}
application/xml, text/xml
<Taxonomy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<name>Store 4</name>
<description>Retail Store #4</description>
<externalCode>300</externalCode>
<cultureName>en-US</cultureName>
<orgUnitLevelName>Store</orgUnitLevelName>
<timeZone>
<timezoneName>EDT</timezoneName>
<timezoneDescription>Eastern Time Zone</timezoneDescription>
<gmtOffset>-5.0</gmtOffset>
</timeZone>
<parentName>Retailer X</parentName>
<address>
<addressLine1>2651 Satellite Blvd</addressLine1>
<city>Duluth</city>
<administrativeArea>Georgia</administrativeArea>
<postalCode>30096</postalCode>
<country>USA</country>
</address>
<location>
<longitude>2</longitude>
<latitude>1</latitude>
</location>
<is24HourStore>false</is24HourStore>
<phone>55587654321</phone>
<fax>55512345678</fax>
<email>email@webmail.com</email>
<locationType>Store</locationType>
<region>Southeast</region>
<openTimeUTC />
<closeTimeUTC />
<trackInventoryFlag>true</trackInventoryFlag>
<shipRoutingPriority>2</shipRoutingPriority>
<sendEligibilityFlag>true</sendEligibilityFlag>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
</Taxonomy>
Response Information
Resource Description
Returns a HTTPResponse Message stating the success/failure of API Action
HttpResponseMessage| Name | Description | Type |
|---|---|---|
| Version | Version | |
| Content | HttpContent | |
| StatusCode | HttpStatusCode | |
| ReasonPhrase | string | |
| Headers | Collection of Object | |
| RequestMessage | HttpRequestMessage | |
| IsSuccessStatusCode | boolean |