> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Campaign Summary
> Returns data for campaign analytics, covering validations, redemptions, publications, and other details specific to a given campaign type.
Use `start_date` and `end_date` to narrow down the data to specific periods.
>🚧 Campaigns created before v20250602 version
>
>This endpoint returns analytics data for campaigns that were created after the [v20250602 version](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20250602) was released on 17 June 2025. Older campaigns return empty data.
## OpenAPI
````yaml /openapi/campaigns.json get /v1/campaigns/{campaignId}/summary
openapi: 3.0.1
info:
title: Voucherify API - Campaigns
version: v2018-08-01
description: >-
Voucherify promotion engine REST API. Please see
https://docs.voucherify.io/docs for more details.
contact:
name: Voucherify Team
url: https://www.voucherify.io/contact-support
email: support@voucherify.io
termsOfService: https://www.voucherify.io/legal/subscription-agreement
license:
name: MIT
url: https://github.com/voucherifyio/voucherify-js-sdk/blob/main/LICENSE
servers:
- url: https://{cluster}.voucherify.io
description: Base URL
variables:
cluster:
default: api
enum:
- api
- us1.api
- as1.api
- download
- us1.download
- as1.download
security: []
paths:
/v1/campaigns/{campaignId}/summary:
parameters:
- in: path
name: campaignId
description: >-
You can either pass the campaign ID, which was assigned by Voucherify,
or the name of the campaign as the path parameter value.
schema:
$ref: '#/components/schemas/ParameterCampaignId'
required: true
get:
tags:
- Campaigns
summary: Get Campaign Summary
description: >-
Returns data for campaign analytics, covering validations, redemptions,
publications, and other details specific to a given campaign type.
Use `start_date` and `end_date` to narrow down the data to specific
periods.
>🚧 Campaigns created before v20250602 version
>
>This endpoint returns analytics data for campaigns that were created
after the [v20250602
version](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20250602)
was released on 17 June 2025. Older campaigns return empty data.
operationId: get-campaign-summary
parameters:
- name: start_date
in: query
schema:
$ref: '#/components/schemas/ParameterDateOnly'
description: >-
Timestamp representing the date which results must begin on.
Represented in ISO 8601 format.
- name: end_date
in: query
schema:
$ref: '#/components/schemas/ParameterDateOnly'
description: >-
Timestamp representing the date which results must end on.
Represented in ISO 8601 format.
responses:
'200':
description: >-
Returns campaign analytics data. Returns different data depending on
the campaign type.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignsSummaryGetResponseBody'
examples:
Generic code discount campaign:
value:
object: campaign_summary
campaign:
id: camp_WaZ6r4LSF1alRaIwJVKS07bs
name: Summer-2025
campaign_type: DISCOUNT_COUPONS
type: STANDALONE
voucher:
type: DISCOUNT_VOUCHER
discount:
type: AMOUNT
amount_off: 2000
effect: APPLY_TO_ORDER
redemption:
quantity: null
is_referral_code: false
auto_join: false
join_once: false
use_voucher_metadata_schema: true
vouchers_count: 1
active: true
metadata: {}
created_at: '2025-06-17T08:05:57.720Z'
creation_status: DONE
vouchers_generation_status: DONE
protected: false
category_id: null
categories: []
object: campaign
redemptions: 10
redemptions_succeeded: 8
redemptions_failed: 2
rollbacks: 1
rollbacks_succeeded: 1
rollbacks_failed: 0
validations: 10
validations_succeeded: 8
validations_failed: 2
vouchers_created: 1
vouchers_deleted: 0
publications: 0
publications_succeeded: 0
publications_failed: 0
discounted_amount: 20000
rolledback_discounted_amount: 200
orders_amount: 19453
orders_rolledback_amount: 800
'404':
description: Returns an error if a campaign is not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Campaign not found:
value:
code: 404
key: not_found
message: Resource not found
details: Cannot find campaign with id DOES_NOT_EXIST
request_id: v-10cb77ea020c70aa60
resource_id: DOES_NOT_EXIST
resource_type: campaign
security:
- X-App-Id: []
X-App-Token: []
- X-Voucherify-OAuth:
- api
- campaigns
components:
schemas:
ParameterCampaignId:
type: string
example: camp_rRsfatlwN7unSeUIJDCYedal
ParameterDateOnly:
type: string
example: '2023-12-22T10:13:06.487Z'
format: date
CampaignsSummaryGetResponseBody:
title: Campaigns Summary Get Response Body
type: object
description: Response body schema for **GET** `/v1/campaigns/{campaignId}/summary`.
oneOf:
- $ref: '#/components/schemas/CampaignsSummaryDiscountCampaign'
- $ref: '#/components/schemas/CampaignsSummaryPromotionCampaign'
- $ref: '#/components/schemas/CampaignsSummaryGiftCampaign'
- $ref: '#/components/schemas/CampaignsSummaryLoyaltyCampaign'
- $ref: '#/components/schemas/CampaignsSummaryReferralCampaign'
Error:
title: Error Object
type: object
description: Error details
properties:
code:
type: integer
description: Error's HTTP status code.
key:
type: string
description: Short string describing the kind of error which occurred.
message:
type: string
description: A human-readable message providing a short description of the error.
details:
type: string
description: A human-readable message providing more details about the error.
request_id:
type: string
example: v-0a885062c80375740f
description: >-
This ID is useful when troubleshooting and/or finding the root cause
of an error response by our support team.
resource_id:
type: string
description: >-
Unique resource ID that can be used in another endpoint to get more
details.
example: rf_0c5d710a87c8a31f86
resource_type:
type: string
description: The resource type.
example: voucher
error:
type: object
description: Includes additional information about the error.
properties:
message:
type: string
description: The message configured by the user in a validation rule.
required:
- code
- message
CampaignsSummaryDiscountCampaign:
type: object
title: Campaigns Summary - Discount Campaign details
description: Campaign summary data for discount campaigns.
allOf:
- $ref: '#/components/schemas/CampaignsSummaryCampaignBase'
- $ref: '#/components/schemas/CampaignsSummaryVouchersPublications'
- $ref: '#/components/schemas/CampaignsSummaryDiscounts'
CampaignsSummaryPromotionCampaign:
type: object
title: Campaigns Summary - Promotion Campaign details
description: Campaign summary data for promotion campaigns.
allOf:
- $ref: '#/components/schemas/CampaignsSummaryCampaignBase'
- $ref: '#/components/schemas/CampaignsSummaryDiscounts'
CampaignsSummaryGiftCampaign:
type: object
title: Campaigns Summary - Gift Campaign details
description: Campaign summary data for gift campaigns.
allOf:
- $ref: '#/components/schemas/CampaignsSummaryCampaignBase'
- $ref: '#/components/schemas/CampaignsSummaryVouchersPublications'
- $ref: '#/components/schemas/CampaignsSummaryGift'
CampaignsSummaryLoyaltyCampaign:
type: object
title: Campaigns Summary - Loyalty Campaign details
description: Campaign summary data for loyalty campaigns.
allOf:
- $ref: '#/components/schemas/CampaignsSummaryCampaignBase'
- $ref: '#/components/schemas/CampaignsSummaryVouchersPublications'
- $ref: '#/components/schemas/CampaignsSummaryLoyalty'
CampaignsSummaryReferralCampaign:
type: object
title: Campaigns Summary - Referral Campaign details
description: Campaign summary data for referral campaigns.
allOf:
- $ref: '#/components/schemas/CampaignsSummaryCampaignBase'
- $ref: '#/components/schemas/CampaignsSummaryVouchersPublications'
- type: object
properties:
referred_customers:
type: integer
description: Total number of all referred customers.
required:
- referred_customers
CampaignsSummaryCampaignBase:
type: object
description: Contains the basic information about any type of campaign.
properties:
object:
type: string
description: The type of the object, which is `campaign_summary`.
default: campaign_summary
enum:
- campaign_summary
campaign:
$ref: '#/components/schemas/CampaignBase'
redemptions:
type: integer
description: >-
Total number of redemptions, which includes successful and failed
redemptions.
redemptions_succeeded:
type: integer
description: Total number of successful redemptions.
redemptions_failed:
type: integer
description: Total number of failed redemptions.
rollbacks:
type: integer
description: >-
Total number of rollbacks, which includes successful and failed
rollbacks.
rollbacks_succeeded:
type: integer
description: Total number of successful rollbacks.
rollbacks_failed:
type: integer
description: Total number of failed rollbacks.
validations:
type: integer
description: >-
Total number of validations, which includes successful and failed
validations.
validations_succeeded:
type: integer
description: Total number of successful validations.
validations_failed:
type: integer
description: Total number of failed validations.
orders_amount:
type: integer
description: >-
Total amount of orders related to the campaign. This amount is not
reduced by `orders_rolledback_amount`. The value is multiplied by
`100` to precisely represent 2 decimal places. For example, `$10` is
represented as `1000`.
orders_rolledback_amount:
type: integer
description: >-
Total amount of orders that were rolled back and are related to the
campaign. The value is multiplied by `100` to precisely represent 2
decimal places. For example, `$10` is represented as `1000`.
required:
- object
- campaign
- redemptions
- redemptions_succeeded
- redemptions_failed
- rollbacks
- rollbacks_succeeded
- rollbacks_failed
- validations
- validations_succeeded
- validations_failed
- orders_amount
- orders_rolledback_amount
CampaignsSummaryVouchersPublications:
type: object
properties:
vouchers_created:
type: integer
description: >-
Total number of vouchers created within the campaign. Includes
vouchers generated when the campaign was created, vouchers added
manually, or vouchers generated automatically when a new customer
joined the campaign.
vouchers_deleted:
type: integer
description: >-
Total number of vouchers deleted within the campaign. Includes
vouchers moved to the bin and vouchers deleted permanently. Vouchers
moved to the bin and then deleted permanently are counted once.
publications:
type: integer
description: >-
Total number of publications, which includes successful and failed
publications.
publications_succeeded:
type: integer
description: Total number of successful publications.
publications_failed:
type: integer
description: Total number of failed publications.
required:
- vouchers_created
- vouchers_deleted
- publications
- publications_succeeded
- publications_failed
CampaignsSummaryDiscounts:
type: object
properties:
discounted_amount:
type: integer
description: >-
Total amount of discounts related to the campaign. This amount is
not reduced by the `rolledback_discounted_amount`. The value is
multiplied by `100` to precisely represent 2 decimal places. For
example, `$10` is represented as `1000`.
rolledback_discounted_amount:
type: integer
description: >-
Total amount of discounts orders that were rolled back and are
related to the campaign. The value is multiplied by `100` to
precisely represent 2 decimal places. For example, `$10` is
represented as `1000`.
required:
- discounted_amount
- rolledback_discounted_amount
CampaignsSummaryGift:
type: object
description: ''
properties:
created_vouchers_amount:
type: integer
description: >-
The total credit amount for all created gift cards. The value is
multiplied by `100` to precisely represent 2 decimal places. For
example, `$10` is represented as `1000`.
amount_added:
type: integer
description: >-
The total credit amount that was added. The value is multiplied by
`100` to precisely represent 2 decimal places. For example, `$10` is
represented as `1000`.
amount_deleted:
type: integer
description: >-
The total credit amount that was deleted by deleting gift cards. The
value is multiplied by `100` to precisely represent 2 decimal
places. For example, `$10` is represented as `1000`.
amount_redeemed:
type: integer
description: >-
The total credit amount that was redeemed. This amount is not
reduced by the `amount_rolledback`. The value is multiplied by `100`
to precisely represent 2 decimal places. For example, `$10` is
represented as `1000`.
amount_rolledback:
type: integer
description: >-
The total credit amount that was rolled back. The value is
multiplied by `100` to precisely represent 2 decimal places. For
example, `$10` is represented as `1000`.
amount_subtracted:
type: integer
description: >-
The total credit amount that was subtracted. The value is multiplied
by `100` to precisely represent 2 decimal places. For example, `$10`
is represented as `1000`.
required:
- created_vouchers_amount
- amount_added
- amount_deleted
- amount_redeemed
- amount_rolledback
- amount_subtracted
CampaignsSummaryLoyalty:
type: object
properties:
created_vouchers_points:
type: integer
description: >-
Total number of points added to newly created loyalty cards. This
also counts points added for the loyalty cards which are created by
importing a CSV file to a campaign.
points_deleted:
type: integer
description: Total number of points that were deleted.
points_subtracted:
type: integer
description: Total number of points that were subtracted.
points_added:
type: integer
description: >-
Total number of points that were added. This includes points added
manually or automatically by redeeming a reward that adds loyalty
points to cards in this campaign.
points_rewarded:
type: integer
description: >-
Total number of points that were rewarded to loyalty cards through
earning rules. This includes pending points that were activated.
points_redeemed:
type: integer
description: Total number of points that were redeemed for rewards.
points_rolledback:
type: integer
description: Total number of points that were rolled back for reward redemptions.
points_expired:
type: integer
description: Total number of points that have expired.
points_transferred_out:
type: integer
description: >-
Total number of points transferred out of loyalty cards covered by
the campaign.
points_transferred_in:
type: integer
description: >-
Total number of points transferred into loyalty cards covered by the
campaign.
pending_points_added:
type: integer
description: >-
Total number of pending points that were added either as part of
earning rules or added manually to an existing pending point bucket.
Pending points that were activated manually or automatically or that
were canceled do not affect this number.
pending_points_subtracted:
type: integer
description: >-
Total number of pending points that were subtracted from existing
pending point buckets.
pending_points_activated:
type: integer
description: >-
Total number of pending points that were activated manually or
automatically.
pending_points_canceled:
type: integer
description: Total number of pending points that were canceled.
required:
- created_vouchers_points
- points_deleted
- points_subtracted
- points_added
- points_rewarded
- points_redeemed
- points_rolledback
- points_expired
- points_transferred_out
- points_transferred_in
- orders_amount
- orders_rolledback_amount
- pending_points_added
- pending_points_subtracted
- pending_points_activated
- pending_points_canceled
CampaignBase:
type: object
title: Campaign Base
description: This is an object representing a campaign.
properties:
id:
type: string
description: Unique campaign ID, assigned by Voucherify.
example: camp_f7fBbQxUuTN7dI7tGOo5XMDA
name:
type: string
description: Campaign name.
description:
type: string
description: >-
An optional field to keep any extra textual information about the
campaign such as a campaign description and details.
campaign_type:
type: string
enum:
- LOYALTY_PROGRAM
- GIFT_VOUCHERS
- DISCOUNT_COUPONS
- PROMOTION
- REFERRAL_PROGRAM
description: Type of campaign.
type:
type: string
description: >-
Defines whether the campaign can be updated with new vouchers after
campaign creation or if the campaign consists of generic
(standalone) vouchers.
- `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will
generate based on set criteria
- `STATIC`: vouchers need to be manually published
- `STANDALONE`: campaign for single vouchers
enum:
- AUTO_UPDATE
- STATIC
- STANDALONE
voucher:
$ref: '#/components/schemas/CampaignVoucher'
auto_join:
type: boolean
description: >-
Indicates whether customers will be able to auto-join a loyalty
campaign if any earning rule is fulfilled.
join_once:
type: boolean
description: >-
If this value is set to `true`, customers will be able to join the
campaign only once. It is always `false` for generic (standalone)
vouchers campaigns and it cannot be changed in them. It is always
`true` for loyalty campaigns and it cannot be changed in them.
use_voucher_metadata_schema:
type: boolean
description: >-
Flag indicating whether the campaign is to use the voucher's
metadata schema instead of the campaign metadata schema.
validity_timeframe:
$ref: '#/components/schemas/ValidityTimeframe'
validity_day_of_week:
$ref: '#/components/schemas/ValidityDayOfWeek'
validity_hours:
$ref: '#/components/schemas/ValidityHours'
activity_duration_after_publishing:
type: string
description: >-
Defines the amount of time the vouchers will be active after
publishing. The value is shown in the ISO 8601 format. For example,
a voucher with the value of P24D will be valid for a duration of 24
days.
vouchers_count:
type: integer
description: Total number of unique vouchers in campaign.
start_date:
type: string
format: date-time
description: >-
Activation timestamp defines when the campaign starts to be active
in ISO 8601 format. Campaign is *inactive before* this date.
example: '2022-09-20T00:00:00.000Z'
expiration_date:
type: string
format: date-time
description: >-
Expiration timestamp defines when the campaign expires in ISO 8601
format. Campaign is *inactive after* this date.
example: '2022-09-30T00:00:00.000Z'
active:
type: boolean
description: >-
A flag to toggle the campaign on or off. You can disable a campaign
even though it's within the active period defined by the
`start_date` and `expiration_date`.
- `true` indicates an *active* campaign
- `false` indicates an *inactive* campaign
metadata:
type: object
description: >-
The metadata object stores all custom attributes assigned to the
campaign. A set of key/value pairs that you can attach to a campaign
object. It can be useful for storing additional information about
the campaign in a structured format.
created_at:
type: string
format: date-time
example: '2021-12-01T08:00:50.038Z'
description: >-
Timestamp representing the date and time when the campaign was
created. The value is shown in the ISO 8601 format.
updated_at:
type: string
format: date-time
example: '2022-09-20T09:18:19.623Z'
description: >-
Timestamp representing the date and time when the campaign was last
updated in ISO 8601 format.
category:
type: string
description: Unique category name.
creation_status:
type: string
enum:
- DONE
- IN_PROGRESS
- FAILED
- DRAFT
- MODIFYING
description: Indicates the status of the campaign creation.
vouchers_generation_status:
type: string
description: Indicates the status of the campaign's voucher generation.
enum:
- DONE
- IN_PROGRESS
- FAILED
- DRAFT
- MODIFYING
readonly:
type: boolean
description: >-
Indicates whether the campaign can be only read by a restricted user
in the Areas and Stores enterprise feature. It is returned only to
restricted users; this field is not returned for users with other
roles. It is also not returned for restricted users who use the [GET
Campaign summary](/api-reference/campaigns/get-campaign-summary)
endpoint.
protected:
type: boolean
description: Indicates whether the resource can be deleted.
category_id:
type: string
nullable: true
description: Unique category ID that this campaign belongs to.
example: cat_0b688929a2476386a7
categories:
type: array
description: >-
Contains details about the campaign category. For the GET [List
campaigns](/api-reference/campaigns/list-campaigns) endpoint, this
is returned only if the `expand=category` query parameter is passed
in the request. Otherwise, it is returned as an empty array. For GET
[Campaign summary](/api-reference/campaigns/get-campaign-summary)
endpoint, it is always returned as an empty array.
items:
$ref: '#/components/schemas/Category'
object:
type: string
default: campaign
description: >-
The type of the object represented by JSON. This object stores
information about the campaign.
referral_program:
$ref: '#/components/schemas/ReferralProgram'
loyalty_tiers_expiration:
$ref: '#/components/schemas/LoyaltyTiersExpirationAll'
access_settings_assignments:
$ref: '#/components/schemas/AccessSettingsCampaignAssignmentsList'
required:
- id
- name
- campaign_type
- type
- auto_join
- join_once
- use_voucher_metadata_schema
- created_at
- creation_status
- vouchers_generation_status
- protected
- category_id
- categories
- object
CampaignVoucher:
type: object
description: Schema model for a campaign voucher.
title: Campaign Voucher
properties:
type:
type: string
description: Type of voucher.
discount:
description: Defines the voucher discount type and details.
allOf:
- $ref: '#/components/schemas/Discount'
gift:
description: Defines the voucher gift details.
allOf:
- $ref: '#/components/schemas/Gift'
loyalty_card:
description: Defines the voucher loyalty card details.
allOf:
- $ref: '#/components/schemas/CampaignLoyaltyCard'
redemption:
type: object
description: Defines the redemption limits on vouchers.
properties:
quantity:
type: integer
nullable: true
description: >-
How many times a voucher can be redeemed. A `null` value means
unlimited.
required:
- quantity
code_config:
allOf:
- $ref: '#/components/schemas/CodeConfig'
required:
- length
- charset
- pattern
is_referral_code:
type: boolean
description: >-
Flag indicating whether this voucher is a referral code; `true` for
campaign type `REFERRAL_PROGRAM`.
start_date:
type: string
format: date-time
description: >-
Activation timestamp defines when the campaign starts to be active
in ISO 8601 format. Campaign is *inactive before* this date.
example: '2022-09-20T00:00:00.000Z'
expiration_date:
type: string
format: date-time
description: >-
Expiration timestamp defines when the campaign expires in ISO 8601
format. Campaign is *inactive after* this date.
example: '2022-09-30T00:00:00.000Z'
validity_timeframe:
$ref: '#/components/schemas/ValidityTimeframe'
validity_day_of_week:
$ref: '#/components/schemas/ValidityDayOfWeek'
validity_hours:
$ref: '#/components/schemas/ValidityHours'
required:
- type
- redemption
- code_config
- is_referral_code
ValidityTimeframe:
title: Validity Timeframe
type: object
description: >-
Set recurrent time periods when the earning rule is valid. For example,
valid for 1 hour every other day.`start_date` **required** when
including the `validity_timeframe`.
properties:
duration:
type: string
description: >-
Defines the amount of time an earning rule will be active in ISO
8601 format. For example, an earning rule with a `duration` of
`PT1H` will be valid for a duration of one hour.
example: PT1H
interval:
type: string
description: >-
Defines the intervening time between two time points in ISO 8601
format, expressed as a duration. For example, an earning rule with
an `interval` of `P2D` will be valid every other day.
example: P2D
ValidityDayOfWeek:
title: Validity Day Of Week
type: array
description: >-
Integer array corresponding to the particular days of the week in which
the voucher is valid.
- `0` Sunday
- `1` Monday
- `2` Tuesday
- `3` Wednesday
- `4` Thursday
- `5` Friday
- `6` Saturday
items:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
ValidityHours:
title: Validity Hours
type: object
description: Determines the hours of validity, e.g. to create a happy hours scenario.
properties:
daily:
type: array
description: >-
Defines the recurring period(s) when the resource is active. The
periods should not overlap.
items:
type: object
description: Defines the recurring period(s) when the resource will be active.
properties:
start_time:
type: string
format: time
description: >-
Defines the starting hour of validity in the HH:mm format. The
resource is *inactive before* this time.
example: '12:00'
days_of_week:
type: array
description: >-
Integer array corresponding to the particular days of the week
in which the resource is valid.
- `0` Sunday
- `1` Monday
- `2` Tuesday
- `3` Wednesday
- `4` Thursday
- `5` Friday
- `6` Saturday
items:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
expiration_time:
type: string
format: time
description: >-
Defines the ending hour of validity in the HH:mm format. The
resource is *inactive after* this time.
example: '14:00'
Category:
title: Category
description: This is an object representing a category.
type: object
properties:
id:
type: string
description: Unique category ID assigned by Voucherify.
name:
type: string
description: Category name.
hierarchy:
type: integer
description: >-
Category hierarchy. Categories with lower hierarchy are processed
before categories with higher hierarchy value.
minimum: 0
object:
type: string
default: category
enum:
- category
description: >-
The type of the object represented by the JSON. This object stores
information about the category.
created_at:
type: string
description: >-
Timestamp representing the date and time when the category was
created. The value is shown in the ISO 8601 format.
example: '2022-07-14T10:45:13.156Z'
format: date-time
updated_at:
type: string
example: '2022-08-16T10:52:08.094Z'
description: >-
Timestamp representing the date and time when the category was
updated. The value is shown in the ISO 8601 format.
format: date-time
required:
- id
- name
- hierarchy
- created_at
- object
ReferralProgram:
title: Referral Program
description: >-
Defines the referee reward and the way a referral is triggered. Context:
`REFERRAL_PROGRAM`.
type: object
properties:
conversion_event_type:
type: string
enum:
- redemption
- custom_event
description: Define how a referral is triggered.
custom_event:
type: object
description: Contains details about the custom event.
properties:
id:
type: string
example: ms_Ll9enAm2BCN0M1s4VxWobLFM
description: Unique custom event ID.
name:
type: string
description: Custom event name.
referee_reward:
type: object
description: Defines the referee reward.
properties:
related_object_parent:
type: object
description: Details of the resource from which the reward originates.
properties:
id:
type: string
example: camp_kdxp3vf1clQ9CFs1jpqv3tZe
description: Unique ID of the reward source.
name:
type: string
description: Name of the reward source.
object:
type: string
default: CAMPAIGN
enum:
- CAMPAIGN
description: Type of resource represented by the source of the reward.
type:
type: string
description: Type of reward.
enum:
- LOYALTY_CARD
- GIFT_VOUCHER
amount:
type: integer
description: >-
Define the number of `points` to add to a loyalty card or
`credits` to the balance on a gift card. In case of the gift
card, the value is multiplied by 100 to precisely represent 2
decimal places. For example, $100 amount is written as 10000.
LoyaltyTiersExpirationAll:
title: Loyalty Tiers Expiration
type: object
description: Defines the Loyalty Tiers Expiration.
properties:
qualification_type:
type: string
enum:
- BALANCE
- POINTS_IN_PERIOD
description: >-
Tier qualification.
`BALANCE`: Points balance is based on the customer's current points
balance. Customers qualify for the tier if their points balance is
in the points range of the tier.
`POINTS_IN_PERIOD`: A customer qualifies for the tier only if the sum of the accumulated points in a **defined time interval** reaches the tier threshold.
qualification_period:
type: string
description: >-
Customers can qualify for the tier if they collected enough points
in a given time period. So, in addition to the customer having to
reach a points range, they also need to have collected the points
within a set time period.
| **Period** | **Definition** |
|:---|:---|
| **Calendar Month** | Points collected in one calendar month
January, February, March, etc. |
| **Calendar Quarter** | Points collected in the quarter
-
January - March
- April - June
- July - September
-
October - December |
| **Calendar Half-year** | Points collected in the half-year
-
January - June
- July - December |
| **Calendar Year** | Points collected in one calendar year
January - December |
enum:
- MONTH
- QUARTER
- HALF_YEAR
- YEAR
start_date:
type: object
description: Defines the conditions for the start date of the tier.
properties:
type:
type: string
enum:
- IMMEDIATE
- NEXT_PERIOD
description: |-
What triggers the tier to be valid for a customer.
`IMMEDIATE`: After reaching the minimum required points.
`NEXT_PERIOD`: When the next qualification period starts.
required:
- type
expiration_date:
type: object
description: Defines the conditions for the expiration date of a tier.
properties:
type:
type: string
enum:
- END_OF_PERIOD
- END_OF_NEXT_PERIOD
- BALANCE_DROP
- CUSTOM
description: >-
What triggers the tier to expire for a customer.
`END_OF_PERIOD`: Expire tier at the end of the period.
`END_OF_NEXT_PERIOD`: Expire tier at the end of the next
period.
`BALANCE_DROP`: Tier expires when the points balance drops below the required range of the tier.
`CUSTOM`: Tier expires after a certain time period passes following the instance the points balance drops below the required range of the tier.
extend:
type: string
description: >-
Extend the expiration by adding extra months or days in ISO 8601
format. The tier will remain active even though it reaches its
expiration time period. For example, a tier with a duration of
`P3M` will be valid for an additional duration of 3 months and a
tier with a duration of `P1D` will be valid for an additional
duration of 1 day.
rounding:
description: Defines the rounding mechanism for tier expiration.
properties:
type:
type: string
enum:
- MONTH
- QUARTER
- HALF_YEAR
- YEAR
- CUSTOM
description: >-
This mechanism describes a custom rounding for the
expiration date.
strategy:
type: string
enum:
- START
- END
description: >-
This mechanism describes a rounding strategy for the
expiration date.
unit:
type: string
description: >-
Defines the type of unit of time in which the rounding
period is counted.
default: MONTH
enum:
- MONTH
value:
type: integer
description: >-
Value for the unit of time that the rounding applies to.
Units for this parameter are defined by the `rounding.unit`
parameter.
- `0`: January
- `1`: February
- `2`: March
- `3`: April
- `4`: May
- `5`: June
- `6`: July
- `7`: August
- `8`: September
- `9`: October
- `10`: November
- `11`: December
required:
- type
- extend
required:
- qualification_type
- start_date
- expiration_date
AccessSettingsCampaignAssignmentsList:
title: Access Settings Campaign Assignments List
type: object
description: >-
Lists all assignments of the campaign to areas and stores. For [GET List
Campaigns](/api-reference/campaigns/list-campaigns), this is returned if
the `expand=access_settings_assignments` query parameter is passed in
the request. This object is not returned for the [GET Campaign summary
endpoint](/api-reference/campaigns/get-campaign-summary).
**NOTE**: This object is returned only if the Areas and Stores
enterprise feature is enabled. Contact [Voucherify
Sales](https://www.voucherify.io/contact-sales) to learn more.
properties:
object:
type: string
default: list
description: >-
The type of the object represented by JSON. Default is `list`. This
object stores information about campaign assignments to areas and
stores
enum:
- list
data_ref:
type: string
default: data
description: >-
Identifies the name of the attribute that contains the array of
campaign assignments.
enum:
- data
data:
type: array
description: Contains an array of campaign assignments.
items:
$ref: '#/components/schemas/AreaStoreCampaignAssignment'
total:
type: integer
description: Total number of areas and stores to which the campaign is assigned.
minimum: 0
required:
- object
- data_ref
- data
- total
Discount:
title: Discount
type: object
description: Contains information about discount.
oneOf:
- $ref: '#/components/schemas/DiscountAmount'
- $ref: '#/components/schemas/DiscountUnit'
- $ref: '#/components/schemas/DiscountUnitMultiple'
- $ref: '#/components/schemas/DiscountPercent'
- $ref: '#/components/schemas/DiscountFixed'
Gift:
title: Gift
type: object
description: Contains current gift card balance information.
properties:
amount:
type: number
description: >-
Total gift card income over the lifetime of the card. The value is
multiplied by 100 to represent 2 decimal places. For example `10000
cents` for `$100.00`.
subtracted_amount:
type: integer
description: Total amount of subtracted credits over the gift card lifetime.
balance:
type: number
description: >-
Available funds. The value is multiplied by 100 to represent 2
decimal places. For example `10000 cents` for `$100.00`. `balance` =
`amount` - `subtracted_amount` - `redemption.redeemed_amount`.
effect:
type: string
description: Defines how the credits are applied to the customer's order.
enum:
- APPLY_TO_ORDER
- APPLY_TO_ITEMS
required:
- amount
- balance
CampaignLoyaltyCard:
type: object
description: Schema model for a campaign loyalty card.
title: Campaign Loyalty Card
properties:
points:
type: integer
description: >-
The initial number of points to assign to the loyalty card. This is
the current loyalty card score i.e. the number of loyalty points on
the card.
expiration_rules:
type: object
description: >-
Defines the loyalty point expiration rule. This expiration rule
applies when there are no `expiration_rules` defined for an earning
rule.
properties:
period_type:
type: string
description: >-
Type of period. Can be set for `MONTH` or `FIXED_DAY_OF_YEAR`.
`MONTH` requires the `period_value` field. `FIXED_DAY_OF_YEAR`
requires the `fixed_month` and `fixed_day` fields.
enum:
- FIXED_DAY_OF_YEAR
- MONTH
period_value:
type: integer
description: 'Value of the period. Required for the `period_type: MONTH`.'
rounding_type:
type: string
description: >-
Type of rounding of the expiration period. Optional for the
`period_type: MONTH`.
enum:
- END_OF_MONTH
- END_OF_QUARTER
- END_OF_HALF_YEAR
- END_OF_YEAR
- PARTICULAR_MONTH
rounding_value:
type: integer
description: >-
Value of rounding of the expiration period. Required for the
`rounding_type`.
fixed_month:
type: integer
description: >-
Determines the month when the points expire; `1` is January, `2`
is February, and so on. Required for the `period_type:
FIXED_DAY_OF_YEAR`.
minimum: 1
maximum: 12
fixed_day:
type: integer
description: >-
Determines the day of the month when the points expire. Required
for the `period_type: FIXED_DAY_OF_YEAR`.
minimum: 1
maximum: 31
required:
- period_type
required:
- points
CodeConfig:
title: Code Config
type: object
description: >-
Contains information about the config used for the voucher code. Defines
the code's pattern (prefix, postfix, length, charset, etc).
properties:
length:
type: number
description: >-
Number of characters in a generated code (excluding prefix and
postfix).
charset:
type: string
description: >-
Characters that can appear in the code.
Examples:
- Alphanumeric:
`0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`
- Alphabetic:
`abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`
- Alphabetic Lowercase: `abcdefghijklmnopqrstuvwxyz`
- Alphabetic Uppercase: `ABCDEFGHIJKLMNOPQRSTUVWXYZ`
- Numbers: `0123456789`
- Custom: a custom character set
prefix:
type: string
description: A text appended before the code.
postfix:
type: string
description: A text appended after the code.
pattern:
type: string
description: >-
A pattern for codes where hashes (#) will be replaced with random
characters. Overrides `length`.
initial_count:
type: integer
description: Internal value, does not change anything if provided.
AreaStoreCampaignAssignment:
title: Areas and Stores Campain Assignment
type: object
description: An object representing an assignment of a campaign to an area or store.
properties:
id:
type: string
description: Unique identifier of the campaign assignment.
example: arsca_0ef5ee192117ae2416
area_id:
type: string
description: Unique identifier of the area to which the campaign is assigned.
example: ar_0ea6cd7b781b8f857f
all_stores:
type: boolean
description: >-
Determines if the campaign is assigned to all of the stores in the
area, i.e. if an area ID is passed in the
`access_settings.assign.area_all_stores_ids` in the request.
area_store_id:
type: string
description: Unique identifier of the store to which the campaign is assigned.
example: ars_0ec347e2016bed85f4
created_at:
type: string
description: >-
Date and time when the assignment was made. The value is shown in
the ISO 8601 format.
format: date-time
example: '2024-06-25T19:04:16.260Z'
object:
type: string
description: >-
The type of the object represented by JSON. This object stores
information about the campaign assignment to areas or stores.
default: area_store_campaign_assignment
enum:
- area_store_campaign_assignment
required:
- id
- area_id
- created_at
- object
DiscountAmount:
type: object
title: Amount
properties:
type:
type: string
default: AMOUNT
enum:
- AMOUNT
description: Defines the type of the voucher.
amount_off:
type: number
description: >-
Amount taken off the subtotal of a price. Value is multiplied by 100
to precisely represent 2 decimal places. For example, a $10 discount
is written as 1000.
amount_off_formula:
type: string
description: Formula used to dynamically calculate the discount.
aggregated_amount_limit:
type: integer
description: Maximum discount amount per order.
effect:
description: Defines how the discount is applied to the customer's order.
allOf:
- $ref: '#/components/schemas/DiscountAmountVouchersEffectTypes'
is_dynamic:
type: boolean
description: Flag indicating whether the discount was calculated using a formula.
required:
- type
- amount_off
DiscountUnit:
type: object
title: Unit
properties:
type:
type: string
default: UNIT
enum:
- UNIT
description: Discount type.
unit_off:
type: integer
description: Number of units to be granted a full value discount.
unit_off_formula:
type: string
description: Formula used to dynamically calculate the number of units.
effect:
description: Defines how the unit is added to the customer's order.
allOf:
- $ref: '#/components/schemas/DiscountUnitVouchersEffectTypes'
unit_type:
type: string
description: >-
The product deemed as free, chosen from product inventory (e.g.
time, items).
product:
description: Contains information about the product.
allOf:
- $ref: '#/components/schemas/SimpleProductDiscountUnit'
sku:
$ref: '#/components/schemas/SimpleSkuDiscountUnit'
is_dynamic:
type: boolean
description: Flag indicating whether the discount was calculated using a formula.
required:
- type
- unit_type
DiscountUnitMultiple:
type: object
title: Unit Multiple
properties:
type:
type: string
default: UNIT
enum:
- UNIT
description: Discount type.
effect:
type: string
default: ADD_MANY_ITEMS
enum:
- ADD_MANY_ITEMS
description: Defines how the discount is applied to the customer's order.
units:
type: array
items:
$ref: '#/components/schemas/DiscountUnitMultipleOneUnit'
required:
- type
- units
DiscountPercent:
type: object
title: Percent
properties:
type:
type: string
default: PERCENT
enum:
- PERCENT
description: Defines the type of the voucher.
percent_off:
type: number
description: The percent discount that the customer will receive.
percent_off_formula:
type: string
description: Formula used to dynamically calculate the discount.
amount_limit:
type: number
description: >-
Upper limit allowed to be applied as a discount. Value is multiplied
by 100 to precisely represent 2 decimal places. For example, a $6
maximum discount is written as 600.
aggregated_amount_limit:
type: integer
description: Maximum discount amount per order.
effect:
description: Defines how the discount is applied to the customer's order.
allOf:
- $ref: '#/components/schemas/DiscountPercentVouchersEffectTypes'
is_dynamic:
type: boolean
description: Flag indicating whether the discount was calculated using a formula.
required:
- type
- percent_off
DiscountFixed:
title: Fixed
type: object
properties:
type:
type: string
default: FIXED
enum:
- FIXED
description: Defines the type of the voucher.
fixed_amount:
type: number
description: >-
Sets a fixed value for an order total or the item price. The value
is multiplied by 100 to precisely represent 2 decimal places. For
example, a $10 discount is written as 1000. If the fixed amount is
calculated by the formula, i.e. the `fixed_amount_formula` parameter
is present in the fixed amount definition, this value becomes the
**fallback value**. As a result, if the formula cannot be calculated
due to missing metadata, for example, this value will be used as the
fixed value.
fixed_amount_formula:
type: string
description: Formula used to dynamically calculate the discount.
effect:
description: Defines how the discount is applied to the customer's order.
allOf:
- $ref: '#/components/schemas/DiscountFixedVouchersEffectTypes'
is_dynamic:
type: boolean
description: Flag indicating whether the discount was calculated using a formula.
required:
- type
- fixed_amount
DiscountAmountVouchersEffectTypes:
title: Discount Amount Vouchers Effect Types
enum:
- APPLY_TO_ORDER
- APPLY_TO_ITEMS
- APPLY_TO_ITEMS_PROPORTIONALLY
- APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY
- APPLY_TO_ITEMS_BY_QUANTITY
type: string
DiscountUnitVouchersEffectTypes:
title: Discount Unit Vouchers Effect Types
enum:
- ADD_MISSING_ITEMS
- ADD_NEW_ITEMS
- ADD_MANY_ITEMS
- ADD_SAME_ITEMS
type: string
SimpleProductDiscountUnit:
type: object
title: Simple Product Discount Unit
properties:
id:
type: string
description: Unique product ID, assigned by Voucherify.
source_id:
type: string
description: Product's source ID.
name:
type: string
description: Product name.
required:
- id
- name
SimpleSkuDiscountUnit:
type: object
title: Simple Sku Discount Unit
properties:
id:
type: string
description: Unique SKU ID, assigned by Voucherify.
source_id:
type: string
description: Product variant's source ID.
name:
type: string
description: Sku name
required:
- id
- name
DiscountUnitMultipleOneUnit:
type: object
title: One Unit
properties:
unit_off:
type: number
description: Number of units to be granted a full value discount.
unit_off_formula:
type: string
description: Formula used to dynamically calculate the number of units.
effect:
type: string
enum:
- ADD_NEW_ITEMS
- ADD_MISSING_ITEMS
description: |+
Defines how the unit is added to the customer's order.
unit_type:
type: string
description: >-
The product deemed as free, chosen from product inventory (e.g.
time, items).
product:
description: Contains information about the product.
allOf:
- $ref: '#/components/schemas/SimpleProductDiscountUnit'
sku:
description: Contains information about the sku.
allOf:
- $ref: '#/components/schemas/SimpleSkuDiscountUnit'
required:
- effect
- unit_type
DiscountPercentVouchersEffectTypes:
title: Discount Percent Vouchers Effect Types
enum:
- APPLY_TO_ORDER
- APPLY_TO_ITEMS
type: string
DiscountFixedVouchersEffectTypes:
title: Discount Fixed Vouchers Effect Types
enum:
- APPLY_TO_ORDER
- APPLY_TO_ITEMS
type: string
securitySchemes:
X-App-Id:
type: apiKey
name: X-App-Id
in: header
X-App-Token:
type: apiKey
name: X-App-Token
in: header
X-Voucherify-OAuth:
type: oauth2
flows:
implicit:
authorizationUrl: https://api.voucherify.io/v1/oauth/token
scopes:
api: Gives access to whole server-side API.
vouchers: >-
Gives access to all endpoints and methods starting with
`v1/vouchers`.
client_api: Gives access to whole client-side API.
client_vouchers: >-
Gives access to all endpoints and methods starting with
`/client/v1/vouchers`.
promotions: >-
Gives access to all endpoints and methods starting with
`/v1/promotions`.
client_promotions: >-
Gives access to all endpoints and methods starting with
`/client/v1/promotions`
campaigns: >-
Gives access to all endpoints and methods starting with
`v1/campaigns`.
client_publish: >-
Gives access to all endpoints and methods starting with
`/client/v1/publish`.
exports: >-
Gives access to all endpoints and methods starting with
`/v1/exports`.
publications: >-
Gives access to all endpoints and methods starting with
`/v1/publications`.
client_validate: >-
Gives access to all endpoints and methods starting with
`/client/v1/validate`.
validations: >-
Gives access to all endpoints and methods starting with
`/v1/validations`.
client_validations: >-
Gives access to all endpoints and methods starting with
`/client/v1/validations`.
qualifications: >-
Gives access to all endpoints and methods starting with
`/v1/qualifications`.
client_qualifications: >-
Gives access to all endpoints and methods starting with
`/client/v1/qualifications`.
client_redeem: >-
Gives access to all endpoints and methods starting with
`/client/v1/redeem
redemptions: >-
Gives access to all endpoints and methods starting with
`/v1/redemptions`.
client_redemptions: >-
Gives access to all endpoints and methods starting with
`/client/v1/redemptions`
customers: >-
Gives access to all endpoints and methods starting with
`/v1/customers`.
client_customers: >-
Gives access to all endpoints and methods starting with
`/client/v1/customers`.
orders: >-
Gives access to all endpoints and methods starting with
`/v1/orders`.
products: >-
Gives access to all endpoints and methods starting with
`/v1/products`.
skus: >-
Gives access to all endpoints and methods starting with
`/v1/SKUs`.
validation-rules: >-
Gives access to all endpoints and methods starting with
`/v1/validation-rules`.
validation-rules-assignments: >-
Gives access to all endpoints and methods starting with
`/v1/validation-rules-assignments
segments: >-
Gives access to all endpoints and methods starting with
`/v1/segments`.
events: >-
Gives access to all endpoints and methods starting with
`/v1/events`.
client_events: >-
Gives access to all endpoints and methods starting with
`client/v1/events`.
rewards: >-
Gives access to all endpoints and methods starting with
`/v1/rewards`.
assets: >-
Gives access to all endpoints and methods starting with
`/v1/assets`.
task-results: >-
Gives access to all endpoints and methods starting with
`/v1/task-results`.
loyalties: >-
Gives access to all endpoints and methods starting with
`/v1/loyalties`.
client_consents: >-
Gives access to all endpoints and methods starting with
`client/v1/consents`.
consents: >-
Gives access to all endpoints and methods starting with
`/v1/consents`.
async-actions: >-
Gives access to all endpoints and methods starting with
`/v1/async-actions`.
product-collections: >-
Gives access to all endpoints and methods starting with
`/v1/product-collections`.
categories: >-
Gives access to all endpoints and methods starting with
`/v1/categories`.
metadata-schemas: >-
Gives access to all endpoints and methods starting with
`/v1/metadata-schemas`.
locations: >-
Gives access to all endpoints and methods starting with
`/v1/locations`.
referrals: >-
Gives access to all endpoints and methods starting with
`/v1/referrals`.
trash-bin: >-
Gives access to all endpoints and methods starting with
`/v1/trash-bin`.
templates: >-
Gives access to all endpoints and methods starting with
`/v1/templates`.
````