EPISHIP API MUD Templates overview

Overview

The EPISHIP MUD Templates API allows you to programmatically manage Mark-Up Discount (MUD) templates. You can develop applications that automate the creation, retrieval, and assignment of pricing strategies, ensuring that service markups and processing fees are consistently applied across your customer base.

View Doc →

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and MUD Template services.

Figure 1. EPISHIP API relationship diagram. MUD template hierarchy and fee application flow.

EPISHIP App

EPISHIP’s application interface allows administrators to visually configure pricing rules. Users can define percentage-based markups, fixed processing fees, or per-shipment charges, and assign these templates to specific companies or reseller accounts.

EPISHIP API

The REST API that provides programmatic access to MUD templates. It supports operations such as listing available templates, retrieving parent company templates for inheritance, and creating custom fee structures via JSON payloads.

Authentication

Secured via Bearer tokens in the Authorization header. Access to templates is governed by strict company hierarchy rules, preventing users from accessing unauthorized parent company data while allowing necessary inheritance logic.

Template Logic

A flexible system for defining cost adjustments. Templates can be configured as `percentage` (e.g., 50% markup), `fixed` (e.g., $99 flat fee), `per_shipment_fixed`, or `per_shipment_percent`, offering granular control over revenue generation.

What can users do with the EPISHIP MUD Templates API?

Users can use the EPISHIP MUD Templates API to perform common workflows, such as:

• Retrieve a listing of all MUD templates associated with a specific company
• Fetch available parent company templates for assignment to child accounts
• Create new MUD templates with custom settings (percentage, fixed amount, etc.)
• Update existing templates to adjust pricing strategies dynamically
• Soft-delete and restore templates to manage lifecycle without data loss

MUD Template properties available to view and filter through the EPISHIP MUD Templates API:

• Template ID
• Name and Description
• Type (percentage, processing_fee)
• Settings (percent value, fixed amount)
• Associated Company ID
• Status (Enabled/Disabled)

Additional info

• Learn more about developing with EPISHIP MUD Templates API, including handling authentication, authorization, reference the Develop on EPISHIP API for your workspace. More →
• Learn more about how to launch and run an EPISHIP MUD Templates API app, read the Developer Page. More →