POST public-api/customers/GetCustomersByNumber

This method returns the full detail of specific customers, looked up by exact customer number. Unlike advancedinfosearch, it returns Custom Field values, Address Models and Phone Models for each customer. Only active customers are returned. Duplicate numbers in the request are collapsed, and matching is case-insensitive. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL. It requires the Allow Customer permission.

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

WaspResultOfListOfCustomerModelInfo

Name	Type	Additional information
Data	Collection of CustomerModelInfo	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,
      "CustomerNumber": "sample string 2",
      "CustomerFirstName": "sample string 3",
      "CustomerLastName": "sample string 4",
      "CustomerEmail": "sample string 5",
      "CustomerDepartment": "sample string 6",
      "CustomerCompanyName": "sample string 7",
      "CustomerContactEmail": "sample string 8",
      "CustomerWebsite": "sample string 9",
      "CustomerContactFirstName": "sample string 10",
      "CustomerContactLastName": "sample string 11",
      "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"
        }
      ],
      "CustomerContactCellNumber": "sample string 12",
      "CustomerBusinessPhoneNumber": "sample string 13",
      "CustomerContactPhoneNumber": "sample string 14",
      "CustomerBusinessFaxNumber": "sample string 15",
      "CustomerContactFaxNumber": "sample string 16",
      "CustomerContactCell": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerBusinessPhone": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerContactPhone": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerBusinessFax": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerContactFax": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerNote": "sample string 17",
      "CustomerNotes": [
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:29.1673897+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:29.1673897+00:00",
          "UserLogon": "sample string 2"
        }
      ],
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-09-15T18:16:29.1673897+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-09-15T18:16:29.1673897+00:00",
          "DcfValueRecordStatus": 0
        }
      ],
      "HasAttachment": true,
      "CustomerName": "sample string 19",
      "IsAutogeneratedCustomerNumber": true,
      "AttachmentsToAdd": [
        "sample string 1",
        "sample string 2"
      ],
      "AttachmentsToDelete": [
        "sample string 1",
        "sample string 2"
      ],
      "LastUpdated": "2026-09-15T18:16:29.1673897+00:00",
      "AttachmentNames": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "ImportRowNumber": 1,
      "CustomerNumber": "sample string 2",
      "CustomerFirstName": "sample string 3",
      "CustomerLastName": "sample string 4",
      "CustomerEmail": "sample string 5",
      "CustomerDepartment": "sample string 6",
      "CustomerCompanyName": "sample string 7",
      "CustomerContactEmail": "sample string 8",
      "CustomerWebsite": "sample string 9",
      "CustomerContactFirstName": "sample string 10",
      "CustomerContactLastName": "sample string 11",
      "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"
        }
      ],
      "CustomerContactCellNumber": "sample string 12",
      "CustomerBusinessPhoneNumber": "sample string 13",
      "CustomerContactPhoneNumber": "sample string 14",
      "CustomerBusinessFaxNumber": "sample string 15",
      "CustomerContactFaxNumber": "sample string 16",
      "CustomerContactCell": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerBusinessPhone": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerContactPhone": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerBusinessFax": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerContactFax": {
        "PhoneNumber": "sample string 1",
        "PhoneExtension": "sample string 2",
        "PhoneTypeName": "sample string 3"
      },
      "CustomerNote": "sample string 17",
      "CustomerNotes": [
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:29.1673897+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:29.1673897+00:00",
          "UserLogon": "sample string 2"
        }
      ],
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-09-15T18:16:29.1673897+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-09-15T18:16:29.1673897+00:00",
          "DcfValueRecordStatus": 0
        }
      ],
      "HasAttachment": true,
      "CustomerName": "sample string 19",
      "IsAutogeneratedCustomerNumber": true,
      "AttachmentsToAdd": [
        "sample string 1",
        "sample string 2"
      ],
      "AttachmentsToDelete": [
        "sample string 1",
        "sample string 2"
      ],
      "LastUpdated": "2026-09-15T18:16:29.1673897+00:00",
      "AttachmentNames": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "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
}