(Quick Reference)

49 Promotion outputs - Reference Documentation

Version: 2.1

Table of Contents

49 Promotion outputs

49.1 List

Service: List promotion outputs

Description: This web service returns a json list of promotion outputs.

URL:

https://BASE_URL/api/VERSION/promotionOutputs

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
maxLimits the number of resources requested to return.Integerno 
offsetTells where to start returning records from the entire set of results.Integerno 
orderOrders ascending or descending.Integernoasc,desc
sortOrders the results by the specified field.Stringno 

The max parameter is set to 100 by default.

Filters parameters:

NameDescriptionTypeRequiredExample values
dateCreated_gtFilters by the resource's creation date time and operator greater thanDateno2016-08-15T14:52:48Z
dateCreated_gteFilters by the resource's creation date time and operator greater than or equalDateno 
dateCreated_ltFilters by the resource's creation date time and operator less thanDateno 
dateCreated_lteFilters by the resource's creation date time and operator less than or equalDateno 
lastUpdated_gtFilters by the resource's last-modified date time and operator greater thanDateno 
lastUpdated_gteFilters by the resource's last-modified date time and operator greater than or equalDateno 
lastUpdated_ltFilters by the resource's last-modified date time and operator less thanDateno 
lastUpdated_lteFilters by the resource's last-modified date time and operator less than or equalDateno 
promotionListReferenceWildcard search by the resource's referenceStringnopromotionListReference=*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": 10,
    "max": 100,
    "offset": 0,
    "previous": null,
    "next": null
  },
  "data": [
    {
      "id": 41,
      "promotionListReference": "buy_more_save_more",
      "itemReference": "84524",
      "unitReference": "unit-01",
      "promotionList": {
        "id": 13,
        "reference": "buy_more_save_more",
        "href": "/api/v1.0/promotionLists/13"
      },
      "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,
      "outputType": "2",
      "sequence": 1,
      "serial": 1,
      "operator": null,
      "duplicatePromotion": true,
      "applyToAllItems": false,
      "organization": "entity1",
      "dateCreated": "2016-10-07T13:15:47Z",
      "lastUpdated": "2016-10-07T13:15:47Z",
      "discountType": "1",
      "value": 150000
    },
    null,
    {
      "id": 43,
      "promotionListReference": "holiday_promo",
      "itemReference": null,
      "unitReference": null,
      "promotionList": {
        "id": 11,
        "reference": "holiday_promo",
        "href": "/api/v1.0/promotionLists/11"
      },
      "item": null,
      "unit": null,
      "itemGroupReference": "cosmetics",
      "itemGroup": {
        "id": 1,
        "reference": "cosmetics",
        "name": "Cosmetics",
        "href": "/api/v1.0/itemGroups/1"
      },
      "outputType": "4",
      "sequence": 1,
      "serial": 1,
      "operator": null,
      "duplicatePromotion": true,
      "applyToAllItems": false,
      "organization": "entity1",
      "dateCreated": "2016-10-07T13:38:31Z",
      "lastUpdated": "2016-10-07T13:38:31Z",
      "discountType": "2",
      "value": 150000
    },
    …
  ]
}

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..."
}

49.2 Show

Service: Show a promotion output

Description: This web service return an existing promotion output of the specified id in JSON format

URL:

https://BASE_URL/api/VERSION/promotionOutputs/{id}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idThe numerical ID of the desired promotion outputLongYes777

Success Output

Success case: response.status = 200

{
  "id": 46,
  "promotionListReference": "holiday_promo",
  "itemReference": null,
  "unitReference": null,
  "promotionList": {
    "id": 17,
    "reference": "holiday_promo",
    "href": "/api/v1.0/promotionLists/17"
  },
  "item": null,
  "unit": null,
  "itemGroupReference": null,
  "itemGroup": null,
  "outputType": "7",
  "sequence": 1,
  "serial": 1,
  "operator": null,
  "duplicatePromotion": true,
  "applyToAllItems": false,
  "organization": "entity1",
  "dateCreated": "2016-10-07T13:46:28Z",
  "lastUpdated": "2016-10-07T13:46:28Z",
  "discountType": "2",
  "value": 150000
}

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 promotion output with the id 199 doesn't exist."
}