(Quick Reference) Service: Show a discount list

Description: This web service return an existing discount list of the specified id in JSON format

URL:

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

URL with external_id:

https://BASE_URL/api/VERSION/discountLists/reference/{id}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idThe ID of the desired discount listLong/StringYes777

Success Output

Success case: response.status=200
{
  "id": 4,
  "reference": "discount70",
  "name": "70% discount",
  "percentageDiscount": 70.0,
  "billingCategory": null,
  "itemCategories": [],
  "organization": "entity1",
  "dateCreated": "2016-06-30T12:23:56Z",
  "lastUpdated": "2016-07-01T10:22:39Z"
}

Failure Output

Failure case:response.status = 404
{
  "error": "not_found",
  "error_description": "The discount list with the id 10 doesn't exist."
}

Failure case:response.status = 400
{
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}