Description: This web service return the list of assigned item customer groups in JSON format
URL:
http://BASE_URL/api/VERSION/itemCustomerGroup
Method: 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* |
itemReference | Wildcard search by the item's reference | String | no | itemReference=Ref-6* , itemReference=*ef-6 , itemReference=*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": 2, "max": 100, "offset": 0, "previous": null, "next": null }, "data": [ { "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" }, { "id": 160, "itemReference": "R-A-001", "customerGroupReference": "RG-2", "item": { "id": 1751, "reference": "R-A-001", "name": "article1", "href": "/api/v1.0/items/1751" }, "customerGroup": { "id": 22, "reference": "RG-2", "name": "CustomerGroup2", "href": "/api/v1.0/customerGroups/22" }, "organization": "Lyon", "dateCreated": "2016-08-23T11:33:13Z", "lastUpdated": "2016-08-23T11:33:13Z" } ] }
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..." }