POST public-api/vendors/getvendorbynumber

This method returns existing vendor by number. It requires the Allow Vendor permission. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL.



Request Information

URI Parameters

None.

Body Parameters

Collection of string

Request Formats

application/json

Sample:
[
  "sample string 1",
  "sample string 2"
]



Response Information

Resource Description

WaspResultOfListOfWaspResultOfVendorModelInfo
NameDescriptionTypeAdditional information
Data

Collection of WaspResultOfVendorModelInfo

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": [
    {
      "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 2",
            "AddressLine2": "sample string 3",
            "AddressLine3": "sample string 4",
            "AddressLine4": "sample string 5",
            "AddressCity": "sample string 6",
            "AddressStateProvince": "sample string 7",
            "AddressCountry": "sample string 8",
            "AddressPostalCode": "sample string 9",
            "AddressTypeName": "sample string 10",
            "ContactPhone": "sample string 11",
            "ContactEmail": "sample string 12"
          },
          {
            "AddressLine1": "sample string 2",
            "AddressLine2": "sample string 3",
            "AddressLine3": "sample string 4",
            "AddressLine4": "sample string 5",
            "AddressCity": "sample string 6",
            "AddressStateProvince": "sample string 7",
            "AddressCountry": "sample string 8",
            "AddressPostalCode": "sample string 9",
            "AddressTypeName": "sample string 10",
            "ContactPhone": "sample string 11",
            "ContactEmail": "sample string 12"
          }
        ],
        "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-07-18T14:20:51.3055105+00:00",
            "UserLogon": "sample string 2"
          },
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-07-18T14:20:51.3055105+00:00",
            "UserLogon": "sample string 2"
          }
        ],
        "CustomFields": [
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-18T14:20:51.3055105+00:00",
            "DcfValueRecordStatus": 0
          },
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-18T14:20:51.3055105+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-07-18T14:20:51.3055105+00:00"
      },
      "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
    },
    {
      "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 2",
            "AddressLine2": "sample string 3",
            "AddressLine3": "sample string 4",
            "AddressLine4": "sample string 5",
            "AddressCity": "sample string 6",
            "AddressStateProvince": "sample string 7",
            "AddressCountry": "sample string 8",
            "AddressPostalCode": "sample string 9",
            "AddressTypeName": "sample string 10",
            "ContactPhone": "sample string 11",
            "ContactEmail": "sample string 12"
          },
          {
            "AddressLine1": "sample string 2",
            "AddressLine2": "sample string 3",
            "AddressLine3": "sample string 4",
            "AddressLine4": "sample string 5",
            "AddressCity": "sample string 6",
            "AddressStateProvince": "sample string 7",
            "AddressCountry": "sample string 8",
            "AddressPostalCode": "sample string 9",
            "AddressTypeName": "sample string 10",
            "ContactPhone": "sample string 11",
            "ContactEmail": "sample string 12"
          }
        ],
        "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-07-18T14:20:51.3055105+00:00",
            "UserLogon": "sample string 2"
          },
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-07-18T14:20:51.3055105+00:00",
            "UserLogon": "sample string 2"
          }
        ],
        "CustomFields": [
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-18T14:20:51.3055105+00:00",
            "DcfValueRecordStatus": 0
          },
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-07-18T14:20:51.3055105+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-07-18T14:20:51.3055105+00:00"
      },
      "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
    }
  ],
  "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
}