(Quick Reference)
48 Promotion inputs - Reference Documentation
Version: 2.1
Service: List promotion inputs
Description: This web service returns a json list of promotion inputs.
URL:
https://BASE_URL/api/VERSION/promotionInputs
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The
max parameter is set to
100 by default.
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 | |
| promotionListReference | Wildcard search by the resource's reference | String | no | promotionListReference=*save_more* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status = 200
{
"paging": {
"total": 7,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 40,
"promotionListReference": "holiday_promo",
"itemReference": "84524",
"unitReference": "unit-01",
"promotionList": {
"id": 12,
"reference": "holiday_promo",
"href": "/api/v1.0/promotionLists/12"
},
"item": {
"id": 13,
"reference": "84524",
"name": "Plateau repas 5 compartiments x 50",
"href": "/api/v1.0/items/13"
},
"unit": {
"id": 1,
"reference": "unit-01",
"name": "Piece",
"href": "/api/v1.0/units/1"
},
"itemGroupReference": null,
"itemGroup": null,
"promotionType": "1",
"inputType": "1",
"sequence": 1,
"serial": 1,
"operator": null,
"enablePromotionSum": true,
"applyToAllItems": true,
"organization": "entity1",
"dateCreated": "2016-10-07T13:11:39Z",
"lastUpdated": "2016-10-07T13:11:39Z",
"value": "20000"
},
{
"id": 41,
"promotionListReference": "buy_more_save_more",
"itemReference": null,
"unitReference": null,
"promotionList": {
"id": 13,
"reference": "buy_more_save_more",
"href": "/api/v1.0/promotionLists/13"
},
"item": null,
"unit": null,
"itemGroupReference": "cosmetics",
"itemGroup": {
"id": 1,
"reference": "cosmetics",
"name": "Cosmetics",
"href": "/api/v1.0/itemGroups/1"
},
"promotionType": "1",
"inputType": "2",
"sequence": 1,
"serial": 1,
"operator": null,
"enablePromotionSum": true,
"applyToAllItems": false,
"organization": "entity1",
"dateCreated": "2016-10-07T13:15:47Z",
"lastUpdated": "2016-10-07T13:15:47Z",
"value": "20000"
},
…
]
} 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..."
}: Show a promotion input
Description: This web service return an existing promotion input of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/promotionInputs/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired promotion input | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 46,
"promotionListReference": "holiday_promo",
"itemReference": null,
"unitReference": null,
"promotionList": {
"id": 18,
"reference": "holiday_promo",
"href": "/api/v1.0/promotionLists/18"
},
"item": null,
"unit": null,
"itemGroupReference": null,
"itemGroup": null,
"promotionType": "1",
"inputType": "5",
"sequence": 1,
"serial": 1,
"operator": null,
"enablePromotionSum": true,
"applyToAllItems": false,
"organization": "entity1",
"dateCreated": "2016-10-07T15:38:31Z",
"lastUpdated": "2016-10-07T15:38:31Z",
"value": "20000"
} 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 Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The promotion input with the id 199 doesn't exist."
}
