Provider connections, APIs and webhooks

Configure provider mapping JSON

Map nested provider values into the module’s normalised fields. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.

Audience: Courier operations staffPermission: Courier: Manage integrationsModule v2.0.0
Jump to steps
Where to goAdmin Area → Courier & Logistics → Settings → Providers → Mapping

What you’ll accomplish

Map nested provider values into the module’s normalised fields. The instructions below follow the supplied module’s controller, form and model rules, including server-side validation and downstream effects.

Follow these steps

  1. Prepare valid JSON.
  2. Enter paths for required external ID and operational fields.
  3. Save.
  4. Test and inspect normalised output.

Fields and options to review

This action uses the values already stored on the selected source record. Review that record before continuing.

Rules the system enforces

  • Invalid JSON is rejected.
  • Path extraction uses configured nested data paths and defaults where supported.

How to confirm it worked

  • The source record, status/history and any downstream notification, provider, POD or finance record should agree after the action.

Security, audit and operational checks

  • Use the exact record and least-privilege role before changing any state.
  • Verify the saved record after every action; a browser message alone is not evidence that every downstream step completed.
  • Use protected document and image routes rather than exposing server filesystem paths.
  • Keep customer, driver, provider, financial and credential data within the authorised workflow.
  • For provider, finance, employment, transport and compliance decisions, follow the organisation’s authorised professional process.
Do not bypass the code flowDo not force database values, invent a status, mark a job completed without signed POD evidence, or expose encrypted credentials to make a screen appear successful.