C1c1st
Promotions

Retrieve promotion

Given a specific promotion id, fetch the entire promotion object.

get/promotions/{id}

Request

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

Path parameters

idinteger required

Response

Ok

idinteger nullable

A unique ID. Use this to handle this subscription.

namestring

Short name for the promotion

descriptionstring nullable

Description of the promotion. This is only displayed in the controlpanel, not for the customers.

deleted0 | 1 nullable

Whether or not the promotion is deleted. Disabled promotions do not trigger even when inside the date range.

startdatestring nullable

Specifies when the promotion starts. Null if the promotion has no startdate and thus is always in effect (except if deleted).

enddatestring nullable

Specifies when the promotion ends. Null if the promotion has no enddate.

minproductsinteger nullable

Minimum number of prodcts before the promotion is in effect

applyallboolean nullable

Whether or not to apply promotion to all

loyalty_members_onlyboolean nullable
storeidinteger nullable
countinteger nullable

The number of times this promotion matches things in the cart. This will only be set in the case of the lookup endpoint.

Example response

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

Changes

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