Integration guide

How to plan an eCommerce integration before writing code

A good integration specification starts with business ownership, data meaning and failure recovery. The API endpoints are only one part of the design.

Ownership

Define the source of truth

For every field or object, decide which system owns it. Products, prices, inventory, customer accounts, orders and shipment status may each have different authorities. Without this, two systems can repeatedly overwrite each other.

Timing

Choose event-driven, scheduled or batch flow deliberately

Not every update needs real-time transport. The right frequency depends on customer impact, operational urgency, data volume, API limits and the cost of failure.

Identity

Use stable identifiers across systems

SKU, order number, external customer ID and shipment IDs need clear mapping. Idempotent processing depends on being able to recognise the same event or record when it is seen again.

Failure handling

Design the exception path before launch

  • What gets retried automatically?
  • What must be corrected manually?
  • How are duplicates prevented?
  • Who is alerted?
  • How can operations replay a failed message?
  • How are the two systems reconciled?
Observability

Make support possible

Integration logs should contain useful correlation identifiers, enough context to understand the failure and a clear link between the record in each system. Silent failures are one of the most expensive integration defects.

Frequently asked questions

Questions we are often asked

Should every integration use middleware?

No. Middleware is valuable when orchestration, transformation or multiple system connections justify it; simple integrations can remain direct.

Are webhooks always better than scheduled jobs?

No. Webhooks are useful for timely events, but scheduled jobs can be simpler and more robust for some high-volume or reconciliation workflows.

How much logging is enough?

Enough to trace a business record across systems without exposing sensitive data unnecessarily.

Related expertise

Continue exploring

Need help applying this to your platform?

We can review your current environment and turn the guidance into a prioritised technical plan.

Start a Conversation