List benefit activities

Documentation in progress

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

Returns a cursor-paginated list of activities recorded for the benefit (created, updated, deleted, activated, drafted). Returns 404 when the benefit does not exist. Supports filtering by activity id, type, and created_at, ordering by created_at (default -created_at), and cursor-based pagination.

GET /v2/loyalties/benefits/{benefitId}/activities

List benefit activities

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/benefits/{benefitId}/activities \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "vl.benefit.created",
      "data": {
        "benefit": {
          "id": "<string>",
          "name": "<string>",
          "type": "POINTS",
          "status": "DRAFT",
          "stock": {
            "type": "UNLIMITED",
            "limited": {
              "quantity": 4503599627370495
            }
          },
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "object": "benefit",
          "points": {
            "value": 4503599627370495,
            "card_definition_id": "<string>"
          },
          "points_proportional": {
            "calculation_type": "PRE_DISCOUNT_ORDER_AMOUNT",
            "card_definition_id": "<string>",
            "order": {
              "amount": {
                "every": 4503599627370496,
                "value": 4503599627370495.5
              },
              "total_amount": {
                "every": 4503599627370496,
                "value": 4503599627370495.5
              },
              "metadata": {
                "every": 4503599627370496,
                "value": 4503599627370495.5,
                "property": "<string>"
              }
            },
            "customer": {
              "metadata": {
                "every": 4503599627370496,
                "value": 4503599627370495.5,
                "property": "<string>"
              }
            },
            "custom_event": {
              "metadata": {
                "every": 4503599627370496,
                "value": 4503599627370495.5,
                "property": "<string>"
              }
            },
            "order_items": {
              "amount": {
                "every": 4503599627370496,
                "value": 4503599627370495.5,
                "applicable_to": [
                  {
                    "type": "product",
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              },
              "subtotal_amount": {
                "every": 4503599627370496,
                "value": 4503599627370495.5,
                "applicable_to": [
                  {
                    "type": "product",
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              },
              "quantity": {
                "every": 4503599627370496,
                "value": 4503599627370495.5,
                "applicable_to": [
                  {
                    "type": "product",
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              }
            }
          },
          "material": {
            "type": "PRODUCT",
            "product": {
              "id": "<string>"
            },
            "sku": {
              "product_id": "<string>",
              "id": "<string>"
            }
          },
          "digital": {
            "type": "GIFT_VOUCHERS",
            "gift_vouchers": {
              "campaign_id": "<string>",
              "balance": 4503599627370495.5
            },
            "discount_coupons": {
              "campaign_id": "<string>"
            }
          }
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "benefit_id": "<string>",
      "group_id": "<string>",
      "source": {
        "channel": "USER_PORTAL",
        "user": {
          "id": "<string>"
        },
        "api_key": {
          "name": "<string>",
          "app_id": "<string>",
          "client_app_id": "<string>"
        }
      }
    }
  ],
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "object": "list"
}

Authorizations

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

benefitId · string · required

Identifies the benefit. Format lben_[a-f0-9]+.

Pattern: ^lben_[a-f0-9]+$

Query Parameters

limit · number string · default: 10

Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.

Required range: 1 <= x <= 100

order · enum<string>[] enum<string>

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.

Available options: created_at, -created_at

cursor · string | null

Continues pagination. Pass the cursor.next value from a previous response. Format lcrsaben_[a-f0-9]+. The cursor matches the filters and order of that response.

Pattern: ^lcrsaben_[a-f0-9]+$

filters · Loyalties Benefits Activities List Request Query · object | null

Filters the results. Pass a deep object, for example filters[type][conditions][$is]=vl.benefit.created. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. Request query schema for GET /v2/loyalties/benefits/{benefitId}/activities.

Show child attributes

Response

200

application/json

Cursor-paginated list of benefit activities

Response body schema for GET /v2/loyalties/benefits/{benefitId}/activities.

data · object[] · required

Activities matching the query, in the requested order.

Show child attributes

cursor · object | null · required

Pagination cursor. null when there are no more results.

Show child attributes

object · string · required

Type of the object. Always list.

Allowed value: "list"