(Quick Reference)
Service: Show
Description: This web service return an existing customer group details of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/customerCategories/{id}
URL with external_id:
https://BASE_URL/api/VERSION/customerGroups/reference/{id}
Method: GET
Parameters:
Name | Description | Type | Required | Example values |
---|
id | id of the wanted customer group | Long/String | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 1,
"name": "Magasins traditionnels",
"reference": "Ref-01",
"organization": "Lyon",
"description": "Magasin traditionnel",
"dateCreated": "2015-10-14T09:45:58Z",
"lastUpdated": "2015-10-14T09:49:43Z"
}
Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer group with the id 999 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."
}