EPISHIP API Company Addresses overview

EPISHIP Company Addresses API icon 32px svg

Overview

The EPISHIP Company Addresses API lets you manage the contact repository for shipping locations within your logistics network. You can develop applications that integrate with EPISHIP to automate the maintenance of address books, facilitate bulk imports and exports of shipping contacts, and synchronize sender/receiver data across your organization.

View Doc → 

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Company Addresses services.

EPISHIP Company Addresses API diagram

Figure 1. EPISHIP API relationship diagram. Address book management and synchronization flow.

EPISHIP App

EPISHIP’s address services provide a centralized address book for storing frequently used shipping destinations and origins. Users can categorize addresses as “Senders” or “Receivers” and flag them as “Residential” or “Commercial” to ensure accurate rating and labeling.

EPISHIP API

The REST API that allows users to create, read, update, and delete (CRUD) address records programmatically. It serves as the backend for managing your organization’s shipping rolodex, supporting both individual record management and batch operations.

Bulk Management

Dedicated capabilities within the API to handle large datasets efficiently. This includes endpoints to export address books to CSV format for reporting or backup, and to import CSV files to rapidly populate shipping contacts.

Soft Deletes & Restoration

A safety system that allows addresses to be “soft-deleted” rather than permanently removed immediately. The API provides specific endpoints to restore these accidentally deleted records, ensuring data integrity.

What can users do with the EPISHIP Company Addresses API?

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

  • Retrieve a paginated list of all stored addresses for a company
  • Create new shipping contacts with validation for required fields (address, city, state, zip)
  • Update existing address details to keep contact info current
  • Soft-delete obsolete addresses or restore previously deleted ones
  • Export the entire address book to a CSV file for external use
  • Bulk delete multiple address records in a single request

Address properties available to view and filter through the EPISHIP Company Addresses API:

  • Address ID & Company ID
  • Contact Name & Company Name
  • Full Address Details (Address 1, Address 2, City, State, Zip, Country)
  • Contact Info (Phone, Email)
  • Flags: Sender (true/false), Residential (true/false)
  • Description (Internal reference note)

Additional info

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

Related

Related Categories