GET api/v7/Vendors?region={region}

Returns a set of vendor records matching the criteria or all vendor records if no criteria are provided.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
region *

The region of the vendor records requested.

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

A response containing an acknowledgement and the requested vendor information.

Collection of 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": "sample string 1",
    "vendorName": "sample string 2",
    "addressLine1": "sample string 3",
    "addressLine2": "sample string 4",
    "addressLine3": "sample string 5",
    "city": "sample string 6",
    "administrativeArea": "sample string 7",
    "postalCode": "sample string 8",
    "country": "sample string 9",
    "phone": "sample string 10",
    "email": "sample string 11",
    "region": "sample string 12",
    "location": {
      "longitude": 1.1,
      "latitude": 2.1
    },
    "locationType": "sample string 13",
    "customerAuditDate": "2018-01-01T00:00:00"
  },
  {
    "vendorCode": "sample string 1",
    "vendorName": "sample string 2",
    "addressLine1": "sample string 3",
    "addressLine2": "sample string 4",
    "addressLine3": "sample string 5",
    "city": "sample string 6",
    "administrativeArea": "sample string 7",
    "postalCode": "sample string 8",
    "country": "sample string 9",
    "phone": "sample string 10",
    "email": "sample string 11",
    "region": "sample string 12",
    "location": {
      "longitude": 1.1,
      "latitude": 2.1
    },
    "locationType": "sample string 13",
    "customerAuditDate": "2018-01-01T00:00:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfVendor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Vendor>
    <vendorCode>sample string 1</vendorCode>
    <vendorName>sample string 2</vendorName>
    <addressLine1>sample string 3</addressLine1>
    <addressLine2>sample string 4</addressLine2>
    <addressLine3>sample string 5</addressLine3>
    <city>sample string 6</city>
    <administrativeArea>sample string 7</administrativeArea>
    <postalCode>sample string 8</postalCode>
    <country>sample string 9</country>
    <phone>sample string 10</phone>
    <email>sample string 11</email>
    <region>sample string 12</region>
    <location>
      <longitude>1.1</longitude>
      <latitude>2.1</latitude>
    </location>
    <locationType>sample string 13</locationType>
    <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
  </Vendor>
  <Vendor>
    <vendorCode>sample string 1</vendorCode>
    <vendorName>sample string 2</vendorName>
    <addressLine1>sample string 3</addressLine1>
    <addressLine2>sample string 4</addressLine2>
    <addressLine3>sample string 5</addressLine3>
    <city>sample string 6</city>
    <administrativeArea>sample string 7</administrativeArea>
    <postalCode>sample string 8</postalCode>
    <country>sample string 9</country>
    <phone>sample string 10</phone>
    <email>sample string 11</email>
    <region>sample string 12</region>
    <location>
      <longitude>1.1</longitude>
      <latitude>2.1</latitude>
    </location>
    <locationType>sample string 13</locationType>
    <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
  </Vendor>
</ArrayOfVendor>