POST api/v7/Vendors
Accepts vendor information from a client.
Tables Impacted
Vendor
Request Information
URI Parameters
None.
Body Parameters
Vendor information to insert/create in db
Vendor| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| vendorCode * |
vendor code |
string |
Yes |
String length: between 1 and 24, inclusive |
| vendorName |
vendor name, example Dockers,columbia |
string |
No |
String length: between 1 and 128, inclusive |
| addressLine1 |
First address for the vendor |
string |
No |
String length: between 1 and 128, inclusive |
| addressLine2 |
Second address for the vendor |
string |
No |
String length: between 1 and 128, inclusive |
| addressLine3 |
Third address for the vendor |
string |
No |
String length: between 1 and 128, inclusive |
| city |
City where vendor is located |
string |
No |
String length: between 1 and 64, inclusive |
| administrativeArea |
The top-level area division in the country, such as state, district, province, island, region, etc. |
string |
No |
String length: between 1 and 20, inclusive |
| postalCode |
Zipcode for the vendor address. |
string |
No |
String length: between 1 and 16, inclusive |
| country |
Country where vendor is located |
string |
No |
String length: between 1 and 64, inclusive |
| phone |
phone number for the vendor |
string |
No |
String length: between 1 and 16, inclusive |
|
email address for the vendor |
string |
No |
String length: between 1 and 55, inclusive |
|
| region |
region where the vendor is located Required for CMA Inventory; grouping of stores in the same sales zone |
string |
No |
String length: between 1 and 50, inclusive |
| location |
Longitude and Latitude position for the vendor location |
ProductCoordinateDto |
No |
None. |
| locationType |
Vendor or Other |
string |
No |
String length: between 1 and 50, inclusive |
| customerAuditDate |
Audit information |
date |
No |
None. |
Request Formats
application/json, text/json
{
"vendorCode": "VND001",
"vendorName": "Vendor 1",
"addressLine1": "123 Main St",
"addressLine2": "Suite 650",
"addressLine3": "",
"city": "Main City",
"administrativeArea": "OH",
"postalCode": "12345",
"country": "USA",
"phone": "404-555-1234",
"email": "help@vendor1.com",
"region": "Midwest",
"location": {
"longitude": -84.145863,
"latitude": 33.807233
},
"locationType": "Vendor",
"customerAuditDate": "2018-01-01T00:00:00"
}
application/xml, text/xml
<Vendor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<vendorCode>VND001</vendorCode>
<vendorName>Vendor 1</vendorName>
<addressLine1>123 Main St</addressLine1>
<addressLine2>Suite 650</addressLine2>
<addressLine3 />
<city>Main City</city>
<administrativeArea>OH</administrativeArea>
<postalCode>12345</postalCode>
<country>USA</country>
<phone>404-555-1234</phone>
<email>help@vendor1.com</email>
<region>Midwest</region>
<location>
<longitude>-84.145863</longitude>
<latitude>33.807233</latitude>
</location>
<locationType>Vendor</locationType>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
</Vendor>
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 |