Overview
The EPISHIP Companies API lets you manage the organizational hierarchy and tenant structure within your logistics network. You can develop applications that integrate with EPISHIP to automate the onboarding of new merchants, manage parent-child relationships (Merchants vs. Shippers), configure financial credit settings, and handle payment gateway integrations via Stripe.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Company services.
Figure 1. EPISHIP API relationship diagram. Company hierarchy and service inheritance flow.
EPISHIP App
EPISHIP’s company management services allow administrators to build a multi-level ecosystem. Users can define entities as “Merchants” (who manage other companies) or “Shippers” (who process labels), configuring specific address details, notification preferences, and shipping permissions for each.
EPISHIP API
The REST API that allows users to create, read, update, and delete (CRUD) company profiles programmatically. It serves as the central directory for all business entities, managing authentication contexts and service enablement.
Service Configuration
A system that defines the capabilities of a company through “Services” (Account Holder, Merchant, Shipper). The API allows you to toggle these services and configure deep settings, such as GL coding templates or sharing account number (SAN) logic.
Financial & Credit Control
Dedicated capabilities within the API to manage the financial health of a company. This includes endpoints to retrieve Stripe public keys for payment processing, audit “Dynamic Threshold Limits” (DTL) for auto-billing, and view current credit balances (success vs. pending amounts).
What can users do with the EPISHIP Companies API?
Users can use the EPISHIP Companies API to perform common workflows, such as:
- Retrieve a paginated list of companies with sorting and search capabilities
- Fetch details for the currently authenticated company context (“Current Company”)
- Create new companies or restore soft-deleted entities
- Retrieve financial credit summaries and Dynamic Threshold Limits (DTL)
- Fetch and validate Stripe credentials for payment integration
- Filter companies by specific service types (e.g., ‘enabled-shipper’ or ‘shipper-san’)
Company properties available to view and filter through the EPISHIP Companies API:
- Company ID & Parent ID
- Company Name, Address, and Contact Info
- Enabled Status
- Active Services (Merchant, Shipper, Account Holder)
- Settings (Notification emails, Print servers, Child configurations)
- Stripe Configuration (Public Keys, Test Mode)