These docs are for v1.0. Click to read the latest docs for v2.0.

Errors

📘

Work in progress

We are working on improving this section of documentation. Please check back in a few days!

Vouchery API will return error responses on invalid requests. Each response will include error_code and message. For POST and PATCH requests a list of detailed errors will be returned, including attribute name and, in some cases, expected value or range.

All of API errors are documented below. Where necessary additional description is provided to clarify under what conditions given error can be expected.

Redemption

AttributeError CodeMessageDescription
basecan_not_delete_already_confirmedRedemption was already previously confirmed and can not be updated or deleted
categoriesmissing_required_tagsCategories do not include any of the required tags
categoriesincludes_forbidden_tagsCategories include forbidden tags
categoriesmissing_required_categoryCategories are missing a required category
locationrequiredLocation is required to redeem this voucherReturned if no location was provided for a voucher belonging to a campaign limited by area rule
locationinvalidLocation coordinates are not validReturned if provided location was in invalid format
locationoutside_of_permitted_areasLocation is outside of permitted areasReturned if provided location is outside of permitted areas
vouchernot_valid_at_this_timeVoucher is not valid at this timeReturned if campaign is limited by time of order or time frame rule
voucherunique_code_already_usedVoucher was already used
campaignnot_activeCampaign is not accepting redemptions because it is not active
campaignmaximum_redemptions_exceededCampaign maximum number of redemptions for this campaign has been already reachedReturned if campaign has max_redemptions set and it has been exceeded
campaignbudget_exceededCampaign maximum budget has already been reachedReturned if campaign has max_total_budget set and it has been exceeded
campaigntotal_budget_exceededCampaign maximum budget has already been reachedReturned if campaign has a budget rule of total type and it's limit has been exceeded
campaignyearly_budget_exceededCampaign yearly budget has already been reachedReturned if campaign has a budget rule of yearly type and it's limit has been exceeded
campaignquarterly_budget_exceededCampaign quarterly budget has already been reachedReturned if campaign has a budget rule of quarterly type and it's limit has been exceeded
campaignmonthly_budget_exceededCampaign monthly budget has already been reachedReturned if campaign has a budget rule of monthly type and it's limit has been exceeded
campaignweekly_budget_exceededCampaign weekly budget has already been reachedReturned if campaign has a budget rule of weekly type and it's limit has been exceeded
campaigndaily_budget_exceededCampaign daily budget has already been reachedReturned if campaign has a budget rule of daily type and it's limit has been exceeded
campaignhourly_budget_exceededCampaign hourly budget has already been reachedReturned if campaign has a budget rule of hourly type and it's limit has been exceeded
customernew_customer_requiredCustomer needs to be a new customerReturned if campaign has new customer rule applied and provided customer has redeemed any voucher in the past
customerper_customer_limit_exceededCustomer has already reached maximum number of redemptionsReturned if campaign has per customer rule applied and customer had exceeded limit of redemptions defined
customertime_limit_expiredCustomer can no longer reedem this discountReturned if campaigns has subscription rule
customerredemptions_limit_exceededCustomer has already reached maximum number of redemptionsReturned if campaigns has subscription rule
customerdoes_not_match_assigned_customerCustomer does not match customer identifier associated with the voucherReturned if a voucher has customer identifier assigned and identifier provided for a redemption doesn't match
customerrequiredCustomer identifier is required to redeem this voucherReturned if voucher is has customer identifier assigned but no identifier was provided for a redemption
origin_redemptionnot_originalOrigin redemption can not be a re-redemptionReturned if campaigns has subscription rule
total_transaction_costnot_a_numberTotal transaction cost must be a decimal number
total_transaction_costbelow_campaign_minimumTotal transaction cost must be greater than or equal to the campaign minimum of %{count}Returned if campaign has minimum value set and a redemption total transaction value is below that value
total_transaction_costabove_campaign_maximumTotal transaction cost must be less than or equal to the campaign maximum of %{count}Returned if campaign has maximum value set and a redemption total transaction value is above that value
transaction_idrequiredTransaction ID is required
transaction_idmust_be_uniqueTransaction ID must be unique