API: Partners
The ERP API Partners endpoint provides a list of customers and prospects and their associated information from the Enapps ERP system. As standard, this method returns 1000 records per page. It is recommended that the results of this API request are stored locally with the view to map e-commerce users with the associated company. This, should be used in conjunction with Addresses and Contacts APIs.
| Base URL | |
| https://<server>:<port>/api/v1 |
| Endpoint | /partners |
| Method | GET |
Request parameters | |||
Name |
Type |
Required | Description |
| _id | integer | No |
ID of a specific Partner to obtain only 1 Partner record details |
| crm_type | string | No |
Available options: customer, prospect |
| write_date | date_time | No |
Filter records modified from the specified date and later (%Y-%m-%d %H:%M:%S). |
| create_date | date_time | No |
Filter records created from the specified date and later (%Y-%m-%d %H:%M:%S). |
| ref | string | No |
Unique reference. |
| website | string | No |
Partner's website URL. |
| additional_fields | array/list | No |
Provide field names of additional fields not part of the standard Endpoint. For more information please refer to Additional Fields |
| page | integer | No |
Optional pagination parameter. |
Response params | ||
| Name | Type |
Description |
| id | integer |
Unique ID of a Partner |
| ref | string |
Company unique reference code in the system |
| name | string |
Company name |
| crm_type | string |
Type of a company: customer, prospect |
| write_date | string |
Partner last modification date |
| create_date | string |
Partner creation date |
Examples | |
| HTTP |
GET /api/v1/partners HTTP/1.1 Host: my_company.erp.zone:4095 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDkxMjQ2NzMsInQiOiJhY2Nlc3MiLCJsIjoid29vY29tbWVyY2VhcGkiLCJkYiI6InByb2R1Y3Rpb24ifQ.sbNvJUHttMLL_7g-IfiKg8WHx_Onq ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="crm_type" prospect ------WebKitFormBoundary7MA4YWxkTrZu0gW |