All guides
User

Coupon Campaigns

Configure offers, claims or customer reward records.

Step-by-step guide

Before you start

Use the account and workspace that own the records. This page does not include administrator configuration forms.

Open this feature

Open /portal/coupon-campaigns on your application domain, or use the matching item in the application menu.

Steps

Create coupon campaign

  1. Open /portal/coupon-campaigns on your own application domain.
  2. Complete these fields in that form: Business, Coupon name, Discount type, Discount value, Coupon code prefix, Usage limit, Terms, Status. Their choices and limits are listed below.
  3. Select Create coupon campaign. The exact label can change between creating and editing a record.
  4. If validation fails, correct the named field and submit again. After success, reopen the same record and compare the saved values.
Field shown in the formWhat to enterExample / note
BusinessRequired. Choose Select business. Enter a whole number.Use the value appropriate to your test account; no preset is supplied.
Coupon nameRequired. No more than 255 characters.Test record (use a unique value where required).
Discount typeRequired. Choose Percentage, Fixed amount, Free item, Custom offer.Choose a displayed option; the available labels are listed above.
Discount valueRequired. No more than 80 characters.Use the value required by the task; no example is assumed.
Coupon code prefixOptional, unless this form asks for it. No more than 24 characters.Use the value required by the task; no example is assumed.
Usage limitOptional, unless this form asks for it. Enter a whole number. At least 1. No more than 100000.Use the value required by the task; no example is assumed.
TermsOptional, unless this form asks for it. No more than 1000 characters.Use the value required by the task; no example is assumed.
StatusRequired. Choose Active, Draft.Choose a displayed option; the available labels are listed above.

Fields shown in the interface

Only fields traced to this role’s handler and its own view are listed. The application can show separate create/edit forms; do not fill every row on one screen.

Form 1 — fields shown in the interface
FieldWhat to enter or choose
BusinessRequired. Choose Select business. Enter a whole number.
Coupon nameRequired. No more than 255 characters.
Discount typeRequired. Choose Percentage, Fixed amount, Free item, Custom offer.
Discount valueRequired. No more than 80 characters.
Coupon code prefixOptional, unless this form asks for it. No more than 24 characters.
Usage limitOptional, unless this form asks for it. Enter a whole number. At least 1. No more than 100000.
TermsOptional, unless this form asks for it. No more than 1000 characters.
StatusRequired. Choose Active, Draft.

Check the result

After a source-checked procedure, verify the same record in the same workspace. Check saved values, visible state and access with the intended test account. An external payment/message/provider action needs its own result check.

Problems and validation

ProblemNext step
A field rejects the valueCheck its named error, the form’s visible choices and the relevant limit. Do not substitute internal numeric codes for the displayed options.
The control is missingCheck role, plan, enabled app and current record state. Do not grant administrator access merely to complete a User task.
The saved result is unexpectedReopen the same record and verify its owner/workspace before repeating the action.

Technical reference

Role-scoped source references

Pinned commit: 5af0236c6d99c50079f5ab8b8fb035506634bd8d

Source-only route information
MethodSource-default route
LIVEWIRE/portal/coupon-campaigns
Unmapped fields — not user instructions

These fields belong to this role’s source handler, but their screen labels were not confirmed.

Source keyHandler
expiry_datemodules/AppCouponCampaigns/Livewire/CouponCampaignIndex.php