(Quick Reference) Service: Save

Description: This web service is used to add a new assigned item group object into the database

URL:

https://BASE_URL/api/VERSION/itemCustomerGroup

Method: POST

Request content type: application/json

Parameters:

NameDescriptionTypeRequiredExample values
customerGroupIdthe id of the customer group to be assignedLong/StringYes777
itemIdthe id of the new item group to assign to an itemGroupLong/StringYes123
useExternalIdBy default, it is set to false. set it to true if you want to use external ids.Booleannotrue , false

Success Output

Success case: response.status=201
{
    "id": 159,
    "itemReference": "R-A-001",
    "customerGroupReference": "RG-3",
    "item": {
      "id": 1751,
      "reference": "R-A-001",
      "name": "article1",
      "href": "/api/v1.0/items/1751"
    },
    "customerGroup": {
      "id": 23,
      "reference": "RG-3",
      "name": "new CustomerGroup3",
      "href": "/api/v1.0/customerGroups/23"
    },
    "organization": "Lyon",
    "dateCreated": "2016-08-23T11:23:27Z",
    "lastUpdated": "2016-08-23T11:23:27Z"
}

Failure Output

Failure case:response.status = 400
{
    "error": "missing_param",
    "error_description": "customerGroupId parameter is missing"
}
{
    "error": "already_assigned",
    "error_description": "item is already assigned to customerGroup."
}
{
     "error": "save_failed",
     "error_description": "Failed to save instance"
}

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

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