Viscore knowledge centre

A configurator integration checklist

Integration success depends on knowing where information is created and maintained—not only on connecting an API. This checklist makes the core decisions visible during discovery.

Integration concept connecting a product configurator to data and order systems

Map systems and data ownership

Product names, SKUs, options, prices, stock, customers and quotes may live in different systems. Begin by identifying each system and the owner of every field.

Define what the configurator reads, what it writes and where it only provides a link.

  • Source of product and part codes
  • Price list and currency
  • Stock or availability
  • Customer and dealer permissions
  • Quote, order and payment status

Make a configuration portable

Sending only a total to CRM is not enough. A configuration identifier, codes, values, quantities and version data let a sales team reopen the same selection.

If product data changes, it also matters which rule and price version produced an earlier quote.

Example data package
FieldPurpose
configurationIdReopen a selection
productCode / optionCodesMatch ERP and orders
priceVersionTrace the calculation
previewUrlGive sales visual context
customerContextDealer or customer terms

Turn field mapping into an API contract

A verbal agreement in an integration meeting is not sufficient for implementation. Document each field name, data type, required status, allowed values and failure behaviour with sample requests and responses.

A missing product code can be sent as an empty value, reject the transaction or open a manual review—three very different business outcomes. Agree on these decisions with product and operations before development begins.

  • Request and response schemas
  • Required and optional fields
  • Code and unit dictionaries
  • Authentication and permission scope
  • Error code, message and retry behaviour
  • Versioning and backward compatibility

Define permissions and personal-data boundaries

Price lists, dealer discounts and customer records should not be exposed in public browser code. Sensitive rules belong on the server, with users seeing only authorised results.

Form and CRM connections should collect only needed personal information, with storage, access and deletion responsibilities aligned with the existing data policy.

Make failed transfers visible and recoverable

An API failure should not make a customer request disappear. Plan retries, unique request identifiers, error records and a manual continuation route.

Test missing codes, stale prices, timeouts and duplicate submissions as well as the successful path.

  1. Validate mappings with sample records
  2. Test unauthorised and incomplete responses
  3. Prevent duplicate records on retry
  4. Define monitoring and ownership
  5. Document rollback and manual continuation

Prepare the integration for a controlled release

A connection that works with test data may behave differently with production permissions and volume. Samples should represent real variety, including multiple currencies, special characters, large option sets and older product versions.

Prepare monitoring, owners, rollback conditions and a first-day checklist before release. Track missing fields, unmatched codes and manual intervention as well as successful responses.

  1. Separate test and production access
  2. Run end-to-end rehearsals with representative data
  3. Measure load and timeout limits
  4. Define alert thresholds and owners
  5. Prepare staged release and rollback plans

Sources and further reading

Define the right starting point for your product.

Tell us about your product structure, existing files and sales journey. We’ll explore an initial scope together.