Overview
The EPISHIP Products API allows you to programmatically manage your company’s product catalog. You can develop applications that automate the synchronization of inventory data, import large product lists via CSV, and maintain product details to ensure accurate descriptions and values on shipping manifests.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Product services.
Figure 1. EPISHIP API relationship diagram. Product inventory management and import flow.
EPISHIP App
EPISHIP’s product management interface acts as a central repository for item details. It allows users to define product names, descriptions, and values, which are then used to auto-fill line items during the order creation process.
EPISHIP API
The REST API that provides comprehensive CRUD (Create, Read, Update, Delete) access to product records. It features specialized endpoints for bulk importing data from CSV files and restoring soft-deleted items to recover accidental removals.
Authentication
Secured via Bearer tokens in the Authorization header. API access is scoped to the specific Company ID, ensuring that product catalogs remain isolated between different tenants or resellers.
Lifecycle Management
The API supports a “soft-delete” mechanism. When a product is deleted, it is marked as inactive rather than being permanently removed immediately. The `restore` endpoint allows administrators to reactivate these products without re-entering data.
What can users do with the EPISHIP Products API?
Users can use the EPISHIP Products API to perform common workflows, such as:
- Retrieve a paginated list of products associated with a specific company
- Bulk import new products using a CSV file upload
- Create individual product records programmatically
- Update existing product details such as descriptions or values
- Soft-delete obsolete products and restore them if needed
Product properties available to view and filter through the EPISHIP Products API:
- Product ID
- Name and Description
- Company ID
- Created/Updated Timestamps
- Deletion Status (Deleted At)