(Quick Reference)
16 Assign customers to groups - Reference Documentation
Version: 2.1
16 Assign customers to groups
16.1 List
Service: List
Description: This web service return the list of assigned CustomerGroups in JSON Format
URL:
https://BASE_URL/api/VERSION/customerGroupAssign
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| offset | Tells where to start returning records from the entire set of results | Integer | No | |
| max | limits the number of resources requested to return | Integer | No | |
| sort | Orders the results by the specified field | String | No | |
| order | Orders ascending (ASC) or descending DESC | Integer | No | asc, desc |
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| groupReference | Wildcard search by the resource's reference | String | no | groupReference=Ref-6* , groupReference=*ef-6 , groupReference=*ef-6* |
| customerReference | Wildcard search by the customer's reference | String | no | customerReference=Ref-13* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 1,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 101,
"customerReference": "C-002",
"customerGroupReference": "CG-001",
"customer": {
"id": 1335,
"reference": "C-002",
"name": "cus2",
"href": "/api/v1.0/customers/1335"
},
"customerGroup": {
"id": 5,
"reference": "CG-001",
"name": "CusG1",
"href": "/api/v1.0/customerGroups/5"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T11:13:12Z",
"lastUpdated": "2016-08-22T11:13:12Z"
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}16.2 Show
Service: Show
Description: This web service return an existing assigned customer_group details of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/customerCategories/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired assigned customer group | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerGroupAssign/reference/{customerId}/{groupId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| groupId | reference of the customer group | String | Yes | CG-001 |
Success Output
Success case: response.status=200
{
"id": 101,
"customerReference": "C-002",
"customerGroupReference": "CG-001",
"customer": {
"id": 1335,
"reference": "C-002",
"name": "cus2",
"href": "/api/v1.0/customers/1335"
},
"customerGroup": {
"id": 5,
"reference": "CG-001",
"name": "CusG1",
"href": "/api/v1.0/customerGroups/5"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T11:13:12Z",
"lastUpdated": "2016-08-22T11:13:12Z"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer group assign 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."
}16.3 Delete
Service: Delete
Description: This web service is used in order to delete an existing assigned customer group object from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/customerGroupAssign/{id}:
| Name | Description | Type | Required | Examples values |
|---|
| id | Id of the assigned customer group to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerGroupAssign/reference/{customerId}/{groupId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| groupId | reference of the customer group | String | Yes | CG-001 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer group assign 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."
}{
"error": "delete_failed",
"error_description": "Failed to delete instance"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}16.4 Update
Service: Update
Description: This web service is used to update an existing assigned customer group object to the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/customerGroupAssign
:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the customer group to update | Long | Yes | 111 |
| groupId | the id of the customer group | Long | Yes | 777 |
| customerId | the id of the customer to assign | Long | Yes | 123 |
URL with external_id:
https://BASE_URL/api/VERSION/customerGroupAssign/reference/{customerId}/{groupId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| groupId | reference of the customer group | String | Yes | CG-001 |
Success Output
Success case: response.status=201
{
"id": 101,
"customerReference": "C-003",
"customerGroupReference": "CG-002",
"customer": {
"id": 1336,
"reference": "C-003",
"name": "cus3",
"href": "/api/v1.0/customers/1336"
},
"customerGroup": {
"id": 6,
"reference": "CG-002",
"name": "CusG2",
"href": "/api/v1.0/customerGroups/6"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T11:13:12Z",
"lastUpdated": "2016-08-22T12:44:42Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "groupId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customer 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 customer group with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}16.5 Create
Service: Save
Description: This web service is used to add a new assigned customer group object to the database
URL:
https://BASE_URL/api/VERSION/customerGroupAssign
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| groupId | the id of the customer group | Long/String | Yes | 777 |
| customerId | the id of the customer to assign | Long/String | Yes | 123 |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output
Success case: response.status=201
{
"id": 102,
"customerReference": "C-002",
"customerGroupReference": "CG-002",
"customer": {
"id": 1335,
"reference": "C-002",
"name": "cus2",
"href": "/api/v1.0/customers/1335"
},
"customerGroup": {
"id": 6,
"reference": "CG-002",
"name": "CusG2",
"href": "/api/v1.0/customerGroups/6"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T12:24:37Z",
"lastUpdated": "2016-08-22T12:24:37Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "groupId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customer 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 customer group with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
