(Quick Reference) Service: Save

Description: This web service is used to add a new customer group object to the database

URL:

https://BASE_URL/api/VERSION/customerGroups

Method: POST

Request content type: application/json

Parameters:

NameDescriptionTypeRequiredExample values
referencethe reference of the new customer groupStringYes 
namethe name of the new customer groupStringYes 
descriptionsome details of the new groupStringNo 
reference must be unique

Success Output

Success case: response.status=201
{
    "id": 4,
    "name": "test",
    "reference": "1",
    "organization": "Lyon",
    "description": null,
    "dateCreated": "2016-08-16T15:36:21Z",
    "lastUpdated": "2016-08-16T15:36:21Z"
}

Failure Output

Failure case:response.status = 400
{
    "error": "missing_param",
    "error_description": "reference parameter is missing"
}
{
    "error": "not_unique",
    "error_description": "reference already used"
}
{
     "error": "save_failed",
     "error_description": "Failed to save instance"
}

Failure case:response.status = 500
{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}