(Quick Reference)
Service: Show
Description: This web service return an existing customerCategoryPriceLists record of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/customerCategoryPriceLists/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerCategoryPriceLists/reference/{customerCategoryId}/{priceListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerCategoryId | reference of the customer category | String | Yes | CC-002 |
| priceListId | reference of the price list | String | Yes | DL-001 |
Success Output
Success case: response.status=200
{
"id": 9,
"priceListReference": "Ref-1",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"priceList": {
"id": 1,
"reference": "Ref-1",
"name": "Retail price",
"href": "/api/v1/priceLists/1"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T10:43:40Z",
"lastUpdated": "2016-08-24T10:43:40Z"
} 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 customer category price list with the id 999 doesn't exist."
}
