Pre-Populating Merchant Context via URL Parameters
Partners can deep-link merchants into the portal flow with pre-populated context, reducing friction and improving data accuracy.
Overview
Pass merchant information as GET parameters to automatically pre-fill form fields. This eliminates manual data entry errors and speeds up the ordering process.
Supported Parameters
| Parameter | Description | Field Behavior |
|---|---|---|
account | Merchant or account name | Pre-populates Account/Merchant name field |
locationId | Merchant location identifier | Pre-populates Location ID field |
integration | Gift card integration type | Pre-selects the matching integration dropdown |
All pre-populated fields remain editable, allowing merchants to correct or adjust values as needed.
URL Format
https://ecardsystems.com/{portal}?account={value}&locationId={value}&integration={value}
Example
https://ecardsystems.com/acme?account=Riverside%20Cafe&locationId=1042&integration=eCard%20Systems
This URL will:
- Open the Acme partner portal
- Pre-fill the account name as "Riverside Cafe"
- Pre-fill the location ID as "1042"
- Pre-select "eCard Systems" in the integration dropdown
Parameter Details
account
account- Type: String
- Encoding: URL-encoded (spaces become
%20) - Behavior: Pre-populates the Account name field
- Editable: Yes
locationId
locationId- Type: String
- Encoding: URL-encoded
- Behavior: Pre-populates the Location ID field
- Editable: Yes
integration
integration- Type: String
- Encoding: URL-encoded
- Validation: Case-insensitive match against configured integration options
- Behavior: Pre-selects the matching dropdown option
- Editable: Yes
If the integration value doesn't match any configured option, the field remains empty (no error is displayed).
URL Encoding Reference
Special characters must be URL-encoded:
| Character | Encoded |
|---|---|
| Space | %20 |
& | %26 |
= | %3D |
# | %23 |
' | %27 |
Encoding Examples
| Original Value | URL-Encoded |
|---|---|
Riverside Cafe | Riverside%20Cafe |
Mike's Deli | Mike%27s%20Deli |
Location #42 | Location%20%2342 |
Coffee & Co | Coffee%20%26%20Co |
Error Handling
The system handles invalid or missing parameters gracefully:
| Scenario | Behavior |
|---|---|
| Missing parameter | Field remains empty (normal state) |
| Invalid parameter name | Silently ignored |
Unknown integration value | Field remains empty |
| Empty parameter value | Field remains empty |
No error messages are displayed to the user for invalid parameters.
Best Practices
-
Always URL-encode parameter values - Special characters can break the URL or cause unexpected behavior.
-
Validate integration values - Ensure the
integrationvalue matches one of the configured options (case-insensitive) before generating the URL. -
Handle missing data gracefully - Only include parameters you have data for. Missing parameters are handled automatically.
-
Test URLs before deployment - Verify that generated URLs pre-populate fields correctly in your test environment.
-
Keep URLs reasonably short - While there's no strict limit, very long URLs may be truncated by some systems.
Notes
- Pre-populated fields remain fully editable so merchants can correct any inaccurate data
- This feature is designed to work when configured -- incomplete partner configuration won't block the portal
- Additional context parameters may be supported in the future using the same pattern
Updated 4 months ago
