GET api/v7/Vendors/{vendorCode}

Returns a vendor record from the database.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
vendorCode *

Code of the vendor record used for location in the database.

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

A response containing an acknowledgement and the requested vendor information.

Vendor
NameDescriptionType
vendorCode

vendor code

 string
vendorName

vendor name, example Dockers,columbia

 string
addressLine1

First address for the vendor

 string
addressLine2

Second address for the vendor

 string
addressLine3

Third address for the vendor

 string
city

City where vendor is located

 string
administrativeArea

The top-level area division in the country, such as state, district, province, island, region, etc.

 string
postalCode

Zipcode for the vendor address.

 string
country

Country where vendor is located

 string
phone

phone number for the vendor

 string
email

email address for the vendor

 string
region

region where the vendor is located Required for CMA Inventory; grouping of stores in the same sales zone

 string
location

Longitude and Latitude position for the vendor location

 ProductCoordinateDto
locationType

Vendor or Other

 string
customerAuditDate

Audit information

 date

Response Formats

application/json, text/json

Sample: 
{
  "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

Sample: 
<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>