This is a series of articles dedicated to managing customer objects via Openprovider API.
This is a second article in a series in which we are going to cover customer handle search. To get more information about our API in general, please use our documentation portal as your reference.
Searching for a handle
Use endpoint path below. Base URL is determined by both the target environment and API version.
GET {base_url}/customer
Our API has two methods that can return information about an existing customer object. The first one that we are going to cover is a method which returns a list of customer objects matching a particular search criteria.
REQUEST VALUES↓
| Name | Type | Description |
| handle_pattern | string | |
| email_pattern | string | |
| first_name_pattern | string | |
| last_name_pattern | string | |
| company_name_pattern | string | |
| comment_pattern | string | |
| with_additional_data | boolean | Accepted values ‘true’ or ‘false’ - default value ‘false’ |
| limit | integer | default value: 100, maximum value: 1000 |
| offset | integer | default value: 0 |
REQUEST EXAMPLE↓
curl -X GET \
'https://api.cte.openprovider.eu/v1beta/customers?handle_pattern=XX123456-XX&with_additional_data=true' \
-H 'Authorization: ,Bearer 2831a37fb8*******90b5aac822' \
RESPONSE EXAMPLE↓
RESPONSE VALUES↓
| Name | Type | Description |
| handle | varchar | Customer unique identifier or handle |
| company_name | ||
| vat | ||
| name | ||
| address | ||
| phone | ||
| fax | ||
| additional_data | if withAdditionalData = true | |
| extension_additional_data | if withAdditionalData = true |
Retrieving a handle
Once we know that a particular user handle exists, we can retrieve its data by calling Get Customer:
Use endpoint path below. Base URL is determined by both the target environment and API version.
GET {base_url}/customer/{handle}
REQUEST VALUES↓
| Name | Type | Description |
| handle | string | |
| with_additional_data | string | Accepted values ‘true’ or ‘false’ - default value ‘false’ |
REQUEST EXAMPLE↓
curl -X GET \
'https://api.cte.openprovider.eu/v1beta/customers/XX123456-XX?with_additional_data=true' \
-H 'Authorization: ,Bearer 2831a37fb8*******90b5aac822' \
RESPONSE EXAMPLE↓
