(Quick Reference)
Service: Update
Description: This web service is used to add an existing customer promotion list object to the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/customerPromotionLists/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired customer promotion list to update | Long | required | 123 |
| promotionListId | the id of the promotionList to assign | Long | Yes | 777 |
| customerId | the id of the customer to assign | Long | Yes | 111 |
URL with external_id:
https://BASE_URL/api/VERSION/customerPromotionLists/reference/{customerId}/{promotionListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| promotionListId | reference of the promotion list | String | Yes | PL-001 |
If the value applyToAllCustomers of the specified promotion list is true then update can not be achieved
Success Output
Success case: response.status = 200
{
"id": 305,
"customerReference": "C-002",
"promotionListReference": "RP-001",
"customer": {
"id": 1335,
"reference": "C-002",
"name": "cus2",
"href": "/api/v1.0/customers/1335"
},
"promotionList": {
"id": 9,
"reference": "RP-001",
"href": "/api/v1.0/promotionLists/9"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T14:43:17Z",
"lastUpdated": "2016-08-22T15:28:56Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "promotionListId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customer is already assigned to promotionList."
}{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The promotionList with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
