Get

[POST] .../v1/promoprogram/get

Returns information about promotion. Use this method to retrieve loyalty promotion programs for POS synchronization, retail card assignment, migration workflows and promotion setup screens. The response returns active, non-deleted programs with their translated type, active days, date/time window, priority, external subtype, description and last update time. The request requires the promotion select permission and can be narrowed by filters; the retail promotion tariff must allow loyalty programs. Business errors such as a missing request body, denied access, disabled tariff option, database errors or empty persistent data are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
allowed_retail_card bool Indicates whether customer cards can be linked to this program. Customer cards can be linked only to the bonus system with type=1.
ids int Promotion IDs.
type_ids int Promotion type IDs.

Request Example

{
  "filters": [
    {
      "Field": "allowed_retail_card",
      "Operator": "Equal",
      "Value": "string"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of PromoProgram Result object.

Response Example

{
  "ok": true,
  "result": [
    {
      "active": true,
      "days": [
        1
      ],
      "description": "string",
      "end_date": "string",
      "end_time": "string",
      "id": 1,
      "last_update": 1,
      "name": "string",
      "priority": 1,
      "start_date": "string",
      "start_time": "string",
      "sub_type": 1,
      "type": {
        "id": 1,
        "last_update": 1,
        "name": "string"
      }
    }
  ]
}