docs

Set up Address Validation (hidden)

This how to set Set up page, therefore a PANEL / AMDIN API guide. Please use the template provided bellow along with the content provided on the mother page of this section + your own research to fill it out.


Introduction

Provide a short explanation of the purpose of this configuration.

This guide explains how to configure [feature name - link back to non technical page], including all required steps, worker services, parameters, and dependencies. It ensures the correct setup for compliant operation across SCAYLE’s platform, including optional customizations.


Prerequisites

List any system knowledge, tools, or API access required before beginning.

  • Familiarity with SCAYLE’s Admin API, Customer Panel (CUPA), and Config API.
  • Access to SCAYLE Panel for merchant and shop settings.
  • Permissions

Set up steps

Break down the configuration into clear, ordered phases. Include panel paths, APIs, and parameter notes. Also include screenshots with features already configured.

Example:

Step 1: Create / Enable Core Feature or Type

e.g. Create a Carrier Type or Enable Anonymization Worker

  • Navigate to: Settings ➜ Shipping and Delivery ➜ Carriers
  • Set up base entity:
    • carrierKey: Unique ID
    • carrierGroupKey: Shared branding or translations
    • Optional: Tracking URL, logo, display name

Step 2: Lorem Ipsum

e.g. Assign Carrier Type to a Merchant

  • Navigate to: Settings ➜ Merchant Management ➜ Merchant ➜ Edit
  • Use dropdowns to assign configuration to each Merchant country

Step 3: Lorem Ipsum

e.g. Add Carrier to Shop Country or Enable Worker Services

  • Navigate to: Settings ➜ Shipping and Delivery ➜ Carriers ➜ Add Carrier
  • Assign to specific shop country
  • Confirm configuration consistency across shops

Configuration Parameters

List all keys, their values, webhooks, FE (TRX emails, notifications etc) and COFE configs and behavior. Highlight anything non-obvious.

ParameterDescriptionNotes
customer.anonymisation.thresholdTime (in days) before deletion is allowed for customers with closed ordersMust be set in Config API or Checkout Config Sheet
customer.anonymisation.storageDeletionDetermines if data (e.g., invoices) is deletedTrue = Keep, False = Delete (counterintuitive)