(Quick Reference)
Service: Update
Description: This web service is used to update an existing customerGroupPromotionLists object to the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/customerGroupPromotionLists
:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to update | Long | Yes | 123 |
| promotionListId | the id of the promotionList to assign | Long | Yes | 777 |
| customerGroupId | the id of the customer to assign | Long | Yes | 111 |
URL with external_id:
https://BASE_URL/api/VERSION/customerGroupPromotionLists/reference/{customerGroupId}/{promotionListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerGroupId | reference of the customer group | String | Yes | CG-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": 6,
"promotionListReference": "RP-001",
"customerGroupReference": "CG-003",
"customerGroup": {
"id": 7,
"reference": "CG-003",
"name": "CusG3",
"href": "/api/v1/customerGroups/7"
},
"promotionList": {
"id": 9,
"reference": "RP-001",
"href": "/api/v1/promotionLists/9"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T11:42:30Z",
"lastUpdated": "2016-08-24T11:42:30Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "promotionListId parameter is missing"
}{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}{
"error": "already_assigned",
"error_description": "customer group is already assigned to promotionList."
}{
"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..."
}
