GET partners?customerNumber={customerNumber}&partnerTypes={partnerTypes}


Get a list of partners based of a customerNumber, and or potentially limit the types that come back in partnerTypes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNumber

Customer you are requesting partner data for.

string

Required

partnerTypes

Provide a filter for what partner types to return.

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseOfPartnerRecord
NameDescriptionTypeAdditional information
totalRecords

integer

None.

maxRecords

integer

None.

isSuccess

boolean

None.

data

Collection of PartnerRecord

None.

returnMessages

Collection of ReturnMessages

None.

Response Formats

application/json, text/json

Sample:
{
  "totalRecords": 1,
  "maxRecords": 2,
  "isSuccess": true,
  "data": [
    {
      "companyNumber": "sample string 1",
      "name1": "sample string 2",
      "name2": "sample string 3",
      "street": "sample string 4",
      "city": "sample string 5",
      "state": "sample string 6",
      "country": "sample string 7",
      "countryLong": "sample string 8",
      "stateLong": "sample string 9",
      "zip": "sample string 10",
      "telephone": "sample string 11",
      "industryType": "sample string 12"
    },
    {
      "companyNumber": "sample string 1",
      "name1": "sample string 2",
      "name2": "sample string 3",
      "street": "sample string 4",
      "city": "sample string 5",
      "state": "sample string 6",
      "country": "sample string 7",
      "countryLong": "sample string 8",
      "stateLong": "sample string 9",
      "zip": "sample string 10",
      "telephone": "sample string 11",
      "industryType": "sample string 12"
    }
  ],
  "returnMessages": [
    {
      "messageNumber": "sample string 1",
      "messageType": "sample string 2",
      "message": "sample string 3",
      "severity": 0,
      "errorField": "sample string 4"
    },
    {
      "messageNumber": "sample string 1",
      "messageType": "sample string 2",
      "message": "sample string 3",
      "severity": 0,
      "errorField": "sample string 4"
    }
  ]
}