(Quick Reference)
Service: Show a promotion list
Description: This web service return an existing promotion list of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/promotionLists/{id}:
https://BASE_URL/api/VERSION/promotionLists/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired promotion list | Long/String | Yes | 777 |
Success Output
Success case: response.status = 200
{
"id": 1,
"reference": "save_more",
"description": "Buy More, Save More",
"startDate": "2015-12-01",
"endDate": "2015-12-31",
"isActive": false,
"applyToAllCustomers": true,
"promotionInputs": [
{
"id": 1,
"href": "/api/v1.0/promotionInputs/1"
}
],
"promotionOutputs": [
{
"id": 1,
"href": "/api/v1.0/promotionOutputs/1"
}
],
"organization": "entity1",
"dateCreated": "2015-12-17T14:36:26Z",
"lastUpdated": "2015-12-17T14:36:26Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The promotion list with the id 199 doesn't exist."
}
