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

ParameterDescriptionField Behavior
accountMerchant or account namePre-populates Account/Merchant name field
locationIdMerchant location identifierPre-populates Location ID field
integrationGift card integration typePre-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

  • Type: String
  • Encoding: URL-encoded (spaces become %20)
  • Behavior: Pre-populates the Account name field
  • Editable: Yes

locationId

  • Type: String
  • Encoding: URL-encoded
  • Behavior: Pre-populates the Location ID field
  • Editable: Yes

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:

CharacterEncoded
Space%20
&%26
=%3D
#%23
'%27

Encoding Examples

Original ValueURL-Encoded
Riverside CafeRiverside%20Cafe
Mike's DeliMike%27s%20Deli
Location #42Location%20%2342
Coffee & CoCoffee%20%26%20Co

Error Handling

The system handles invalid or missing parameters gracefully:

ScenarioBehavior
Missing parameterField remains empty (normal state)
Invalid parameter nameSilently ignored
Unknown integration valueField remains empty
Empty parameter valueField remains empty

No error messages are displayed to the user for invalid parameters.

Best Practices

  1. Always URL-encode parameter values - Special characters can break the URL or cause unexpected behavior.

  2. Validate integration values - Ensure the integration value matches one of the configured options (case-insensitive) before generating the URL.

  3. Handle missing data gracefully - Only include parameters you have data for. Missing parameters are handled automatically.

  4. Test URLs before deployment - Verify that generated URLs pre-populate fields correctly in your test environment.

  5. 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