EPISHIP API Carrier Services overview

EPISHIP Carrier Services API icon 32px svg

Overview

The EPISHIP Carrier Services API lets you manage the shipping service levels available within your logistics network. You can develop applications that integrate with EPISHIP to automate the retrieval of valid service codes, map carrier-specific service names to internal definitions, and validate which services are active for quoting and labeling.

View Doc →

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

EPISHIP Carrier Services API diagram

Figure 1. EPISHIP API relationship diagram. Service level retrieval and validation flow.

EPISHIP App

EPISHIP’s service configuration allows administrators to control which carrier services are available to shippers. Users can toggle specific services on or off to control costs or operation capabilities.

EPISHIP API

The REST API that allows users to list, sort, and filter carrier services programmatically, serving as the source of truth for available shipping methods, internal “rocket codes,” and service directions (import/export).

Service Mapping

A system that links various carrier naming conventions to a single service definition via csv_types, ensuring consistent service matching across different data sources.

Directional Logic

A dedicated capability within the API that categorizes services based on their flow such as “export,” “import,” or domestic (null) in order to enable applications to filter relevant services based on the shipment’s origin and destination.

What can users do with the EPISHIP Carrier Services API?

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

  • Retrieve a paginated list of all supported carrier services
  • Filter services by specific carrier to build carrier-specific dropdowns
  • Sort services by ID or Name to organize display logic
  • Retrieve the full details of a specific service record by ID
  • Identify the internal “Rocket Code” required for label generation requests
  • Audit enabled/disabled status of services within the platform

Service properties available to view and filter through the EPISHIP Carrier Services API:

  • Service ID & Common Service ID
  • Carrier Name
  • Display Name
  • Rocket Code (Internal API Code)
  • Direction (Import/Export/Null)
  • Enabled Status

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