(Quick Reference)
Service: Show a promotion output
Description: This web service return an existing promotion output of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/promotionOutputs/{id}
Method: GET
Parameters:
Name | Description | Type | Required | Example values |
---|
id | The numerical ID of the desired promotion output | Long | Yes | 777 |
Success Output
Success case: response.status = 200
{
"id": 46,
"promotionListReference": "holiday_promo",
"itemReference": null,
"unitReference": null,
"promotionList": {
"id": 17,
"reference": "holiday_promo",
"href": "/api/v1.0/promotionLists/17"
},
"item": null,
"unit": null,
"itemGroupReference": null,
"itemGroup": null,
"outputType": "7",
"sequence": 1,
"serial": 1,
"operator": null,
"duplicatePromotion": true,
"applyToAllItems": false,
"organization": "entity1",
"dateCreated": "2016-10-07T13:46:28Z",
"lastUpdated": "2016-10-07T13:46:28Z",
"discountType": "2",
"value": 150000
}
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 output with the id 199 doesn't exist."
}