EPISHIP API Orders overview

EPISHIP Orders API icon 32px svg

Overview

The EPISHIP Orders API allows you to programmatically manage the lifecycle of shipping orders. You can develop applications that automate order creation, import large batches of orders via CSV, update order statuses in real-time, and retrieve detailed shipment tracking information associated with specific orders.

View Doc →

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

EPISHIP Orders API diagram

Figure 1. EPISHIP API relationship diagram. Order creation, update, and shipment association flow.

EPISHIP App

EPISHIP’s order management interface provides a centralized view of all shipping requests. It allows users to manually edit order details, view line items, and track the fulfillment status of individual packages linked to an order.

EPISHIP API

The REST API that facilitates comprehensive order management. It supports creating orders with complex line items, updating financial details like tax and discounts, and performing bulk imports using multipart form data.

Authentication

Secured via Bearer tokens in the Authorization header. API access is scoped to the specific company ID, ensuring that order data remains isolated and secure across different tenant accounts.

Order Association

A relational system that links Orders to specific Company IDs, Billing/Shipping addresses, and individual Shipment records. This enables a complete audit trail from the initial order request to the final delivery.

What can users do with the EPISHIP Orders API?

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

  • Retrieve a paginated list of orders filtered by status, date, or sender
  • Import orders in bulk via CSV file upload
  • Create new orders with detailed line items and product information
  • Update existing orders with tracking numbers, shipping costs, and status changes
  • Soft-delete and restore orders to manage historical data

Order properties available to view and filter through the EPISHIP Orders API:

  • Order ID and Number
  • Order Status (e.g., pending, shipped)
  • Financial Totals (Amount, Discount, Tax, Grand Total)
  • Shipping Status
  • Associated Shipment IDs

Additional info

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

Related

Related Categories