(Quick Reference) Service: Show a promotion input

Description: This web service return an existing promotion input of the specified id in JSON format

URL:

https://BASE_URL/api/VERSION/promotionInputs/{id}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idThe numerical ID of the desired promotion inputLongYes777

Success Output

Success case: response.status=200

{
  "id": 46,
  "promotionListReference": "holiday_promo",
  "itemReference": null,
  "unitReference": null,
  "promotionList": {
    "id": 18,
    "reference": "holiday_promo",
    "href": "/api/v1.0/promotionLists/18"
  },
  "item": null,
  "unit": null,
  "itemGroupReference": null,
  "itemGroup": null,
  "promotionType": "1",
  "inputType": "5",
  "sequence": 1,
  "serial": 1,
  "operator": null,
  "enablePromotionSum": true,
  "applyToAllItems": false,
  "organization": "entity1",
  "dateCreated": "2016-10-07T15:38:31Z",
  "lastUpdated": "2016-10-07T15:38:31Z",
  "value": "20000"
}

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 Output

Failure case:response.status = 404
{
  "error": "not_found",
  "error_description": "The promotion input with the id 199 doesn't exist."
}