(Quick Reference)
46 Assign categories of customers to discount Lists - Reference Documentation
Version: 2.1
46 Assign categories of customers to discount Lists
46.1 List
Service: List
Description: This web service return the list of customerCategoryDiscountLists data in JSON format
URL:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists
: 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 | |
| customerCategoryReference | Wildcard search by the resource's reference | String | no | customerCategoryReference=Ref-6* , customerCategoryReference=*ef-6 , customerCategoryReference=*ef-6* |
| discountListReference | Wildcard search by the resource's reference | String | no | discountListReference=Ref-6* , discountListReference=*ef-6 , discountListReference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 3,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"discountListReference": "RDis-001",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"discountList": {
"id": 4,
"reference": "RDis-001",
"name": "discount1",
"href": "/api/v1/discountLists/4"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T09:55:22Z",
"lastUpdated": "2016-08-24T09:55:22Z"
},
{
"id": 2,
"discountListReference": "RDis-001",
"customerCategoryReference": "1111",
"customerCategory": {
"id": 61,
"reference": "1111",
"name": "joe",
"href": "/api/v1/customerCategories/61"
},
"discountList": {
"id": 4,
"reference": "RDis-001",
"name": "discount1",
"href": "/api/v1/discountLists/4"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T09:55:24Z",
"lastUpdated": "2016-08-24T09:55:24Z"
},
{
"id": 3,
"discountListReference": "RDis-002",
"customerCategoryReference": "102",
"customerCategory": {
"id": 60,
"reference": "102",
"name": "Preferred Customers",
"href": "/api/v1/customerCategories/60"
},
"discountList": {
"id": 5,
"reference": "RDis-002",
"name": "discount2",
"href": "/api/v1/discountLists/5"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T09:55:34Z",
"lastUpdated": "2016-08-24T09:55:34Z"
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}46.2 Show
Service: Show
Description: This web service return an existing customerCategoryDiscountLists of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists/{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/customerCategoryDiscountLists/reference/{customerCategoryId}/{discountListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerCategoryId | reference of the customer category | String | Yes | CC-002 |
| discountListId | reference of the discount list | String | Yes | DL-001 |
Success Output
Success case: response.status=200
{
"id": 1,
"discountListReference": "RDis-001",
"customerCategoryReference": "101",
"customerCategory": {
"id": 3,
"reference": "101",
"name": "new Categ",
"href": "/api/v1/customerCategories/3"
},
"discountList": {
"id": 4,
"reference": "RDis-001",
"name": "discount1",
"href": "/api/v1/discountLists/4"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T09:55:22Z",
"lastUpdated": "2016-08-24T09:55:22Z"
} 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 discount list with the id 999 doesn't exist."
}46.3 Delete
Service: Delete
Description: This web service is used in order to delete an existing customerCategoryDiscountLists object from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists/{id}:
| Name | Description | Type | Required | Examples values |
|---|
| id | Id of the customerCategoryDiscountLists record to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists/reference/{customerCategoryId}/{discountListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerCategoryId | reference of the customer category | String | Yes | CC-002 |
| discountListId | reference of the discount list | String | Yes | DL-001 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
} 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."
}{
"error": "delete_failed",
"error_description": "Failed to delete instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer category discount list with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}46.4 Update
Service: Update
Description: This web service is used to update an existing customerCategoryDiscountLists object to the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to update | Long | Yes | 123 |
| discountListId | the discount id to be assigned | Long | Yes | 777 |
| customerCategoryId | the id of the customer category to assign | Long | Yes | 111 |
URL with external_id:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists/reference/{customerCategoryId}/{discountListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerCategoryId | reference of the customer category | String | Yes | CC-002 |
| discountListId | reference of the discount list | String | Yes | DL-001 |
Success Output
Success case: response.status=200
{
"id": 4,
"discountListReference": "RDis-001",
"customerCategoryReference": "1113",
"customerCategory": {
"id": 62,
"reference": "1113",
"name": "joe",
"href": "/api/v1/customerCategories/62"
},
"discountList": {
"id": 4,
"reference": "RDis-001",
"name": "discount1",
"href": "/api/v1/discountLists/4"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T10:11:58Z",
"lastUpdated": "2016-08-24T10:16:55Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "discountListId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customerCategory is already assigned to discountList."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
}{
"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 discountList with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}46.5 Create
Service: Save
Description: This web service is used to add a new customerCategoryDiscountLists object into the database
URL:
https://BASE_URL/api/VERSION/customerCategoryDiscountLists
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| discountListId | the discount id to be assigned | Long/String | Yes | 777 |
| customerCategoryId | the id of the customer category to assign | Integer/String | Yes | |
| 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": 4,
"discountListReference": "RDis-001",
"customerCategoryReference": "102",
"customerCategory": {
"id": 60,
"reference": "102",
"name": "Preferred Customers",
"href": "/api/v1/customerCategories/60"
},
"discountList": {
"id": 4,
"reference": "RDis-001",
"name": "discount1",
"href": "/api/v1/discountLists/4"
},
"organization": "Lyon",
"dateCreated": "2016-08-24T10:11:58Z",
"lastUpdated": "2016-08-24T10:11:58Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "discountListId parameter is missing"
}{
"error": "already_assigned",
"error_description": "customerCategory is already assigned to discountList."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error":"not_found",
"error_description": "The discountList with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
