EPISHIP API Shipping Accounts overview

EPISHIP Shipping Accounts API icon 32px svg

Overview

The EPISHIP Shipping Accounts API allows you to programmatically manage carrier accounts linked to your company. You can develop applications that validate carrier credentials, upload historical shipping data via CSV, and dynamically attach or detach shipping accounts to specific company profiles.

View Doc →

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Shipping Account services.

EPISHIP Shipping Accounts API diagram

Figure 1. EPISHIP API relationship diagram. Credential validation and account linkage flow.

EPISHIP App

EPISHIP’s account management interface serves as the central hub for configuring carrier relationships. Users can input API keys, meter numbers, and passwords for all carriers, enabling the system to rate shop and generate labels on their behalf.

EPISHIP API

The REST API that handles the secure storage and validation of carrier credentials. It supports operations to test account connectivity in real-time, update account settings, and soft-delete accounts that are no longer in use.

Authentication

Secured via Bearer tokens in the Authorization header. Access is restricted based on company hierarchy, ensuring that users can only manage shipping accounts relevant to their specific organization or its children.

Data Import

A specialized feature designed for historical analysis. The API accepts CSV file uploads containing past shipping data, allowing users to backfill their account history for reporting and audit purposes.

What can users do with the EPISHIP Shipping Accounts API?

Users can use the EPISHIP Shipping Accounts API to perform common workflows, such as:

  • Retrieve a list of all configured shipping accounts for a company
  • Validate carrier credentials (username, password, meter number) before saving
  • Create new shipping accounts and link them to specific Company IDs
  • Upload bulk shipping data via CSV for historical analysis
  • Attach or detach specific shipping accounts to sub-companies for shared access

Shipping Account properties available to view and filter through the EPISHIP Shipping Accounts API:

  • Account ID and Name
  • Carrier
  • Account Number
  • Authentication Settings (API Key, Meter Number)
  • Enabled Status
  • Company Relation (e.g., descendant)

Additional info

  • Learn more about developing with EPISHIP Shipping Accounts 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 Shipping Accounts API app, read the Developer Page. More →

Related

Related Categories