Skip to content

Salesforce API (1)

This API provides access to several CDQ API endpoints according to the Salesforce object reference. Requests and responses are mapped from the CDQ data model to the Salesforce object reference in order to simplify service access from Salesforce integrations.

Download OpenAPI description
api-v1.json
api-v1.yaml
Languages
Servers
Production

https://api.cdq.com/salesforce/rest/

Business Partners

Operations

Lookup Business Partners

Request

Lookup a business partner in all available data sources.

Security
apiKey
Bodyapplication/jsonrequired
namestring

Name of the Business Partner.

Example: "CDQ AG"
identifierTypestring

Identifier type of the Business Partner.

Example: "EU_VAT_ID_DE"
identifierValuestring

Identifier value of the Business Partner.

Example: "DE123456789"
countrystring

Country of the Business Partner.

Example: "DE"
citystring

City of the Business Partner.

Example: "Hamburg"
postCodestring

Post code of the Business Partner.

Example: "20095"
streetstring

Street of the Business Partner.

Example: "Jungfernstieg"
houseNostring

House number of the Business Partner.

Example: "4"
matchingThresholdnumber(double)[ 0 .. 1 ]

Matching threshold for the Business Partner.

Example: "0.5"
maxCandidatesinteger[ 20 .. 100 ]

Maximum number of candidates to return. Default is 50.

Example: "50"
pageSizeinteger

Number of items per page.

Example: "10"
pageinteger

Current page number.

Default 0
Example: "0"
limitResultsinteger

Number of items per page.

Example: "100"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
curl -i -X POST \
  https://api.cdq.com/salesforce/rest/referencedata/restv3/businesspartners/lookup \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "businessPartner": {
      "addresses": [
        {
          "country": {
            "shortName": "PL"
          }
        }
      ],
      "identifiers": [
        {
          "value": "PL9280012700",
          "type": {
            "technicalKey": "EU_VAT_ID_PL"
          }
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
pageSizeinteger

Number of items per page.

Example: "10"
totalsinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger

Current page number.

Example: "0"
limitResultsinteger

Number of items per page.

Example: "100"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
businessPartnerCandidatesArray of objects(SalesforceBusinessPartnerLookupCandidate)

List of Business Partner candidates.

Response
application/json
{
  "pageSize": "10",
  "totals": "67",
  "page": "0",
  "limitResults": "100",
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "businessPartnerCandidates": [
    { … }
  ]
}