C1c1st
Promotions

List promotions for store.

get/promotions

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/promotions
  • Auth
    HTTP bearer

Query parameters

cursorstring

Cursor for pagination. If parameter is set, paginationStart will be ignored. Only allowed for default sorting or based on id.

paginationStartinteger

Determine the offset (in number of items) to fetch. This is usually a multiple of the pageLength.

paginationPageLengthinteger

Determine the number of item to fetch in one page.

allowDeletedinteger

Optional. If equal to 1, deleted promotions will be included in the response.

freeTextstring

Optional. Search for promotion name, product, brand, tag and customer group

actionType'percentage' | 'adjustPriceBy' | 'percentageByCostprice' | 'totalPriceUnit'

Optional. Search promotions by its action type

startDatestring

Optional. Search promotions by start date (format YYYY-MM-DD HH:MM:SS)

endDatestring

Optional. Search promotions by end date (format YYYY-MM-DD HH:MM:SS)

hideDiscountProductnoboolean

Optional. Filter out single product discounts

hideChainPromotionsboolean

Optional. Filter out chain promotions

Response

Ok

countinteger

The total number of promotions found by the query if ignoring pagination.

hasMoreboolean

True if there are data to retrieve than the given page length

nextCursorstring nullable

Cursor for next page when using cursor based pagination.

Example response

{
  "content": [
    {
      "id": 123,
      "name": "Summer discount",
      "description": "10% on all bikes in the summer.",
      "deleted": 1,
      "startdate": "2019-01-01 12:00:00",
      "enddate": "2019-02-01 12:00:00",
      "minproducts": 1,
      "productfilters": [
        {
          "attribute": "tag",
          "value": "Bike"
        }
      ],
      "customerfilters": [
        {
          "attribute": "tag",
          "value": [
            "1",
            "2",
            "3"
          ]
        }
      ],
      "serviceplanfilters": [
        {
          "attribute": "tag",
          "value": [
            "1",
            "2",
            "3"
          ]
        }
      ],
      "articles": [
        {
          "productno": "456",
          "quantity": 5
        }
      ],
      "action": {
        "type": "percentage",
        "amount": 10
      }
    }
  ],
  "count": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.