Search Business Partners

Use for single queries to quickly find a Business Partner. User have to verify the results. To be used when Business Partner is not normalized e.g. Company Name and Address are in one line.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

page
integer (schemas-Page) >= 0
Default: 0

Current page number.

Example: "1"
pageSize
integer (PageSize) [ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "10"
query
string non-empty

Pattern which will be used to search in multiple fields.

Example: "CDQ Lukasstrasse 4, Sankt Gallen 9000"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/search
Request samples
application/json
{
  • "query": "CDQ, 50-078 Wrocław"
}
Response samples
application/json
{
  • "pageSize": "10",
  • "totals": "67",
  • "page": "1",
  • "values": [
    ]
}