Update Customer - Sellercloud API Docs
Overview
This endpoint can be used to update an existing customer.
In order to consume the endpoint you must:
- Be authenticated user
For information on how you can authenticate, see: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed to the call.
Endpoint
Example for such endpoint for TT server is https://tt.api.sellercloud.com/rest/api/Customers/{id}
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Customers/{id}
Request
- Method Type: HttpPut
- Authorization: Use Bearer Token
- token received from token authentication
- Header info: Content-Type: application/json
| Parameter | Data Type | Description | Is Required |
| Title | String | Customer title Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Name | String | Customer name Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| String | Customer email Optional. Provide null or omit in the request if no update of this field is needed. |
No | |
| EmailCC | String | Customer CC email Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| BusinessName | String | Customer business name Field is required when customer is Wholesale and client setting ‘Enable Required Fields for WholeSale Customers’ is enabled. Provide null or omit in the request if no update of this field is needed. |
No |
| BusinessAliases | List |
Customer business aliases Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| SourceId | String | Customer source id Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| IsWholesale | Boolean | Is wholesale customer Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| CompanyId | Integer | Customer company id Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| AccountManager1Id | Integer | Customer account manager 1 id Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| AccountManager1Commission | Decimal | Customer account manager 1 commission Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| AccountManager2Id | Integer | Customer account manager 2 id Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| AccountManager2Commission | Decimal | Customer account manager 2 commission Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| AccountManager3Id | Integer | Customer account manager 3 id Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| AccountManager3Commission | Decimal | Customer account manager 3 commission Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Salesman | String | Customer salesman Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Comments | String | Customer comments Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Rating | Enum | Customer rating Possible values: -NotRated = 0 -Very_Dissatisfied = 1 -Dissatisfied = 2 -Neutral = 3 -Satisfied = 4 -Very_Satisfied = 5 Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Phone1 | String | Customer phone 1 Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Phone2 | String | Customer phone 2 Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Phone3 | String | Customer phone 3 Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Mobile | String | Customer mobile phone Optional. Provide null or omit in the request if no update of this field is needed. |
No |
| Fax | String | Customer fax Optional. Provide null or omit in the request if no update of this field is needed. |
No |
Response
- If user is authenticated and the request is successful, then response will be Status Code 200 => OK
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- In case of error, response will be Status Code 500 => Internal Server Error
- In case of incorrect request, response will be with status code 400 Bad Request