POST http:///api/v1/partner/vendors
The request body takes a complete VendorAddRequest resource, containing the following writable properties:
{
"accountOwnerId": "string",
"active": "boolean",
"additionalAddressList": [
{
"address": "string",
"addressLine2": "string",
"city": "string",
"companyId": "string",
"country": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"latitude": "number",
"longitude": "number",
"modified": "int64",
"state": "string",
"updated": "boolean",
"zipCode": "string"
}
],
"address": {
"address": "string",
"addressLine2": "string",
"city": "string",
"companyId": "string",
"country": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"latitude": "number",
"longitude": "number",
"modified": "int64",
"state": "string",
"updated": "boolean",
"zipCode": "string"
},
"armsLengthType": "string",
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"brands": [
"string"
],
"companyLicenses": [
{
"companyType": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"licenseExpirationDate": "int64",
"licenseNumber": "string",
"licenseType": "string",
"modified": "int64",
"toDefault": "boolean",
"updated": "boolean"
}
],
"companyType": "string",
"connectedShop": "string",
"contactFirstName": "string",
"contactLastName": "string",
"contactPerson": "string",
"dbaName": "string",
"defaultContactId": "string",
"defaultPaymentTerm": "string",
"description": "string",
"email": "string",
"employeeId": "string",
"externalId": "string",
"fax": "string",
"firstName": "string",
"importId": "string",
"lastName": "string",
"licenceType": "string",
"licenseExpirationDate": "int64",
"licenseNumber": "string",
"medical": "boolean",
"mobileNumber": "string",
"name": "string",
"notes": [
{
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
}
],
"phone": "string",
"relatedEntity": "boolean",
"salesPerson": "string",
"vendorType": "string",
"website": "string"
}
Name | Type | Description | Additional |
---|---|---|---|
accountOwnerId | string | Optional | |
active | boolean | Optional | |
additionalAddressList[] | array | Optional | |
additionalAddressList[].address | string | Optional | |
additionalAddressList[].addressLine2 | string | Optional | |
additionalAddressList[].city | string | Optional | |
additionalAddressList[].companyId | string | Optional | |
additionalAddressList[].country | string | Optional | |
additionalAddressList[].created | int64 | Optional | |
additionalAddressList[].deleted | boolean | Optional | |
additionalAddressList[].id | string | Optional | |
additionalAddressList[].latitude | number | Optional | |
additionalAddressList[].longitude | number | Optional | |
additionalAddressList[].modified | int64 | Optional | |
additionalAddressList[].state | string | Optional | |
additionalAddressList[].updated | boolean | Optional | |
additionalAddressList[].zipCode | string | Optional | |
address | object | Address | Optional |
address.address | string | Optional | |
address.addressLine2 | string | Optional | |
address.city | string | Optional | |
address.companyId | string | Optional | |
address.country | string | Optional | |
address.created | int64 | Optional | |
address.deleted | boolean | Optional | |
address.id | string | Optional | |
address.latitude | number | Optional | |
address.longitude | number | Optional | |
address.modified | int64 | Optional | |
address.state | string | Optional | |
address.updated | boolean | Optional | |
address.zipCode | string | Optional | |
armsLengthType | string |
Possible values are:
|
Optional |
assets[] | array | Optional | |
assets[].active | boolean | Optional | |
assets[].assetType | string |
Possible values are:
|
Optional |
assets[].companyId | string | Optional | |
assets[].created | int64 | Optional | |
assets[].deleted | boolean | Optional | |
assets[].id | string | Optional | |
assets[].key | string | Optional | |
assets[].largeURL | string | Optional | |
assets[].largeX2URL | string | Optional | |
assets[].mediumURL | string | Optional | |
assets[].modified | int64 | Optional | |
assets[].name | string | Optional | |
assets[].origURL | string | Optional | |
assets[].priority | int32 | Optional | |
assets[].publicURL | string | Optional | |
assets[].secured | boolean | Optional | |
assets[].thumbURL | string | Optional | |
assets[].type | string |
Possible values are:
|
Optional |
assets[].updated | boolean | Optional | |
brands[] | array of string | Optional | |
companyLicenses[] | array | Optional | |
companyLicenses[].companyType | string |
Possible values are:
|
Optional |
companyLicenses[].created | int64 | Optional | |
companyLicenses[].deleted | boolean | Optional | |
companyLicenses[].id | string | Optional | |
companyLicenses[].licenseExpirationDate | int64 | Optional | |
companyLicenses[].licenseNumber | string | Optional | |
companyLicenses[].licenseType | string |
Possible values are:
|
Optional |
companyLicenses[].modified | int64 | Optional | |
companyLicenses[].toDefault | boolean | Optional | |
companyLicenses[].updated | boolean | Optional | |
companyType | string |
Possible values are:
|
Optional |
connectedShop | string | Optional | |
contactFirstName | string | Optional | |
contactLastName | string | Optional | |
contactPerson | string | Optional | |
dbaName | string | Optional | |
defaultContactId | string | Optional | |
defaultPaymentTerm | string | Optional | |
description | string | Optional | |
string | Optional | ||
employeeId | string | Optional | |
externalId | string | Optional | |
fax | string | Optional | |
firstName | string | Optional | |
importId | string | Optional | |
lastName | string | Optional | |
licenceType | string |
Possible values are:
|
Optional |
licenseExpirationDate | int64 | Optional | |
licenseNumber | string | Optional | |
medical | boolean | Optional | |
mobileNumber | string | Optional | |
name | string | Optional | |
notes[] | array | Optional | |
notes[].created | int64 | Optional | |
notes[].deleted | boolean | Optional | |
notes[].enableOnFleet | boolean | Optional | |
notes[].id | string | Optional | |
notes[].message | string | Optional | |
notes[].modified | int64 | Optional | |
notes[].updated | boolean | Optional | |
notes[].writerId | string | Optional | |
notes[].writerName | string | Optional | |
phone | string | Optional | |
relatedEntity | boolean | Optional | |
salesPerson | string | Optional | |
vendorType | string |
Possible values are:
|
Optional |
website | string | Optional |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK successful operation |
Vendor |