Home
ePAL REST API Overview
Use the information provided here to understand how to use the REST API.
API Reference Guide
This sections describes all the endpoints, requests and fields that you can use for your API integration.

ePAL REST API Overview
Use the information provided here to understand how to use the REST API.
- Getting Started with the API
  Use the information here to help you get started with your integration with the ePAL REST API.
- API Reference Guide
  This sections describes all the endpoints, requests and fields that you can use for your API integration.
  - Health Endpoint Overview
    Use the requests available for this endpoint to check on the general health of your connecttion to the ePAL API and ePAL's overall health status.
  - Health Check Endpoint
    Use the request in this endpoint to check the health of various connections and applications.rest_api/epal_api_rqst_chck_all_sts.html
  - Transactions Endpoint
    Use this endpoint to find requests that are related to transactions.
  - Quotes Endpoint
    Use the requests in this endpoint to create and manage quotes.rest_api/epal_api_qte_ssn_rwdt_rqst.html
  - Documents Overview
    Use the requests available for this endpoint to manage documents such as shipping labels, customs declarations, commercial invoices and more.rest_api/epal_api_gt_shppo_cstms_dclrtn_rqst.html
  - Fulfillment Endpoint
    Use the request in this endpont to process fulfillments.
  - IOSS Validation Endpoint
    Use the requests here to check if a transaction qualifies for IOSS.
  - Code Translation Endpoint
    Use the requesy in this endpoint to map commodity codes to export, import or transport codes.
  - HS Code Endpoint
    Use the requests in this endpoint to seach HS codes.rest_api/epal_api_srch_hs_desc_rqst.html

API Reference Guide

This sections describes all the endpoints, requests and fields that you can use for your API integration.

Each request topic contains all the details you need to perform each function.

Requests and Endpoints

The following table shows the requests and endpoints:

Table 1. Endpoints and Requests
Endpoint	Requests
Health (`/health`)	Get welcome message
Health (`/health`)	Health check
Health Check (`/Health/Integrations`)	Check health status of all integrations
Transactions (`/transaction`)	Process transaction
Quotes (`/quotes`)	Get user quotes
	Get user quotes (Pagination/Summary)
	Get quotes by session ID
	Get quote by session ID with raw data ()
Documents (`/generate-labels`)	Generate shipping labels and documents
	Get label by ID
	Get label by tracking number
	Get all Shippo documents for a transaction
	Get Shippo customs declaration by ID
Fulfillment (`/fulfillment`)	Process fulfillment
IOSS Validation (`/{ioss-validation}`)	Validate IOSS eligibility
IOSS Validation (`/{ioss-validation}`)	Validate IOSS eligibility by session ID
Code Translation (`/code-translation`)	Translate export/import/transport codes
HS Code (`/hscode`)	Search HS/TARIC by code
HS Code (`/hscode`)	Search HS/TARIC by description