EPISHIP API Shipments overview

EPISHIP Shipments API icon 32px svg

Overview

Figure 1. EPISHIP API relationship diagram. Shipment data retrieval, assignment, and archiving flow.

EPISHIP App

EPISHIP’s shipment management interface provides a comprehensive view of all logistics activity. Users can filter shipments by company or status, view detailed payout breakdowns, and access associated documents directly from the shipment record.

EPISHIP API

The REST API that powers shipment operations. It enables the retrieval of shipment details, manages the downloading of files (individual or bulk zip), and handles the assignment of “orphaned” shipments to the correct billing accounts.

Authentication

Secured via Bearer tokens in the Authorization header. Access to shipment data is strictly controlled based on the user’s role and company association, ensuring that resellers and shippers only see data relevant to their specific accounts.

File Management

A robust system for handling attachments. The API allows for the direct download of files associated with a shipment (e.g., proof of delivery, commercial invoices) either as individual streams, base64 encoded strings, or bulk zipped archives.

What can users do with the EPISHIP Shipments API?

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

Shipment properties available to view and filter through the EPISHIP Shipments API:

Additional info

Related

Related Categories