Help
Service Mappings
Service Mappings translate a shipment’s carrier and service into the billing metric that should be charged.
This is how “what the carrier/service was” becomes “which metric should be charged”.
Who can access this page
- Not shown to client-level users.
- Tenant users can create/edit mappings in their tenant.
- Platform admins can manage mappings across different organisations.
When you need a mapping
Add or adjust a mapping when:
- A carrier integration returns a new or unexpected service name/code.
- You want different billing codes based on weight bands, DG (dangerous goods), or other attributes.
- You want tenant-wide defaults, with client-specific overrides.
How matching works (conceptually)
Each mapping row matches against:
- Source value: the shipment service wording or code that should trigger this mapping.
- Optional qualifiers:
- Client: leave blank for tenant-wide mapping.
- Max weight (g): optional weight upper bound for a band.
- Mode: Standard or Dangerous goods.
- Size / Speed / Zone: optional extra selectors.
The mapping outputs:
- Pricing metric: the billing metric that should be used.
Create a mapping
- Go to Billing → Service Mappings.
- Click Create.
- Set:
- Client (optional): blank means “global for this tenant”.
- Source value: the carrier/service text or code you see on shipments.
- Metric key: choose an existing pricing metric (or type a code if the list is not available).
- Optionally set Max weight (g) and Mode.
- Save.
Tips:
- Start with a tenant-wide mapping, then add client-specific overrides only when needed.
- Use Mode = Dangerous goods to charge a different shipping metric when the shipment contains DG items.
Actions
- Create: add a new mapping row.
- Edit: adjust matching fields (source value, weight band, mode) or the target metric key.
- Delete: remove a mapping when it is incorrect or no longer needed.