POST public-api/vendors/advancedinfosearch

This method returns a page full of active vendors given a precise set of search, sort or filter criteria. It's a paging API so this is meant to be called with a smaller number (ca 100) of records to fetch, repeatedly, until you get them all. 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

AdvancedSearchParameters

Name	Type	Additional information
TotalCountFromPriorFetch	integer	None.
AdditionalSkipCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Sort	Collection of Object	None.
Filter	TopLevelFilterType	None.
ClientUtcOffset	TimeZoneInfoId	None.
FilterBehavior	FilterBehaviorFlags	None.
IgnoreAttachments	boolean	None.
IgnoreGeoLocation	boolean	None.
WorkingSiteIdCsvList	string	None.

Request Formats

application/json

Sample:

{
  "_sortCriteria": [],
  "TotalCountFromPriorFetch": 1,
  "AdditionalSkipCount": 1,
  "PageSize": 2,
  "PageNumber": 3,
  "Filter": {
    "$id": "1",
    "field": "sample string 1",
    "operator": "sample string 2",
    "value": {},
    "logic": "sample string 4",
    "filters": []
  },
  "ClientUtcOffset": null,
  "FilterBehavior": 0,
  "IgnoreAttachments": true,
  "IgnoreGeoLocation": true,
  "WorkingSiteIdCsvList": "6"
}

Response Information

Resource Description

WaspResultOfListOfVendorModelInfo

Name	Type	Additional information
Data	Collection of VendorModelInfo	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": [
    {
      "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-02-17T11:52:06.5469618+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-02-17T11:52:06.5469618+00:00",
          "UserLogon": "sample string 2"
        }
      ],
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T11:52:06.5469618+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T11:52:06.5469618+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-02-17T11:52:06.5469618+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-02-17T11:52:06.5469618+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-02-17T11:52:06.5469618+00:00",
          "UserLogon": "sample string 2"
        }
      ],
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T11:52:06.5469618+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-02-17T11:52:06.5469618+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-02-17T11:52:06.5469618+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
}