POST public-api/vendors/createNew
This method creates new Vendor. It requires the Create Vendor permission. It accepts a maximum of 500 records at a time. This will ignore the Vendor name already in existence. To create/update addresses (instead of ignoring them), please use the API public-api/addresses/suppliers/save. Use “Save” to perform operations including both inserts and updates.
Request Information
URI Parameters
None.
Body Parameters
VendorSaveRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicableFields | Collection of string |
None. |
|
| Data | Collection of VendorModelInfo |
None. |
Request Formats
application/json
Sample:
{
"ApplicableFields": [
"sample string 1",
"sample string 2"
],
"Data": [
{
"ImportRowNumber": 1,
"VendorNumber": "sample string 2",
"VendorName": "sample string 3",
"VendorEmail": "sample string 4",
"VendorWebsite": "sample string 5",
"VendorContactName": "sample string 6",
"VendorContactEmail": "sample string 7",
"VendorContactPhoneNumber": "sample string 8",
"VendorContactCellNumber": "sample string 9",
"VendorContactFaxNumber": "sample string 10",
"VendorPhoneNumber": "sample string 11",
"VendorFaxNumber": "sample string 12",
"Addresses": [
{
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
},
{
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
}
],
"ContactCell": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"ContactFax": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"ContactPhone": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"Phone": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"Fax": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"VendorNote": "sample string 13",
"VendorNotes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-03-12T14:43:01.4191155+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-03-12T14:43:01.4191155+00:00",
"UserLogon": "sample string 2"
}
],
"CustomFields": [
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-03-12T14:43:01.4191155+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-03-12T14:43:01.4191155+00:00",
"DcfValueRecordStatus": 0
}
],
"AttachmentsToAdd": [
"sample string 1",
"sample string 2"
],
"AttachmentsToDelete": [
"sample string 1",
"sample string 2"
],
"AttachmentNames": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"HasAttachment": true,
"LastUpdated": "2026-03-12T14:43:01.4191155+00:00"
},
{
"ImportRowNumber": 1,
"VendorNumber": "sample string 2",
"VendorName": "sample string 3",
"VendorEmail": "sample string 4",
"VendorWebsite": "sample string 5",
"VendorContactName": "sample string 6",
"VendorContactEmail": "sample string 7",
"VendorContactPhoneNumber": "sample string 8",
"VendorContactCellNumber": "sample string 9",
"VendorContactFaxNumber": "sample string 10",
"VendorPhoneNumber": "sample string 11",
"VendorFaxNumber": "sample string 12",
"Addresses": [
{
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
},
{
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"AddressCity": "sample string 5",
"AddressStateProvince": "sample string 6",
"AddressCountry": "sample string 7",
"AddressPostalCode": "sample string 8",
"AddressTypeName": "sample string 9",
"ContactPhone": "sample string 10",
"ContactEmail": "sample string 11"
}
],
"ContactCell": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"ContactFax": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"ContactPhone": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"Phone": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"Fax": {
"PhoneNumber": "sample string 1",
"PhoneExtension": "sample string 2",
"PhoneTypeName": "sample string 3"
},
"VendorNote": "sample string 13",
"VendorNotes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-03-12T14:43:01.4191155+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-03-12T14:43:01.4191155+00:00",
"UserLogon": "sample string 2"
}
],
"CustomFields": [
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-03-12T14:43:01.4191155+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-03-12T14:43:01.4191155+00:00",
"DcfValueRecordStatus": 0
}
],
"AttachmentsToAdd": [
"sample string 1",
"sample string 2"
],
"AttachmentsToDelete": [
"sample string 1",
"sample string 2"
],
"AttachmentNames": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"HasAttachment": true,
"LastUpdated": "2026-03-12T14:43:01.4191155+00:00"
}
]
}
Response Information
Resource Description
WaspResultOfResults| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Results |
None. |
|
| Messages | Collection of WtResult |
None. |
|
| BatchNumber | integer |
None. |
|
| HasError | boolean |
None. |
|
| HasHttpError | boolean |
None. |
|
| HasMessage | boolean |
None. |
|
| HasSuccessWithMoreDataRemaining | boolean |
None. |
|
| TotalRecordsLongCount | integer |
None. |
Response Formats
application/json
Sample:
{
"Data": {
"ResultList": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"SuccessfullResults": 1,
"TotalResults": 2,
"ErrorCount": 0
},
"Messages": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"BatchNumber": 1,
"HasError": false,
"HasHttpError": false,
"HasMessage": true,
"HasSuccessWithMoreDataRemaining": false,
"TotalRecordsLongCount": 1
}