(Quick Reference)
Service: Save
Description: This web service is used to add a new customer promotion list object to the database
URL:
https://BASE_URL/api/VERSION/customerPromotionLists
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| promotionListId | the id of the promotionList to assign | Long/String | Yes | 777 |
| customerId | the id of the customer to assign | Long/String | Yes | 111 |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
If the value applyToAllCustomers of the specified promotion list is true then save can not be achieved
Success Output
Success case: response.status = 201
{
"id": 307,
"customerReference": "C-003",
"promotionListReference": "RP-001",
"customer": {
"id": 1336,
"reference": "C-003",
"name": "cus3",
"href": "/api/v1.0/customers/1336"
},
"promotionList": {
"id": 9,
"reference": "RP-001",
"href": "/api/v1.0/promotionLists/9"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T15:16:25Z",
"lastUpdated": "2016-08-22T15:16:25Z"
} 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": "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..."
}
